MUSE Pipeline Reference Manual  2.1.1
muse_scipost_calibrate_flux_z.c
1 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim:set sw=2 sts=2 et cin: */
3 /*
4  * This file is part of the MUSE Instrument Pipeline
5  * Copyright (C) 2005-2015 European Southern Observatory
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  */
21 
22 /* This file was automatically generated */
23 
24 #ifdef HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27 
28 /*----------------------------------------------------------------------------*
29  * Includes *
30  *----------------------------------------------------------------------------*/
31 #include <string.h> /* strcmp(), strstr() */
32 #include <strings.h> /* strcasecmp() */
33 #include <cpl.h>
34 
35 #include "muse_scipost_calibrate_flux_z.h" /* in turn includes muse.h */
36 
37 /*----------------------------------------------------------------------------*/
43 /*----------------------------------------------------------------------------*/
46 /*----------------------------------------------------------------------------*
47  * Static variables *
48  *----------------------------------------------------------------------------*/
49 static const char *muse_scipost_calibrate_flux_help =
50  "Replace the intensity in the MUSE pixel tables by the absolute flux. This is a task separated from muse_scipost.";
51 
52 static const char *muse_scipost_calibrate_flux_help_esorex =
53  "\n\nInput frames for raw frame tag \"PIXTABLE_OBJECT\":\n"
54  "\n Frame tag Type Req #Fr Description"
55  "\n -------------------- ---- --- --- ------------"
56  "\n PIXTABLE_OBJECT raw Y Pixel table without flux calibration"
57  "\n EXTINCT_TABLE calib Y 1 Atmospheric extinction table"
58  "\n STD_RESPONSE calib Y 1 Response curve as derived from standard star(s)"
59  "\n STD_TELLURIC calib . 1 Telluric absorption correction as derived from standard star(s)"
60  "\n\nProduct frames for raw frame tag \"PIXTABLE_OBJECT\":\n"
61  "\n Frame tag Level Description"
62  "\n -------------------- -------- ------------"
63  "\n PIXTABLE_OBJECT final Flux calibrated pixel table";
64 
65 /*----------------------------------------------------------------------------*/
73 /*----------------------------------------------------------------------------*/
74 static cpl_recipeconfig *
75 muse_scipost_calibrate_flux_new_recipeconfig(void)
76 {
77  cpl_recipeconfig *recipeconfig = cpl_recipeconfig_new();
78 
79  cpl_recipeconfig_set_tag(recipeconfig, "PIXTABLE_OBJECT", 1, -1);
80  cpl_recipeconfig_set_input(recipeconfig, "PIXTABLE_OBJECT", "EXTINCT_TABLE", 1, 1);
81  cpl_recipeconfig_set_input(recipeconfig, "PIXTABLE_OBJECT", "STD_RESPONSE", 1, 1);
82  cpl_recipeconfig_set_input(recipeconfig, "PIXTABLE_OBJECT", "STD_TELLURIC", -1, 1);
83  cpl_recipeconfig_set_output(recipeconfig, "PIXTABLE_OBJECT", "PIXTABLE_OBJECT");
84 
85  return recipeconfig;
86 } /* muse_scipost_calibrate_flux_new_recipeconfig() */
87 
88 /*----------------------------------------------------------------------------*/
98 /*----------------------------------------------------------------------------*/
99 static cpl_error_code
100 muse_scipost_calibrate_flux_prepare_header(const char *aFrametag, cpl_propertylist *aHeader)
101 {
102  cpl_ensure_code(aFrametag, CPL_ERROR_NULL_INPUT);
103  cpl_ensure_code(aHeader, CPL_ERROR_NULL_INPUT);
104  if (!strcmp(aFrametag, "PIXTABLE_OBJECT")) {
105  } else {
106  cpl_msg_warning(__func__, "Frame tag %s is not defined", aFrametag);
107  return CPL_ERROR_ILLEGAL_INPUT;
108  }
109  return CPL_ERROR_NONE;
110 } /* muse_scipost_calibrate_flux_prepare_header() */
111 
112 /*----------------------------------------------------------------------------*/
121 /*----------------------------------------------------------------------------*/
122 static cpl_frame_level
123 muse_scipost_calibrate_flux_get_frame_level(const char *aFrametag)
124 {
125  if (!aFrametag) {
126  return CPL_FRAME_LEVEL_NONE;
127  }
128  if (!strcmp(aFrametag, "PIXTABLE_OBJECT")) {
129  return CPL_FRAME_LEVEL_FINAL;
130  }
131  return CPL_FRAME_LEVEL_NONE;
132 } /* muse_scipost_calibrate_flux_get_frame_level() */
133 
134 /*----------------------------------------------------------------------------*/
143 /*----------------------------------------------------------------------------*/
144 static muse_frame_mode
145 muse_scipost_calibrate_flux_get_frame_mode(const char *aFrametag)
146 {
147  if (!aFrametag) {
148  return MUSE_FRAME_MODE_ALL;
149  }
150  if (!strcmp(aFrametag, "PIXTABLE_OBJECT")) {
151  return MUSE_FRAME_MODE_ALL;
152  }
153  return MUSE_FRAME_MODE_ALL;
154 } /* muse_scipost_calibrate_flux_get_frame_mode() */
155 
156 /*----------------------------------------------------------------------------*/
166 /*----------------------------------------------------------------------------*/
167 static int
168 muse_scipost_calibrate_flux_create(cpl_plugin *aPlugin)
169 {
170  /* Check that the plugin is part of a valid recipe */
171  cpl_recipe *recipe;
172  if (cpl_plugin_get_type(aPlugin) == CPL_PLUGIN_TYPE_RECIPE) {
173  recipe = (cpl_recipe *)aPlugin;
174  } else {
175  return -1;
176  }
177 
178  /* register the extended processing information (new FITS header creation, *
179  * getting of the frame level for a certain tag) */
181  muse_scipost_calibrate_flux_new_recipeconfig(),
182  muse_scipost_calibrate_flux_prepare_header,
183  muse_scipost_calibrate_flux_get_frame_level,
184  muse_scipost_calibrate_flux_get_frame_mode);
185 
186  /* XXX initialize timing in messages *
187  * since at least esorex is too stupid to turn it on, we have to do it */
189  cpl_msg_set_time_on();
190  }
191 
192  /* Create the parameter list in the cpl_recipe object */
193  recipe->parameters = cpl_parameterlist_new();
194  /* Fill the parameters list */
195  cpl_parameter *p;
196 
197  /* --lambdamin: Cut off the data below this wavelength after loading the pixel table(s). */
198  p = cpl_parameter_new_value("muse.muse_scipost_calibrate_flux.lambdamin",
199  CPL_TYPE_DOUBLE,
200  "Cut off the data below this wavelength after loading the pixel table(s).",
201  "muse.muse_scipost_calibrate_flux",
202  (double)4000.);
203  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CFG, "lambdamin");
204  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "lambdamin");
205 
206  cpl_parameterlist_append(recipe->parameters, p);
207 
208  /* --lambdamax: Cut off the data above this wavelength after loading the pixel table(s). */
209  p = cpl_parameter_new_value("muse.muse_scipost_calibrate_flux.lambdamax",
210  CPL_TYPE_DOUBLE,
211  "Cut off the data above this wavelength after loading the pixel table(s).",
212  "muse.muse_scipost_calibrate_flux",
213  (double)10000.);
214  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CFG, "lambdamax");
215  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "lambdamax");
216 
217  cpl_parameterlist_append(recipe->parameters, p);
218 
219  return 0;
220 } /* muse_scipost_calibrate_flux_create() */
221 
222 /*----------------------------------------------------------------------------*/
233 /*----------------------------------------------------------------------------*/
234 static int
235 muse_scipost_calibrate_flux_params_fill(muse_scipost_calibrate_flux_params_t *aParams, cpl_parameterlist *aParameters)
236 {
237  cpl_ensure_code(aParams, CPL_ERROR_NULL_INPUT);
238  cpl_ensure_code(aParameters, CPL_ERROR_NULL_INPUT);
239  cpl_parameter *p;
240 
241  p = cpl_parameterlist_find(aParameters, "muse.muse_scipost_calibrate_flux.lambdamin");
242  cpl_ensure_code(p, CPL_ERROR_DATA_NOT_FOUND);
243  aParams->lambdamin = cpl_parameter_get_double(p);
244 
245  p = cpl_parameterlist_find(aParameters, "muse.muse_scipost_calibrate_flux.lambdamax");
246  cpl_ensure_code(p, CPL_ERROR_DATA_NOT_FOUND);
247  aParams->lambdamax = cpl_parameter_get_double(p);
248 
249  return 0;
250 } /* muse_scipost_calibrate_flux_params_fill() */
251 
252 /*----------------------------------------------------------------------------*/
259 /*----------------------------------------------------------------------------*/
260 static int
261 muse_scipost_calibrate_flux_exec(cpl_plugin *aPlugin)
262 {
263  if (cpl_plugin_get_type(aPlugin) != CPL_PLUGIN_TYPE_RECIPE) {
264  return -1;
265  }
267  cpl_recipe *recipe = (cpl_recipe *)aPlugin;
268  cpl_msg_set_threadid_on();
269 
270  cpl_frameset *usedframes = cpl_frameset_new(),
271  *outframes = cpl_frameset_new();
273  muse_scipost_calibrate_flux_params_fill(&params, recipe->parameters);
274 
275  cpl_errorstate prestate = cpl_errorstate_get();
276 
277  muse_processing *proc = muse_processing_new("muse_scipost_calibrate_flux",
278  recipe);
279  int rc = muse_scipost_calibrate_flux_compute(proc, &params);
280  cpl_frameset_join(usedframes, proc->usedframes);
281  cpl_frameset_join(outframes, proc->outframes);
283 
284  if (!cpl_errorstate_is_equal(prestate)) {
285  /* dump all errors from this recipe in chronological order */
286  cpl_errorstate_dump(prestate, CPL_FALSE, muse_cplerrorstate_dump_some);
287  /* reset message level to not get the same errors displayed again by esorex */
288  cpl_msg_set_level(CPL_MSG_INFO);
289  }
290  /* clean up duplicates in framesets of used and output frames */
293 
294  /* to get esorex to see our classification (frame groups etc.), *
295  * replace the original frameset with the list of used frames *
296  * before appending product output frames */
297  /* keep the same pointer, so just erase all frames, not delete the frameset */
298  muse_cplframeset_erase_all(recipe->frames);
299  cpl_frameset_join(recipe->frames, usedframes);
300  cpl_frameset_join(recipe->frames, outframes);
301  cpl_frameset_delete(usedframes);
302  cpl_frameset_delete(outframes);
303  return rc;
304 } /* muse_scipost_calibrate_flux_exec() */
305 
306 /*----------------------------------------------------------------------------*/
313 /*----------------------------------------------------------------------------*/
314 static int
315 muse_scipost_calibrate_flux_destroy(cpl_plugin *aPlugin)
316 {
317  /* Get the recipe from the plugin */
318  cpl_recipe *recipe;
319  if (cpl_plugin_get_type(aPlugin) == CPL_PLUGIN_TYPE_RECIPE) {
320  recipe = (cpl_recipe *)aPlugin;
321  } else {
322  return -1;
323  }
324 
325  /* Clean up */
326  cpl_parameterlist_delete(recipe->parameters);
328  return 0;
329 } /* muse_scipost_calibrate_flux_destroy() */
330 
331 /*----------------------------------------------------------------------------*/
341 /*----------------------------------------------------------------------------*/
342 int
343 cpl_plugin_get_info(cpl_pluginlist *aList)
344 {
345  cpl_recipe *recipe = cpl_calloc(1, sizeof *recipe);
346  cpl_plugin *plugin = &recipe->interface;
347 
348  char *helptext;
350  helptext = cpl_sprintf("%s%s", muse_scipost_calibrate_flux_help,
351  muse_scipost_calibrate_flux_help_esorex);
352  } else {
353  helptext = cpl_sprintf("%s", muse_scipost_calibrate_flux_help);
354  }
355 
356  /* Initialize the CPL plugin stuff for this module */
357  cpl_plugin_init(plugin, CPL_PLUGIN_API, MUSE_BINARY_VERSION,
358  CPL_PLUGIN_TYPE_RECIPE,
359  "muse_scipost_calibrate_flux",
360  "Calibrate flux for MUSE pixel tables.",
361  helptext,
362  "Ole Streicher",
363  "usd-help@eso.org",
365  muse_scipost_calibrate_flux_create,
366  muse_scipost_calibrate_flux_exec,
367  muse_scipost_calibrate_flux_destroy);
368  cpl_pluginlist_append(aList, plugin);
369  cpl_free(helptext);
370 
371  return 0;
372 } /* cpl_plugin_get_info() */
373 
void muse_processing_delete(muse_processing *aProcessing)
Free the muse_processing structure.
muse_cplframework_type muse_cplframework(void)
Return the CPL framework the recipe is run under.
double lambdamax
Cut off the data above this wavelength after loading the pixel table(s).
cpl_frameset * usedframes
muse_processing * muse_processing_new(const char *aName, cpl_recipe *aRecipe)
Create a new processing structure.
const char * muse_get_license(void)
Get the pipeline copyright and license.
Definition: muse_utils.c:83
muse_frame_mode
cpl_frameset * outframes
void muse_cplerrorstate_dump_some(unsigned aCurrent, unsigned aFirst, unsigned aLast)
Dump some CPL errors.
void muse_processinginfo_delete(cpl_recipe *)
Clear all information from the processing info and from the recipe config.
cpl_error_code muse_cplframeset_erase_duplicate(cpl_frameset *aFrames)
Erase all duplicate frames from a frameset.
cpl_error_code muse_cplframeset_erase_all(cpl_frameset *aFrames)
Erase all frames in a frameset.
Structure to hold the parameters of the muse_scipost_calibrate_flux recipe.
void muse_processinginfo_register(cpl_recipe *, cpl_recipeconfig *, muse_processing_prepare_header_func *, muse_processing_get_frame_level_func *, muse_processing_get_frame_mode_func *)
Register extended functionalities for MUSE recipes.
double lambdamin
Cut off the data below this wavelength after loading the pixel table(s).
void muse_processing_recipeinfo(cpl_plugin *)
Output main pipeline configuration, inputs, and parameters.