uves_cal_mflat7
Creates the master flat field frame
Usage
esorex uves_cal_mflat [OPTIONS] FILE.sof
Overview
This recipe creates a master flat frame by 1) subtracting the master bias frame from each flat field frame, 2) dividing each flat field frame by the
exposure time for that frame, 3) taking the median of all bias subtracted,
normalized raw
flat frames, 4) optionally subtracting the master dark frame, and 5) subtracting
the background to get the bias subtracted, optionally dark subtracted, normalized, background subtracted master flat-field frame. Symbolically,
masterflat = median( (flat_i - masterbias)/exptime_i ) - masterdark/exptime
- background.
The input flat field frames must have same tag which must match (I|D|S|T|SCREEN|)FLAT_(BLUE|RED), for example TFLAT_BLUE or FLAT_RED. Also, a master bias (MASTER_BIAS_xxxx) and ordertable (ORDER_TABLE_xxxx) must be provided for each chip (xxxx = BLUE, REDL, REDU). A master dark frame (MASTER_(P)DARK_xxxx) may optionally be provided. On blue input the recipe computes one master flat field frame; on red input the recipe produces a master flat field frame for each chip (MASTER_FLAT_xxxx, MASTER_IFLAT_xxxx, MASTER_DFLAT_xxxx, MASTER_TFLAT_xxxx or MASTER_SCREEN_FLAT_xxxx).
Options
-
--backsub.mmethod <str> -
Background measuring method. If equal to ´median´ the background is sampled using the median of a subwindow. If ´minimum´, the subwindow minimum value is used. If ´no´, no background subtraction is done. (str; default: ´median´). The full name of this option for the EsoRex configuration file is
uves_cal_mflat.backsub.mmethod[default = median].
-
--backsub.npoints <int> -
This is the number of columns in interorder space used to sample the background. (int; default: 82). The full name of this option for the EsoRex configuration file is
uves_cal_mflat.backsub.npoints[default = 82].
-
--backsub.radiusy <int> -
The height (in pixels) of the background sampling window is (2*radiusy + 1). This parameter is not corrected for binning. (int; default: 2). The full name of this option for the EsoRex configuration file is
uves_cal_mflat.backsub.radiusy[default = 2].
-
--backsub.sdegree <int> -
Degree of interpolating splines. Currently only degree = 1 is supported (int; default: 1). The full name of this option for the EsoRex configuration file is
uves_cal_mflat.backsub.sdegree[default = 1].
-
--backsub.smoothx <float> -
If spline interpolation is used to measure the background, the x-radius of the post-smoothing window is (smoothx * image_width). Here, ´image_width´ is the image width after binning. If negative, the default values are used: (25.0/4096) for blue flat-field frames, (50.0/4096) for red flat-field frames, (300.0/4096) for blue science frames and (300.0/4096) for red science frames. (float; default: -1.0). The full name of this option for the EsoRex configuration file is
uves_cal_mflat.backsub.smoothx[default = -1.0].
-
--backsub.smoothy <float> -
If spline interpolation is used to measure the background, the y-radius of the post-smoothing window is (smoothy * image_height). Here, ´image_height´ is the image height after binning. If negative, the default values are used: (100.0/2048) for blue flat-field frames, (300.0/2048) for red flat-field frames, (200.0/2048) for blue science frames and (500.0/2048) for red science frames. (float; default: -1.0). The full name of this option for the EsoRex configuration file is
uves_cal_mflat.backsub.smoothy[default = -1.0].
-
--debug <bool> -
Whether or not to save intermediate results to local directory (bool; default: False). The full name of this option for the EsoRex configuration file is
uves.debug[default = False].
-
--norm_method <str> -
Method used to build master frame (str; default: ´explevel´). The full name of this option for the EsoRex configuration file is
uves_cal_mflat.norm_method[default = explevel].
-
--plotter <str> -
Any plots produced by the recipe are redirected to the command specified by this parameter. The plotting command must contain the substring ´gnuplot´ and must be able to parse gnuplot syntax on its standard input. Valid examples of such a command may include ´gnuplot -persist´ and ´cat > mygnuplot$$.gp´. A finer control of the plotting options can be obtained by writing an executable script, e.g. my_gnuplot.pl, that executes gnuplot after setting the desired gnuplot options (e.g. set terminal pslatex color). To turn off plotting, set this parameter to ´no´ (str; default: ´no´). The full name of this option for the EsoRex configuration file is
uves.plotter[default = no].
-
--process_chip <str> -
For RED arm data process the redl, redu, or both chip(s) (str; default: ´both´). The full name of this option for the EsoRex configuration file is
uves.process_chip[default = both].
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.
Version
uves_cal_mflat 6.1.8
Releases
5 releases since Debian 8 (Jessie); the text changed 4 times.