File: flames_writenormfactors.c

package info (click to toggle)
cpl-plugin-uves 6.1.3+dfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 23,128 kB
  • sloc: ansic: 171,056; sh: 4,359; python: 3,002; makefile: 1,322
file content (468 lines) | stat: -rw-r--r-- 18,956 bytes parent folder | download | duplicates (3)
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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
/*===========================================================================
  Copyright (C) 2001 European Southern Observatory (ESO)

  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., 675 Massachusetss Ave, Cambridge, 
  MA 02139, USA.

  Corresponding concerning ESO-MIDAS should be addressed as follows:
    Internet e-mail: midas@eso.org
    Postal address: European Southern Observatory
            Data Management Division 
            Karl-Schwarzschild-Strasse 2
            D 85748 Garching bei Muenchen 
            GERMANY
===========================================================================*/
/* Program  : writenormfactors.c                                           */
/* Author   : G. Mulas  -  ITAL_FLAMES Consortium                          */
/* Date     :                                                              */
/*                                                                         */
/* Purpose  : Missing                                                      */
/*                                                                         */
/*                                                                         */
/* Input:  see interface                                                   */ 
/*                                                                      */
/* Output:                                                              */
/*                                                                         */
/* DRS Functions called:                                                   */
/* none                                                                    */ 
/*                                                                         */ 
/* Pseudocode:                                                             */
/* Missing                                                                 */ 
/*                                                                         */ 
/* Version  :                                                              */
/* Last modification date: 2002/08/05                                      */
/* Who     When        Why                Where                            */
/* AMo     02-08-05   Add header         header                            */
/*-------------------------------------------------------------------------*/
#ifdef HAVE_CONFIG_H
#  include <config.h>
#endif


#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <math.h>
#include <flames_midas_def.h>
#include <flames_writenormfactors.h>
#include <flames_uves.h>
#include <flames_newmatrix.h>


flames_err writenormfactors(const cpl_frameset *catname, allflats *myflats)
{

    int32_t nflats=0, ncommon=0, nnormal=0, nnsigma=0;
    int entrynum=0;
    flames_err status=0;
    char filename[CATREC_LEN+1];
    char identifier[CATREC_LEN+1];
    char normalname[CATREC_LEN+1];
    char nsigmaname[CATREC_LEN+1];
    char commoname[CATREC_LEN+1];
    int commid=0;
    int normid=0;
    int nsigid=0;
    int actvals=0;
    int unit=0;
    int null=0;
    int ibuf[4]={0,0,0,0};
    double dbuf[4]={0,0,0,0};
    float lhcuts[4]={0,0,0,0};
    char cbuf[CATREC_LEN+1];
    char cunit[81];
    int32_t ****longarray=0;

    frame_data *fdvecbuf1=0;
    frame_mask *fmvecbuf1=0;
    int32_t *lvecbuf1=0;
    float fbuf1=0;
    float minimum=0;
    float maximum=0;
    int32_t fibreboundssize=0;
    int32_t iorderifibreixend=0;
    int32_t iorderifibreixindex=0;
    int32_t iiorderifibreixend=0;
    int32_t iiorderifibreixindex=0;


    memset(filename, 0, CATREC_LEN+1);
    memset(identifier, 0, CATREC_LEN+1);
    memset(normalname, 0, CATREC_LEN+1);
    memset(nsigmaname, 0, CATREC_LEN+1);
    memset(commoname, 0, CATREC_LEN+1);
    memset(cbuf, 0, CATREC_LEN+1);
    memset(cunit, 0, 81);


    nflats = 0;
    ncommon = 0;
    nnsigma = 0;
    nnormal = 0;
    /* first open the catalog, count the fibre FF frames, the normalisation
     frame(s) and the common 4D frame present */
    entrynum = 0;
    do {
        if ((status = SCCGET(catname, 1, filename, identifier, &entrynum)) != 0) {
            /* error getting catalog entry */
            return flames_midas_error(MAREMMA);
        }
        /* did I get a valid catalog entry? */
        if (filename[0] != ' ') {
            /* is this a int32_t slit FF frame? */
            if(strcmp(identifier, "Cleaned fibre FF                        ") == 0) {
                nflats++;
            }
            /* is this a normalisation frame? */
            if(strcmp(identifier, "Normalisation data for fibre FF         ") == 0) {
                nnormal++;
                strcpy(normalname, filename);
            }
            /* is this a normalisation frame? */
            if(strcmp(identifier, "Normalisation sigmas for fibre FF       ") == 0) {
                nnsigma++;
                strcpy(nsigmaname, filename);
            }
            /* is this a common frame? */
            if(strcmp(identifier, "Common data for fibre FF                ") == 0) {
                ncommon++;
                strcpy(commoname, filename);
            }
        }
    } while (filename[0] != ' ');
    /* did I get at least 1 FF frame name? */
    if (myflats->nflats != nflats) {
        /* I need at least 1 FF frame! */
        return flames_midas_error(MAREMMA);
    }
    /* did I get exactly 1 normalisation frame and common frame name? */
    if (nnormal != 1) {
        /* I need exactly 1 normalisation frame name! */
        return flames_midas_error(MAREMMA);
    }
    if (nnsigma != 1) {
        /* I need exactly 1 normalisation sigmas frame name! */
        return flames_midas_error(MAREMMA);
    }
    if (ncommon != 1) {
        /* I need exactly 1 common frame name! */
        return flames_midas_error(MAREMMA);
    }

    /* open the common frame to get the descriptors */
    if ((status = SCFOPN(commoname, D_I4_FORMAT, 0, F_IMA_TYPE,
                    &commid)) != 0) {
        /* could not open the frame */
        return flames_midas_error(MAREMMA);
    }
    /* read the relevant information from the frame */
    if ((status = SCDRDI(commid, "NFLATS", 1, 1, &actvals, ibuf,
                    &unit, &null)) != 0) {
        /* problems reading NFLATS: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->nflats != ibuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDI(commid, "ROWS", 1, 1, &actvals, ibuf,
                    &unit, &null)) != 0) {
        /* problems reading ROWS: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->subrows != ibuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDI(commid, "COLS", 1, 1, &actvals, ibuf,
                    &unit, &null)) != 0) {
        /* problems reading COLS: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->subcols != ibuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDD(commid, "STARTX", 1, 1, &actvals,
                    dbuf, &unit, &null)) != 0) {
        /* problems reading STEPX: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->substartx != dbuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDD(commid, "STARTY", 1, 1, &actvals,
                    dbuf, &unit, &null)) != 0) {
        /* problems reading STEPY: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->substarty != dbuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDD(commid, "STEPX", 1, 1, &actvals,
                    dbuf, &unit, &null)) != 0) {
        /* problems reading STEPX: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->substepx != dbuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDD(commid, "STEPY", 1, 1, &actvals,
                    dbuf, &unit, &null)) != 0) {
        /* problems reading STEPY: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->substepy != dbuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDC(commid, "CHIPCHOICE", 1, 1, 1, &actvals,
                    cbuf, &unit, &null)) != 0) {
        /* problems reading CHIPCHOICE: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->chipchoice != cbuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDD(commid, "RON", 1, 1, &actvals,
                    dbuf, &unit, &null)) != 0) {
        /* problems reading RON: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->ron != dbuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDD(commid, "GAIN", 1, 1, &actvals,
                    dbuf, &unit, &null)) != 0) {
        /* problems reading GAIN: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->gain != dbuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDI(commid, "ORDERLIM", 1, 1, &actvals,
                    ibuf, &unit, &null)) != 0) {
        /* problems reading FIRSTORDER: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->firstorder != ibuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDI(commid, "ORDERLIM", 2, 1, &actvals,
                    ibuf, &unit, &null)) != 0) {
        /* problems reading LASTORDER: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->lastorder != ibuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDI(commid, "TAB_IN_OUT_OSHIFT", 1, 1, &actvals,
                    ibuf, &unit, &null)) != 0) {
        /* problems reading TAB_IN_OUT_OSHIFT: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->tab_io_oshift != ibuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDI(commid, "MAXFIBRES", 1, 1, &actvals, ibuf,
                    &unit, &null)) != 0) {
        /* problems reading COLS: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->maxfibres != ibuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDD(commid, "PIXMAX", 1, 1, &actvals,
                    dbuf, &unit, &null)) != 0) {
        /* problems reading GAIN: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->pixmax != dbuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDD(commid, "HALFIBREWIDTH", 1, 1, &actvals,
                    dbuf, &unit, &null)) != 0) {
        /* problems reading GAIN: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->halfibrewidth != dbuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDD(commid, "MINFIBREFRAC", 1, 1, &actvals,
                    dbuf, &unit, &null)) != 0) {
        /* problems reading GAIN: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->minfibrefrac != dbuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    if ((status = SCDRDI(commid, "NUMFIBRES", 1, 1, &actvals, ibuf,
                    &unit, &null)) != 0) {
        /* problems reading COLS: complain... */
        return flames_midas_error(MAREMMA);
    }
    if (myflats->numfibres != ibuf[0]) {
        /* mismatch between catalog and descriptors, abort */
        return flames_midas_error(MAREMMA);
    }
    /* build the 4D array to be dumped to disk */
    /* allocate the memory */
    longarray = l4tensor(0, 2, 0, myflats->lastorder-myflats->firstorder,
                    0, myflats->maxfibres-1, 0, myflats->subcols-1);
    fibreboundssize = (myflats->lastorder-myflats->firstorder+1)*
                    myflats->maxfibres*myflats->subcols;
    iorderifibreixend = fibreboundssize-1;
    /* fill the 4D array: use memcpy for the fibrebounds, since they are
     already int32_t data type, run an explicit loop for goodfibres, which
     needs to be cast before copying */
    memcpy(longarray[0][0][0], myflats->lowfibrebounds[0][0],
           fibreboundssize*sizeof(int32_t));
    memcpy(longarray[1][0][0], myflats->highfibrebounds[0][0],
           fibreboundssize*sizeof(int32_t));
    lvecbuf1 = longarray[2][0][0];
    fmvecbuf1 = myflats->goodfibres[0][0];
    for (iorderifibreixindex=0; iorderifibreixindex<=iorderifibreixend;
                    iorderifibreixindex++) {
        lvecbuf1[iorderifibreixindex] = (int32_t) fmvecbuf1[iorderifibreixindex];
    }
    /* write the 4D array to file */
    if (SCFPUT(commid, 1, 3*(1+myflats->lastorder-myflats->firstorder)*
                    myflats->maxfibres*myflats->subcols,
                    (char *) (longarray[0][0][0])) != 0) {
        /* I could not write this big frame to disk: complain... */
        return(flames_midas_error(MAREMMA));
    }
    /* initialise LHCUTS */
    lvecbuf1 = longarray[0][0][0];
    lhcuts[0] = lhcuts[1] = 0;
    minimum = maximum = (float) lvecbuf1[0];
    iiorderifibreixend = (3*fibreboundssize)-1;
    for (iiorderifibreixindex=1; iiorderifibreixindex<=iiorderifibreixend;
                    iiorderifibreixindex++) {
        fbuf1 = (float)lvecbuf1[iiorderifibreixindex];
        if (fbuf1<minimum) minimum = fbuf1;
        if (fbuf1>maximum) maximum = fbuf1;
    }
    lhcuts[2] = minimum;
    lhcuts[3] = maximum;
    /* free the 4D array */
    free_l4tensor(longarray, 0, 2, 0, myflats->lastorder-myflats->firstorder,
                  0, myflats->maxfibres-1, 0, myflats->subcols-1);
    /* write LHCUTS */
    if (SCDWRR(commid, "LHCUTS", lhcuts, 1, 4, &null) != 0) {
        /* I could not write the descriptor: complain... */
        return flames_midas_error(MAREMMA);
    }
    /* we are indeed writing normalisation data, hence flag this fibre FF set
     as normalised */
    if (SCDWRC(commid, "NORMALISED", 1, "y", 1, 1, &unit) != 0) {
        SCTPUT("Error updating the NORMALISED flag");
        return flames_midas_error(MAREMMA);
    }
    /* close the common frame */
    if ((status = SCFCLO(commid)) != 0) {
        /* error closing common frame: complain */
        return flames_midas_error(MAREMMA);
    }

    /* open the normalisation data frame on disk */
    if (SCFOPN(normalname, FLAMESDATATYPE, 0, F_IMA_TYPE, &normid) != 0) {
        /* could not open the file */
        return flames_midas_error(MAREMMA);
    }
    /* write the 3D array to file */
    if (SCFPUT(normid, 1,
                    (myflats->lastorder-myflats->firstorder+1)*myflats->maxfibres*
                    myflats->subcols,
                    (char *) myflats->normfactors[0][0]) != 0) {
        /* I could not write this big frame to disk: complain... */
        return flames_midas_error(MAREMMA);
    }
    /* write the standard descriptors */
    /* initialise LHCUTS, otherwise MIDAS will complain*/
    fdvecbuf1 = myflats->normfactors[0][0];
    lhcuts[0] = lhcuts[1] = 0;
    minimum = maximum = fdvecbuf1[0];
    for (iorderifibreixindex=1; iorderifibreixindex<=iorderifibreixend;
                    iorderifibreixindex++) {
        fbuf1 = (float) fdvecbuf1[iorderifibreixindex];
        if (fbuf1<minimum) minimum = fbuf1;
        if (fbuf1>maximum) maximum = fbuf1;
    }
    lhcuts[2] = minimum;
    lhcuts[3] = maximum;
    /* write the LHCUTS descriptor */
    if ((status = SCDWRR(normid, "LHCUTS", lhcuts, 1, 4, &null)) != 0) {
        /* I could not write the descriptor: complain... */
        return flames_midas_error(MAREMMA);
    }
    /* all right, close normalisation frame */
    if (SCFCLO(normid) != 0) {
        /* problems closing common frame */
        return flames_midas_error(MAREMMA);
    }

    /* create the normalisation sigmas frame on disk */
    if (SCFOPN(nsigmaname, FLAMESDATATYPE, 0, F_IMA_TYPE, &nsigid) != 0) {
        /* could not open the file */
        return flames_midas_error(MAREMMA);
    }
    /* write the 3D array to file */
    if (SCFPUT(nsigid, 1,
                    (myflats->lastorder-myflats->firstorder+1)*myflats->maxfibres*
                    myflats->subcols,
                    (char *) myflats->normsigmas[0][0]) != 0) {
        /* I could not write this big frame to disk: complain... */
        return flames_midas_error(MAREMMA);
    }
    /* initialise LHCUTS, otherwise MIDAS will complain*/
    fdvecbuf1 = myflats->normsigmas[0][0];
    lhcuts[0] = lhcuts[1] = 0;
    minimum = maximum = fdvecbuf1[0];
    for (iorderifibreixindex=1; iorderifibreixindex<=iorderifibreixend;
                    iorderifibreixindex++) {
        fbuf1 = (float) fdvecbuf1[iorderifibreixindex];
        if (fbuf1<minimum) minimum = fbuf1;
        if (fbuf1>maximum) maximum = fbuf1;
    }
    lhcuts[2] = minimum;
    lhcuts[3] = maximum;
    /* write the LHCUTS descriptor */
    if ((status = SCDWRR(nsigid, "LHCUTS", lhcuts, 1, 4, &null)) != 0) {
        /* I could not write the descriptor: complain... */
        return flames_midas_error(MAREMMA);
    }
    /* close this frame */
    if ((status = SCFCLO(nsigid)) != 0) {
        /* error closing common frame: complain */
        return flames_midas_error(MAREMMA);
    }

    return NOERR;

}