The vimos_ima_standard recipe
===============================================================

.. data:: vimos_ima_standard

Synopsis
--------

Standard field processing for imaging

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

vimos_ima_standard -- VIMOS standard star recipe.


Take a list of standard frames and correct them to remove bias, dark
and flat field signatures. Optionally defringe the reddest filter
images. Astrometrically and photometrically calibrate the individual
images, but do no stacking

The program accepts the following files in the SOF:

    Tag                   Description
    STD                   A list of raw standard images
    MASTER_BIAS           A master bias frame
    MASTER_DARK           A master dark frame
    MASTER_TWILIGHT_FLAT  A master flat frame
    MASTER_CONF           A master confidence map
    MASTER_FRINGE         A master fringe map (optional)
    MASTER_FRINGE_VAR     A master fringe variance map (optional)
    MASTER_READGAIN       A master readgain table
    MASTER_2MASS_CATALOGUE_ASTROM A master 2MASS index for astrometry or
    MASTER_PPMXL_CATALOGUE_ASTROM A master PPMXL index for astrometry or
    MASTER_APASS_CATALOGUE_ASTROM A master APASS index for astrometry or
    MASTER_LOCAL_CATALOGUE_ASTROM A master local catalogue index for astrometry
    MASTER_APASS_CATALOGUE_PHOTOM A master APASS index for photometry or
    MASTER_LOCAL_CATALOGUE_PHOTOM A master local catalogue index for photometry
    PHOTCAL_TAB           A photometric calibration table
    SCHLEGEL_MAP_NORTH    Northern Schlegel Map
    SCHLEGEL_MAP_SOUTH    Southern Schlegel Map
All of these are required unless specified otherwise.


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

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

   Create an object for the recipe vimos_ima_standard.

::

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

Parameters
----------

.. py:attribute:: vimos_ima_standard.param.preview_only

    Preview only? (bool; default: False) [default=False].
.. py:attribute:: vimos_ima_standard.param.minphotom

    Minimum stars for photometry solution (int; default: 1) [default=1].
.. py:attribute:: vimos_ima_standard.param.prettynames

    Use pretty product names? (bool; default: False) [default=False].
.. py:attribute:: vimos_ima_standard.param.savemstd

    Save matched standard catalogues? (bool; default: False) [default=False].
.. py:attribute:: vimos_ima_standard.param.cdssearch_astrom

    CDS astrometric catalogue (str; default: 'none') [default="none"].
.. py:attribute:: vimos_ima_standard.param.cdssearch_photom

    CDS photometric catalogue (str; default: 'none') [default="none"].
.. py:attribute:: vimos_ima_standard.param.ignore_fringe

    Ignore provided fringe frame? (bool; default: False) [default=False].
.. py:attribute:: vimos_ima_standard.param.src_cat_ipix

    Minimum pixel area for each detected object (int; default: 5) [default=5].
.. py:attribute:: vimos_ima_standard.param.src_cat_thresh

    Detection threshold in sigma above sky (float; default: 2.5) [default=2.5].
.. py:attribute:: vimos_ima_standard.param.src_cat_icrowd

    Use deblending? (bool; default: True) [default=True].
.. py:attribute:: vimos_ima_standard.param.src_cat_rcore

    Value of Rcore in pixels (float; default: 5.0) [default=5.0].
.. py:attribute:: vimos_ima_standard.param.src_cat_nbsize

    Background smoothing box size (int; default: 128) [default=128].
.. py:attribute:: vimos_ima_standard.param.cacheloc

    Location for standard star cache (str; default: '.') [default="."].
.. py:attribute:: vimos_ima_standard.param.magerrcut

    A cut in the magnitude error (float; default: 100.0) [default=100.0].
.. py:attribute:: vimos_ima_standard.param.lthr_mag

    STD stars with magnitudes BRIGHTER than this are removed. (float;  default: 15.0) [default=15.0].
.. py:attribute:: vimos_ima_standard.param.hthr_mag

    STD stars with magnitudes FAINTER than this are removed. (float;  default: 32.0) [default=32.0].


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

::

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

   vimos_ima_standard.param.preview_only = False
   vimos_ima_standard.param.minphotom = 1
   vimos_ima_standard.param.prettynames = False
   vimos_ima_standard.param.savemstd = False
   vimos_ima_standard.param.cdssearch_astrom = "none"
   vimos_ima_standard.param.cdssearch_photom = "none"
   vimos_ima_standard.param.ignore_fringe = False
   vimos_ima_standard.param.src_cat_ipix = 5
   vimos_ima_standard.param.src_cat_thresh = 2.5
   vimos_ima_standard.param.src_cat_icrowd = True
   vimos_ima_standard.param.src_cat_rcore = 5.0
   vimos_ima_standard.param.src_cat_nbsize = 128
   vimos_ima_standard.param.cacheloc = "."
   vimos_ima_standard.param.magerrcut = 100.0
   vimos_ima_standard.param.lthr_mag = 15.0
   vimos_ima_standard.param.hthr_mag = 32.0


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

::

   import cpl
   vimos_ima_standard = cpl.Recipe("vimos_ima_standard")
   [...]
   res = vimos_ima_standard( ..., param = {"preview_only":False, "minphotom":1})


.. 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 `Jim Lewis <jrl@ast.cam.ac.uk>`_. Alternatively, you may 
send a report to the `ESO User Support Department <usd-help@eso.org>`_.

Copyright
---------

This file is part of the VIMOS Instrument Pipeline
Copyright (C) 2019 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., 59 Temple Place, Suite 330, Boston, 
MA  02111-1307  USA

.. codeauthor:: Jim Lewis <jrl@ast.cam.ac.uk>
