ERIS Pipeline Reference Manual 1.8.15
eris_utils.h
1/* $Id: eris_utils.h,v 1.15 2013-07-22 13:38:01 jtaylor Exp $
2 *
3 * This file is part of the ERIS Pipeline
4 * Copyright (C) 2002,2003 European Southern Observatory
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21/*
22 * $Author: jtaylor $
23 * $Date: 2013-07-22 13:38:01 $
24 * $Revision: 1.15 $
25 * $Name: not supported by cvs2svn $
26 */
27
28#ifndef ERIS_UTILS_H
29#define ERIS_UTILS_H
30
31#ifdef HAVE_CONFIG_H
32#include <config.h>
33#endif
34
35/*-----------------------------------------------------------------------------
36 Includes
37 -----------------------------------------------------------------------------*/
38
39#include <cpl.h>
40
41#define CPL_DFS_PRO_DID "PRO-1.16"
42/*-----------------------------------------------------------------------------
43 Prototypes
44 -----------------------------------------------------------------------------*/
45cpl_error_code eris_setup_product_header(const char* filename,
46 const char* pro_catg,
47 cpl_frame_type type,
48 const char* recipe_name,
49 cpl_frameset* frameset,
50 const cpl_parameterlist* parlist,
51 cpl_propertylist *plist);
52const char * eris_get_license(void);
53cpl_error_code eris_check_error_code(const char* func_id);
54int eris_print_rec_status(const int val);
55long
56eris_image_get_threshpix(cpl_image* img, double threshold,
57 cpl_boolean thresh_is_min);
58cpl_error_code
59eris_image_flag_threshpix(cpl_image** img, double threshold,
60 cpl_boolean thresh_is_min);
61cpl_error_code
62eris_dfs_extract_raw_frames (cpl_frameset * input, cpl_frameset * raws);
63cpl_error_code
64eris_dfs_extract_cal_frames (cpl_frameset * input, cpl_frameset * calibs);
65
66cpl_frameset*
67eris_dfs_extract_frames_with_tag (cpl_frameset * input, const char* rtag);
68cpl_error_code
69eris_dfs_check_input_tags(cpl_frameset * input, const char** tags, const int n,
70 const int mode);
71
72cpl_error_code
73eris_get_sat_qc_for_image(const char* frame_name, cpl_frame* frm_mdark,
74 const double saturation, const double saturation_negative,
75 const double threshold, const long long i, cpl_propertylist* applist);
76
77cpl_error_code
78eris_get_sat_qc_for_cube(const char* frame_name, cpl_frame* frm_mdark,
79 const double saturation, const double saturation_negative,
80 const double threshold, const long long i, cpl_propertylist* applist);
81
82cpl_error_code
83eris_get_sat_pix_qc_for_image(const char* frame_name, cpl_frame* frm_mdark,
84 const double saturation, const double saturation_negative,
85 const long long i, cpl_propertylist* applist);
86
87cpl_error_code
88eris_get_thresh_pix_qc_for_image(const char* frame_name, cpl_frame* frm_mdark,
89 const double threshold, const long long i, cpl_propertylist* applist);
90cpl_boolean
91eris_param_has_changed(const cpl_parameter* p);
92
93cpl_error_code
94eris_parameters_get_int(const cpl_parameterlist* parlist,
95 const char* pname, int *pvalue);
96cpl_error_code
97eris_parameters_get_double(const cpl_parameterlist* parlist,
98 const char* pname, double *pvalue);
99cpl_error_code
100eris_files_dont_exist(cpl_frameset *frameset);
101
102cpl_error_code
103eris_image_flag_nan(cpl_image** ima);
104#endif
cpl_error_code eris_files_dont_exist(cpl_frameset *frameset)
Check if all SOF files exist.
Definition: eris_utils.c:867
cpl_error_code eris_parameters_get_double(const cpl_parameterlist *parlist, const char *pname, double *pvalue)
get double parameter value if changed by the user
Definition: eris_utils.c:765
cpl_error_code eris_check_error_code(const char *func_id)
handle CPL errors
Definition: eris_utils.c:56
cpl_frameset * eris_dfs_extract_frames_with_tag(cpl_frameset *input, const char *rtag)
Extract frames of user given tag.
Definition: eris_utils.c:227
cpl_error_code eris_dfs_extract_raw_frames(cpl_frameset *input, cpl_frameset *raws)
split input sof in groups: raw and calib
Definition: eris_utils.c:260
const char * eris_get_license(void)
Get the pipeline copyright and license.
Definition: eris_utils.c:138
cpl_boolean eris_param_has_changed(const cpl_parameter *p)
verify if a parameter value has been changed (from command line or or rc file by a user)
Definition: eris_utils.c:809
cpl_error_code eris_dfs_extract_cal_frames(cpl_frameset *input, cpl_frameset *calibs)
split input sof in groups: raw and calib
Definition: eris_utils.c:287