The gistandard recipe

gistandard

Synopsis

Process a spectro-photometric standard star observation and compute the instrument response curve.

Description

For detailed information please refer to the GIRAFFE pipeline user manual.

It is available at http://www.eso.org/pipelines.

Constructor

cpl.Recipe("gistandard")

Create an object for the recipe gistandard.

import cpl
gistandard = cpl.Recipe("gistandard")

Parameters

gistandard.param.remove_bias

Enable bias removal (bool; default: True) [default=True].

gistandard.param.bsremove_method

Bias removal method (str; default: ‘PROFILE’) [default=”PROFILE”].

gistandard.param.bsremove_areas

Bias areas to use (Xl0:Xr0:Yl0:Yr0, … ,Xln:Xrn:Yln:Yrn) (str; default: ‘5:40:0:4095’) [default=”5:40:0:4095”].

gistandard.param.bsremove_sigma

Sigma Clipping: sigma threshold factor (float; default: 2.5) [default=2.5].

gistandard.param.bsremove_niter

Sigma Clipping: maximum number of iterations (int; default: 5) [default=5].

gistandard.param.bsremove_mfrac

Sigma Clipping: minimum fraction of points accepted/total [0.0..1.0] (float; default: 0.8) [default=0.8].

gistandard.param.bsremove_xorder

Order of X polynomial fit (CURVE method only) (int; default: 1) [default=1].

gistandard.param.bsremove_yorder

Order of Y polynomial fit (CURVE method only) (int; default: 1) [default=1].

gistandard.param.bsremove_xstep

Sampling step along X (CURVE method only) (int; default: 1) [default=1].

gistandard.param.bsremove_ystep

Sampling step along Y (CURVE method only) (int; default: 1) [default=1].

gistandard.param.extr_method

Extraction method: ‘SUM’, ‘HORNE’ or ‘OPTIMAL’ (str; default: ‘SUM’) [default=”SUM”].

gistandard.param.extr_ron

New bias sigma (RON) value for bias and dark corrected image (float; default: -1.0) [default=-1.0].

gistandard.param.extr_psfmodel

PSF profile model: `psfexp’, `psfexp2’ (str; default: ‘psfexp2’) [default=”psfexp2”].

gistandard.param.extr_psfsigma

Sigma clippging threshold used for rejecting data points during PSF fitting (Horne’s sigma). It is used to reject bad pixels and cosmics. (float; default: 7.0) [default=7.0].

gistandard.param.extr_psfniter

Maximum number of iterations used for fitting the PSF profile. (int; default: 2) [default=2].

gistandard.param.extr_hewidth

Horne extraction method: Number of extra pixels added to the fiber half-width. (int; default: 2) [default=2].

gistandard.param.extr_hmingood

Horne extraction method: Minimum number of points used for the profile fit. It sets the lower limit of data points for the pixel rejection. (int; default: 3) [default=3].

gistandard.param.extr_omfrac

Optimal extraction method: Minimum fraction of the data points used for fitting the fiber profiles. It sets the lower limit for the pixel rejection. (float; default: 0.9) [default=0.9].

gistandard.param.extr_owfactor

Optimal extraction method: Factor by which the fiber PSF half width is multiplied. Adjacent spectra within this area are assumed to affect the spectrum being extracted. (float; default: 3.0) [default=3.0].

gistandard.param.extr_obkgorder

Optimal extraction method: Order of the polynomial background model, which is fitted for each wavelength bin along the spatial direction. (int; default: 2) [default=2].

gistandard.param.flat_apply

Controls the flat field correction. (bool; default: False) [default=False].

gistandard.param.transmission_apply

Controls the fiber to fiber transmission correction. (bool; default: False) [default=False].

gistandard.param.rbin_method

Method to use : `linear’ or `spline’ (str; default: ‘linear’) [default=”linear”].

gistandard.param.rbin_xresid

Use x residuals during rebinning? `true’/`false’ (bool; default: True) [default=True].

gistandard.param.rbin_lstep

Lambda step size, only used if scaling method is ‘linear’ (float; default: 0.005) [default=0.005].

gistandard.param.rbin_scmethod

Scaling method: `log’ or `linear’ (str; default: ‘linear’) [default=”linear”].

gistandard.param.rbin_size

Size of output rebinned spectra, 0 means calculate size based on wavelength range and lambda stepsize (int; default: 0) [default=0].

gistandard.param.rbin_range

Rebinning range: `setup’ or `common’ (str; default: ‘common’) [default=”common”].

gistandard.param.recon_min

Minimum wavelength for image reconstruction (float; default: 0.0) [default=0.0].

gistandard.param.recon_max

Maximum wavelength for image reconstruction (float; default: 0.0) [default=0.0].

gistandard.param.recon_cube

Turns data cube creation on and off (bool; default: True) [default=True].

gistandard.param.recon_format

Selects the file format for cubes (str; default: ‘single’) [default=”single”].

gistandard.param.flx_skycorr

Correct spectra for the sky emission (bool; default: False) [default=False].

gistandard.param.max_dist

Standar star search radius (float; default: 60.0) [default=60.0].

The following code snippet shows the default settings for the available parameters.

import cpl
gistandard = cpl.Recipe("gistandard")

gistandard.param.remove_bias = True
gistandard.param.bsremove_method = "PROFILE"
gistandard.param.bsremove_areas = "5:40:0:4095"
gistandard.param.bsremove_sigma = 2.5
gistandard.param.bsremove_niter = 5
gistandard.param.bsremove_mfrac = 0.8
gistandard.param.bsremove_xorder = 1
gistandard.param.bsremove_yorder = 1
gistandard.param.bsremove_xstep = 1
gistandard.param.bsremove_ystep = 1
gistandard.param.extr_method = "SUM"
gistandard.param.extr_ron = -1.0
gistandard.param.extr_psfmodel = "psfexp2"
gistandard.param.extr_psfsigma = 7.0
gistandard.param.extr_psfniter = 2
gistandard.param.extr_hewidth = 2
gistandard.param.extr_hmingood = 3
gistandard.param.extr_omfrac = 0.9
gistandard.param.extr_owfactor = 3.0
gistandard.param.extr_obkgorder = 2
gistandard.param.flat_apply = False
gistandard.param.transmission_apply = False
gistandard.param.rbin_method = "linear"
gistandard.param.rbin_xresid = True
gistandard.param.rbin_lstep = 0.005
gistandard.param.rbin_scmethod = "linear"
gistandard.param.rbin_size = 0
gistandard.param.rbin_range = "common"
gistandard.param.recon_min = 0.0
gistandard.param.recon_max = 0.0
gistandard.param.recon_cube = True
gistandard.param.recon_format = "single"
gistandard.param.flx_skycorr = False
gistandard.param.max_dist = 60.0

You may also set or overwrite some or all parameters by the recipe parameter param, as shown in the following example:

import cpl
gistandard = cpl.Recipe("gistandard")
[...]
res = gistandard( ..., param = {"remove_bias":True, "bsremove_method":"PROFILE"})

See also

cpl.Recipe for more information about the recipe object.

Bug reports

Please report any problems to Giraffe Pipeline. Alternatively, you may send a report to the ESO User Support Department.