Provided by: cpl-plugin-kmos-doc_1.3.17+dfsg-1_all bug

NAME

       kmos_std_star - Create the telluric correction frame.

SYNOPSIS

       esorex kmos_std_star [OPTIONS] FILE.sof

DESCRIPTION

       This recipe creates a telluric frame and a PSF frames.

       Since  there  cannot  be 1 std star per IFU in one exposure, we use several exposures in order to have at
       least one standard star and one sky in each IFU. The frames are organised following this  logic:  1.  For
       each IFU the first standard star in the list of frames is
          taken.  All  subsequent  standard  star  exposures  for  this IFU are ignored 2. A closest in time sky
       exposure is uѕed 3. IFUs not containing a standard star and a sky will be empty in the result

       NOISE_SPEC contains the shot noise  [sqrt(counts*gain)/gain]  If  the  exposures  have  been  taken  with
       KMOS_spec_cal_stdstarscipatt,  an  additional noise component is added: All existing sky exposures for an
       IFU are subtracted pairwise, spectra are extracted and the std deviation is computed

         Input files:

          DO                      KMOS
          category                Type  Explanation                Required #Frames
          --------                ----- -----------                -------- -------
          STD                     RAW   Std. star & sky exposures      Y     >=1
          XCAL                    F2D   x calibration frame            Y      1
          YCAL                    F2D   y calibration frame            Y      1
          LCAL                    F2D   Wavelength calib. frame        Y      1
          MASTER_FLAT             F2D   Master flat frame              Y      1
          WAVE_BAND               F2L   Table with start-/end-wl       Y      1
          ILLUM_CORR              F2I   Illumination correction        N     0,1
          SOLAR_SPEC              F1S   Solar spectrum                 N     0,1
                                        (only for G stars)
          ATMOS_MODEL             F1S   Model atmospheric transmisson  N     0,1
                                        (only for OBAF stars in K band)
          SPEC_TYPE_LOOKUP        F2L   LUT  eff. stellar temperature  N     0,1

         Output files:

          DO                      KMOS
          category                Type   Explanation
          --------                -----  -----------
          TELLURIC                F1I    The normalised telluric spectrum
                                         (including errors)
          STAR_SPEC               F1I    The extracted star spectrum
                                         (including errors)
          STD_IMAGE               F2I    The standard star PSF images
          STD_MASK                F2I    The mask used to extract the star spec
          NOISE_SPEC              F1I    The extracted noise spectrum

OPTIONS

       --startype <str>
              The spectral type of the star (O, B, A, F, G) e.g. G4V (str; default: ´´). The full name  of  this
              option for the EsoRex configuration file is kmos.kmos_std_star.startype [default = ].

       --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.kmos_std_star.imethod [default = CS].

       --fmethod <str>
              Fitting method (gauss, moffat, profile (str; default: ´gauss´). The full name of this  option  for
              the EsoRex configuration file is kmos.kmos_std_star.fmethod [default = gauss].

       --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.kmos_std_star.neighborhoodRange [default =
              1.001].

       --magnitude <str>
              Star magnitude (2 values in HK, eg. 12.1,13.2) (str; default: ´´). The full name  of  this  option
              for the EsoRex configuration file is kmos.kmos_std_star.magnitude [default = ].

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

       --save_cubes <bool>
              Flag to save reconstructed cubes (bool; default: False). The full name  of  this  option  for  the
              EsoRex configuration file is kmos.kmos_std_star.save_cubes [default = False].

       --no_noise <bool>
              Skip  the  noise computation on sky exposures (bool; default: False). The full name of this option
              for the EsoRex configuration file is kmos.kmos_std_star.no_noise [default = False].

       --xcal_interpolation <bool>
              Flag to Interpolate xcal between rotator angles (bool; default:  True).  The  full  name  of  this
              option  for  the  EsoRex  configuration  file  is kmos.kmos_std_star.xcal_interpolation [default =
              True].

       --suppress_extension <bool>
              Flag to Suppress filename extension (bool; default: False). The full name of this option  for  the
              EsoRex configuration file is kmos.kmos_std_star.suppress_extension [default = False].

       --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.kmos_std_star.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.kmos_std_star.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.kmos_std_star.b_end [default = -1.0].

       --mask_method <str>
              Method  used : mask, integrated or optimal (str; default: ´optimal´). The full name of this option
              for the EsoRex configuration file is kmos.kmos_std_star.mask_method [default = optimal].

       --centre <str>
              The centre of the circular mask (pixel) (str; default: ´7.5,7.5´). The full name  of  this  option
              for the EsoRex configuration file is kmos.kmos_std_star.centre [default = 7.5,7.5].

       --radius <float>
              The  radius  of  the circular mask (pixel) (float; default: 3.0). The full name of this option for
              the EsoRex configuration file is kmos.kmos_std_star.radius [default = 3.0].

       --cmethod <str>
              Apply "average", "median", "sum", "min_max." or "ksigma". (str; default: ´ksigma´). The full  name
              of this option for the EsoRex configuration file is kmos.kmos_std_star.cmethod [default = ksigma].

       --cpos_rej <float>
              The  positive  rejection  threshold  for kappa-sigma-clipping (sigma).  (float; default: 3.0). The
              full name of this option for the EsoRex configuration file is kmos.kmos_std_star.cpos_rej [default
              = 3.0].

       --cneg_rej <float>
              The negative rejection threshold for kappa-sigma-clipping (sigma).   (float;  default:  3.0).  The
              full name of this option for the EsoRex configuration file is kmos.kmos_std_star.cneg_rej [default
              = 3.0].

       --citer <long>
              The  number  of  iterations  for  kappa-sigma-clipping.  (long; default: 3). The full name of this
              option for the EsoRex configuration file is kmos.kmos_std_star.citer [default = 3].

       --cmax <long>
              The number of maximum pixel values to clip with min/max-clipping.  (long; default:  1).  The  full
              name of this option for the EsoRex configuration file is kmos.kmos_std_star.cmax [default = 1].

       --cmin <long>
              The  number  of  minimum pixel values to clip with min/max-clipping.  (long; default: 1). The full
              name of this option for the EsoRex configuration file is kmos.kmos_std_star.cmin [default = 1].

       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.

SEE ALSO

       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_arithmetic(7),  kmo_copy(7),  kmo_fit_profile(7),
       kmo_fits_check(7),  kmo_fits_strip(7),  kmo_illumination_flat(7),  kmo_make_image(7),   kmo_noise_map(7),
       kmo_rotate(7),    kmo_shift(7),    kmo_sky_mask(7),    kmo_stats(7),    kmos_combine(7),    kmos_dark(7),
       kmos_extract_spec(7),  kmos_flat(7),  kmos_gen_reflines(7),  kmos_illumination(7),   kmos_reconstruct(7),
       kmos_sci_red(7), kmos_sky_tweak(7), kmos_test(7), kmos_wave_cal(7)

VERSION

       kmos_std_star 1.3.17

AUTHOR

       Alex Agudo Berbel, Y. Jung <usd-help@eso.org>

BUG REPORTS

       Please  report  any  problems  to  usd-help@eso.org. Alternatively, you may send a report to the ESO User
       Support Department <usd-help@eso.org>.

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

kmos_std_star                                        1.3.17                                     KMOS_STD_STAR(7)