SYNOPSIS

esorex kmo_reconstruct [OPTIONS] FILE.sof

DESCRIPTION

Data with or without noise is reconstructed into a cube using the calibration frames XCAL, YCAL and LCAL. XCAL and YCAL are generated using recipe kmo_flat, LCAL is generated using recipe kmo_wave_cal.

The input data can contain noise extensions and will be reconstructed into additional extensions.

If an OH spectrum is given in the SOF file the lambda axis will be corrected using the OH lines as reference.

BASIC PARAMETERS

--imethod The interpolation method used for reconstruction.

--detectorimage Specify if the resampled image of the input frame should be generated.

Therefore all slitlets of all IFUs are aligned one next to the other. This frame serves for quality control. One can immediately see if the reconstruction was successful.

--file_extensionSet to TRUE if OBS_ID (from input frame header) should be appended to the output frame.

ADVANCED PARAMETERS

--flux Specify if flux conservation should be applied.

--neighborhoodRange Defines the range to search for neighbors during reconstruction

--b_samples The number of samples in spectral direction for the reconstructed cube.Ideally this number should be greater than 2048, the detector size.

--b_start --b_end Used to define manually the start and end wavelength for the reconstructed cube. By default the internally defined values are used.

--pix_scale Change the pixel scale [arcsec]. Default of 0.2" results into cubes of 14x14pix, a scale of 0.1" results into cubes of 28x28pix, etc.

--xcal_interpolation If TRUE interpolate the pixel position in the slitlet (xcal) using the two closest rotator angles in the calibration file. Otherwise take the values of the closest rotator angle

  Input files:
   DO              KMOS
   category        Type     Explanation                    Required #Frames
   --------        -----    -----------                    -------- -------
   DARK    or      RAW/F2D  data with                          Y       1
   FLAT_ON or      RAW/F2D  or without noise
   ARC_ON  or      RAW/F2D
   OBJECT  or      RAW
   STD     or      RAW
   SCIENCE         RAW
   XCAL            F2D      x-direction calib. frame           Y       1
   YCAL            F2D      y-direction calib. frame           Y       1
   LCAL            F2D      Wavelength calib. frame            Y       1
   WAVE_BAND       F2L      Table with start-/end-wavelengths  Y       1
   OH_SPEC         F1S      Vector holding OH lines            N       1
  Output files:
   DO                KMOS
   category          Type     Explanation
   --------              -----    -----------
   CUBE_DARK   or    F3I      Reconstructed cube
   CUBE_FLAT   or    RAW/F2D  with or without noise
   CUBE_ARC    or
   CUBE_OBJECT or
   CUBE_STD    or
   CUBE_SCIENCE

OPTIONS

--imethod <str>

Method to use for interpolation. ["NN" (nearest neighbour), "lwNN" (linear weighted nearest neighbor), "swNN" (square weighted nearest neighbor), "MS" (Modified Shepard\'s method)"CS" (Cubic spline)] (str; default: \'CS\'). The full name of this option for the EsoRex configuration file is kmos.kmo_reconstruct.imethod [default = CS].

--neighborhoodRange <float>

Defines the range to search for neighbors. in pixels (float; default: 1.001). The full name of this option for the EsoRex configuration file is kmos.kmo_reconstruct.neighborhoodRange [default = 1.001].

--flux <bool>

TRUE: Apply flux conservation. FALSE: otherwise (bool; default: False). The full name of this option for the EsoRex configuration file is kmos.kmo_reconstruct.flux [default = False].

--detimg <bool>

TRUE: if resampled detector frame should be created, FALSE: otherwise (bool; default: False). The full name of this option for the EsoRex configuration file is kmos.kmo_reconstruct.detectorimage [default = False].

--file_extension <bool>

TRUE: if OBS_ID keyword should be appended to output frames, FALSE: otherwise (bool; default: False). The full name of this option for the EsoRex configuration file is kmos.kmo_reconstruct.file_extension [default = False].

--pix_scale <float>

Change the pixel scale [arcsec]. Default of 0.2" results into cubes of 14x14pix, a scale of 0.1" results into cubes of 28x28pix, etc. (float; default: 0.2). The full name of this option for the EsoRex configuration file is kmos.kmo_reconstruct.pix_scale [default = 0.2].

--xcal_interpolation <bool>

TRUE: Interpolate xcal between rotator angles. FALSE: otherwise (bool; default: True). The full name of this option for the EsoRex configuration file is kmos.kmo_reconstruct.xcal_interpolation [default = True].

--b_samples <long>

The number of samples in wavelength for the reconstructed cube (long; default: 2048). The full name of this option for the EsoRex configuration file is kmos.kmo_reconstruct.b_samples [default = 2048].

--b_start <float>

The lowest wavelength [um] to use when reconstructing. Derived by default, depending on the band (float; default: -1.0). The full name of this option for the EsoRex configuration file is kmos.kmo_reconstruct.b_start [default = -1.0].

--b_end <float>

The highest wavelength [um] to use when reconstructing. Derived by default, depending on the band (float; default: -1.0). The full name of this option for the EsoRex configuration file is kmos.kmo_reconstruct.b_end [default = -1.0].

Note that it is possible to create a configuration file containing these options, along with suitable default values. Please refer to the details provided by the 'esorex --help' command.

RELATED TO kmo_reconstruct…

The full documentation for the kmos pipeline can be downloaded as a PDF file using the following URL:

  • ftp://ftp.eso.org/pub/dfs/pipelines/kmos/kmos-pipeline-manual-2.9.pdf

An overview over the existing ESO pipelines can be found on the web page http://www.eso.org/sci/software/pipelines/.

Basic documentation about the EsoRex program can be found at the esorex (1) man page.

It is possible to call the pipelines from python using the python-cpl package. See http://packages.python.org/python-cpl/index.html for further information.

The other recipes of the kmos pipeline are kmo_copy(7), kmo_fits_check(7), kmo_sci_red(7), kmo_fits_stack(7), kmo_noise_map(7), kmo_rotate(7), kmo_extract_spec(7), kmo_multi_reconstruct(7), kmo_sky_tweak(7), kmo_shift(7), kmos_gen_reflines(7), kmo_stats(7), kmo_arithmetic(7), kmos_dark(7), kmo_fits_strip(7), kmo_combine(7), kmo_std_star(7), kmo_illumination_flat(7), kmo_make_image(7), kmos_flat(7), kmo_fit_profile(7), kmo_sky_mask(7), kmos_illumination(7), kmos_wave_cal(7)

VERSION

kmo_reconstruct 1.3.5

AUTHOR

Alex Agudo Berbel <[email protected]>

BUG REPORTS

Please report any problems to [email protected] Alternatively, you may send a report to the ESO User Support Department <[email protected]>.

LICENSE

This file is part of the CRIRES Instrument Pipeline Copyright (C) 2002,2003 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, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA