The hawki_science_postprocess recipe
===============================================================

.. data:: hawki_science_postprocess

Synopsis
--------

HAWKI post processing recipe

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

hawki_science_postprocess -- HAWKI science post processing recipe.


Postprocess a stacked pawprint for HAWKI data. Form a filled tile and
photometrically and astrometrically calibrate the tiled image
Optionally nebulise the stacked images before source detection

The program accepts the following files in the SOF:

    Tag                   Description
    BASIC_CALIBRATED_SCI  A set of processed images from a jitter sequence
    BASIC_VAR_MAP         A variance map for each sequence image
    MASTER_CONF           A master confidence map for the jitter sequence
    PHOTCAL_TAB           A photometric calibration table
    MASTER_2MASS_CATALOGUE_ASTROM A master 2MASS index for astrometry or
    MASTER_PPMXL_CATALOGUE_ASTROM A master PPMXL index for astrometry or
    MASTER_LOCAL_CATALOGUE_ASTROM A master local astrometric FITS file
    MASTER_2MASS_CATALOGUE_PHOTOM A master 2MASS index for photometry or
    MASTER_PPMXL_CATALOGUE_PHOTOM A master PPMXL index photometry or
    MASTER_LOCAL_CATALOGUE_PHOTOM A master local photometric FITS file
    MATCHSTD_PHOTOM       A master photometric matched stds catalogue (optional)
    SCHLEGEL_MAP_NORTH    Northern Schlegel Map
    SCHLEGEL_MAP_SOUTH    Southern Schlegel Map
All of the above are required unless specified otherwise. The astrometricand photometric files are not required if these can be obtained fromthe CDS using the --cdssearch options


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

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

   Create an object for the recipe hawki_science_postprocess.

::

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

Parameters
----------

.. py:attribute:: hawki_science_postprocess.param.nebulise

    Nebulise the stacks before object detection? (bool; default: False) [default=False].
.. py:attribute:: hawki_science_postprocess.param.minphotom

    Minimum number of stars for photometry solution (int; default: 20) [default=20].
.. py:attribute:: hawki_science_postprocess.param.prettynames

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

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

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

    Use fast stacking? (str; default: 'auto') [default="auto"].
.. py:attribute:: hawki_science_postprocess.param.stk_nfst

    Nframes before we switch to slow stack algorithm (int; default: 30) [default=30].
.. py:attribute:: hawki_science_postprocess.param.savemstd

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

    Median filter size for nebuliser (int; default: 101) [default=101].
.. py:attribute:: hawki_science_postprocess.param.neb_linfilt

    Linear filter size for nebuliser (int; default: 33) [default=33].
.. py:attribute:: hawki_science_postprocess.param.cat_ipix

    Minimum pixel area for each detected object (int; default: 4) [default=4].
.. py:attribute:: hawki_science_postprocess.param.cat_thresh

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

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

    Value of Rcore in pixels (float; default: 10.0) [default=10.0].
.. py:attribute:: hawki_science_postprocess.param.cat_nbsize

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

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

    Cut in magnitude error (float; default: 100.0) [default=100.0].


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

::

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

   hawki_science_postprocess.param.nebulise = False
   hawki_science_postprocess.param.minphotom = 20
   hawki_science_postprocess.param.prettynames = False
   hawki_science_postprocess.param.cdssearch_astrom = "none"
   hawki_science_postprocess.param.cdssearch_photom = "none"
   hawki_science_postprocess.param.stk_fast = "auto"
   hawki_science_postprocess.param.stk_nfst = 30
   hawki_science_postprocess.param.savemstd = False
   hawki_science_postprocess.param.neb_medfilt = 101
   hawki_science_postprocess.param.neb_linfilt = 33
   hawki_science_postprocess.param.cat_ipix = 4
   hawki_science_postprocess.param.cat_thresh = 2.5
   hawki_science_postprocess.param.cat_icrowd = True
   hawki_science_postprocess.param.cat_rcore = 10.0
   hawki_science_postprocess.param.cat_nbsize = 64
   hawki_science_postprocess.param.cacheloc = "."
   hawki_science_postprocess.param.magerrcut = 100.0


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

::

   import cpl
   hawki_science_postprocess = cpl.Recipe("hawki_science_postprocess")
   [...]
   res = hawki_science_postprocess( ..., param = {"nebulise":False, "minphotom":20})


.. 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 HAWKI Instrument Pipeline
Copyright (C) 2015 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>
