File: uves_wavecal_utils.h

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 (133 lines) | stat: -rw-r--r-- 4,343 bytes parent folder | download | duplicates (4)
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
/*
 * This file is part of the ESO UVES Pipeline
 * Copyright (C) 2004,2005 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, 51 Franklin St, Fifth Floor, Boston, MA  02111-1307  USA
 */

/*
 * $Author: amodigli $
 * $Date: 2010-09-24 09:32:10 $
 * $Revision: 1.10 $
 * $Name: not supported by cvs2svn $
 * $Log: not supported by cvs2svn $
 * Revision 1.8  2007/06/06 08:17:34  amodigli
 * replace tab with 4 spaces
 *
 * Revision 1.7  2007/03/05 10:47:00  jmlarsen
 * Reject outliers based on line FWHM and fit residual
 *
 * Revision 1.6  2006/10/10 11:20:11  jmlarsen
 * Renamed line table columns to match MIDAS
 *
 * Revision 1.5  2006/07/14 12:52:57  jmlarsen
 * Exported/renamed function find_nearest
 *
 * Revision 1.4  2006/06/01 14:43:17  jmlarsen
 * Added missing documentation
 *
 * Revision 1.3  2006/04/21 12:29:30  jmlarsen
 * Write QC parameters to line table
 *
 * Revision 1.2  2006/02/15 13:19:15  jmlarsen
 * Reduced source code max. line length
 *
 * Revision 1.1  2006/02/03 07:46:30  jmlarsen
 * Moved recipe implementations to ./uves directory
 *
 * Revision 1.2  2005/12/19 16:17:55  jmlarsen
 * Replaced bool -> int
 *
 * Revision 1.1  2005/11/11 13:18:54  jmlarsen
 * Reorganized code, renamed source files
 *
 */
#ifndef UVES_WAVECAL_UTILS_H
#define UVES_WAVECAL_UTILS_H

#include <uves_utils_polynomial.h>
#include <cpl.h>
#include <stdbool.h>

/*-----------------------------------------------------------------------------
                                Defines
 -----------------------------------------------------------------------------*/
/* Use #defines to have consistent column names in all recipes */
#define LINETAB_PIXELSIZE "Pixel"
#define LINETAB_RESIDUAL  "Residual"  /* in wlu, not pixels */
#define LINETAB_LAMBDAC   "WaveC"     /* computed wavelength */

/*-----------------------------------------------------------------------------
                                Typedefs
 -----------------------------------------------------------------------------*/

/**
   A 'line table' is not just a table. It consists of
   (for each (window, trace))

   a table
   a dispersion relation,
   a map from (pixel, pixel) to (absolute order number)
   absolute order number limits
*/
typedef struct
{
    /** Number of windows */
    int windows;

    /** Number of traces */
    int traces;

    /** The table */
    cpl_table        **table;

    /** f(x,m) = lambda*m  */
    polynomial       **dispersion_relation;

    /** m = abs_order(x,y) */
    polynomial       **absolute_order;

    /** Conversion from relative to absolute (physical) order number */
    int *first_absolute_order;

    /** Last absolute order */
    int *last_absolute_order;

} lt_type;


int uves_wavecal_find_nearest(const cpl_table *line_refer, double lambda, int lo, int hi);

cpl_error_code uves_draw_lines(cpl_image *image,
                   polynomial *dispersion, 
                   const polynomial *order_locations,
                   const cpl_table *t,
                   const char *lambda_column, const char *abs_order,
                   const int *relative_order, 
                   int minorder, int maxorder, bool vertical, int offset);

int uves_delete_bad_lines(cpl_table *table, double TOLERANCE, double kappa);


lt_type *uves_lt_new(int windows, int traces);
void uves_lt_delete(lt_type **lt);
cpl_table **uves_lt_get_table(const lt_type *lt, int window, int trace);
polynomial **uves_lt_get_disprel(const lt_type *lt, int window, int trace);
polynomial **uves_lt_get_absord(const lt_type *lt, int window, int trace);
int *uves_lt_get_firstabs(const lt_type *lt, int window, int trace);
int *uves_lt_get_lastabs(const lt_type *lt, int window, int trace);

#endif