--- name: "kmo_std_star" section: "7" platform: "linux" package: "cpl-plugin-kmos-doc" version: "1.3.5+dfsg-1" release: "Debian 8 (Jessie)" platforms: ["linux"] url: "https://new.carta.tech/kmo_std_star" --- # kmo\_std\_star(7) Create the telluric correction frame. ## NAME kmo\_std\_star - Create the telluric correction frame. ## SYNOPSIS esorex **kmo\_std\_star** \[OPTIONS\] FILE.sof ## DESCRIPTION This recipe creates a telluric calibration frame and a PSF frame. It must be called after the kmo\_illumination-recipe. Since there won’t be enough standard stars to observe for all IFUs in one ex- posure, one has to do several exposures in a way that there is at least one standard star and one sky exposure in each IFU. A internal data organiser will analyse the provided exposures and select the appropriate frames as follows: 1. For each IFU the first standard star in the list of provided exposures is\ taken. All subsequent standard star exposures for this IFU will be ignored 2. A corresponding sky exposure will be chosen which will be as close in time\ to the standard star exposure as possible. 3\. For any IFUs not containing a standard star and a sky exposure an empty\ frame will be returned. NOISE\_SPEC contains in any case the shot noise \[sqrt(counts\*gain)/gain\]. If the exposures have been taken with template KMOS\_spec\_cal\_stdstarscipatt, then an additional noise component is added in: All existing sky exposures for an IFU are subtracted pairwise, spectra are extracted and the std deviation is calculated. ### BASIC PARAMETERS \--startype If this parameter is specified, the stored star types of the observed obejcts in the FITS headers are overridden. This value applies to all objects exa- mined in the input frames. Examples would be “A3I”, “G3IV” or “K0I”. The first letter defines the star type, the second letter the spectral class and the last letters the luminosity class. \--magnitude If this parameter is specified, the stored magnitudes in the FITS headers are overridden. For HK two magnitudes for each H and K have to be specified. All other gratings just use a single magnitude. If two values are provided, they have to be separated with a comma. \--fmethod The type of function that should be fitted spatially to the collapsed image. This fit is used to create a mask to extract the spectrum of the object. Valid values are “gauss” and “moffat”. \--imethod The interpolation method used for reconstruction. As default ´CS´ is selected. Note that no error spectra will be generated for this interpolation method. Select a nearest neighbour method otherwise \--range The spectral range \[um\] to combine when collapsing the reconstructed cubes. \--save\_cubes Set to TRUE if the intermediate reconstructed cubes (eventually divided by illumination correction) should be saved as well. Default is FALSE. \--no\_noise Applies only for data taken with template KMOS\_spec\_cal\_stdstarscipatt: Skip lengthy calculation of noise-spectra on all sky exposures (no NOISE\_SPEC will be produced). ### 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. \--cmethod Following methods of frame combination are available:\ \* ´ksigma´ (Default)\ An iterative sigma clipping. For each position all pixels in the spectrum\ are examined. If they deviate significantly, they will be rejected according\ to the conditions:\ val \> mean + stdev \* cpos\_rej\ and\ val \< mean - stdev \* cneg\_rej\ where --cpos\_rej, --cneg\_rej and --citer are the corresponding configuration\ parameters. In the first iteration median and percentile level are used. \* ´median´\ At each pixel position the median is calculated. \* ´average´\ At each pixel position the average is calculated. \* ´sum´\ At each pixel position the sum is calculated. \* ´min\_max´\ The specified number of minimum and maximum pixel values will be rejected. \--cmax and --cmin apply to this method. \--cpos\_rej --cneg\_rej --citer see --cmethod=´ksigma´ \--cmax --cmin see --cmethod=´min\_max´ \--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 \--suppress\_extension If set to TRUE, the arbitrary filename extensions are supressed. If multiple products with the same category are produced, they will be numered consecutively starting from 0. 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-wavelengths 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 generated mask used to extract the star \ spectrum \ NOISE\_SPEC F1I The extracted noise spectrum ## OPTIONS - **--startype** *\* The spectral type of the star (O, B, A, F, G) Format: G4V etc. (str; default: ´´). The full name of this option for the EsoRex configuration file is **kmos.kmo\_std\_star.startype** \[default = \]. - **--imethod** *\* 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\_std\_star.imethod** \[default = *CS*\]. - **--fmethod** *\* Either fit a ´gauss´ or ´moffat´ profile. (str; default: ´gauss´). The full name of this option for the EsoRex configuration file is **kmos.kmo\_std\_star.fmethod** \[default = *gauss*\]. - **--neighborhoodRange** *\* 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\_std\_star.neighborhoodRange** \[default = *1.001*\]. - **--magnitude** *\* The magnitude of the std star. For HK two values have to provided (eg. 12.1,13.2) (str; default: ´´). The full name of this option for the EsoRex configuration file is **kmos.kmo\_std\_star.magnitude** \[default = \]. - **--flux** *\* TRUE: Apply flux conservation. FALSE: otherwise (bool; default: True). The full name of this option for the EsoRex configuration file is **kmos.kmo\_std\_star.flux** \[default = *True*\]. - **--save\_cubes** *\* TRUE: Save reconstructed cubes, FALSE: otherwise (bool; default: False). The full name of this option for the EsoRex configuration file is **kmos.kmo\_std\_star.save\_cubes** \[default = *False*\]. - **--no\_noise** *\* Applies only for data taken with template KMOS\_spec\_cal\_stdstarscipatt: FALSE: Calculate noise-spectra on all sky exposures. TRUE: skip this step (bool; default: False). The full name of this option for the EsoRex configuration file is **kmos.kmo\_std\_star.no\_noise** \[default = *False*\]. - **--xcal\_interpolation** *\* 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\_std\_star.xcal\_interpolation** \[default = *True*\]. - **--suppress\_extension** *\* Suppress arbitrary filename extension.(TRUE (apply) or FALSE (don´t apply) (bool; default: False). The full name of this option for the EsoRex configuration file is **kmos.kmo\_std\_star.suppress\_extension** \[default = *False*\]. - **--b\_samples** *\* 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\_std\_star.b\_samples** \[default = *2048*\]. - **--b\_start** *\* 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\_std\_star.b\_start** \[default = *-1.0*\]. - **--b\_end** *\* 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\_std\_star.b\_end** \[default = *-1.0*\]. - **--cmethod** *\* Apply "average", "median", "sum", "min\_max." or "ksigma". (str; default: ´ksigma´). The full name of this option for the EsoRex configuration file is **kmos.kmo\_std\_star.cmethod** \[default = *ksigma*\]. - **--cpos\_rej** *\* 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.kmo\_std\_star.cpos\_rej** \[default = *3.0*\]. - **--cneg\_rej** *\* 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.kmo\_std\_star.cneg\_rej** \[default = *3.0*\]. - **--citer** *\* The number of iterations for kappa-sigma-clipping. (long; default: 3). The full name of this option for the EsoRex configuration file is **kmos.kmo\_std\_star.citer** \[default = *3*\]. - **--cmax** *\* 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.kmo\_std\_star.cmax** \[default = *1*\]. - **--cmin** *\* 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.kmo\_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\_copy*(7)](/kmo_copy/7.md), [*kmo\_fits\_check*(7)](/kmo_fits_check/7.md), [*kmo\_sci\_red*(7)](/kmo_sci_red/7.md), [*kmo\_fits\_stack*(7)](/kmo_fits_stack/7.md), [*kmo\_noise\_map*(7)](/kmo_noise_map/7.md), [*kmo\_rotate*(7)](/kmo_rotate/7.md), [*kmo\_extract\_spec*(7)](/kmo_extract_spec/7.md), [*kmo\_multi\_reconstruct*(7)](/kmo_multi_reconstruct/7.md), [*kmo\_sky\_tweak*(7)](/kmo_sky_tweak/7.md), [*kmo\_shift*(7)](/kmo_shift/7.md), [*kmos\_gen\_reflines*(7)](/kmos_gen_reflines/7.md), [*kmo\_stats*(7)](/kmo_stats/7.md), [*kmo\_arithmetic*(7)](/kmo_arithmetic/7.md), [*kmos\_dark*(7)](/kmos_dark/7.md), [*kmo\_fits\_strip*(7)](/kmo_fits_strip/7.md), [*kmo\_combine*(7)](/kmo_combine/7.md), [*kmo\_illumination\_flat*(7)](/kmo_illumination_flat/7.md), [*kmo\_make\_image*(7)](/kmo_make_image/7.md), [*kmos\_flat*(7)](/kmos_flat/7.md), [*kmo\_fit\_profile*(7)](/kmo_fit_profile/7.md), [*kmo\_sky\_mask*(7)](/kmo_sky_mask/7.md), [*kmos\_illumination*(7)](/kmos_illumination/7.md), [*kmos\_wave\_cal*(7)](/kmos_wave_cal/7.md), [*kmo\_reconstruct*(7)](/kmo_reconstruct/7.md) ## VERSION kmo\_std\_star 1.3.5 ## AUTHOR Alex Agudo Berbel \ ## BUG REPORTS Please report any problems to usd-help@eso.org. Alternatively, you may send a report to the ESO User Support Department \. ## 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