vircam_darkcor.c

/* $Id: vircam_darkcor.c,v 1.10 2007/10/15 12:53:55 jim Exp $
 *
 * This file is part of the VIRCAM Pipeline
 * Copyright (C) 2006 Cambridge Astronomy Survey Unit
 *
 * 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
 */

/*
 * $Author: jim $
 * $Date: 2007/10/15 12:53:55 $
 * $Revision: 1.10 $
 * $Name:  $
 */

/* Includes */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <stdio.h>
#include <cpl.h>

#include "vircam_utils.h"
#include "vircam_dfs.h"
#include "vircam_fits.h"
#include "vircam_mods.h"

/* Function prototypes */

static int vircam_darkcor_create(cpl_plugin *) ;
static int vircam_darkcor_exec(cpl_plugin *) ;
static int vircam_darkcor_destroy(cpl_plugin *) ;
static int vircam_darkcor_test(cpl_parameterlist *, cpl_frameset *) ;
static int vircam_darkcor_save(cpl_frameset *framelist,
                               cpl_parameterlist *parlist);
static void vircam_darkcor_init(void);
static void vircam_darkcor_tidy(void);

static struct {

    /* Input */

    float       darkscl;
    int         extenum;

} vircam_darkcor_config;

static struct {
    int         *labels;
    cpl_frame   *dark;
    cpl_frame   *img;
    vir_fits    *darkf;
    vir_fits    *imgf;
} ps;

static int isfirst;
static cpl_frame *product_frame = NULL;


static char vircam_darkcor_description[] =
"vircam_darkcor -- VIRCAM dark correction test recipe.\n\n"
"Dark correct an input frame using a master dark frame\n\n"
"The program accepts the following files in the SOF:\n\n"
"    Tag                   Description\n"
"    -----------------------------------------------------------------------\n"
"    %-21s A input uncorrected image\n"
"    %-21s A master dark frame\n"
"\n";

/* Function code */


/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

int cpl_plugin_get_info(cpl_pluginlist *list) {
    cpl_recipe  *recipe = cpl_calloc(1,sizeof(*recipe));
    cpl_plugin  *plugin = &recipe->interface;
    char alldesc[SZ_ALLDESC];
    (void)snprintf(alldesc,SZ_ALLDESC,vircam_darkcor_description,
                   VIRCAM_TEST_SCIENCE_RAW,VIRCAM_CAL_DARK);

    cpl_plugin_init(plugin,
                    CPL_PLUGIN_API,
                    VIRCAM_BINARY_VERSION,
                    CPL_PLUGIN_TYPE_RECIPE,
                    "vircam_darkcor",
                    "VIRCAM dark correction test recipe [test]",
                    alldesc,
                    "Jim Lewis",
                    "jrl@ast.cam.ac.uk",
                    vircam_get_license(),
                    vircam_darkcor_create,
                    vircam_darkcor_exec,
                    vircam_darkcor_destroy);

    cpl_pluginlist_append(list,plugin);

    return(0);
}

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

static int vircam_darkcor_create(cpl_plugin *plugin) {
    cpl_recipe      *recipe;
    cpl_parameter   *p;

    /* Get the recipe out of the plugin */

    if (cpl_plugin_get_type(plugin) == CPL_PLUGIN_TYPE_RECIPE)
        recipe = (cpl_recipe *)plugin;
    else
        return(-1);

    /* Create the parameters list in the cpl_recipe object */

    recipe->parameters = cpl_parameterlist_new();

    /* Fill in the parameters. First the dark scaling factor */

    p = cpl_parameter_new_value("vircam.vircam_darkcor.darkscl",
                                CPL_TYPE_DOUBLE,
                                "Dark correction scale factor",
                                "vircam.vircam_darkcor",1.0);
    cpl_parameter_set_alias(p,CPL_PARAMETER_MODE_CLI,"darkscl");
    cpl_parameterlist_append(recipe->parameters,p);

    /* Extension number of input frames to use */

    p = cpl_parameter_new_range("vircam.vircam_darkcor.extenum",
                                CPL_TYPE_INT,
                                "Extension number to be done, 0 == all",
                                "vircam.vircam_darkcor",1,0,16);
    cpl_parameter_set_alias(p,CPL_PARAMETER_MODE_CLI,"ext");
    cpl_parameterlist_append(recipe->parameters,p);

    /* Get out of here */

    return(0);
}

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

static int vircam_darkcor_exec(cpl_plugin *plugin) {
    cpl_recipe  *recipe;

    /* Get the recipe out of the plugin */

    if (cpl_plugin_get_type(plugin) == CPL_PLUGIN_TYPE_RECIPE)
        recipe = (cpl_recipe *)plugin;
    else
        return(-1);

    return(vircam_darkcor_test(recipe->parameters,recipe->frames));
}

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

static int vircam_darkcor_destroy(cpl_plugin *plugin) {
    cpl_recipe *recipe ;

    /* Get the recipe out of the plugin */

    if (cpl_plugin_get_type(plugin) == CPL_PLUGIN_TYPE_RECIPE)
        recipe = (cpl_recipe *)plugin;
    else
        return(-1);

    cpl_parameterlist_delete(recipe->parameters);
    return(0);
}

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

static int vircam_darkcor_test(cpl_parameterlist *parlist, 
                               cpl_frameset *framelist) {
    const char *fctid="vircam_darkcor";
    cpl_parameter *p;
    int nlab,jst,jfn,status,j;

    /* Check validity of input frameset */

    if (framelist == NULL || cpl_frameset_get_size(framelist) <= 0) {
        cpl_msg_error(fctid,"Input framelist NULL or has no input data\n");
        return(-1);
    }

    /* Initialise some things */

    vircam_darkcor_init();

    /* Get the parameters */

    p = cpl_parameterlist_find(parlist,"vircam.vircam_darkcor.darkscl");
    vircam_darkcor_config.darkscl = cpl_parameter_get_double(p);
    p = cpl_parameterlist_find(parlist,"vircam.vircam_darkcor.extenum");
    vircam_darkcor_config.extenum = cpl_parameter_get_int(p);

    /* Sort out raw from calib frames */

    if (vircam_dfs_set_groups(framelist) != VIR_OK) {
        cpl_msg_error(fctid,"Cannot identify RAW and CALIB frames");
        vircam_darkcor_tidy();
        return(-1);
    }

    /* Get the frames */

    if ((ps.labels = cpl_frameset_labelise(framelist,vircam_compare_tags,
                                           &nlab)) == NULL) {
        cpl_msg_error(fctid,"Cannot labelise the input frames");
        vircam_darkcor_tidy();
        return(-1);
    }
    if ((ps.dark = vircam_frameset_subgroup_1(framelist,ps.labels,nlab,
                                              VIRCAM_CAL_DARK)) == NULL) {
        cpl_msg_info(fctid,"No master dark found -- cannot continue");
        vircam_darkcor_tidy();
        return(-1);
    }
    if ((ps.img = vircam_frameset_subgroup_1(framelist,ps.labels,nlab,
                                             VIRCAM_TEST_SCIENCE_RAW)) == NULL) {
        cpl_msg_info(fctid,"No raw image found -- cannot continue");
        vircam_darkcor_tidy();
        return(-1);
    }

    /* Now, how many image extensions do we want to do? If the extension
       number is zero, then we loop for all possible extensions. If it
       isn't then we just do the extension specified */

    vircam_exten_range(vircam_darkcor_config.extenum,(const cpl_frame *)ps.img,
                       &jst,&jfn);
    if (jst == -1 || jfn == -1) {
        cpl_msg_error(fctid,"Unable to continue");
        vircam_darkcor_tidy();
        return(-1);
    }

    /* Now loop for all the extension... */

    status = VIR_OK;
    for (j = jst; j <= jfn; j++) {
        isfirst = (j == jst);

        /* Load up the images */

        ps.imgf = vircam_fits_load(ps.img,CPL_TYPE_FLOAT,j);
        ps.darkf = vircam_fits_load(ps.dark,CPL_TYPE_FLOAT,j);
        if (ps.img == NULL || ps.darkf == NULL) {
            vircam_darkcor_tidy();
            return(-1);
        }

        /* Now do the correction */

        cpl_msg_info(fctid,"Doing the dark correction for extension %d",j);
        (void)vircam_darkcor(ps.imgf,ps.darkf,vircam_darkcor_config.darkscl,
                             &status);
        if (status != VIR_OK) {
            vircam_darkcor_tidy();
            return(-1);
        }

        /* Now save the result */

        cpl_msg_info(fctid,"Saving results for extension %d",j);
        if (vircam_darkcor_save(framelist,parlist) != 0) {
            vircam_darkcor_tidy();
            return(-1);
        }

        /* Tidy a few things before the next image */

        freefits(ps.imgf);
        freefits(ps.darkf);
    }
    vircam_darkcor_tidy();
    return(0);
}

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

static int vircam_darkcor_save(cpl_frameset *framelist, 
                               cpl_parameterlist *parlist) {
    const char *fctid = "vircam_darkcor_save";
    const char *outfile = "darkcor.fits";
    const char *recipeid = "vircam_darkcor";
    cpl_propertylist *plist;

    /* If we need to make a PHU then do that now based on the first frame
       in the input frame list */

    if (isfirst) {

        /* Create a new product frame object and define some tags */

        product_frame = cpl_frame_new();
        cpl_frame_set_filename(product_frame,outfile);
        cpl_frame_set_tag(product_frame,VIRCAM_PRO_SIMPLE_TEST);
        cpl_frame_set_type(product_frame,CPL_FRAME_TYPE_IMAGE);
        cpl_frame_set_group(product_frame,CPL_FRAME_GROUP_PRODUCT);
        cpl_frame_set_level(product_frame,CPL_FRAME_LEVEL_FINAL);

        /* Set up the header */

        plist = vircam_fits_get_phu(ps.imgf);
        vircam_dfs_set_product_primary_header(plist,product_frame,framelist,
                                              parlist,(char *)recipeid,
                                              "?Dictionary?");

        /* 'Save' the PHU image */

        if (cpl_image_save(NULL,outfile,CPL_BPP_8_UNSIGNED,plist,
                           CPL_IO_DEFAULT) != CPL_ERROR_NONE) {
            cpl_msg_error(fctid,"Cannot save product PHU");
            cpl_frame_delete(product_frame);
            return(-1);
        }
        cpl_frameset_insert(framelist,product_frame);
    }

    /* Get the extension property list */

    plist = vircam_fits_get_ehu(ps.imgf);

    /* Fiddle with the header now */

    vircam_dfs_set_product_exten_header(plist,product_frame,framelist,parlist,
                                        (char *)recipeid,"?Dictionary?");

    /* Save the image */

    if (cpl_image_save(vircam_fits_get_image(ps.imgf),outfile,CPL_BPP_IEEE_FLOAT,
                       plist,CPL_IO_EXTEND) != CPL_ERROR_NONE) {
        cpl_msg_error(fctid,"Cannot save product image extension");
        return(-1);
    }

    return(0);
}


/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

static void vircam_darkcor_init(void) {
    ps.labels = NULL;
    ps.dark = NULL;
    ps.darkf = NULL;
    ps.img = NULL;
    ps.imgf = NULL;
}


/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

static void vircam_darkcor_tidy(void) {
    freespace(ps.labels);
    freefits(ps.imgf);
    freefits(ps.darkf);
    freeframe(ps.dark);
    freeframe(ps.img);
}

/*

$Log: vircam_darkcor.c,v $
Revision 1.10  2007/10/15 12:53:55  jim
Modified for compatibility with cpl_4.0

Revision 1.9  2007/07/09 13:22:08  jim
Modified to use new version of vircam_exten_range

Revision 1.8  2007/04/13 12:27:38  jim
Added some extra docs

Revision 1.7  2007/04/04 10:36:29  jim
Modified to use new dfs tags

Revision 1.6  2007/03/01 12:42:58  jim
Modified slightly after code checking

Revision 1.5  2006/06/15 09:58:59  jim
Minor changes to docs

Revision 1.4  2006/05/04 11:53:40  jim
Fixed _save routine so that it's more consistent with the standard CPL
way of doing things

Revision 1.3  2006/05/02 11:29:11  jim
Fixed problem where propertylist was being deleted incorrectly

Revision 1.2  2006/04/27 14:22:04  jim
Fixed docs

Revision 1.1  2006/04/24 10:42:44  jim
New routine


*/

---