vmimobsstare - Reduce an imaging science exposure.
esorex vmimobsstare [OPTIONS] FILE.sof
This recipe is used to apply basic reduction steps to one exposure
made in direct imaging mode. SExtractor v2.1.6 is run on the reduced image,
producing a table of detected objects with their instrumental magnitudes,
their celestial and image coordinates, and their stellarity index. The image
WCS, together with the component describing the instrument optical
distortions, is converted into the convention followed by VMMPS (the VIMOS
mask preparation software). This set of coefficients, the CO-matrix used in
the SAO WCSTools package, is written to the header of the reduced image.
Input files:
DO category: Type: Explanation: Required:
IMG_SCIENCE Raw Science exposure Y
MASTER_BIAS Calib Master bias Y
MASTER_DARK Calib Master dark .
IMG_MASTER_SKY_FLAT Calib Master sky flat Y
PHOT_COEFF_TABLE Calib Photometric table .
CCD_TABLE Calib Bad pixel table .
Output files:
DO category: Data type: Explanation:
IMG_SCIENCE_REDUCED FITS image Reduced scientific exposure
IMG_GALAXY_TABLE FITS table List of detected objects
If a photometric table is specified, the magnitude zeropoint, the
atmospheric extinction coefficient, and the colour term are copied from the
photometric table to the header of the reduced image. A CCD table must be
specified in input only if a bad pixel cleaning is requested. The galaxy
table is the output of SExtractor converted into FITS format. The content of
this table is defined within the VIMOS pipeline DRS, with the only intent of
serving the purpose of the involved pipeline recipes. For a customised
output SExtractor table, it is always possible to run SExtractor separately,
after configuring the native SExtractor parameter files. For a complete
explanation of the output parameters please refer to the SExtractor
documentation - see for instance:
http://terapix.iap.fr/rubrique.php?id_rubrique=91/index.html).
For more details, please refer to the VIMOS Pipeline User´s
Guide.
- --BiasMethod
<str>
- Bias removal method. (str; default: ´Zmaster´). The full
name of this option for the EsoRex configuration file is
vimos.Parameters.bias.removing.method [default =
Zmaster].
- --CleanBadPixel
<bool>
- Bad pixel correction on reduced science image. (bool; default: False). The
full name of this option for the EsoRex configuration file is
vimos.Parameters.badpixel.clean [default = False].
- --CleanCosmic
<bool>
- Cosmic ray removal from input science image. (bool; default: True). The
full name of this option for the EsoRex configuration file is
vimos.Parameters.cosmics.clean [default = True].
- --CosmicsThreshold
<float>
- Threshold for cosmic ray candidate selection. (float; default: 4.0). The
full name of this option for the EsoRex configuration file is
vimos.Parameters.cosmics.threshold [default = 4.0].
- --CosmicsRatio
<float>
- Ratio for discrimination of objects and cosmics. (float; default: 2.0).
The full name of this option for the EsoRex configuration file is
vimos.Parameters.cosmics.ratio [default = 2.0].
- --StarIndex
<float>
- Stellarity index used to select stars in the image. (float; default: 0.5).
The full name of this option for the EsoRex configuration file is
vimos.Parameters.matching.stellarity [default = 0.5].
- --SearchRadius
<float>
- Aperture used for object identification. (float; default: 2.0). The full
name of this option for the EsoRex configuration file is
vimos.Parameters.matching.radius [default = 2.0].
- --TemperatureCheck
<bool>
- Check beam temperature when updating the world coordinate system. (bool;
default: True). The full name of this option for the EsoRex configuration
file is vimos.Parameters.temperature.check [default =
True].
- --TemperatureTolerance
<float>
- Maximum allowed difference between beam and ambient temperature. (float;
default: 3.0). The full name of this option for the EsoRex configuration
file is vimos.Parameters.temperature.tolerance [default =
3.0].
- --ComputeQC
<bool>
- Compute QC1 parameters (bool; default: True). The full name of this option
for the EsoRex configuration file is
vimos.Parameters.quality.enable [default = True].
- Surface brightness threshold for FWHM computation. (float; default: 2.5).
The full name of this option for the EsoRex configuration file is
vimos.SExtractor.AnalysisThresh [default = 2.5].
- Column indices for columns to copy to the catalog output. (str; default:
´2,3,4´). The full name of this option for the EsoRex
configuration file is vimos.SExtractor.AssocData [default =
2,3,4].
- Name of the ASSOC file. (str; default: ´sky.list´). The full
name of this option for the EsoRex configuration file is
vimos.SExtractor.AssocName [default = sky.list].
- Column indices in the ASSOC file to use as coordinates and weight for
cross-matching. (str; default: ´2,3,4´). The full name of
this option for the EsoRex configuration file is
vimos.SExtractor.AssocParams [default = 2,3,4].
- Search radius for ASSOC. (float; default: 2.0). The full name of this
option for the EsoRex configuration file is
vimos.SExtractor.AssocRadius [default = 2.0].
- Output selector for detected sources. (str; default:
´MATCHED´). The full name of this option for the EsoRex
configuration file is vimos.SExtractor.AssocSelecType [default =
MATCHED].
- Method for cross-matching. (str; default: ´MAG_SUM´). The
full name of this option for the EsoRex configuration file is
vimos.SExtractor.AssocType [default = MAG_SUM].
- Size (in background meshes) of the background filtering mask. (int;
default: 3). The full name of this option for the EsoRex configuration
file is vimos.SExtractor.BackFilterSize [default = 3].
- Thickness of the background LOCAL annulus. (int; default: 24). The full
name of this option for the EsoRex configuration file is
vimos.SExtractor.BackPhotoThick [default = 24].
- Select background for magnitude computation. (str; default:
´GLOBAL´). The full name of this option for the EsoRex
configuration file is vimos.SExtractor.BackPhotoType [default =
GLOBAL].
- Size of a background mesh. (int; default: 64). The full name of this
option for the EsoRex configuration file is
vimos.SExtractor.BackSize [default = 64].
- Constant to subtract from the images for MANUAL background subtraction.
(float; default: 0.0). The full name of this option for the EsoRex
configuration file is vimos.SExtractor.BackValue [default =
0.0].
- Select output catalog format (only ASCII_HEAD is supported). (str;
default: ´ASCII_HEAD´). The full name of this option for the
EsoRex configuration file is vimos.SExtractor.CatalogType [default
= ASCII_HEAD].
- Check image file name. (str; default: ´check.fits´). The
full name of this option for the EsoRex configuration file is
vimos.SExtractor.CheckImageName [default = check.fits].
- Select information to put in the `check image´. (str; default:
´NONE´). The full name of this option for the EsoRex
configuration file is vimos.SExtractor.CheckImageType [default =
NONE].
- If `Y´, clean catalog before writing. (str; default:
´Y´). The full name of this option for the EsoRex
configuration file is vimos.SExtractor.Clean [default =
Y].
- Cleaning efficiency. (float; default: 1.0). The full name of this option
for the EsoRex configuration file is vimos.SExtractor.CleanParam
[default = 1.0].
- Minimum contrast for deblending. (float; default: 0.005). The full name of
this option for the EsoRex configuration file is
vimos.SExtractor.DeblendMinCont [default = 0.005].
- Number of deblending sub-thresholds. (int; default: 32). The full name of
this option for the EsoRex configuration file is
vimos.SExtractor.DeblendNthresh [default = 32].
- Minimum number of pixels above threshold triggering detection. (int;
default: 5). The full name of this option for the EsoRex configuration
file is vimos.SExtractor.DetectMinArea [default = 5].
- Detection threshold (relative to background RMS). (float; default: 2.0).
The full name of this option for the EsoRex configuration file is
vimos.SExtractor.DetectThresh [default = 2.0].
- Device type the image originates from. (str; default:
´CCD´). The full name of this option for the EsoRex
configuration file is vimos.SExtractor.DetectType [default =
CCD].
- If `Y´, filter data before extraction. (str; default:
´N´). The full name of this option for the EsoRex
configuration file is vimos.SExtractor.Filter [default =
N].
- Name of the file containing the filter definition. (str; default:
´/usr/share/esopipes/vimos-3.2.3/config/vimos.conv´). The
full name of this option for the EsoRex configuration file is
vimos.SExtractor.FilterName [default =
/usr/share/esopipes/vimos-3.2.3/config/vimos.conv].
- Lower, upper threshold (in background sigmas) for filtering (retina-
filtering only). (str; default: ´´). The full name of this
option for the EsoRex configuration file is
vimos.SExtractor.FilterThresh [default = ].
- Flag image file name. (str; default: ´flag.fits´). The full
name of this option for the EsoRex configuration file is
vimos.SExtractor.FlagImage [default = flag.fits].
- Flag combination method. (str; default: ´OR´). The full name
of this option for the EsoRex configuration file is
vimos.SExtractor.FlagType [default = OR].
- Maximum X gap allowed in interpolation. (int; default: 16). The full name
of this option for the EsoRex configuration file is
vimos.SExtractor.InterpMaxXlag [default = 16].
- Maximum Y gap allowed in interpolation. (int; default: 16). The full name
of this option for the EsoRex configuration file is
vimos.SExtractor.InterpMaxYlag [default = 16].
- Interpolation method. (str; default: ´ALL´). The full name
of this option for the EsoRex configuration file is
vimos.SExtractor.InterpType [default = ALL].
- Gamma of emulsion (only used in PHOTO mode). (float; default: 4.0). The
full name of this option for the EsoRex configuration file is
vimos.SExtractor.MagGamma [default = 4.0].
- Zero-point offset to apply to magnitudes. (float; default: 0.0). The full
name of this option for the EsoRex configuration file is
vimos.SExtractor.MagZeropoint [default = 0.0].
- Masking of neighbours for photometry. (str; default:
´CORRECT´). The full name of this option for the EsoRex
configuration file is vimos.SExtractor.MaskType [default =
CORRECT].
- Number of scan-lines in the image buffer. (int; default: 1024). The full
name of this option for the EsoRex configuration file is
vimos.SExtractor.MemoryBufSize [default = 1024].
- Maximum number of objects the object stack can contain. (int; default:
2000). The full name of this option for the EsoRex configuration file is
vimos.SExtractor.MemoryObjStack [default = 2000].
- Maximum number of pixels the pixel stack can contain. (int; default:
100000). The full name of this option for the EsoRex configuration file is
vimos.SExtractor.MemoryPixStack [default = 100000].
- Aperture diameters used for MAG_APER. (float; default: 5.0). The full name
of this option for the EsoRex configuration file is
vimos.SExtractor.PhotApertures [default = 5.0].
- MAG_AUTO controls: 1st order moment scaling parameter, minimum Rmin. (str;
default: ´2.5,3.5´). The full name of this option for the
EsoRex configuration file is vimos.SExtractor.PhotAutoParams
[default = 2.5,3.5].
- Path to the sextractor executable. (str; default:
´/usr/bin/sex´). The full name of this option for the EsoRex
configuration file is vimos.SExtractor.SExtractor [default =
/usr/bin/sex].
- Pixel values above are considered saturated. (float; default: 60000.0).
The full name of this option for the EsoRex configuration file is
vimos.SExtractor.SaturLevel [default = 60000.0].
- Name of the neuronal network weights file. (str; default:
´/usr/share/esopipes/vimos-3.2.3/config/vimos.nnw´). The
full name of this option for the EsoRex configuration file is
vimos.SExtractor.StarNnwName [default =
/usr/share/esopipes/vimos-3.2.3/config/vimos.nnw].
- Time after which sextractor will be aborted. (float; default: 300.0). The
full name of this option for the EsoRex configuration file is
vimos.SExtractor.Timeout [default = 300.0].
- Selects verbosity level. (str; default: ´QUIET´). The full
name of this option for the EsoRex configuration file is
vimos.SExtractor.VerboseType [default = QUIET].
- Selects the weighting scheme. (str; default: ´NONE´). The
full name of this option for the EsoRex configuration file is
vimos.SExtractor.WeightType [default = NONE].
- Frame window used in SExtractor detection. (str; default:
´100,100,1948,2340´). The full name of this option for the
EsoRex configuration file is vimos.SExtractor.Window [default =
100,100,1948,2340].
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.
The full documentation for the vimos pipeline can be downloaded as
a PDF file using the following URL:
- ftp://ftp.eso.org/pub/dfs/pipelines/vimos/vimos-pipeline-manual-6.9.pdf
An overview over the existing ESO pipelines can be found on the
web page https://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
https://packages.python.org/python-cpl/index.html for further
information.
The other recipes of the vimos pipeline are vmbias(7),
vmdark(7), vmdet(7), vmifucalib(7),
vmifucombine(7), vmifucombinecube(7), vmifuscience(7),
vmifustandard(7), vmimcalphot(7), vmimflatscreen(7),
vmimflatsky(7), vmimobsjitter(7), vmimpreimaging(7),
vmimstandard(7), vmmoscalib(7), vmmoscombine(7),
vmmosobsjitter(7), vmmosobsstare(7), vmmosscience(7),
vmmosstandard(7), vmspcaldisp(7), vmspflat(7),
vmspphot(7)
ESO VIMOS Pipeline Team and VIMOS Consortium
<usd-help@eso.org>
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>.
This file is part of the VIMOS Instrument Pipeline Copyright (C)
2002-2005 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA