moo_loc.c

/*
 * This file is part of the MOONS Pipeline
 * Copyright (C) 2002-2016 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 Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
 
/*-----------------------------------------------------------------------------
                                   Includes
 -----------------------------------------------------------------------------*/
#include <math.h>
#include <cpl.h>
#include <hdrl.h>
#include "moo_pfits.h"
#include "moo_loc.h"
#include "moo_fibres_table.h"
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
/*-----------------------------------------------------------------------------
                              Function codes
 -----------------------------------------------------------------------------*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
moo_loc *
moo_loc_new(void)
{
    moo_loc *res = cpl_calloc(1, sizeof(moo_loc));
    return res;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
moo_loc *
moo_loc_create(const char *filename)
{
    cpl_ensure(filename != NULL, CPL_ERROR_NULL_INPUT, NULL);
    cpl_errorstate prev_state = cpl_errorstate_get();
    moo_loc *res = moo_loc_new();
    res->primary_header = cpl_propertylist_new();
    res->filename = cpl_strdup(filename);
    cpl_propertylist_save(res->primary_header, filename, CPL_IO_CREATE);
    if (!cpl_errorstate_is_equal(prev_state)) {
        cpl_msg_error("moo_loc", "Can't load filename %s (%s)", filename,
                      cpl_error_get_message());
    }
    return res;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
moo_loc *
moo_loc_load(const cpl_frame *locframe)
{
    cpl_ensure(locframe != NULL, CPL_ERROR_NULL_INPUT, NULL);
 
    const char *filename = cpl_frame_get_filename(locframe);
    cpl_ensure(filename != NULL, CPL_ERROR_NULL_INPUT, NULL);
    cpl_errorstate prev_state = cpl_errorstate_get();
    moo_loc *res = moo_loc_new();
 
    res->filename = cpl_strdup(filename);
    res->primary_header = cpl_propertylist_load(filename, 0);
 
    for (int i = 1; i <= 2; i++) {
        res->ri[i - 1] =
            moo_loc_single_create(res->filename,
                                  moo_detector_get_extname(MOO_TYPE_RI, i));
        res->yj[i - 1] =
            moo_loc_single_create(res->filename,
                                  moo_detector_get_extname(MOO_TYPE_YJ, i));
        res->h[i - 1] =
            moo_loc_single_create(res->filename,
                                  moo_detector_get_extname(MOO_TYPE_H, i));
    }
    if (!cpl_errorstate_is_equal(prev_state)) {
        const char *tag = cpl_frame_get_tag(locframe);
        cpl_msg_error("moo_loc", "Cant' load %s (%s) error code : %d", filename,
                      tag, cpl_error_get_code());
    }
    return res;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
moo_loc_single *
moo_loc_get_single(moo_loc *self, moo_detector_type type, int ntas)
{
    cpl_ensure(self != NULL, CPL_ERROR_NULL_INPUT, NULL);
    cpl_ensure(ntas >= 1 && ntas <= 2, CPL_ERROR_ILLEGAL_INPUT, NULL);
 
    switch (type) {
        case MOO_TYPE_RI:
            return self->ri[ntas - 1];
            break;
        case MOO_TYPE_YJ:
            return self->yj[ntas - 1];
            break;
        case MOO_TYPE_H:
            return self->h[ntas - 1];
            break;
        default:
            return NULL;
    }
}
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
cpl_error_code
moo_loc_set_single(moo_loc *self,
                   moo_detector_type type,
                   int ntas,
                   moo_loc_single *single)
{
    cpl_ensure_code(self != NULL, CPL_ERROR_NULL_INPUT);
    cpl_ensure_code(single != NULL, CPL_ERROR_NULL_INPUT);
 
    cpl_error_code status = CPL_ERROR_NONE;
    cpl_errorstate prev_state = cpl_errorstate_get();
 
    switch (type) {
        case MOO_TYPE_RI:
            self->ri[ntas - 1] = single;
            break;
        case MOO_TYPE_YJ:
            self->yj[ntas - 1] = single;
            break;
        case MOO_TYPE_H:
            self->h[ntas - 1] = single;
            break;
    }
    if (!cpl_errorstate_is_equal(prev_state)) {
        cpl_msg_error("moo_loc", "Error for adding fibre table to %s (%d)",
                      self->filename, cpl_error_get_code());
        status = cpl_error_get_code();
        cpl_errorstate_set(prev_state);
    }
    return status;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
cpl_error_code
moo_loc_add_single(moo_loc *self,
                   moo_loc_single *single,
                   moo_detector_type type,
                   int ntas,
                   int keep_points)
{
    cpl_ensure_code(self != NULL, CPL_ERROR_NULL_INPUT);
    cpl_ensure_code(self->filename != NULL, CPL_ERROR_NULL_INPUT);
    cpl_ensure_code(single != NULL, CPL_ERROR_NULL_INPUT);
 
    cpl_error_code status = CPL_ERROR_NONE;
    cpl_errorstate prev_state = cpl_errorstate_get();
 
    moo_loc_set_single(self, type, ntas, single);
    moo_loc_single_save(single, self->filename, keep_points);
    if (!cpl_errorstate_is_equal(prev_state)) {
        cpl_errorstate_dump(prev_state, CPL_FALSE, cpl_errorstate_dump_one);
        cpl_msg_error("moo_loc", "Error for adding LOC single table to %s (%d)",
                      self->filename, cpl_error_get_code());
        status = cpl_error_get_code();
        cpl_errorstate_set(prev_state);
    }
    return status;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
cpl_error_code
moo_loc_add_fibre_table(moo_loc *self, cpl_table *fibre_table)
{
    cpl_ensure_code(self != NULL, CPL_ERROR_NULL_INPUT);
    cpl_ensure_code(self->filename != NULL, CPL_ERROR_NULL_INPUT);
    cpl_ensure_code(fibre_table != NULL, CPL_ERROR_NULL_INPUT);
 
    cpl_error_code status = CPL_ERROR_NONE;
    cpl_errorstate prev_state = cpl_errorstate_get();
    self->fibre_table = fibre_table;
 
    cpl_propertylist *h = cpl_propertylist_new();
    cpl_propertylist_append_string(h, MOO_PFITS_EXTNAME,
                                   MOO_FIBRES_TABLE_EXTNAME);
    cpl_table_save(self->fibre_table, NULL, h, self->filename, CPL_IO_EXTEND);
    cpl_propertylist_delete(h);
 
    if (!cpl_errorstate_is_equal(prev_state)) {
        cpl_msg_error("moo_loc", "Error for adding fibre table to %s (%d)",
                      self->filename, cpl_error_get_code());
        status = cpl_error_get_code();
        cpl_errorstate_set(prev_state);
    }
    return status;
}
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
cpl_table *
moo_loc_get_fibre_table(moo_loc *self)
{
    cpl_ensure(self != NULL, CPL_ERROR_NULL_INPUT, NULL);
 
    if (self->fibre_table == NULL && self->filename != NULL) {
        cpl_size qnum =
            cpl_fits_find_extension(self->filename, MOO_FIBRES_TABLE_EXTNAME);
        if (qnum > 0) {
            self->fibre_table = cpl_table_load(self->filename, qnum, 0);
        }
    }
    return self->fibre_table;
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
moo_loc_delete(moo_loc *self)
{
    if (self != NULL) {
        int i;
        if (self->filename != NULL) {
            cpl_free(self->filename);
        }
        if (self->primary_header != NULL) {
            cpl_propertylist_delete(self->primary_header);
        }
        for (i = 0; i < 2; i++) {
            if (self->ri[i] != NULL) {
                moo_loc_single_delete(self->ri[i]);
            }
            if (self->yj[i] != NULL) {
                moo_loc_single_delete(self->yj[i]);
            }
            if (self->h[i] != NULL) {
                moo_loc_single_delete(self->h[i]);
            }
        }
        if (self->fibre_table != NULL) {
            cpl_table_delete(self->fibre_table);
        }
        cpl_free(self);
    }
}
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
void
moo_loc_save(moo_loc *self, const char *filename, int keep_points)
{
    if (self != NULL) {
        cpl_propertylist_save(self->primary_header, filename, CPL_IO_CREATE);
 
        int i;
        for (i = 0; i < 2; i++) {
            if (self->ri[i] != NULL) {
                moo_loc_single_save(self->ri[i], filename, keep_points);
            }
            if (self->yj[i] != NULL) {
                moo_loc_single_save(self->yj[i], filename, keep_points);
            }
            if (self->h[i] != NULL) {
                moo_loc_single_save(self->h[i], filename, keep_points);
            }
        }
 
        if (self->fibre_table != NULL) {
            cpl_propertylist *h = cpl_propertylist_new();
            cpl_propertylist_append_string(h, MOO_PFITS_EXTNAME,
                                           MOO_FIBRES_TABLE_EXTNAME);
            cpl_table_save(self->fibre_table, h, h, filename, CPL_IO_EXTEND);
            cpl_propertylist_delete(h);
        }
    }
}
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
cpl_error_code
moo_loc_dump(const moo_loc *self, FILE *stream)
{
    cpl_ensure_code(self != NULL, CPL_ERROR_NULL_INPUT);
    cpl_ensure_code(stream != NULL, CPL_ERROR_NULL_INPUT);
 
    fprintf(stream, "---MOO_LOC\n");
    fprintf(stream, "filename %s\n", self->filename);
    int i;
    for (i = 0; i < 2; i++) {
        moo_loc_single_dump(self->ri[i], stream);
        moo_loc_single_dump(self->yj[i], stream);
        moo_loc_single_dump(self->h[i], stream);
    }
 
    return CPL_ERROR_NONE;
}