MUSE Pipeline Reference Manual  1.0.2
muse_scipost_correct_dar_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-2014 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_correct_dar_z.h" /* in turn includes muse.h */
36 
37 /*----------------------------------------------------------------------------*/
43 /*----------------------------------------------------------------------------*/
46 /*----------------------------------------------------------------------------*
47  * Static variables *
48  *----------------------------------------------------------------------------*/
49 static const char *muse_scipost_correct_dar_help =
50  "Correct the coordinates in the pixel table by differential atmospheric refraction. This is a task separated from muse_scipost.";
51 
52 static const char *muse_scipost_correct_dar_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 DAR correction"
57  "\n\nProduct frames for raw frame tag \"PIXTABLE_OBJECT\":\n"
58  "\n Frame tag Level Description"
59  "\n -------------------- -------- ------------"
60  "\n PIXTABLE_OBJECT final DAR corrected pixel table";
61 
62 /*----------------------------------------------------------------------------*/
70 /*----------------------------------------------------------------------------*/
71 static cpl_recipeconfig *
72 muse_scipost_correct_dar_new_recipeconfig(void)
73 {
74  cpl_recipeconfig *recipeconfig = cpl_recipeconfig_new();
75  const char *tag;
76 
77  tag = "PIXTABLE_OBJECT";
78  cpl_recipeconfig_set_tag(recipeconfig, tag, 1, -1);
79  cpl_recipeconfig_set_output(recipeconfig, tag, "PIXTABLE_OBJECT");
80 
81  return recipeconfig;
82 } /* muse_scipost_correct_dar_new_recipeconfig() */
83 
84 /*----------------------------------------------------------------------------*/
94 /*----------------------------------------------------------------------------*/
95 static cpl_error_code
96 muse_scipost_correct_dar_prepare_header(const char *aFrametag, cpl_propertylist *aHeader)
97 {
98  cpl_ensure_code(aFrametag, CPL_ERROR_NULL_INPUT);
99  cpl_ensure_code(aHeader, CPL_ERROR_NULL_INPUT);
100  if (!strcmp(aFrametag, "PIXTABLE_OBJECT")) {
101  } else {
102  cpl_msg_warning(__func__, "Frame tag %s is not defined", aFrametag);
103  return CPL_ERROR_ILLEGAL_INPUT;
104  }
105  return CPL_ERROR_NONE;
106 } /* muse_scipost_correct_dar_prepare_header() */
107 
108 /*----------------------------------------------------------------------------*/
117 /*----------------------------------------------------------------------------*/
118 static cpl_frame_level
119 muse_scipost_correct_dar_get_frame_level(const char *aFrametag)
120 {
121  if (!aFrametag) {
122  return CPL_FRAME_LEVEL_NONE;
123  }
124  if (!strcmp(aFrametag, "PIXTABLE_OBJECT")) {
125  return CPL_FRAME_LEVEL_FINAL;
126  }
127  return CPL_FRAME_LEVEL_NONE;
128 } /* muse_scipost_correct_dar_get_frame_level() */
129 
130 /*----------------------------------------------------------------------------*/
139 /*----------------------------------------------------------------------------*/
140 static muse_frame_mode
141 muse_scipost_correct_dar_get_frame_mode(const char *aFrametag)
142 {
143  if (!aFrametag) {
144  return MUSE_FRAME_MODE_ALL;
145  }
146  if (!strcmp(aFrametag, "PIXTABLE_OBJECT")) {
147  return MUSE_FRAME_MODE_ALL;
148  }
149  return MUSE_FRAME_MODE_ALL;
150 } /* muse_scipost_correct_dar_get_frame_mode() */
151 
152 /*----------------------------------------------------------------------------*/
162 /*----------------------------------------------------------------------------*/
163 static int
164 muse_scipost_correct_dar_create(cpl_plugin *aPlugin)
165 {
166  /* Check that the plugin is part of a valid recipe */
167  cpl_recipe *recipe;
168  if (cpl_plugin_get_type(aPlugin) == CPL_PLUGIN_TYPE_RECIPE) {
169  recipe = (cpl_recipe *)aPlugin;
170  } else {
171  return -1;
172  }
173 
174  /* register the extended processing information (new FITS header creation, *
175  * getting of the frame level for a certain tag) */
177  muse_scipost_correct_dar_new_recipeconfig(),
178  muse_scipost_correct_dar_prepare_header,
179  muse_scipost_correct_dar_get_frame_level,
180  muse_scipost_correct_dar_get_frame_mode);
181 
182  /* XXX initialize timing in messages *
183  * since at least esorex is too stupid to turn it on, we have to do it */
185  cpl_msg_set_time_on();
186  }
187 
188  /* Create the parameter list in the cpl_recipe object */
189  recipe->parameters = cpl_parameterlist_new();
190  /* Fill the parameters list */
191  cpl_parameter *p;
192 
193  /* --lambdamin: Cut off the data below this wavelength after loading the pixel table(s). */
194  p = cpl_parameter_new_value("muse.muse_scipost_correct_dar.lambdamin",
195  CPL_TYPE_DOUBLE,
196  "Cut off the data below this wavelength after loading the pixel table(s).",
197  "muse.muse_scipost_correct_dar",
198  (double)4000.);
199  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CFG, "lambdamin");
200  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "lambdamin");
201 
202  cpl_parameterlist_append(recipe->parameters, p);
203 
204  /* --lambdamax: Cut off the data above this wavelength after loading the pixel table(s). */
205  p = cpl_parameter_new_value("muse.muse_scipost_correct_dar.lambdamax",
206  CPL_TYPE_DOUBLE,
207  "Cut off the data above this wavelength after loading the pixel table(s).",
208  "muse.muse_scipost_correct_dar",
209  (double)10000.);
210  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CFG, "lambdamax");
211  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "lambdamax");
212 
213  cpl_parameterlist_append(recipe->parameters, p);
214 
215  /* --lambdaref: Reference wavelength used for correction of differential atmospheric refraction. The R-band (peak wavelength ~7000 Angstrom) that is usually used for guiding, is close to the central wavelength of MUSE, so a value of 7000.0 Angstrom should be used if nothing else is known. A value less than zero switches DAR correction off. */
216  p = cpl_parameter_new_value("muse.muse_scipost_correct_dar.lambdaref",
217  CPL_TYPE_DOUBLE,
218  "Reference wavelength used for correction of differential atmospheric refraction. The R-band (peak wavelength ~7000 Angstrom) that is usually used for guiding, is close to the central wavelength of MUSE, so a value of 7000.0 Angstrom should be used if nothing else is known. A value less than zero switches DAR correction off.",
219  "muse.muse_scipost_correct_dar",
220  (double)7000.);
221  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CFG, "lambdaref");
222  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "lambdaref");
223 
224  cpl_parameterlist_append(recipe->parameters, p);
225 
226  /* --darcheck: Carry out a check of the theoretical DAR correction using source centroiding. If "correct" it will also apply an empirical correction. */
227  p = cpl_parameter_new_enum("muse.muse_scipost_correct_dar.darcheck",
228  CPL_TYPE_STRING,
229  "Carry out a check of the theoretical DAR correction using source centroiding. If \"correct\" it will also apply an empirical correction.",
230  "muse.muse_scipost_correct_dar",
231  (const char *)"none",
232  3,
233  (const char *)"none",
234  (const char *)"check",
235  (const char *)"correct");
236  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CFG, "darcheck");
237  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "darcheck");
238 
239  cpl_parameterlist_append(recipe->parameters, p);
240 
241  return 0;
242 } /* muse_scipost_correct_dar_create() */
243 
244 /*----------------------------------------------------------------------------*/
255 /*----------------------------------------------------------------------------*/
256 static int
257 muse_scipost_correct_dar_params_fill(muse_scipost_correct_dar_params_t *aParams, cpl_parameterlist *aParameters)
258 {
259  cpl_ensure_code(aParams, CPL_ERROR_NULL_INPUT);
260  cpl_ensure_code(aParameters, CPL_ERROR_NULL_INPUT);
261  cpl_parameter *p;
262 
263  p = cpl_parameterlist_find(aParameters, "muse.muse_scipost_correct_dar.lambdamin");
264  cpl_ensure_code(p, CPL_ERROR_DATA_NOT_FOUND);
265  aParams->lambdamin = cpl_parameter_get_double(p);
266 
267  p = cpl_parameterlist_find(aParameters, "muse.muse_scipost_correct_dar.lambdamax");
268  cpl_ensure_code(p, CPL_ERROR_DATA_NOT_FOUND);
269  aParams->lambdamax = cpl_parameter_get_double(p);
270 
271  p = cpl_parameterlist_find(aParameters, "muse.muse_scipost_correct_dar.lambdaref");
272  cpl_ensure_code(p, CPL_ERROR_DATA_NOT_FOUND);
273  aParams->lambdaref = cpl_parameter_get_double(p);
274 
275  p = cpl_parameterlist_find(aParameters, "muse.muse_scipost_correct_dar.darcheck");
276  cpl_ensure_code(p, CPL_ERROR_DATA_NOT_FOUND);
277  aParams->darcheck_s = cpl_parameter_get_string(p);
278  aParams->darcheck =
279  (!strcasecmp(aParams->darcheck_s, "none")) ? MUSE_SCIPOST_CORRECT_DAR_PARAM_DARCHECK_NONE :
280  (!strcasecmp(aParams->darcheck_s, "check")) ? MUSE_SCIPOST_CORRECT_DAR_PARAM_DARCHECK_CHECK :
281  (!strcasecmp(aParams->darcheck_s, "correct")) ? MUSE_SCIPOST_CORRECT_DAR_PARAM_DARCHECK_CORRECT :
282  MUSE_SCIPOST_CORRECT_DAR_PARAM_DARCHECK_INVALID_VALUE;
283  cpl_ensure_code(aParams->darcheck != MUSE_SCIPOST_CORRECT_DAR_PARAM_DARCHECK_INVALID_VALUE,
284  CPL_ERROR_ILLEGAL_INPUT);
285 
286  return 0;
287 } /* muse_scipost_correct_dar_params_fill() */
288 
289 /*----------------------------------------------------------------------------*/
296 /*----------------------------------------------------------------------------*/
297 static int
298 muse_scipost_correct_dar_exec(cpl_plugin *aPlugin)
299 {
300  if (cpl_plugin_get_type(aPlugin) != CPL_PLUGIN_TYPE_RECIPE) {
301  return -1;
302  }
303  cpl_recipe *recipe = (cpl_recipe *)aPlugin;
304  cpl_msg_set_threadid_on();
305 
306  cpl_frameset *usedframes = cpl_frameset_new(),
307  *outframes = cpl_frameset_new();
309  muse_scipost_correct_dar_params_fill(&params, recipe->parameters);
310 
311  cpl_errorstate prestate = cpl_errorstate_get();
312 
313  muse_processing *proc = muse_processing_new("muse_scipost_correct_dar",
314  recipe);
315  int rc = muse_scipost_correct_dar_compute(proc, &params);
316  cpl_frameset_join(usedframes, proc->usedframes);
317  cpl_frameset_join(outframes, proc->outframes);
319 
320  if (!cpl_errorstate_is_equal(prestate)) {
321  /* dump all errors from this recipe in chronological order */
322  cpl_errorstate_dump(prestate, CPL_FALSE, muse_cplerrorstate_dump_some);
323  /* reset message level to not get the same errors displayed again by esorex */
324  cpl_msg_set_level(CPL_MSG_INFO);
325  }
326  /* clean up duplicates in framesets of used and output frames */
329 
330  /* to get esorex to see our classification (frame groups etc.), *
331  * replace the original frameset with the list of used frames *
332  * before appending product output frames */
333  /* keep the same pointer, so just erase all frames, not delete the frameset */
334  muse_cplframeset_erase_all(recipe->frames);
335  cpl_frameset_join(recipe->frames, usedframes);
336  cpl_frameset_join(recipe->frames, outframes);
337  cpl_frameset_delete(usedframes);
338  cpl_frameset_delete(outframes);
339  return rc;
340 } /* muse_scipost_correct_dar_exec() */
341 
342 /*----------------------------------------------------------------------------*/
349 /*----------------------------------------------------------------------------*/
350 static int
351 muse_scipost_correct_dar_destroy(cpl_plugin *aPlugin)
352 {
353  /* Get the recipe from the plugin */
354  cpl_recipe *recipe;
355  if (cpl_plugin_get_type(aPlugin) == CPL_PLUGIN_TYPE_RECIPE) {
356  recipe = (cpl_recipe *)aPlugin;
357  } else {
358  return -1;
359  }
360 
361  /* Clean up */
362  cpl_parameterlist_delete(recipe->parameters);
364  return 0;
365 } /* muse_scipost_correct_dar_destroy() */
366 
367 /*----------------------------------------------------------------------------*/
377 /*----------------------------------------------------------------------------*/
378 int
379 cpl_plugin_get_info(cpl_pluginlist *aList)
380 {
381  cpl_recipe *recipe = cpl_calloc(1, sizeof *recipe);
382  cpl_plugin *plugin = &recipe->interface;
383 
384  char *helptext;
386  helptext = cpl_sprintf("%s%s", muse_scipost_correct_dar_help,
387  muse_scipost_correct_dar_help_esorex);
388  } else {
389  helptext = cpl_sprintf("%s", muse_scipost_correct_dar_help);
390  }
391 
392  /* Initialize the CPL plugin stuff for this module */
393  cpl_plugin_init(plugin, CPL_PLUGIN_API, MUSE_BINARY_VERSION,
394  CPL_PLUGIN_TYPE_RECIPE,
395  "muse_scipost_correct_dar",
396  "Apply DAR correction for MUSE pixel tables.",
397  helptext,
398  "Ole Streicher",
399  "usd-help@eso.org",
401  muse_scipost_correct_dar_create,
402  muse_scipost_correct_dar_exec,
403  muse_scipost_correct_dar_destroy);
404  cpl_pluginlist_append(aList, plugin);
405  cpl_free(helptext);
406 
407  return 0;
408 } /* cpl_plugin_get_info() */
409 
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.
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:84
muse_frame_mode
cpl_frameset * outframes
double lambdaref
Reference wavelength used for correction of differential atmospheric refraction. The R-band (peak wav...
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.
Structure to hold the parameters of the muse_scipost_correct_dar recipe.
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.
int darcheck
Carry out a check of the theoretical DAR correction using source centroiding. If "correct" it will al...
double lambdamin
Cut off the data below this wavelength after loading the pixel table(s).
const char * darcheck_s
Carry out a check of the theoretical DAR correction using source centroiding. If "correct" it will al...
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 lambdamax
Cut off the data above this wavelength after loading the pixel table(s).