FORS Pipeline Reference Manual  5.0.9
Macros | Functions
Instrument setting

Macros

#define cleanup
 
#define cleanup
 

Functions

static fors_settingfors_setting_new_level (const cpl_frame *raw, cpl_msg_severity level)
 Create setting from FITS header. More...
 
fors_settingfors_setting_new (const cpl_frame *raw)
 Create setting from FITS header. More...
 
void fors_setting_verify (const fors_setting *ref_setting, const cpl_frame *frame, fors_setting **setting)
 Verify that instrument settings are compatible. More...
 
void fors_setting_delete (fors_setting **s)
 Deallocate and and set pointer to NULL. More...
 

Detailed Description

Macro Definition Documentation

#define cleanup
Value:
do { \
cpl_propertylist_delete(header); \
} while (0)

Definition at line 386 of file fors_setting.c.

#define cleanup
Value:
do { \
fors_setting_delete(&input_setting); \
} while (0)
void fors_setting_delete(fors_setting **s)
Deallocate and and set pointer to NULL.
Definition: fors_setting.c:498

Definition at line 386 of file fors_setting.c.

Function Documentation

static fors_setting * fors_setting_new_level ( const cpl_frame *  raw,
cpl_msg_severity  level 
)
static

Create setting from FITS header.

Parameters
rawraw frame
levelprint instrument setting on this message level
Returns
newly allocated instrument setting

Definition at line 82 of file fors_setting.c.

References assure, and fors_dfs_pipeline_version().

Referenced by fors_setting_new(), and fors_setting_verify().

fors_setting* fors_setting_new ( const cpl_frame *  raw)

Create setting from FITS header.

Parameters
rawraw frame
Returns
newly allocated instrument setting

The instrument setting is printed on the CPL_MSG_INFO level

Definition at line 64 of file fors_setting.c.

References fors_setting_new_level().

Referenced by test_bias(), test_dark(), test_identify(), test_image(), test_img_screen_flat(), test_img_sky_flat(), test_new(), test_setting(), and test_stack().

void fors_setting_verify ( const fors_setting ref_setting,
const cpl_frame *  frame,
fors_setting **  setting 
)

Verify that instrument settings are compatible.

Parameters
ref_settingreference to compare with
frameinput frame
setting(output) if non-NULL, the input frame setting is returned

If the instrument settings are incompatible, a warning is printed but the function does not fail

Definition at line 401 of file fors_setting.c.

References assure, and fors_setting_new_level().

void fors_setting_delete ( fors_setting **  s)

Deallocate and and set pointer to NULL.

Parameters
ssetting to delete

Definition at line 498 of file fors_setting.c.