File: hdrl_overscan.h

package info (click to toggle)
cpl-plugin-xshoo 3.5.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 20,920 kB
  • sloc: ansic: 170,001; sh: 4,369; python: 2,391; makefile: 1,211
file content (146 lines) | stat: -rw-r--r-- 6,519 bytes parent folder | download | duplicates (19)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
 * This file is part of the HDRL
 * Copyright (C) 2012,2013 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_OVERSCAN_H
#define HDRL_OVERSCAN_H

/*-----------------------------------------------------------------------------
                                Include
 -----------------------------------------------------------------------------*/

#include "hdrl_utils.h"
#include "hdrl_image.h"

#include <cpl.h>

CPL_BEGIN_DECLS

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

#define HDRL_OVERSCAN_FULL_BOX -1
typedef struct _hdrl_overscan_compute_result_ hdrl_overscan_compute_result;
typedef struct _hdrl_overscan_correct_result_ hdrl_overscan_correct_result;

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

/*----------------------------------------------------------------------------
                           Overscan Computation Parameters
  ----------------------------------------------------------------------------*/
hdrl_parameter * hdrl_overscan_parameter_create(hdrl_direction, double, int, 
        hdrl_parameter *, hdrl_parameter *) ;
cpl_error_code hdrl_overscan_parameter_verify(const hdrl_parameter *,
        cpl_size, cpl_size) ;
cpl_boolean hdrl_overscan_parameter_check(const hdrl_parameter *) ;

/* Accessors */
hdrl_direction hdrl_overscan_parameter_get_correction_direction(
        const hdrl_parameter *) ;
double hdrl_overscan_parameter_get_ccd_ron(const hdrl_parameter *) ;
int hdrl_overscan_parameter_get_box_hsize(const hdrl_parameter *) ;
hdrl_parameter * hdrl_overscan_parameter_get_collapse(const hdrl_parameter *) ;
hdrl_parameter * hdrl_overscan_parameter_get_rect_region(const hdrl_parameter*);

/* Parameter Lists */
cpl_parameterlist * hdrl_overscan_parameter_create_parlist(const char *, 
        const char *, const char *, int, double,
        hdrl_parameter *, const char *, hdrl_parameter *, hdrl_parameter *) ;
hdrl_parameter * hdrl_overscan_parameter_parse_parlist(
        const cpl_parameterlist *, const char *) ;

/*----------------------------------------------------------------------------
                           Overscan Computation
  ----------------------------------------------------------------------------*/
hdrl_overscan_compute_result * hdrl_overscan_compute(
        const cpl_image         *   source,
        const hdrl_parameter    *   params) ;

/*----------------------------------------------------------------------------
                           Overscan Computation Result
  ----------------------------------------------------------------------------*/
hdrl_image * hdrl_overscan_compute_result_get_correction( 
        const hdrl_overscan_compute_result *);
hdrl_image * hdrl_overscan_compute_result_unset_correction( 
        hdrl_overscan_compute_result *); 

cpl_image * hdrl_overscan_compute_result_get_contribution(
        const hdrl_overscan_compute_result *);
cpl_image * hdrl_overscan_compute_result_unset_contribution(
        hdrl_overscan_compute_result *); 

cpl_image * hdrl_overscan_compute_result_get_chi2(
        const hdrl_overscan_compute_result *);
cpl_image * hdrl_overscan_compute_result_unset_chi2(
        hdrl_overscan_compute_result *); 

cpl_image * hdrl_overscan_compute_result_get_red_chi2(
        const hdrl_overscan_compute_result *);
cpl_image * hdrl_overscan_compute_result_unset_red_chi2(
        hdrl_overscan_compute_result *); 

cpl_image * hdrl_overscan_compute_result_get_sigclip_reject_low(
        const hdrl_overscan_compute_result *);
cpl_image * hdrl_overscan_compute_result_unset_sigclip_reject_low(
        hdrl_overscan_compute_result *); 

cpl_image * hdrl_overscan_compute_result_get_sigclip_reject_high(
        const hdrl_overscan_compute_result *);
cpl_image * hdrl_overscan_compute_result_unset_sigclip_reject_high(
        hdrl_overscan_compute_result *); 

cpl_image * hdrl_overscan_compute_result_get_minmax_reject_low(
        const hdrl_overscan_compute_result *);
cpl_image * hdrl_overscan_compute_result_unset_minmax_reject_low(
        hdrl_overscan_compute_result *); 

cpl_image * hdrl_overscan_compute_result_get_minmax_reject_high(
        const hdrl_overscan_compute_result *);
cpl_image * hdrl_overscan_compute_result_unset_minmax_reject_high(
        hdrl_overscan_compute_result *); 

void hdrl_overscan_compute_result_delete(hdrl_overscan_compute_result *);

/*----------------------------------------------------------------------------
                           Overscan Correction
  ----------------------------------------------------------------------------*/
hdrl_overscan_correct_result * hdrl_overscan_correct(
        const hdrl_image                        *   source,
        const hdrl_parameter                    *   region,
        const hdrl_overscan_compute_result      *   os_computation) ;

/*----------------------------------------------------------------------------
                           Overscan Correction Result
  ----------------------------------------------------------------------------*/
hdrl_image * hdrl_overscan_correct_result_get_corrected(
        const hdrl_overscan_correct_result *);
hdrl_image * hdrl_overscan_correct_result_unset_corrected(
        hdrl_overscan_correct_result *);

cpl_image * hdrl_overscan_correct_result_get_badmask(
        const hdrl_overscan_correct_result *);
cpl_image * hdrl_overscan_correct_result_unset_badmask(
        hdrl_overscan_correct_result *);
void hdrl_overscan_correct_result_delete(hdrl_overscan_correct_result *);

CPL_END_DECLS

#endif