ERIS Pipeline Reference Manual 1.8.14
Functions
IFU DFS related functions

Functions

cpl_error_code eris_ifu_dfs_set_groups (cpl_frameset *self)
 Set the group as RAW or CALIB in a frameset.
 
cpl_frameset * eris_ifu_extract_frameset (const cpl_frameset *in, const char *tag)
 Extract the frames with the given tag from a frameset.
 
cpl_error_code eris_ifu_heades_add_hduclass_common (cpl_propertylist *plist, const char *deq_hduclas)
 add common properties
 
cpl_error_code eris_ifu_heades_add_hduclass_data (cpl_propertylist *plist)
 add common data info properties
 
cpl_error_code eris_ifu_heades_add_hduclass_errs (cpl_propertylist *plist, deqErrorType errorType)
 add common errors info properties
 
cpl_error_code eris_ifu_heades_add_hduclass_qual (cpl_propertylist *plist, deqQualityType qualityType)
 add common quality info properties on errors
 
cpl_error_code eris_ifu_save_deq_image (cpl_frameset *allframes, cpl_propertylist *header, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const cpl_frame *inherit, const char *recipe, const cpl_propertylist *applist, const char *remregexp, const char *filename, const cpl_image *image, const cpl_image *error, deqErrorType errorType, const cpl_image *dataQualityMask, deqQualityType dataQualityType, const char *unit)
 Write DFS pipeline product with image, error and data qual.
 
cpl_error_code eris_ifu_save_deq_cube (cpl_frameset *allframes, cpl_propertylist *header, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const cpl_frame *inherit, const char *recipe, cpl_propertylist *applist, const char *remregexp, const char *filename, cpl_imagelist *data, cpl_imagelist *error, deqErrorType errorType, const cpl_imagelist *dataQualityMask, deqQualityType qualityType)
 Write DFS pipeline product with image, error and data qual.
 
cpl_error_code eris_ifu_save_image_phase3 (cpl_frameset *allframes, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const char *recipe, const cpl_propertylist *applist, const char *remregexp, const char *filename, const cpl_image *image, cpl_type type, const char *unit)
 Write DFS pipeline product with image, error and data qual.
 
cpl_error_code eris_ifu_save_table (cpl_frameset *allframes, cpl_propertylist *header, const cpl_parameterlist *parlist, const cpl_frameset *usedframes, const cpl_frame *inherit, const char *recipe, const char *procatg, cpl_propertylist *applist, const char *remregexp, const char *filename, const cpl_table *table)
 Write DFS pipeline product with table.
 
cpl_error_code eris_ifu_load_deq_image (const char *filename, cpl_propertylist **primaryHeader, cpl_image **dataImage, cpl_image **errImage, cpl_image **qualImage, deqErrorType *errorType, deqQualityType *qualityType)
 ‍** Function to write a DFS compliant pipeline product with a badpixel map
 
cpl_error_code eris_ifu_load_deq_imagelist (const char *filename, cpl_propertylist **primaryHeader, cpl_imagelist **dataImagelist, cpl_imagelist **errImagelist, cpl_imagelist **qualImagelist, deqErrorType *errorType, deqQualityType *qualityType)
 Function to load an imagelist with error an quality extensions.
 
hdrl_image * eris_ifu_load_deq_hdrl_image (const char *filename, cpl_propertylist **primaryHeader, cpl_image **qualImage, deqQualityType *qualityType)
 Function to load an HDRL image with quality extensions.
 
hdrl_imagelist * eris_ifu_load_deq_hdrl_imagelist (const char *filename, cpl_propertylist **primaryHeader, cpl_imagelist **qualImagelist, deqQualityType *qualityType)
 Function to load an HDRL imagelist with quality extensions.
 
hdrl_image * eris_ifu_load_cal_image_frame (const cpl_frame *frame, ifsBand band, ifsPreopticsScale scale, cpl_image **qualImage, deqQualityType *qualType)
 Function to load a calibration image frame.
 
hdrl_image * eris_ifu_load_cal_image_file (const char *filename, ifsBand band, ifsPreopticsScale scale, cpl_image **qualImage, deqQualityType *qualType)
 Function to load a calibration image filename.
 
cpl_error_code eris_ifu_load_distortion_polynomials_old (const char *filename, cpl_polynomial **poly_u, cpl_polynomial **poly_v)
 Function to load distortion polynomials.
 
cpl_error_code eris_ifu_load_distortion_polynomials (const char *filename, cpl_polynomial ***polynomials, cpl_table **borders)
 Function to load distortion polynomials.
 
cpl_vector * eris_ifu_load_distances (const char *filename)
 Function to load slitlet distances.
 
cpl_bivector * eris_ifu_load_slit_positions (const char *filename)
 Function to load slitlet positions.
 
cpl_error_code eris_ifu_append_qc_int (cpl_propertylist *pl, const char *name, int val, const char *comment)
 Append a QC parameter of type INT to a property list.
 
cpl_error_code eris_ifu_append_qc_double (cpl_propertylist *pl, const char *name, double val, const char *comment)
 Append a QC parameter of type DOUBLE to a property list.
 
cpl_error_code eris_ifu_append_qc_float (cpl_propertylist *pl, const char *name, float val, const char *comment)
 Append a QC parameter of type FLOAT to a property list.
 
cpl_error_code eris_ifu_set_qc_int (cpl_propertylist *pl, const char *name, int val, const char *comment)
 Set a QC parameter of type INT to a property list.
 
bool eris_ifu_frame_is_on (const cpl_frame *fr)
 Determine if a frame is obtained with lamps ON or OFF.
 
bool eris_ifu_frame_is_sky (const cpl_frame *fr)
 Determine if a frame is a Sky frame or not.
 
float eris_ifu_get_dit (cpl_propertylist *header)
 Determine if a frame is a Sky frame or not.
 
int eris_ifu_get_callamp_status (cpl_propertylist *header)
 Return a bit mask indicating which calibration lamps are turned on.
 
ifsBand eris_ifu_get_band (const cpl_propertylist *header)
 Determine preoptic band.
 
ifsInstrument eris_ifu_get_instrument (const cpl_propertylist *header)
 Return the used instrument of the FITS file header.
 
ifsPreopticsScale eris_ifu_get_spiffier_preoptics_scale (const char *scaleId)
 Determine observing scale on Sky.
 
ifsPreopticsScale eris_ifu_get_spiffi_preoptics_scale (const char *scaleId)
 Determine observing scale on Sky.
 
ifsPreopticsScale eris_ifu_get_preopticsScale (cpl_propertylist *header)
 Return the the pre-optics scaling.
 
double eris_get_cumoffs_ra (cpl_frame *frame)
 find out the ESO OCS CUMOFFS RA of the observation
 
double eris_get_cumoffs_dec (cpl_frame *frame)
 find out the ESO OCS CUMOFFS DEC of the observation
 
double eris_get_mjd_obs (cpl_frame *frame)
 find out the Julian Date of the observation
 
cpl_boolean eris_ifu_tag_is_cdb (char *tag)
 check if input frame tag is a static of master calibration
 
cpl_boolean eris_ifu_tag_is_sky (const char *tag)
 check if input frame tag is a static of master calibration
 
cpl_boolean eris_ifu_tag_is_obj (const char *tag)
 Add PRO* keywords to a SINFONI FITS header.
 
cpl_error_code eris_ifu_extract_obj_frames (const cpl_frameset *sof, cpl_frameset *obj)
 extract object raw frames from frame set and put them in a new one
 
cpl_error_code eris_ifu_extract_sky_frames (const cpl_frameset *sof, cpl_frameset *sky)
 extract sky raw frames from frame set and put them in a new one
 
cpl_error_code eris_ifu_extract_mst_frames (const cpl_frameset *sof, cpl_frameset *cdb)
 extract master and ref frames from input set and put them in a new one
 

Detailed Description

TBD

Function Documentation

◆ eris_get_cumoffs_dec()

double eris_get_cumoffs_dec ( cpl_frame *  frame)

find out the ESO OCS CUMOFFS DEC of the observation

Parameters
frameinput frame
Returns
the requested value or 0.0 on error

Queries FITS header ESO OCS CUMOFFS DEC

Definition at line 2209 of file eris_ifu_dfs.c.

References eris_check_error_code().

◆ eris_get_cumoffs_ra()

double eris_get_cumoffs_ra ( cpl_frame *  frame)

find out the ESO OCS CUMOFFS RA of the observation

Parameters
frameinput frame
Returns
the requested value or 0.0 on error

Queries FITS header ESO OCS CUMOFFS RA

Definition at line 2167 of file eris_ifu_dfs.c.

References eris_check_error_code().

◆ eris_get_mjd_obs()

double eris_get_mjd_obs ( cpl_frame *  frame)

find out the Julian Date of the observation

Parameters
frameinput frame
Returns
the requested value or 0.0 on error

Queries FITS header MJD-OBS

Definition at line 2249 of file eris_ifu_dfs.c.

References eris_check_error_code(), and eris_pfits_get_mjdobs().

◆ eris_ifu_append_qc_double()

cpl_error_code eris_ifu_append_qc_double ( cpl_propertylist *  pl,
const char *  name,
double  val,
const char *  comment 
)

Append a QC parameter of type DOUBLE to a property list.

Parameters
plproperty list
namename of QC parameter
valvalue of QC parameter
commentcomment to be attached
Returns
CPL_ERROR_NONE if OK

Definition at line 1585 of file eris_ifu_dfs.c.

References CATCH, eris_check_error_code(), eris_ifu_free_string(), and TRY.

Referenced by eris_ifu_get_badpix_qc_from_ima(), and eris_ifu_get_badpix_qc_from_mask().

◆ eris_ifu_append_qc_float()

cpl_error_code eris_ifu_append_qc_float ( cpl_propertylist *  pl,
const char *  name,
float  val,
const char *  comment 
)

Append a QC parameter of type FLOAT to a property list.

Parameters
plproperty list
namename of QC parameter
valvalue of QC parameter
commentcomment to be attached
Returns
CPL_ERROR_NONE if OK

Definition at line 1624 of file eris_ifu_dfs.c.

References CATCH, eris_check_error_code(), eris_ifu_free_string(), and TRY.

◆ eris_ifu_append_qc_int()

cpl_error_code eris_ifu_append_qc_int ( cpl_propertylist *  pl,
const char *  name,
int  val,
const char *  comment 
)

Append a QC parameter of type INT to a property list.

Parameters
plproperty list
namename of QC parameter
valvalue of QC parameter
commentcomment to be attached
Returns
CPL_ERROR_NONE if OK

Definition at line 1547 of file eris_ifu_dfs.c.

References CATCH, eris_check_error_code(), eris_ifu_free_string(), and TRY.

Referenced by eris_ifu_get_badpix_qc_from_ima(), and eris_ifu_get_badpix_qc_from_mask().

◆ eris_ifu_dfs_set_groups()

cpl_error_code eris_ifu_dfs_set_groups ( cpl_frameset *  self)

Set the group as RAW or CALIB in a frameset.

Parameters
selfThe frameset to process
Returns
CPL_ERROR_NONE if OK

Definition at line 63 of file eris_ifu_dfs.c.

References BRK_IF_ERROR, BRK_IF_NULL, BRK_WITH_ERROR_MSG, CATCH, eris_check_error_code(), eris_ifu_get_instrument_frame(), and TRY.

◆ eris_ifu_extract_frameset()

cpl_frameset * eris_ifu_extract_frameset ( const cpl_frameset *  in,
const char *  tag 
)

Extract the frames with the given tag from a frameset.

Parameters
inA non-empty frameset
tagThe tag of the requested frames
Returns
The newly created frameset or NULL on error

The returned frameset must be de allocated with cpl_frameset_delete()

Definition at line 171 of file eris_ifu_dfs.c.

References eris_check_error_code().

Referenced by eris_ifu_combine(), and eris_ifu_combine_pbp().

◆ eris_ifu_extract_mst_frames()

cpl_error_code eris_ifu_extract_mst_frames ( const cpl_frameset *  sof,
cpl_frameset *  cdb 
)

extract master and ref frames from input set and put them in a new one

Parameters
sofinput frame set
cdboutput frame set
Returns
CPL error code

Definition at line 2440 of file eris_ifu_dfs.c.

References eris_check_error_code(), and eris_ifu_tag_is_cdb().

◆ eris_ifu_extract_obj_frames()

cpl_error_code eris_ifu_extract_obj_frames ( const cpl_frameset *  sof,
cpl_frameset *  obj 
)

extract object raw frames from frame set and put them in a new one

Parameters
sofinput frame set
objoutput frame set
Returns
CPL error code

Definition at line 2367 of file eris_ifu_dfs.c.

References eris_check_error_code(), and eris_ifu_tag_is_obj().

◆ eris_ifu_extract_sky_frames()

cpl_error_code eris_ifu_extract_sky_frames ( const cpl_frameset *  sof,
cpl_frameset *  sky 
)

extract sky raw frames from frame set and put them in a new one

Parameters
sofinput frame set
skyoutput frame set
Returns
CPL error code

Definition at line 2406 of file eris_ifu_dfs.c.

References eris_check_error_code(), and eris_ifu_tag_is_sky().

◆ eris_ifu_frame_is_on()

bool eris_ifu_frame_is_on ( const cpl_frame *  fr)

Determine if a frame is obtained with lamps ON or OFF.

Parameters
frinput frame
Returns
CPL_TRUE if frame is ON, else CPL_FALSE

Definition at line 1697 of file eris_ifu_dfs.c.

References BRK_WITH_ERROR_MSG, CATCH, eris_check_error_code(), eris_ifu_free_propertylist(), eris_ifu_free_string(), eris_ifu_get_callamp_status(), and TRY.

◆ eris_ifu_frame_is_sky()

bool eris_ifu_frame_is_sky ( const cpl_frame *  fr)

Determine if a frame is a Sky frame or not.

Parameters
frinput frame
Returns
CPL_TRUE if frame is Sky, else CPL_FALSE

Definition at line 1752 of file eris_ifu_dfs.c.

References BRK_WITH_ERROR_MSG, CATCH, eris_check_error_code(), eris_ifu_free_propertylist(), eris_ifu_free_string(), and TRY.

◆ eris_ifu_get_band()

ifsBand eris_ifu_get_band ( const cpl_propertylist *  header)

Determine preoptic band.

Parameters
headerinput FITS header
Returns
INS3 SPGW ID

Definition at line 1927 of file eris_ifu_dfs.c.

References BRK_WITH_ERROR, CATCH, CHECK_ERROR_STATE, eris_check_error_code(), eris_ifu_get_instrument(), and TRY.

Referenced by eris_ifu_lcorr_get(), and eris_ifu_load_cal_image_file().

◆ eris_ifu_get_callamp_status()

int eris_ifu_get_callamp_status ( cpl_propertylist *  header)

Return a bit mask indicating which calibration lamps are turned on.

Parameters
headerof the FITS file as property list
Returns
an integer bit mask, for each active lamp the bit is set

The bit values for the lamps are defined in the AR_LAMP, KR_LAMP, NE_LAMP, XE_LAMP and QTH_LAMP macros.

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT The header parameter is a NULL pointer
  • CPL_ERROR_DATA_NOT_FOUND The header ' an ERIS/SPIFFIER nor an SINFONI/SPIFFI one.

Definition at line 1839 of file eris_ifu_dfs.c.

References CATCH, CHECK_ERROR_STATE, eris_check_error_code(), eris_ifu_get_instrument(), and TRY.

Referenced by eris_ifu_frame_is_on().

◆ eris_ifu_get_dit()

float eris_ifu_get_dit ( cpl_propertylist *  header)

Determine if a frame is a Sky frame or not.

Parameters
headerinput FITS header
Returns
DET SEQ1 DIT

Definition at line 1799 of file eris_ifu_dfs.c.

References CATCH, CHECK_ERROR_STATE, eris_check_error_code(), eris_ifu_get_instrument(), and TRY.

◆ eris_ifu_get_instrument()

ifsInstrument eris_ifu_get_instrument ( const cpl_propertylist *  header)

Return the used instrument of the FITS file header.

Parameters
headerof the FITS file as property list
Returns
an value of the instrument enumeration (SPIFFIER,SPIFFI,NIX,OTHER)

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT The header parameter is a NULL pointer
  • CPL_ERROR_BAD_FILE_FORMAT Unknown VLT instrument in header

Definition at line 2006 of file eris_ifu_dfs.c.

References BRK_WITH_ERROR, CATCH, CHECK_ERROR_STATE_MSG, eris_check_error_code(), SET_ERROR_MSG, and TRY.

Referenced by eris_ifu_get_band(), eris_ifu_get_callamp_status(), eris_ifu_get_dit(), eris_ifu_get_instrument_frame(), eris_ifu_get_preopticsScale(), and eris_ifu_load_exposure_file().

◆ eris_ifu_get_preopticsScale()

ifsPreopticsScale eris_ifu_get_preopticsScale ( cpl_propertylist *  header)

Return the the pre-optics scaling.

Parameters
headerof the FITS file as property list
Returns
an value of the preopticsScale enumeration (S250MAS, S100MAS or S25MAS) )

Possible cpl_error_code set in this function:

  • CPL_ERROR_NULL_INPUT The header parameter is a NULL pointer
  • CPL_ERROR_BAD_FILE_FORMAT Unknown VLT instrument in header

Definition at line 2122 of file eris_ifu_dfs.c.

References CATCH, CHECK_ERROR_STATE, eris_check_error_code(), eris_ifu_get_instrument(), eris_ifu_get_spiffi_preoptics_scale(), eris_ifu_get_spiffier_preoptics_scale(), and TRY.

Referenced by eris_ifu_load_cal_image_file().

◆ eris_ifu_get_spiffi_preoptics_scale()

ifsPreopticsScale eris_ifu_get_spiffi_preoptics_scale ( const char *  scaleId)

Determine observing scale on Sky.

Parameters
scaleIdscale ID
Returns
scale setting

Definition at line 2090 of file eris_ifu_dfs.c.

References eris_check_error_code().

Referenced by eris_ifu_get_preopticsScale().

◆ eris_ifu_get_spiffier_preoptics_scale()

ifsPreopticsScale eris_ifu_get_spiffier_preoptics_scale ( const char *  scaleId)

Determine observing scale on Sky.

Parameters
scaleIdscale ID
Returns
scale setting

Definition at line 2065 of file eris_ifu_dfs.c.

References eris_check_error_code().

Referenced by eris_ifu_get_preopticsScale().

◆ eris_ifu_heades_add_hduclass_common()

cpl_error_code eris_ifu_heades_add_hduclass_common ( cpl_propertylist *  plist,
const char *  deq_hduclas 
)

add common properties

Parameters
plistfits header
deq_hduclasvalue to be put in FHDR_HDUCLAS1
Returns
CPL_ERROR_NONE if OK

Definition at line 211 of file eris_ifu_dfs.c.

References eris_check_error_code().

Referenced by eris_ifu_resample_save_cube(), eris_ifu_save_deq_cube(), eris_ifu_save_deq_image(), and eris_ifu_save_table().

◆ eris_ifu_heades_add_hduclass_data()

cpl_error_code eris_ifu_heades_add_hduclass_data ( cpl_propertylist *  plist)

add common data info properties

Parameters
plistfits header
Returns
CPL_ERROR_NONE if OK

Definition at line 229 of file eris_ifu_dfs.c.

References eris_check_error_code().

Referenced by eris_ifu_resample_save_cube(), eris_ifu_save_deq_cube(), and eris_ifu_save_deq_image().

◆ eris_ifu_heades_add_hduclass_errs()

cpl_error_code eris_ifu_heades_add_hduclass_errs ( cpl_propertylist *  plist,
deqErrorType  errorType 
)

add common errors info properties

Parameters
plistfits header
errorTypeerror type
Returns
CPL_ERROR_NONE if OK

Definition at line 246 of file eris_ifu_dfs.c.

References eris_check_error_code().

Referenced by eris_ifu_resample_save_cube(), eris_ifu_save_deq_cube(), and eris_ifu_save_deq_image().

◆ eris_ifu_heades_add_hduclass_qual()

cpl_error_code eris_ifu_heades_add_hduclass_qual ( cpl_propertylist *  plist,
deqQualityType  qualityType 
)

add common quality info properties on errors

Parameters
plistfits header
qualityTypequality type
Returns
CPL_ERROR_NONE if OK

Definition at line 265 of file eris_ifu_dfs.c.

References eris_check_error_code().

Referenced by eris_ifu_resample_save_cube(), eris_ifu_save_deq_cube(), and eris_ifu_save_deq_image().

◆ eris_ifu_load_cal_image_file()

hdrl_image * eris_ifu_load_cal_image_file ( const char *  filename,
ifsBand  band,
ifsPreopticsScale  scale,
cpl_image **  qualImage,
deqQualityType *  qualType 
)

Function to load a calibration image filename.

Parameters
filenameinput filename
bandinput band
scaleinput pre-optic scale
qualImageQUAL image
qualTypequality image data type
Returns
HDRL image if OK, or NULL if error occurred

Definition at line 1257 of file eris_ifu_dfs.c.

References BRK_WITH_ERROR_MSG, CATCH, eris_check_error_code(), eris_ifu_free_image(), eris_ifu_free_propertylist(), eris_ifu_get_band(), eris_ifu_get_preopticsScale(), eris_ifu_load_deq_hdrl_image(), hdrl_image_create(), hdrl_image_delete(), and TRY.

Referenced by eris_ifu_load_cal_image_frame().

◆ eris_ifu_load_cal_image_frame()

hdrl_image * eris_ifu_load_cal_image_frame ( const cpl_frame *  frame,
ifsBand  band,
ifsPreopticsScale  scale,
cpl_image **  qualImage,
deqQualityType *  qualType 
)

Function to load a calibration image frame.

Parameters
frameinput frame
bandinput band
scaleinput pre-optic scale
qualImageQUAL image
qualTypequality image data type
Returns
HDRL image if OK, or NULL if error occurred

Definition at line 1221 of file eris_ifu_dfs.c.

References CATCH, eris_check_error_code(), eris_ifu_load_cal_image_file(), hdrl_image_delete(), and TRY.

◆ eris_ifu_load_deq_hdrl_image()

hdrl_image * eris_ifu_load_deq_hdrl_image ( const char *  filename,
cpl_propertylist **  primaryHeader,
cpl_image **  qualImage,
deqQualityType *  qualityType 
)

Function to load an HDRL image with quality extensions.

Parameters
filenameimage filename
primaryHeaderimage primary FITS header
qualImageQUAL image
qualityTypequality image data type
Returns
HDRL image if OK, or NULL if error occurred

Definition at line 1003 of file eris_ifu_dfs.c.

References BRK_WITH_ERROR_MSG, CATCH, CHECK_ERROR_STATE, eris_check_error_code(), eris_ifu_load_deq_image(), hdrl_image_create(), hdrl_image_delete(), and TRY.

Referenced by eris_ifu_load_cal_image_file().

◆ eris_ifu_load_deq_hdrl_imagelist()

hdrl_imagelist * eris_ifu_load_deq_hdrl_imagelist ( const char *  filename,
cpl_propertylist **  primaryHeader,
cpl_imagelist **  qualImagelist,
deqQualityType *  qualityType 
)

Function to load an HDRL imagelist with quality extensions.

Parameters
filenameimage filename
primaryHeaderimage primary FITS header
qualImagelistQUAL imagelist
qualityTypequality image data type
Returns
HDRL imagelist if OK, or NULL if error occurred

Definition at line 1095 of file eris_ifu_dfs.c.

References BRK_IF_ERROR, BRK_WITH_ERROR_MSG, CATCH, CHECK_ERROR_STATE, eris_check_error_code(), eris_ifu_is_nan_or_inf(), eris_ifu_load_deq_imagelist(), hdrl_imagelist_create(), hdrl_imagelist_delete(), and TRY.

◆ eris_ifu_load_deq_image()

cpl_error_code eris_ifu_load_deq_image ( const char *  filename,
cpl_propertylist **  primaryHeader,
cpl_image **  dataImage,
cpl_image **  errImage,
cpl_image **  qualImage,
deqErrorType *  errorType,
deqQualityType *  qualityType 
)

‍** Function to write a DFS compliant pipeline product with a badpixel map

Function to load an image with error an quality extensions

Parameters
filenameimage filename
primaryHeaderimage primary FITS header
dataImageData image
errImageErrs image
qualImageQUAL image
errorTypeerror image data type
qualityTypequality image data type
Returns
CPL_ERROR_NONE if OK

Definition at line 796 of file eris_ifu_dfs.c.

References BRK_WITH_ERROR_MSG, CATCH, CHECK_ERROR_STATE, eris_check_error_code(), eris_ifu_free_propertylist(), and TRY.

Referenced by eris_ifu_load_deq_hdrl_image().

◆ eris_ifu_load_deq_imagelist()

cpl_error_code eris_ifu_load_deq_imagelist ( const char *  filename,
cpl_propertylist **  primaryHeader,
cpl_imagelist **  dataImagelist,
cpl_imagelist **  errImagelist,
cpl_imagelist **  qualImagelist,
deqErrorType *  errorType,
deqQualityType *  qualityType 
)

Function to load an imagelist with error an quality extensions.

Parameters
filenameimage filename
primaryHeaderimage primary FITS header
dataImagelistData imagelist
errImagelistErrs imagelist
qualImagelistQUAL imagelist
errorTypeerror image data type
qualityTypequality image data type
Returns
CPL_ERROR_NONE if OK

Definition at line 901 of file eris_ifu_dfs.c.

References BRK_WITH_ERROR_MSG, CATCH, CHECK_ERROR_STATE, eris_check_error_code(), eris_ifu_free_propertylist(), and TRY.

Referenced by eris_ifu_load_deq_hdrl_imagelist().

◆ eris_ifu_load_distances()

cpl_vector * eris_ifu_load_distances ( const char *  filename)

Function to load slitlet distances.

Parameters
filenameinput filename
Returns
cpl_vector with slitlet distances

Definition at line 1440 of file eris_ifu_dfs.c.

References BRK_IF_ERROR, CATCH, eris_check_error_code(), eris_ifu_free_table(), SET_ERROR, and TRY.

◆ eris_ifu_load_distortion_polynomials()

cpl_error_code eris_ifu_load_distortion_polynomials ( const char *  filename,
cpl_polynomial ***  polynomials,
cpl_table **  borders 
)

Function to load distortion polynomials.

Parameters
filenameinput filename
polynomialscpl polynomials
borderstable listing slitlet borders
Returns
CPL_ERROR_NONE if OK

Definition at line 1377 of file eris_ifu_dfs.c.

References CATCH, CHECK_ERROR_STATE, eris_check_error_code(), eris_ifu_free_table(), and TRY.

◆ eris_ifu_load_distortion_polynomials_old()

cpl_error_code eris_ifu_load_distortion_polynomials_old ( const char *  filename,
cpl_polynomial **  poly_u,
cpl_polynomial **  poly_v 
)

Function to load distortion polynomials.

Parameters
filenameinput filename
poly_uout polynomial
poly_vout polynomial
Returns
CPL_ERROR_NONE if OK

Definition at line 1327 of file eris_ifu_dfs.c.

References CATCH, CHECK_ERROR_STATE, eris_check_error_code(), eris_ifu_free_table(), and TRY.

◆ eris_ifu_load_slit_positions()

cpl_bivector * eris_ifu_load_slit_positions ( const char *  filename)

Function to load slitlet positions.

Parameters
filenameinput filename
Returns
cpl_vector with slitlet positions (x=start, y=end)

Definition at line 1486 of file eris_ifu_dfs.c.

References CATCH, CHECK_ERROR_STATE, eris_check_error_code(), eris_ifu_free_table(), RECOVER, and TRY.

◆ eris_ifu_save_deq_cube()

cpl_error_code eris_ifu_save_deq_cube ( cpl_frameset *  allframes,
cpl_propertylist *  header,
const cpl_parameterlist *  parlist,
const cpl_frameset *  usedframes,
const cpl_frame *  inherit,
const char *  recipe,
cpl_propertylist *  applist,
const char *  remregexp,
const char *  filename,
cpl_imagelist *  data,
cpl_imagelist *  error,
deqErrorType  errorType,
const cpl_imagelist *  dataQualityMask,
deqQualityType  qualityType 
)

Write DFS pipeline product with image, error and data qual.

Function to write a DFS compliant pipeline product with a data image, error and data quality information according to VLT-SPE-ESO-19500-5667

Parameters
allframesThe list of input frames for the recipe
headerNULL or filled with properties written to product header
parlistThe list of input parameters
usedframesThe list of raw/calibration frames used for this product
inheritNULL or product frames inherit their header from this frame
recipeThe recipe name
applistPropertylist to append to primary header, w. PRO.CATG
remregexpNULL or regexp of properties not to put in main header
filenameFilename of created product
dataThe data image to be saved
errorThe image with the corresponding errors
errorTypeError type: MSE, RMSE, INVMSE or INVRMSE
dataQualityMaskThe image with the correspondint quality flags
qualityTypeQuality type: MASKZERO, MASKONE, FLAG32BIT or FLAG16BIT
Returns
CPL_ERROR_NONE if OK

Definition at line 441 of file eris_ifu_dfs.c.

References CATCH, eris_check_error_code(), eris_ifu_heades_add_hduclass_common(), eris_ifu_heades_add_hduclass_data(), eris_ifu_heades_add_hduclass_errs(), eris_ifu_heades_add_hduclass_qual(), and TRY.

◆ eris_ifu_save_deq_image()

cpl_error_code eris_ifu_save_deq_image ( cpl_frameset *  allframes,
cpl_propertylist *  header,
const cpl_parameterlist *  parlist,
const cpl_frameset *  usedframes,
const cpl_frame *  inherit,
const char *  recipe,
const cpl_propertylist *  applist,
const char *  remregexp,
const char *  filename,
const cpl_image *  image,
const cpl_image *  error,
deqErrorType  errorType,
const cpl_image *  dataQualityMask,
deqQualityType  dataQualityType,
const char *  unit 
)

Write DFS pipeline product with image, error and data qual.

Function to write a DFS compliant pipeline product with a data image, error and data quality information according to VLT-SPE-ESO-19500-5667

Parameters
allframesThe list of input frames for the recipe
headerNULL or filled with properties written to product header
parlistThe list of input parameters
usedframesThe list of raw/calibration frames used for this product
inheritNULL or product frames inherit their header from this frame
recipeThe recipe name
applistPropertylist to append to primary header, w. PRO.CATG
remregexpNULL or regexp of properties not to put in main header
filenameFilename of created product
imageThe data image to be saved (required)
errorThe image with the corresponding errors (optional)
errorTypeError type: MSE, RMSE, INVMSE or INVRMSE
dataQualityMaskThe image with the correspondint quality flags (optional)
dataQualityTypeQuality type: MASKZERO, MASKONE, FLAG32BIT or FLAG16BIT
unitphysical unit to be set in BUNIT
Returns
CPL_ERROR_NONE if OK

Definition at line 300 of file eris_ifu_dfs.c.

References CATCH, eris_check_error_code(), eris_ifu_free_propertylist(), eris_ifu_free_string(), eris_ifu_heades_add_hduclass_common(), eris_ifu_heades_add_hduclass_data(), eris_ifu_heades_add_hduclass_errs(), eris_ifu_heades_add_hduclass_qual(), and TRY.

Referenced by eris_ifu_combine_pbp(), and eris_ifu_cube_collapse_mean_and_save().

◆ eris_ifu_save_image_phase3()

cpl_error_code eris_ifu_save_image_phase3 ( cpl_frameset *  allframes,
const cpl_parameterlist *  parlist,
const cpl_frameset *  usedframes,
const char *  recipe,
const cpl_propertylist *  applist,
const char *  remregexp,
const char *  filename,
const cpl_image *  image,
cpl_type  type,
const char *  unit 
)

Write DFS pipeline product with image, error and data qual.

Function to write a DFS compliant pipeline product with a data image, error and data quality information according to VLT-SPE-ESO-19500-5667

Parameters
allframesThe list of input frames for the recipe
parlistThe list of input parameters
usedframesThe list of raw/calibration frames used for this product
recipeThe recipe name
applistPropertylist to append to primary header, w. PRO.CATG
remregexpNULL or regexp of properties not to put in main header
filenameFilename of created product
imageThe data image to be saved (required)
typeThe image saving data type
unitThe physical unit to be set in BUNIT
Returns
CPL_ERROR_NONE if OK

Definition at line 586 of file eris_ifu_dfs.c.

References CATCH, eris_check_error_code(), eris_ifu_free_propertylist(), eris_ifu_free_string(), and TRY.

Referenced by eris_ifu_combine_pbp(), and eris_ifu_cube_collapse_mean_and_save().

◆ eris_ifu_save_table()

cpl_error_code eris_ifu_save_table ( cpl_frameset *  allframes,
cpl_propertylist *  header,
const cpl_parameterlist *  parlist,
const cpl_frameset *  usedframes,
const cpl_frame *  inherit,
const char *  recipe,
const char *  procatg,
cpl_propertylist *  applist,
const char *  remregexp,
const char *  filename,
const cpl_table *  table 
)

Write DFS pipeline product with table.

Function to write a DFS compliant pipeline product with a table according to VLT-SPE-ESO-19500-5667

Parameters
allframesThe list of input frames for the recipe
headerNULL or filled with properties written to product header
parlistThe list of input parameters
usedframesThe list of raw/calibration frames used for this product
inheritNULL or product frames inherit their header from this frame
recipeThe recipe name
procatgOutput product category
applistPropertylist to append to primary header, w. PRO.CATG
remregexpNULL or regexp of properties not to put in main header
filenameFilename of created product
tableThe data table to be saved
Returns
CPL_ERROR_NONE if OK

Definition at line 660 of file eris_ifu_dfs.c.

References CATCH, CATCH_MSGS, eris_check_error_code(), eris_ifu_free_propertylist(), eris_ifu_free_string(), eris_ifu_heades_add_hduclass_common(), and TRY.

◆ eris_ifu_set_qc_int()

cpl_error_code eris_ifu_set_qc_int ( cpl_propertylist *  pl,
const char *  name,
int  val,
const char *  comment 
)

Set a QC parameter of type INT to a property list.

Parameters
plproperty list
namename of QC parameter
valvalue of QC parameter
commentcomment to be attached
Returns
CPL_ERROR_NONE if OK

Definition at line 1663 of file eris_ifu_dfs.c.

References CATCH, eris_check_error_code(), eris_ifu_free_string(), and TRY.

◆ eris_ifu_tag_is_cdb()

cpl_boolean eris_ifu_tag_is_cdb ( char *  tag)

check if input frame tag is a static of master calibration

Parameters
taginput tag
Returns
CPL_TRUE if true, CPL_FALSE otherwise

Definition at line 2287 of file eris_ifu_dfs.c.

Referenced by eris_ifu_extract_mst_frames().

◆ eris_ifu_tag_is_obj()

cpl_boolean eris_ifu_tag_is_obj ( const char *  tag)

Add PRO* keywords to a SINFONI FITS header.

Parameters
taginput tag
Returns
CPL_TRUE if true, CPL_FALSE otherwise

Definition at line 2339 of file eris_ifu_dfs.c.

Referenced by eris_ifu_extract_obj_frames().

◆ eris_ifu_tag_is_sky()

cpl_boolean eris_ifu_tag_is_sky ( const char *  tag)

check if input frame tag is a static of master calibration

Parameters
taginput tag
Returns
CPL_TRUE if true, CPL_FALSE otherwise

Definition at line 2312 of file eris_ifu_dfs.c.

Referenced by eris_ifu_extract_sky_frames().