/*
 * This file is part of the HDRL
 * Copyright (C) 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 St, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef HDRL_CATALOGUE_H
#define HDRL_CATALOGUE_H

/*-----------------------------------------------------------------------------
                                Includes
 -----------------------------------------------------------------------------*/
#include <cpl.h>

#include "catalogue/hdrl_cat_conf.h"

#include "hdrl_types.h"
#include "hdrl_image.h"



CPL_BEGIN_DECLS

/*-----------------------------------------------------------------------------
                                Define
 -----------------------------------------------------------------------------*/


/*-----------------------------------------------------------------------------
                            Functions prototypes
 -----------------------------------------------------------------------------*/


typedef struct {
    cpl_table * catalogue;
    cpl_image * segmentation_map;
    cpl_image * background;
    cpl_propertylist * qclist;
} hdrl_catalogue_result;



hdrl_catalogue_result *
hdrl_catalogue_compute(const cpl_image * image_, const cpl_image * confidence_map,
                       const cpl_wcs * wcs, hdrl_parameter * param_);
#if defined HDRL_USE_EXPERIMENTAL
/**
 * @brief Build object catalog including additional experimental QC keywords.
 * @warning Experimental interface: use at your own risk.
 *          The additional QC content and behavior may change without notice.
 *          Experimental QC keywords are not fully tested or verified.
 */
hdrl_catalogue_result *
hdrl_catalogue_compute_experimental(const cpl_image * image_,
                            const cpl_image * confidence_map,
                            const cpl_wcs * wcs, hdrl_parameter * param_);
#endif
void hdrl_catalogue_result_delete(hdrl_catalogue_result * result);

hdrl_parameter * hdrl_catalogue_parameter_create(int obj_min_pixels,
                       double obj_threshold, cpl_boolean obj_deblending,
                       double obj_core_radius,
                       cpl_boolean bkg_estimate, int bkg_mesh_size,
                       double bkg_smooth_fwhm, double det_eff_gain,
                       double det_saturation,
                       hdrl_catalogue_options resulttype);
cpl_error_code hdrl_catalogue_parameter_set_option(hdrl_parameter * par,
                                                   hdrl_catalogue_options opt);
cpl_boolean hdrl_catalogue_parameter_check(const hdrl_parameter * self);
hdrl_parameter * hdrl_catalogue_parameter_parse_parlist(
        const cpl_parameterlist *   parlist,
        const char              *   prefix);
cpl_parameterlist * hdrl_catalogue_parameter_create_parlist(
        const char      *   base_context,
        const char      *   prefix,
        hdrl_parameter  *   defaults);


/*-----------------------------------------------------------------------------
             Private declarations - must not be used outside of hdrl
 -----------------------------------------------------------------------------*/

#ifdef HDRL_USE_PRIVATE

#endif

CPL_END_DECLS

#endif
