GRAVI Pipeline Reference Manual  1.2.3
Functions
DFS related functions

Functions

cpl_error_code gravi_dfs_set_groups (cpl_frameset *set)
 Set the group as RAW or CALIB in a frameset. More...
 
cpl_error_code gravi_parameter_disable (cpl_parameter *p)
 Disable a parameter. More...
 
cpl_parameter * gravi_parameter_add_badpix (cpl_parameterlist *self)
 Add badpix parameters to the input parameter list. More...
 
cpl_parameter * gravi_parameter_add_profile (cpl_parameterlist *self)
 Add profile parameters to the input parameter list. More...
 
cpl_parameter * gravi_parameter_add_preproc (cpl_parameterlist *self)
 Add preprocessing parameters to the input parameter list. More...
 
cpl_parameter * gravi_parameter_add_wave (cpl_parameterlist *self)
 Add wavelength calibration parameters to the input parameter list. More...
 
cpl_error_code gravi_parameter_add_rejection (cpl_parameterlist *self, int isCalib)
 Add rejection parameters to the input parameter list. More...
 
cpl_frameset * gravi_frameset_extract (cpl_frameset *frameset, const char **frame_tags, int nb_tags)
 Extract a list of tags from a frameset. More...
 
cpl_frameset * gravi_frameset_extract_p2vm_data (cpl_frameset *frameset)
 Extract P2VM_RAW frame from the input frameset. More...
 
cpl_frameset * gravi_frameset_extract_dark_data (cpl_frameset *frameset)
 Extract DARK_RAW frame from the input frameset. More...
 
double gravi_param_get_double_default (const cpl_parameterlist *parlist, const char *name, double def)
 Get the parameter from the parameter list. More...
 

Detailed Description

This module implements the functions linked to the data flow system.

There is a list of function gravi_parameter_add_[param_name]() to add the parameters to the parameter list mainly used in the recipe, they are manly called by the [recipe_name]_create() functions.

There is a list of functions gravi_frameset_extract_[tag_description]() to extract from input frameset the frame of interest.

Function Documentation

cpl_error_code gravi_dfs_set_groups ( cpl_frameset *  set)

Set the group as RAW or CALIB in a frameset.

Parameters
setthe input frameset
Returns
CPL_ERROR_NONE if OK

Definition at line 78 of file gravi_dfs.c.

cpl_frameset* gravi_frameset_extract ( cpl_frameset *  frameset,
const char **  frame_tags,
int  nb_tags 
)

Extract a list of tags from a frameset.

Parameters
framesetinput frameset
frame_tagsTag list to extract
nb_tagsSize of the tag list
Returns
The selected frameset
Exceptions
CPL_ERROR_NULL_INPUTinput data is missing
CPL_ERROR_ILLEGAL_INPUTnb_tags < 0

The function returns a frameset corresponding the list of tags

Definition at line 855 of file gravi_dfs.c.

Referenced by gravi_frameset_extract_dark_data(), and gravi_frameset_extract_p2vm_data().

cpl_frameset* gravi_frameset_extract_dark_data ( cpl_frameset *  frameset)

Extract DARK_RAW frame from the input frameset.

Parameters
framesetinput frameset
Returns
The selected frameset

The function return a frameset with the DARK_RAW frames

Definition at line 913 of file gravi_dfs.c.

References gravi_frameset_extract().

cpl_frameset* gravi_frameset_extract_p2vm_data ( cpl_frameset *  frameset)

Extract P2VM_RAW frame from the input frameset.

Parameters
framesetinput frameset
Returns
The selected frameset

The function returns a frameset with the P2VM_RAW frames

Definition at line 895 of file gravi_dfs.c.

References gravi_frameset_extract().

double gravi_param_get_double_default ( const cpl_parameterlist *  parlist,
const char *  name,
double  def 
)

Get the parameter from the parameter list.

Parameters
parlistinput parameter list
nameName of the paramter to find
defdefaul value to return
Returns
Value of the parameter

The function get the parameter from the list. It provide a default in case the parameter is NOT in the list.

Definition at line 1045 of file gravi_dfs.c.

Referenced by gravi_force_uncertainties(), and gravi_metrology_reduce().

cpl_parameter* gravi_parameter_add_badpix ( cpl_parameterlist *  self)

Add badpix parameters to the input parameter list.

Parameters
selfparameter list
Returns
last parameter allocated
Exceptions
CPL_ERROR_NULL_INPUTinput data is missing

Definition at line 187 of file gravi_dfs.c.

cpl_parameter* gravi_parameter_add_preproc ( cpl_parameterlist *  self)

Add preprocessing parameters to the input parameter list.

Parameters
selfparameter list
Returns
last parameter allocated
Exceptions
CPL_ERROR_NULL_INPUTinput data is missing

Definition at line 264 of file gravi_dfs.c.

cpl_parameter* gravi_parameter_add_profile ( cpl_parameterlist *  self)

Add profile parameters to the input parameter list.

Parameters
selfparameter list
Returns
last parameter allocated
Exceptions
CPL_ERROR_NULL_INPUTinput data is missing

Definition at line 212 of file gravi_dfs.c.

cpl_error_code gravi_parameter_add_rejection ( cpl_parameterlist *  self,
int  isCalib 
)

Add rejection parameters to the input parameter list.

Parameters
selfparameter list
isCalib1 if it's calibrator 0 otherwise
Returns
last parameter allocated
Exceptions
CPL_ERROR_NULL_INPUTinput data is missing

Definition at line 593 of file gravi_dfs.c.

cpl_parameter* gravi_parameter_add_wave ( cpl_parameterlist *  self)

Add wavelength calibration parameters to the input parameter list.

Parameters
selfparameter list
Returns
last parameter allocated
Exceptions
CPL_ERROR_NULL_INPUTinput data is missing

Definition at line 290 of file gravi_dfs.c.

cpl_error_code gravi_parameter_disable ( cpl_parameter *  p)

Disable a parameter.

Parameters
pthe input parameter
Returns
CPL_ERROR_NONE if OK
Exceptions
CPL_ERROR_NULL_INPUTinput data is missing

Definition at line 169 of file gravi_dfs.c.