MUSE Pipeline Reference Manual  2.1.1
muse_scipost_subtract_sky_simple.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 #ifdef HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25 
26 /*---------------------------------------------------------------------------*
27  * Includes *
28  *---------------------------------------------------------------------------*/
29 #include <muse.h>
30 #include "muse_scipost_subtract_sky_simple_z.h"
31 
32 /*----------------------------------------------------------------------------*/
40 /*----------------------------------------------------------------------------*/
41 int
42 muse_scipost_subtract_sky_simple_compute(muse_processing *aProcessing,
44 {
45  cpl_table *spectrum = muse_processing_load_ctable(aProcessing, MUSE_TAG_SKY_SPECTRUM, 0);
46  if (!spectrum) {
47  cpl_msg_warning(__func__, "Could not load %s", MUSE_TAG_SKY_SPECTRUM);
48  }
49  /* simple subtraction: pretend that the spectrum is a *
50  * continuum and use that function for direct subtraction */
51  cpl_table_name_column(spectrum, "data", "flux");
52 
53  cpl_errorstate prestate = cpl_errorstate_get();
54  cpl_frameset *inframes = muse_frameset_find_tags(aProcessing->inframes,
55  aProcessing->intags, 0,
56  CPL_FALSE);
57  cpl_error_code rc = CPL_ERROR_NONE;
58  cpl_size iframe, nframes = cpl_frameset_get_size(inframes);
59  for (iframe = 0; iframe < nframes; iframe++) {
60  cpl_frame *frame = cpl_frameset_get_position(inframes, iframe);
61  const char *fn = cpl_frame_get_filename(frame);
62  muse_pixtable *pixtable =
64  aParams->lambdamin,
65  aParams->lambdamax);
66  if (pixtable == NULL) {
67  cpl_msg_error(__func__, "NULL pixel table for \"%s\"", fn);
68  rc = CPL_ERROR_NULL_INPUT;
69  break;
70  }
71  muse_processing_append_used(aProcessing, frame, CPL_FRAME_GROUP_RAW, 1);
72 
73  /* erase pre-existing QC parameters */
74  cpl_propertylist_erase_regexp(pixtable->header, "ESO QC ", 0);
75 
76  if (muse_pixtable_is_skysub(pixtable) == CPL_TRUE) {
77  cpl_msg_error(__func__, "Pixel table \"%s\" already sky subtracted", fn);
78  muse_pixtable_delete(pixtable);
79  rc = CPL_ERROR_ILLEGAL_INPUT;
80  break;
81  }
82 
83  rc = muse_sky_subtract_continuum(pixtable, spectrum);
84  if (rc != CPL_ERROR_NONE) {
85  cpl_msg_error(__func__, "while subtracting sky spectrum from \"%s\"", fn);
86  muse_pixtable_delete(pixtable);
87  break;
88  }
89  muse_processing_save_table(aProcessing, -1, pixtable, NULL,
90  MUSE_TAG_PIXTABLE_REDUCED,
92  muse_pixtable_delete(pixtable);
93  } /* for iframe (all input frames) */
94  cpl_frameset_delete(inframes);
95  cpl_table_delete(spectrum);
96 
97  return cpl_errorstate_is_equal(prestate) ? 0 : rc;
98 } /* muse_scipost_subtract_sky_simple_compute() */
double lambdamax
Cut off the data above this wavelength after loading the pixel table(s).
cpl_boolean muse_pixtable_is_skysub(muse_pixtable *aPixtable)
Determine whether the pixel table is sky subtracted.
Structure definition of MUSE pixel table.
cpl_error_code muse_sky_subtract_continuum(muse_pixtable *, cpl_table *)
Subtract sky continuum from pixel table.
void muse_processing_append_used(muse_processing *aProcessing, cpl_frame *aFrame, cpl_frame_group aGroup, int aDuplicate)
Add a frame to the set of used frames.
muse_pixtable * muse_pixtable_load_restricted_wavelength(const char *aFilename, double aLambdaMin, double aLambdaMax)
Load a pixel table from file and cut down the wavelength range.
cpl_table * muse_processing_load_ctable(muse_processing *aProcessing, const char *aTag, unsigned char aIFU)
Load a CPL table according to its tag and IFU/channel number.
Structure to hold the parameters of the muse_scipost_subtract_sky_simple recipe.
cpl_array * intags
cpl_frameset * inframes
cpl_error_code muse_processing_save_table(muse_processing *aProcessing, int aIFU, void *aTable, cpl_propertylist *aHeader, const char *aTag, muse_table_type aType)
Save a computed table to disk.
double lambdamin
Cut off the data below this wavelength after loading the pixel table(s).
void muse_pixtable_delete(muse_pixtable *aPixtable)
Deallocate memory associated to a pixel table object.
cpl_propertylist * header
The FITS header.
cpl_frameset * muse_frameset_find_tags(const cpl_frameset *aFrames, const cpl_array *aTags, unsigned char aIFU, cpl_boolean aInvert)
return frameset containing data from an IFU/channel with the given tag(s)
Definition: muse_utils.c:253