GRAVI Pipeline Reference Manual  1.2.3
Functions
Gravity property list

Functions

int gravi_pfits_get_startx (const cpl_propertylist *plist)
 find out the name of the propertylist More...
 
double gravi_pfits_get_time_sc (const cpl_propertylist *header, cpl_size row)
 Time of the middle of the SC exposure row in [us], counted from PRC.ACQ.START. More...
 
double gravi_pfits_get_time_acqcam (const cpl_propertylist *header, cpl_size row)
 Time of the middle of the ACQCAM exposure row in [us], counted from PRC.ACQ.START. More...
 
double gravi_pfits_get_ft_gain (const cpl_propertylist *plist)
 FT system gain in [ADU/e]. More...
 
double gravi_pfits_get_sc_gain (const cpl_propertylist *plist)
 SC system gain in [ADU/e]. More...
 
cpl_propertylist * gravi_plist_get_oifits_keywords (cpl_propertylist *header)
 Create OIFITS keywords to satisfy standar. More...
 
cpl_propertylist * gravi_plist_get_qc (cpl_propertylist *header)
 Extract QC parameters. More...
 
double gravi_pfits_get_double (const cpl_propertylist *self, const char *name)
 Get the double value of the given property list entry. More...
 
cpl_error_code gravi_pfits_add_check (cpl_propertylist *header, char *msg)
 Add a QC.CHECK keyword to the header. More...
 
cpl_error_code gravi_pfits_add_pipe_build (cpl_propertylist *header)
 Add the ESO PRO REC# PIPE LAST_BUILD in header. More...
 

Detailed Description

This module implement the function to access the a given property of the header. Some of the are specific for one keywords like gravi_pfits_det_starx() (not all of them are documented), and some are more generic like gravi_pfits_get_double()

Function Documentation

cpl_error_code gravi_pfits_add_check ( cpl_propertylist *  header,
char *  msg 
)

Add a QC.CHECK keyword to the header.

Parameters
headerthe propertylist to update (in-place)
msgthe string of the message

Add a QC.CHECK keyword to the header, and dump a warning message. The function increments the QC.CHECK.FLAGS counter and create a new string keyword QC.CHECK.MSGi This function allows to propagate in HEADER the most critical warning generated by the pipeline.

Definition at line 1398 of file gravi_pfits.c.

Referenced by gravi_compute_dark(), gravi_data_check_consistency(), gravi_extract_spectrum(), and gravi_wave_compute_opds().

cpl_error_code gravi_pfits_add_pipe_build ( cpl_propertylist *  header)

Add the ESO PRO REC# PIPE LAST_BUILD in header.

Parameters
headerthe propertylist to update (in-place)

The header is updated with a string keyword 'ESO PRO REC# PIPE LAST_BUILD' where # is incremented to avoid overwriting the same keyword. The value is set to DATE TIME, which are compiler-macro with the last time of full rebuilt.

Definition at line 1438 of file gravi_pfits.c.

Referenced by gravi_data_save_new().

double gravi_pfits_get_double ( const cpl_propertylist *  self,
const char *  name 
)

Get the double value of the given property list entry.

Parameters
selfA property list.
nameThe property name to look up.
Returns
The double value stored in the list entry. The function returns 0 if an error occurs and an appropriate error code is set.

Unlike cpl_propertylist_get_double(), this variant will happily convert from integer to double.

Definition at line 1217 of file gravi_pfits.c.

References gravi_pfits_get_double().

Referenced by gravi_pfits_get_double(), and gravi_pfits_get_startx().

double gravi_pfits_get_ft_gain ( const cpl_propertylist *  plist)

FT system gain in [ADU/e].

Parameters
plistThe main header
Returns
The gain value

Definition at line 727 of file gravi_pfits.c.

Referenced by gravi_extract_spectrum().

double gravi_pfits_get_sc_gain ( const cpl_propertylist *  plist)

SC system gain in [ADU/e].

Parameters
plistThe main header
Returns
The gain value

Definition at line 766 of file gravi_pfits.c.

Referenced by gravi_extract_spectrum().

int gravi_pfits_get_startx ( const cpl_propertylist *  plist)

find out the name of the propertylist

Parameters
plistproperty list to read from
Returns
The requested value or the pointer to the string

Definition at line 66 of file gravi_pfits.c.

References gravi_pfits_get_double().

Referenced by gravi_extract_spectrum().

double gravi_pfits_get_time_acqcam ( const cpl_propertylist *  header,
cpl_size  row 
)

Time of the middle of the ACQCAM exposure row in [us], counted from PRC.ACQ.START.

Parameters
headerThe main header
rowThe frame number (0..NDIT-1)
Returns
The time value

Definition at line 624 of file gravi_pfits.c.

Referenced by gravi_reduce_acqcam().

double gravi_pfits_get_time_sc ( const cpl_propertylist *  header,
cpl_size  row 
)

Time of the middle of the SC exposure row in [us], counted from PRC.ACQ.START.

Parameters
headerThe main header
rowThe frame number (0..NDIT-1)
Returns
The time value

Definition at line 590 of file gravi_pfits.c.

Referenced by gravi_data_check_consistency(), and gravi_extract_spectrum().

cpl_propertylist* gravi_plist_get_oifits_keywords ( cpl_propertylist *  header)

Create OIFITS keywords to satisfy standar.

Parameters
headerThe input header
Returns
A new cpl_parameterlist with the keywords

Definition at line 801 of file gravi_pfits.c.

Referenced by gravi_data_save_new().

cpl_propertylist* gravi_plist_get_qc ( cpl_propertylist *  header)

Extract QC parameters.

Parameters
headerThe input header
Returns
A new cpl_parameterlist with the QC keywords

Definition at line 856 of file gravi_pfits.c.