AMBER OI frame selector
This recipe selects frames stored in an AMBER OI product by various methods and writes a filtered OI product. After selecting a method one can set a selection criteria for every baseline by defining the variables X1, X2, and X3. If only one baseline is available, X2 and X3 can be neglected. Moreover one can choose the combining method of the single criteria by setting the Boolean variable ANDselection.
If ANDselection is not set (–ANDselection=FALSE), a frame passes the filter if at least one of the selection criteria (X1 || X2 || X3) is fulfilled.
If ANDselection is set (–ANDselection=TRUE), a frame passes the filter only if ALL selection criteria (X1 && X2 && X3) are fulfilled.
If AverageFrames is set (–AverageFrames=TRUE), the final product will contain the average of the frames
Please note, that for three baselines in both cases the visibility triplet is written to the product file!
DO category: Type: Explanation: Required:
SCIENCE_REDUCED Products OI-Fits file
or
SCIENCE_REDUCED_FILTERED Products OI-Fits file
or
CALIB_REDUCED Products OI-Fits file Y
or
CALIB_REDUCED_FILTERED Products OI-Fits file
or
SCIENCE_CALIBRATED Products OI-Fits file
DO category: Data type: Explanation:
SCIENCE_REDUCED_FILTERED Products: filtered OI-fits file
or
CALIB_REDUCED_FILTERED Products: filtered OI-fits file
Create an object for the recipe amber_selector.
import cpl
amber_selector = cpl.Recipe("amber_selector")
Selection methods (str; default: ‘Fringe_SNR_gt_x’) [default=”Fringe_SNR_gt_x”].
X1 Value (float; default: 2.0) [default=2.0].
X2 Value (float; default: 2.0) [default=2.0].
X3 Value (float; default: 2.0) [default=2.0].
X1, X2, and X3 combining method (bool; default: False) [default=False].
Average all frames after selection (bool; default: False) [default=False].
The following code snippet shows the default settings for the available parameters.
import cpl
amber_selector = cpl.Recipe("amber_selector")
amber_selector.param.selection_method = "Fringe_SNR_gt_x"
amber_selector.param.X1 = 2.0
amber_selector.param.X2 = 2.0
amber_selector.param.X3 = 2.0
amber_selector.param.ANDselection = False
amber_selector.param.AverageFrames = False
You may also set or overwrite some or all parameters by the recipe parameter param, as shown in the following example:
import cpl
amber_selector = cpl.Recipe("amber_selector")
[...]
res = amber_selector( ..., param = {"selection_method":"Fringe_SNR_gt_x", "X1":2.0})
See also
cpl.Recipe for more information about the recipe object.
Please report any problems to Armin Gabasch. Alternatively, you may send a report to the ESO User Support Department.
Code author: Armin Gabasch <usd-help@eso.org>