High-Level Data Reduction Library: hdrl_catalogue.h Source File

High-Level Data Reduction Library 1.6.0 High-Level data reduction routines for ESO pipelines

Loading...
Searching...
No Matches
hdrl_catalogue.h
Go to the documentation of this file.
1/*
2 * This file is part of the HDRL
3 * Copyright (C) 2016 European Southern Observatory
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19
20#ifndef HDRL_CATALOGUE_H
21#define HDRL_CATALOGUE_H
22
23/*-----------------------------------------------------------------------------
24 Includes
25 -----------------------------------------------------------------------------*/
26#include <cpl.h>
27
28#include "catalogue/hdrl_cat_conf.h"
29
30#include "hdrl_types.h"
31#include "hdrl_image.h"
32
33
34
35CPL_BEGIN_DECLS
36
37/*-----------------------------------------------------------------------------
38 Define
39 -----------------------------------------------------------------------------*/
40
41
42/*-----------------------------------------------------------------------------
43 Functions prototypes
44 -----------------------------------------------------------------------------*/
45
46
47 typedef struct {
48 cpl_table * catalogue;
49 cpl_image * segmentation_map;
50 cpl_image * background;
51 cpl_propertylist * qclist;
52} hdrl_catalogue_result;
53
54
55
56 hdrl_catalogue_result *
57 hdrl_catalogue_compute(const cpl_image * image_, const cpl_image * confidence_map,
58 const cpl_wcs * wcs, hdrl_parameter * param_);
59#if defined HDRL_USE_EXPERIMENTAL
66 hdrl_catalogue_result *
67 hdrl_catalogue_compute_experimental(const cpl_image * image_,
68 const cpl_image * confidence_map,
69 const cpl_wcs * wcs, hdrl_parameter * param_);
70#endif
71 void hdrl_catalogue_result_delete(hdrl_catalogue_result * result);
72
73 hdrl_parameter * hdrl_catalogue_parameter_create(int obj_min_pixels,
74 double obj_threshold, cpl_boolean obj_deblending,
75 double obj_core_radius,
76 cpl_boolean bkg_estimate, int bkg_mesh_size,
77 double bkg_smooth_fwhm, double det_eff_gain,
78 double det_saturation,
79 hdrl_catalogue_options resulttype);
80cpl_error_code hdrl_catalogue_parameter_set_option(hdrl_parameter * par,
81 hdrl_catalogue_options opt);
82cpl_boolean hdrl_catalogue_parameter_check(const hdrl_parameter * self);
83 hdrl_parameter * hdrl_catalogue_parameter_parse_parlist(
84 const cpl_parameterlist * parlist,
85 const char * prefix);
86cpl_parameterlist * hdrl_catalogue_parameter_create_parlist(
87 const char * base_context,
88 const char * prefix,
89 hdrl_parameter * defaults);
90
91
92/*-----------------------------------------------------------------------------
93 Private declarations - must not be used outside of hdrl
94 -----------------------------------------------------------------------------*/
95
96#ifdef HDRL_USE_PRIVATE
97
98#endif
99
100CPL_END_DECLS
101
102#endif
hdrl_types.h
hdrl_cat_conf.h
hdrl_catalogue_options
hdrl_catalogue_options
Definition hdrl_cat_def.h:153
hdrl_image.h
hdrl_parameter
struct _hdrl_parameter_ hdrl_parameter
Definition hdrl_parameter.h:27
hdrl_catalogue_compute
hdrl_catalogue_result * hdrl_catalogue_compute(const cpl_image *image_, const cpl_image *confidence_map, const cpl_wcs *wcs, hdrl_parameter *param_)
build object catalog
Definition hdrl_catalogue.c:465
hdrl_catalogue_compute_experimental
hdrl_catalogue_result * hdrl_catalogue_compute_experimental(const cpl_image *image_, const cpl_image *confidence_map, const cpl_wcs *wcs, hdrl_parameter *param_)
build object catalog (experimental QC mode)
Definition hdrl_catalogue.c:488
hdrl_catalogue_result_delete
void hdrl_catalogue_result_delete(hdrl_catalogue_result *result)
delete hdrl parameter result object
Definition hdrl_catalogue.c:442
hdrl_catalogue_parameter_create
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)
Creates catalogue Parameters object.
Definition hdrl_catalogue.c:179
hdrl_catalogue_parameter_check
cpl_boolean hdrl_catalogue_parameter_check(const hdrl_parameter *self)
Check that the parameter is a catalogue parameter.
Definition hdrl_catalogue.c:220
hdrl_catalogue_parameter_parse_parlist
hdrl_parameter * hdrl_catalogue_parameter_parse_parlist(const cpl_parameterlist *parlist, const char *prefix)
Parse parameter list to create input parameters for the catalogue.
Definition hdrl_catalogue.c:363
hdrl_catalogue_parameter_create_parlist
cpl_parameterlist * hdrl_catalogue_parameter_create_parlist(const char *base_context, const char *prefix, hdrl_parameter *defaults)
Create parameter list for the catalogue computation.
Definition hdrl_catalogue.c:274
hdrl_catalogue_parameter_set_option
cpl_error_code hdrl_catalogue_parameter_set_option(hdrl_parameter *par, hdrl_catalogue_options opt)
set result option of catalogue parameter
Definition hdrl_catalogue.c:235
hdrl_catalogue_result
Definition hdrl_catalogue.h:47
hdrl_catalogue_result::segmentation_map
cpl_image * segmentation_map
Definition hdrl_catalogue.h:49
hdrl_catalogue_result::catalogue
cpl_table * catalogue
Definition hdrl_catalogue.h:48
hdrl_catalogue_result::background
cpl_image * background
Definition hdrl_catalogue.h:50
hdrl_catalogue_result::qclist
cpl_propertylist * qclist
Definition hdrl_catalogue.h:51