MOONS Pipeline Reference Manual 0.13.1
moo_products.h
1/*
2 * This file is part of the MOONS Pipeline
3 * Copyright (C) 2002-2016 European Southern Observatory
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20#ifndef MOO_PRODUCTS_H
21#define MOO_PRODUCTS_H
22
23
24/*-----------------------------------------------------------------------------
25 Includes
26 -----------------------------------------------------------------------------*/
27#include <cpl.h>
28
29#include "moo_detector.h"
30#include "moo_det.h"
31#include "moo_params.h"
32#include "moo_raw.h"
33#include "moo_ext.h"
34#include "moo_rbn.h"
35#include "moo_sci.h"
36#include "moo_f2f.h"
37#include "moo_psf.h"
38#include "moo_loc.h"
39#include "moo_map.h"
40#include "moo_bpm.h"
41#include "moo_cube.h"
42#include "moo_resp.h"
43#include "moo_telluric.h"
44#include "moo_target_table.h"
45#include "moo_molectable.h"
46#include "moo_s1d.h"
47#include "moo_prepare.h"
48
49#define DICTIONARY_ID "ESO-VLT-DIC.PRO-1.16"
50#define MOO_PRODUCTS_PIPEID "moons"
51typedef struct
52{
53 cpl_frameset *framelist;
54 cpl_frameset *temporarylist;
55 const cpl_parameterlist *parlist;
56 const char *recid;
57 const char *pipeline_id;
58 int keep_temp;
59 moo_params *params;
60} moo_products;
61
62/*-----------------------------------------------------------------------------
63 Types
64 -----------------------------------------------------------------------------*/
65
66/*-----------------------------------------------------------------------------
67 Functions prototypes
68 -----------------------------------------------------------------------------*/
69moo_products *moo_products_new(cpl_frameset *framelist,
70 const cpl_parameterlist *parlist,
71 const char *recid,
72 const char *pipeline_id);
73
74void moo_products_delete(moo_products *self);
75const moo_params *moo_products_get_params(const moo_products *self);
76cpl_error_code
77moo_products_add_frame(const moo_products *self, cpl_frame *frame);
78
79cpl_frame *moo_products_add(moo_products *self,
80 moo_det *det,
81 cpl_frame_level level,
82 const char *tag,
83 const char *filename,
84 const cpl_frame *inherit_frame);
85
86cpl_frame *moo_products_add_loc(moo_products *self,
87 moo_loc *loc,
88 int keep_points,
89 cpl_frame_level level,
90 const char *tag,
91 const char *filename,
92 const cpl_frame *inherit_frame);
93
94cpl_frame *moo_products_add_ext(moo_products *self,
95 moo_ext *ext,
96 cpl_frame_level level,
97 const char *tag,
98 const char *filename,
99 const cpl_frame *inherit_frame);
100
101cpl_frame *moo_products_add_rbn(moo_products *self,
102 moo_rbn *rbn,
103 cpl_frame_level level,
104 const char *tag,
105 const char *filename,
106 const cpl_frame *inherit_frame);
107
108cpl_frame *moo_products_add_sci(moo_products *self,
109 moo_sci *sci,
110 cpl_frame_level level,
111 const char *tag,
112 const char *filename,
113 const cpl_frame *inherit_frame);
114
115cpl_frame *moo_products_add_resp(moo_products *self,
116 moo_resp *resp,
117 cpl_frame_level level,
118 const char *tag,
119 const char *filename,
120 const cpl_frame *inherit_frame);
121
122cpl_frame *moo_products_add_telluric(moo_products *self,
123 moo_telluric *tell,
124 cpl_frame_level level,
125 const char *tag,
126 const char *filename,
127 const cpl_frame *inherit_frame);
128
129cpl_frame *moo_products_add_map(moo_products *self,
130 moo_map *map,
131 cpl_frame_level level,
132 const char *tag,
133 const char *filename,
134 const cpl_frame *inherit_frame,
135 moo_rbn *rbn);
136
137cpl_frame *moo_products_add_molectable(moo_products *self,
138 moo_molectable *mtable,
139 cpl_frame_level level,
140 const char *tag,
141 const char *filename,
142 const cpl_frame *inherit_frame);
143
144cpl_frame *moo_products_add_bpm(moo_products *self,
145 moo_bpm *bpm,
146 cpl_frame_level level,
147 const char *tag,
148 const char *filename,
149 const cpl_frame *inherit_frame);
150
151cpl_frame *moo_products_add_saturate_map(moo_products *self,
152 moo_saturate_map *saturate,
153 cpl_frame_level level,
154 const char *tag,
155 const char *filename,
156 const cpl_frame *inherit_frame);
157
158cpl_frame *moo_products_add_cube(moo_products *self,
159 moo_cube *cube,
160 cpl_frame_level level,
161 const char *tag,
162 const char *filename,
163 const cpl_frame *inherit_frame);
164
165cpl_frame *moo_products_add_s1d(moo_products *self,
166 moo_s1d *s1d,
167 const char *tag,
168 const cpl_frame *inherit_frame);
169
170
171cpl_frame *moo_products_add_target_table(moo_products *self,
172 moo_target_table *ttable,
173 cpl_frame_level level,
174 const char *tag,
175 const char *filename,
176 const cpl_frame *inherit_frame);
177
178cpl_frame *moo_products_add_f2f(moo_products *self,
179 moo_f2f *f2f,
180 cpl_frame_level level,
181 const char *tag,
182 const char *filename,
183 const cpl_frame *inherit_frame);
184
185cpl_frame *moo_products_add_psf(moo_products *self,
186 moo_psf *psf,
187 cpl_frame_level level,
188 const char *tag,
189 const char *filename,
190 const cpl_frame *inherit_frame);
191
192cpl_frame *moo_products_add_raw(moo_products *self,
193 moo_raw *raw,
194 cpl_frame_level level,
195 const char *tag,
196 const char *filename,
197 const cpl_frame *inherit_frame);
198
199cpl_error_code moo_masterbias(moo_det *det,
200 moo_detlist *bias_list,
201 moo_bias_params *bias_params,
202 moo_products *products);
203
204cpl_error_code moo_masterdark(moo_det *det, moo_products *products, int mode);
205
206#endif
moo_products_new
moo_products * moo_products_new(cpl_frameset *framelist, const cpl_parameterlist *parlist, const char *recid, const char *pipeline_id)
create a moo_product object for a recipe
Definition: moo_products.c:51
moo_products_add_s1d
cpl_frame * moo_products_add_s1d(moo_products *self, moo_s1d *s1d, const char *tag, const cpl_frame *inherit_frame)
create a product from a MOLECTABLE object
Definition: moo_products.c:1134
moo_products_add_loc
cpl_frame * moo_products_add_loc(moo_products *self, moo_loc *loc, int keep_points, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame)
This function creates a product from a LOC structure.
Definition: moo_products.c:229
moo_products_add_sci
cpl_frame * moo_products_add_sci(moo_products *self, moo_sci *sci, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame)
create a product from a SCI object
Definition: moo_products.c:372
moo_products_add_rbn
cpl_frame * moo_products_add_rbn(moo_products *self, moo_rbn *rbn, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame)
create a product from a RBN object
Definition: moo_products.c:328
moo_products_add_ext
cpl_frame * moo_products_add_ext(moo_products *self, moo_ext *ext, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame)
create a product from a EXT object
Definition: moo_products.c:285
moo_products_add_molectable
cpl_frame * moo_products_add_molectable(moo_products *self, moo_molectable *mtable, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame)
create a product from a MOLECTABLE object
Definition: moo_products.c:552
moo_products_add_frame
cpl_error_code moo_products_add_frame(const moo_products *self, cpl_frame *frame)
add a frame to the recipe products
Definition: moo_products.c:152
moo_products_add_target_table
cpl_frame * moo_products_add_target_table(moo_products *self, moo_target_table *ttable, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame)
create a product from a TARGET_TABLE object
Definition: moo_products.c:726
moo_products_add_saturate_map
cpl_frame * moo_products_add_saturate_map(moo_products *self, moo_saturate_map *saturate, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame)
create a product from a SATURATE MAP object
Definition: moo_products.c:639
moo_products_add_resp
cpl_frame * moo_products_add_resp(moo_products *self, moo_resp *resp, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame)
create a product from a RESP object
Definition: moo_products.c:416
moo_products_add_map
cpl_frame * moo_products_add_map(moo_products *self, moo_map *map, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame, moo_rbn *rbn)
create a product from a EXT object
Definition: moo_products.c:506
moo_products_add_cube
cpl_frame * moo_products_add_cube(moo_products *self, moo_cube *cube, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame)
create a product from a CUBE object
Definition: moo_products.c:683
moo_products_add_bpm
cpl_frame * moo_products_add_bpm(moo_products *self, moo_bpm *bpm, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame)
create a product from a BPM object
Definition: moo_products.c:595
moo_masterdark
cpl_error_code moo_masterdark(moo_det *det, moo_products *products, int mode)
This function creates the master dark frame as a product and essentially produces a standard output a...
Definition: moo_products.c:1038
moo_products_add
cpl_frame * moo_products_add(moo_products *self, moo_det *det, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame)
create a product from a DET object
Definition: moo_products.c:188
moo_masterbias
cpl_error_code moo_masterbias(moo_det *det, moo_detlist *bias_list, moo_bias_params *bias_params, moo_products *products)
This function creates the master bias frame as a product and essentially produces a standard output a...
Definition: moo_products.c:947
moo_products_get_params
const moo_params * moo_products_get_params(const moo_products *self)
get the moo_params object
Definition: moo_products.c:85
moo_products_add_telluric
cpl_frame * moo_products_add_telluric(moo_products *self, moo_telluric *tell, cpl_frame_level level, const char *tag, const char *filename, const cpl_frame *inherit_frame)
create a product from a TELLURIC object
Definition: moo_products.c:460
moo_target_table
the different type of detectors
Definition: moo_target_table.h:124
Generated on Wed Oct 8 2025 20:38:52 for MOONS Pipeline Reference Manual by doxygen 1.9.6