recipes/eris_ifu_strehl.c

/*
 * This file is part of the HDRLDEMO pipeline
 * Copyright (C) 2014 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
 */
 
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
 
/*-----------------------------------------------------------------------------
                                    Includes
 -----------------------------------------------------------------------------*/
 
#include <hdrl.h>
 
#include <hdrl_utils.h>
#include <eris_ifu_dfs.h>
#include <eris_ifu_strehl.h>
#include <cpl.h>
 
 
#define HDRLDEMO_RAW_BPM                    "RAW_BPM"
#define HDRLDEMO_RAW_ERROR                  "RAW_ERROR"
/*-----------------------------------------------------------------------------
                            Functions prototypes
 -----------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------
                            Static global variables
 -----------------------------------------------------------------------------*/
 
#define RECIPE_NAME "eris_ifu_strehl"
 
static char eris_ifu_strehl_description[] =
"                                                                           \n"
"The recipe computes the Strehl on individual bias subtracted images.       \n"
"                                                                           \n"
"Input files:                                                               \n"
"                                                                           \n"
"  DO category:                 Explanation:           Required:            \n"
"  RAW                          Data                   Yes                  \n"
"  RAW_BPM                      Bad Pixel Mask         No                   \n"
"  RAW_ERROR                    Associated Error       No                   \n"
"                                                                           \n"
"Output files:                                                              \n"
"                                                                           \n"
"  DO category:                 Explanation:                                \n"
"  ERIS_IFU_STREHL              Fitsfile containing strehl as QC param      \n"
"                                                                           \n"
"Usage of the recipe:                                                       \n"
"                                                                           \n"
"There is currently one method implemented:                                 \n"
"                                                                           \n"
"The recipe assumes that the input raw image contains a single object       \n"
"and it is already pre-processed. This means that the instrument            \n"
"signature has been removed and the contribute from the sky background      \n"
"subtracted. Additionally, it allows the user to correct a residual         \n"
"local sky background evaluated in an annular region centred on the         \n"
"peak of the object PSF, by setting the values of the corresponding         \n"
"parameters (--bkg-radius-low, and --bkg-radius-high in arcsec units).      \n"
"                                                                           \n"
"The PSF is identified and its integrated flux, whose determination is      \n"
"controlled by the parameter --flux-radius (in arcsec), is normalized       \n"
"to unity. Next the PSF barycentre is computed and used to generate the     \n"
"theoretical normalised PSF. This depends on i) the telescope pupil         \n"
"characteristics (telescope radius and central obstruction parameters,      \n"
"controlled by --m1, and --m2 in meter) ii) the wavelength (parameter       \n"
"--wavelength in meter) at which the image has been obtained and iii)       \n"
"the detector pixel scale on sky in arcsec (--pixel-scale-x, and            \n"
"--pixel-scale-y).                                                          \n"
"                                                                           \n"
"Then the Strehl ratio is obtained by dividing the maximum intensity of     \n"
"the image PSF by the maximum intensity of the ideal PSF.                   \n"
"                                                                           \n"
"Please note that if no error image is provided, the error is estimated     \n"
"by measuring the MAD (scaled to an rms) on the input image, i.e. each      \n"
"pixel has the same associated error.                                       \n"
"                                                                          \n";
/* TODO:
 *  consistency checks on input parameters.
 *  Make sure psf size is at least 1x1 pixels
 *  Test without errors
 *  Add gain and ron input parameters for error model
 */
/* Standard CPL recipe definition */
cpl_recipe_define(eris_ifu_strehl, ERIS_BINARY_VERSION, "Andrea Modigliani",
        PACKAGE_BUGREPORT, "2022", "Computes Strehl",
        eris_ifu_strehl_description);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static cpl_error_code eris_ifu_strehl_fill_parameterlist(
        cpl_parameterlist   *   self) 
{                                  
    cpl_parameter   *   par ;
 
    /* --eris_ifu_strehl.ext-nb-raw
    par = cpl_parameter_new_value(RECIPE_NAME".ext-nb-raw", CPL_TYPE_INT,
            "FITS extension of the RAW", RECIPE_NAME, 0);
    cpl_parameter_set_alias(par, CPL_PARAMETER_MODE_CLI, "ext-r");
    cpl_parameter_disable(par, CPL_PARAMETER_MODE_ENV);
    cpl_parameterlist_append(self, par);
    */
    
    /* --eris_ifu_strehl.ext-nb-raw-err
    par = cpl_parameter_new_value(RECIPE_NAME".ext-nb-raw-err", CPL_TYPE_INT,
            "FITS extension of the ERROR", RECIPE_NAME, 0);
    cpl_parameter_set_alias(par, CPL_PARAMETER_MODE_CLI, "ext-e");
    cpl_parameter_disable(par, CPL_PARAMETER_MODE_ENV);
    cpl_parameterlist_append(self, par);
    */
 
    /* --eris_ifu_strehl.ext-nb-raw-bpm
    par = cpl_parameter_new_value(RECIPE_NAME".ext-nb-raw-bpm", CPL_TYPE_INT,
            "FITS extension or the input BPM", RECIPE_NAME, 0);
    cpl_parameter_set_alias(par, CPL_PARAMETER_MODE_CLI, "ext-b");
    cpl_parameter_disable(par, CPL_PARAMETER_MODE_ENV);
    cpl_parameterlist_append(self, par);
    */
 
    /* --eris_ifu_strehl.region-llx/lly/urx/ury */
    hdrl_parameter * deflts = hdrl_rect_region_parameter_create(1, 1, 0, 0) ;
    cpl_parameterlist * reg_param = hdrl_rect_region_parameter_create_parlist(
                RECIPE_NAME, "", "region-", deflts);
    hdrl_parameter_delete(deflts) ;
    for (cpl_parameter * p = cpl_parameterlist_get_first(reg_param) ;
            p != NULL; p = cpl_parameterlist_get_next(reg_param))
        cpl_parameterlist_append(self, cpl_parameter_duplicate(p));
    cpl_parameterlist_delete(reg_param);
 
 
    hdrl_parameter * s_def =
        hdrl_strehl_parameter_create(1.635e-6,
                                     5.08/2, 1.8288/2,
                                     0.0165966, 0.0165966,
                                     1.5, -1 , -1);
 
    cpl_parameterlist * s_param =
        hdrl_strehl_parameter_create_parlist(RECIPE_NAME, "", s_def);
    hdrl_parameter_delete(s_def) ;
    for (cpl_parameter * p = cpl_parameterlist_get_first(s_param);
            p != NULL; p = cpl_parameterlist_get_next(s_param))
        cpl_parameterlist_append(self, cpl_parameter_duplicate(p));
    cpl_parameterlist_delete(s_param);
 
    return CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
static int eris_ifu_strehl(
        cpl_frameset            *   frameset, 
        const cpl_parameterlist *   parlist)
{
    eris_ifu_strehl_compute(frameset, parlist, RECIPE_NAME);
 
    return (int)cpl_error_get_code();
}