The fors_zeropoint recipe
===============================================================

.. data:: fors_zeropoint

Synopsis
--------

Compute zeropoint

Description
-----------

Input files
^^^^^^^^^^^^
::

  DO category:               Type:       Explanation:              Number:
  STANDARD_IMG               FITS image  Phot. standard field        1
  MASTER_BIAS                FITS image  Master bias                 1
  MASTER_SKY_FLAT_IMG        FITS image  Master sky flatfield        1
  FLX_STD_IMG                FITS table  Standard star catalog       1+
  PHOT_TABLE                 FITS table  Filter ext. coeff, color    1

Output files
^^^^^^^^^^^^
::

  DO category:               Data type:  Explanation:
  SOURCES_STD_IMG            FITS image  Unfiltered SExtractor output
  ALIGNED_PHOT               FITS table
  PHOT_BACKGROUND_STD_IMG    FITS image  Reduced science image background
  STANDARD_REDUCED_IMG       FITS image  Reduced std image

Constructor
-----------

.. method:: cpl.Recipe("fors_zeropoint")
   :noindex:

   Create an object for the recipe fors_zeropoint.

::

   import cpl
   fors_zeropoint = cpl.Recipe("fors_zeropoint")

Parameters
----------

.. py:attribute:: fors_zeropoint.param.sex_exe

    SExtractor executable (str; default: '/usr/bin/source-extractor') [default="/usr/bin/source-extractor"].
.. py:attribute:: fors_zeropoint.param.sex_config

    SExtractor configuration file (str; default: '/usr/share/cpl-  plugins/fors-5.5.6/config/fors.sex') [default="/usr/share/cpl-plugins/fors-5.5.6/config/fors.sex"].
.. py:attribute:: fors_zeropoint.param.sex_mag

    SExtractor magnitude (str; default: 'MAG_APER') [default="MAG_APER"].
.. py:attribute:: fors_zeropoint.param.sex_magerr

    SExtractor magnitude error (str; default: 'MAGERR_APER') [default="MAGERR_APER"].
.. py:attribute:: fors_zeropoint.param.sex_radius

    Background error map median filter radius (unbinned pixels) (int;  default: 64) [default=64].
.. py:attribute:: fors_zeropoint.param.maxoffset

    Maximum acceptable offset between the image and catalogue WCS (pixels)  (float; default: 150.0) [default=150.0].
.. py:attribute:: fors_zeropoint.param.magcutE

    Zeropoint absolute cutoff (magnitude) (float; default: 1.0) [default=1.0].
.. py:attribute:: fors_zeropoint.param.magcutk

    Zeropoint kappa rejection parameter (float; default: 5.0) [default=5.0].
.. py:attribute:: fors_zeropoint.param.magsyserr

    Systematic error in magnitude (float; default: 0.01) [default=0.01].


The following code snippet shows the default settings for the available 
parameters.

::

   import cpl
   fors_zeropoint = cpl.Recipe("fors_zeropoint")

   fors_zeropoint.param.sex_exe = "/usr/bin/source-extractor"
   fors_zeropoint.param.sex_config = "/usr/share/cpl-plugins/fors-5.5.6/config/fors.sex"
   fors_zeropoint.param.sex_mag = "MAG_APER"
   fors_zeropoint.param.sex_magerr = "MAGERR_APER"
   fors_zeropoint.param.sex_radius = 64
   fors_zeropoint.param.maxoffset = 150.0
   fors_zeropoint.param.magcutE = 1.0
   fors_zeropoint.param.magcutk = 5.0
   fors_zeropoint.param.magsyserr = 0.01


You may also set or overwrite some or all parameters by the recipe 
parameter `param`, as shown in the following example:

::

   import cpl
   fors_zeropoint = cpl.Recipe("fors_zeropoint")
   [...]
   res = fors_zeropoint( ..., param = {"sex_exe":"/usr/bin/source-extractor", "sex_config":"/usr/share/cpl-plugins/fors-5.5.6/config/fors.sex"})


.. seealso:: `cpl.Recipe <https://packages.python.org/python-cpl/recipe.html>`_
   for more information about the recipe object.

Bug reports
-----------

Please report any problems to `Jonas M. Larsen <usd-help@eso.org>`_. Alternatively, you may 
send a report to the `ESO User Support Department <usd-help@eso.org>`_.

Copyright
---------

This file is currently part of the FORS Instrument Pipeline
Copyright (C) 2002-2011 European Southern Observatory

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA


.. codeauthor:: Jonas M. Larsen <usd-help@eso.org>