File: vimos_overscan.cc

package info (click to toggle)
cpl-plugin-vimos 4.1.1%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 28,228 kB
  • sloc: ansic: 169,271; cpp: 16,177; sh: 4,344; python: 3,678; makefile: 1,138; perl: 10
file content (373 lines) | stat: -rw-r--r-- 14,513 bytes parent folder | download | duplicates (2)
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
/* $Id: moses.c,v 1.116 2013/10/15 09:27:38 cgarcia Exp $
 *
 * This file is part of the MOSES library
 * Copyright (C) 2002-2010 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
 */

/*
 * $Author: cgarcia $
 * $Date: 2013/10/15 09:27:38 $
 * $Revision: 1.116 $
 * $Name:  $
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <stdexcept>
#include <string>
#include <cpl.h>
#include <hdrl.h>
#include "vimos_overscan.h"
#include "ccd_config.h"
#include "statistics.h"


/**
 * @brief
 *   Subtract the overscan from a CCD exposure
 *
 * @param image       Image containing the data to correct
 * @param header      Header of the image
 *
 * @return A newly allocated overscan subtracted image
 *
 */
mosca::image  vimos_preoverscan::subtract_prescan(mosca::image& image, 
                                   const mosca::ccd_config& ccd_config)
{
    int box_hsize = HDRL_OVERSCAN_FULL_BOX;

    //Get number of ports
    size_t nports = ccd_config.nports();
    
    //Create a copy where to store the results
    cpl_image * image_err = cpl_image_duplicate(image.get_cpl_image_err());
    cpl_mask * old_bpm = cpl_image_set_bpm(image_err, 
                            cpl_mask_duplicate(cpl_image_get_bpm(image.get_cpl_image())));
    cpl_mask_delete(old_bpm);
    hdrl_image * target_image = hdrl_image_create(image.get_cpl_image(), image_err);
    cpl_image_delete(image_err);

    //Loop on the ports
    for(size_t iport = 0; iport < nports; iport++)
    {
        hdrl_parameter * collapse_method =  
                hdrl_collapse_median_parameter_create();
        mosca::rect_region ps_reg = ccd_config.prescan_region(iport).coord_0to1();
        hdrl_parameter * prescan_region = ps_reg.hdrl_param(); //deleted by ps_reg

        hdrl_direction correction_direction;
        if(ccd_config.prescan_region(iport).length_x() > 
           ccd_config.prescan_region(iport).length_y())
            correction_direction = HDRL_Y_AXIS;
        else 
            correction_direction = HDRL_X_AXIS;
        
        double ron = ccd_config.computed_ron(iport);
        hdrl_parameter * prescan_params =
                hdrl_overscan_parameter_create(correction_direction,
                                               ron,
                                               box_hsize,
                                               collapse_method,
                                               prescan_region);
                
        hdrl_overscan_compute_result * os_computation =
                hdrl_overscan_compute(image.get_cpl_image(), prescan_params);

        hdrl_image * os_image = 
                hdrl_overscan_compute_result_get_correction(os_computation);
        m_median_correction = 
                cpl_image_get_median(hdrl_image_get_image(os_image));
        
        mosca::rect_region por_reg = ccd_config.validpix_region(iport).coord_0to1(); 
        hdrl_parameter * port_region = por_reg.hdrl_param(); //deleted by por_reg

        hdrl_overscan_correct_result * os_correction =
            hdrl_overscan_correct(target_image, port_region, os_computation);

        hdrl_image * os_corrected_ima = 
            hdrl_overscan_correct_result_get_corrected(os_correction);
        
        hdrl_image * port_image = hdrl_image_extract(os_corrected_ima,
                       ccd_config.validpix_region(iport).coord_0to1().llx(),
                       ccd_config.validpix_region(iport).coord_0to1().lly(),
                       ccd_config.validpix_region(iport).coord_0to1().urx(),
                       ccd_config.validpix_region(iport).coord_0to1().ury());

        hdrl_image_copy(target_image, port_image, 
                        ccd_config.validpix_region(iport).coord_0to1().llx(), 
                        ccd_config.validpix_region(iport).coord_0to1().lly());
        
        hdrl_overscan_compute_result_delete(os_computation);
        hdrl_overscan_correct_result_delete(os_correction);
        hdrl_image_delete(port_image);
        hdrl_parameter_delete(prescan_params);
        
    }
    
    //The rest of the VIMOS pipeline works with float images, so we cast it
    mosca::image os_subtracted(
       cpl_image_cast(hdrl_image_get_image_const(target_image), CPL_TYPE_FLOAT), 
       cpl_image_cast(hdrl_image_get_error_const(target_image), CPL_TYPE_FLOAT),
       true, mosca::Y_AXIS);
    
    hdrl_image_delete(target_image);
    return os_subtracted;
}

//TODO: This is by far not efficient. Too many copies are happening
std::vector<mosca::image> vimos_preoverscan::subtract_prescan
(std::vector<mosca::image>& ima_list, const mosca::ccd_config& ccd_config)
{
    int nima = ima_list.size();
    std::vector<mosca::image> ima_list_os_sub;

    std::vector<double> mean_corr;
    for(int ima = 0; ima < nima; ++ima)
    {
        ima_list_os_sub.push_back(subtract_prescan(ima_list[ima], ccd_config));
        mean_corr.push_back(get_median_correction());
    }
    m_median_correction = mosca::mean(mean_corr.begin(), mean_corr.end());
    return ima_list_os_sub;
}

/**
 * @brief
 *   Subtract the overscan from a CCD exposure
 *
 * @param image       Image containing the data to correct
 * @param header      Header of the image
 *
 * @return A newly allocated overscan subtracted image
 * TODO: Refactor this with subtract_prescan
 */
mosca::image  vimos_preoverscan::subtract_overscan(mosca::image& image, 
                                   const mosca::ccd_config& ccd_config)
{
    int box_hsize = HDRL_OVERSCAN_FULL_BOX;

    //Get number of ports
    size_t nports = ccd_config.nports();
    
    //Create a copy where to store the results
    cpl_image * image_err = cpl_image_duplicate(image.get_cpl_image_err());
    cpl_mask * old_bpm = cpl_image_set_bpm(image_err, 
                            cpl_mask_duplicate(cpl_image_get_bpm(image.get_cpl_image())));
    cpl_mask_delete(old_bpm);
    hdrl_image * target_image = hdrl_image_create(image.get_cpl_image(), image_err);
    cpl_image_delete(image_err);

    //Loop on the ports
    for(size_t iport = 0; iport < nports; iport++)
    {
        hdrl_parameter * collapse_method =  
                hdrl_collapse_median_parameter_create();
        mosca::rect_region ps_reg = ccd_config.overscan_region(iport).coord_0to1();
        hdrl_parameter * overscan_region = ps_reg.hdrl_param(); //deleted by ps_reg

        hdrl_direction correction_direction;
        if(ccd_config.overscan_region(iport).length_x() > 
           ccd_config.overscan_region(iport).length_y())
            correction_direction = HDRL_Y_AXIS;
        else 
            correction_direction = HDRL_X_AXIS;
        
        double ron = ccd_config.computed_ron(iport);
        hdrl_parameter * overscan_params =
                hdrl_overscan_parameter_create(correction_direction,
                                               ron,
                                               box_hsize,
                                               collapse_method,
                                               overscan_region);
                
        hdrl_overscan_compute_result * os_computation =
                hdrl_overscan_compute(image.get_cpl_image(), overscan_params);

        hdrl_image * os_image = 
                hdrl_overscan_compute_result_get_correction(os_computation);
        m_median_correction = 
                cpl_image_get_median(hdrl_image_get_image(os_image));
        
        mosca::rect_region por_reg = ccd_config.validpix_region(iport).coord_0to1(); 
        hdrl_parameter * port_region = por_reg.hdrl_param(); //deleted by por_reg

        hdrl_overscan_correct_result * os_correction =
            hdrl_overscan_correct(target_image, port_region, os_computation);

        hdrl_image * os_corrected_ima = 
            hdrl_overscan_correct_result_get_corrected(os_correction);
        
        hdrl_image * port_image = hdrl_image_extract(os_corrected_ima,
                       ccd_config.validpix_region(iport).coord_0to1().llx(),
                       ccd_config.validpix_region(iport).coord_0to1().lly(),
                       ccd_config.validpix_region(iport).coord_0to1().urx(),
                       ccd_config.validpix_region(iport).coord_0to1().ury());

        hdrl_image_copy(target_image, port_image, 
                        ccd_config.validpix_region(iport).coord_0to1().llx(), 
                        ccd_config.validpix_region(iport).coord_0to1().lly());
        
        hdrl_overscan_compute_result_delete(os_computation);
        hdrl_overscan_correct_result_delete(os_correction);
        hdrl_image_delete(port_image);
        hdrl_parameter_delete(overscan_params);
        
    }
    
    //The rest of the VIMOS pipeline works with float images, so we cast it
    mosca::image os_subtracted(
       cpl_image_cast(hdrl_image_get_image_const(target_image), CPL_TYPE_FLOAT), 
       cpl_image_cast(hdrl_image_get_error_const(target_image), CPL_TYPE_FLOAT),
       true, mosca::Y_AXIS);
    
    hdrl_image_delete(target_image);
    return os_subtracted;
}

//TODO: This is by far not efficient. Too many copies are happening
std::vector<mosca::image> vimos_preoverscan::subtract_overscan
(std::vector<mosca::image>& ima_list, const mosca::ccd_config& ccd_config)
{
    int nima = ima_list.size();
    std::vector<mosca::image> ima_list_os_sub;

    std::vector<double> mean_corr;
    for(int ima = 0; ima < nima; ++ima)
    {
        ima_list_os_sub.push_back(subtract_overscan(ima_list[ima], ccd_config));
        mean_corr.push_back(get_median_correction());
    }
    m_median_correction = mosca::mean(mean_corr.begin(), mean_corr.end());
    return ima_list_os_sub;
}

mosca::image vimos_preoverscan::trimm_preoverscan(mosca::image& image, 
                                           const mosca::ccd_config& ccd_config)
{
    mosca::rect_region crop_region = ccd_config.whole_valid_region();
    mosca::rect_region crop_region_1 = crop_region.coord_0to1(); 
    if(crop_region_1.is_empty())
        throw std::invalid_argument("Region to crop is empty");
    mosca::image image_trimmed = 
            image.trim(crop_region_1.lly(), crop_region_1.llx(),
                       crop_region_1.ury(), crop_region_1.urx());
    return image_trimmed;
}

//TODO: This is by far not efficient. Too many copies are happening
std::vector<mosca::image> vimos_preoverscan::trimm_preoverscan
(std::vector<mosca::image>& ima_list, const mosca::ccd_config& ccd_config)
{
    int nima = ima_list.size();
    std::vector<mosca::image> ima_list_trimmed;

    for(int ima = 0; ima < nima; ++ima)
        ima_list_trimmed.push_back(trimm_preoverscan(ima_list[ima], ccd_config));
    return ima_list_trimmed;
}

mosca::rect_region vimos_preoverscan::get_wcs_crop_region(const cpl_propertylist * header){
    mosca::fiera_config ccd_config(header);
    mosca::rect_region crop_region = ccd_config.whole_valid_region();
    return crop_region.coord_0to1();
}

void vimos_preoverscan::fix_wcs_trimm(cpl_propertylist * header)
{
    mosca::rect_region crop_region_1 = get_wcs_crop_region(header);
    if(crop_region_1.is_empty())
        throw std::invalid_argument("Cannot fix WCS from overscan trimming");
    cpl_propertylist_update_double(header, "CRPIX1",
        cpl_propertylist_get_double(header, "CRPIX1") - crop_region_1.llx() + 1);
    cpl_propertylist_update_double(header, "CRPIX2",
        cpl_propertylist_get_double(header, "CRPIX2") - crop_region_1.lly() + 1);
}

double vimos_preoverscan::get_median_correction() const
{
    return m_median_correction;
}

cpl_image * vimos_subtract_prescan(cpl_image * image, cpl_image * image_var, 
                                   cpl_propertylist * header)
{
    mosca::fiera_config config_ccd(header);
    
    cpl_image * image_err = cpl_image_power_create(image_var, 0.5); 
    mosca::image target(image, image_err, false, mosca::Y_AXIS);
    
    vimos_preoverscan scan_corr;
    
    mosca::image target_corr = 
            scan_corr.subtract_prescan(target, config_ccd);
    
    cpl_image_delete(image_err);
    return cpl_image_duplicate(target_corr.get_cpl_image()); 
}

cpl_image * vimos_subtract_overscan(cpl_image * image, cpl_image * image_var, 
                                   cpl_propertylist * header)
{
    mosca::fiera_config config_ccd(header);
    
    cpl_image * image_err = cpl_image_power_create(image_var, 0.5); 
    mosca::image target(image, image_err, false, mosca::Y_AXIS);
    
    vimos_preoverscan scan_corr;
    
    mosca::image target_corr = 
            scan_corr.subtract_overscan(target, config_ccd);
    
    cpl_image_delete(image_err);
    return cpl_image_duplicate(target_corr.get_cpl_image()); 
}

cpl_image * vimos_trimm_preoverscan(cpl_image * image, 
                                    cpl_propertylist * header)
{
    mosca::fiera_config config_ccd(header);
    
    mosca::image target(image, false, mosca::Y_AXIS);
    
    vimos_preoverscan scan_corr;
    
    mosca::image target_corr = 
            scan_corr.trimm_preoverscan(target, config_ccd);
    
    return cpl_image_duplicate(target_corr.get_cpl_image()); 
}



//void fors_trimm_fill_info(cpl_propertylist * header,
//                          const mosca::ccd_config& ccd_config)
//{
//    mosca::rect_region crop_region = ccd_config.whole_valid_region();
//    mosca::rect_region crop_region_1 = crop_region.coord_0to1(); 
//
//    cpl_propertylist_append_int(header, "ESO QC TRIMM LLX",
//                                crop_region_1.llx());
//    cpl_propertylist_append_int(header, "ESO QC TRIMM LLY",
//                                crop_region_1.lly());
//    cpl_propertylist_append_int(header, "ESO QC TRIMM URX",
//                                crop_region_1.urx());
//    cpl_propertylist_append_int(header, "ESO QC TRIMM URY",
//                                crop_region_1.ury());
//}