Slice Offset Data Handling
[Data Format Handling functions]

Functions

xsh_slice_offsetxsh_slice_offset_create (void)
 Create an empty slice_offset.
xsh_slice_offsetxsh_slice_offset_load (cpl_frame *frame)
 Load a slice_offset from a frame.
void xsh_slice_offset_free (xsh_slice_offset **list)
 Free memory associated to a slice_offset.
cpl_propertylist * xsh_slice_offset_get_header (xsh_slice_offset *list)
 Get header of the table.
cpl_frame * xsh_slice_offset_save (xsh_slice_offset *list, const char *filename, xsh_instrument *instrument)
 Save an slice_offset list to a frame.

Function Documentation

xsh_slice_offset* xsh_slice_offset_create ( void   ) 

Create an empty slice_offset.

Returns:
The slice offset structure

Definition at line 66 of file xsh_data_slice_offset.c.

References xsh_slice_offset::header, XSH_CALLOC, XSH_NEW_PROPERTYLIST, and xsh_slice_offset_free().

Referenced by xsh_compute_slice_dist(), and xsh_slice_offset_load().

void xsh_slice_offset_free ( xsh_slice_offset **  list  ) 

Free memory associated to a slice_offset.

Parameters:
[in] list The slice_offset to free

Definition at line 137 of file xsh_data_slice_offset.c.

References xsh_free_propertylist().

Referenced by xsh_compute_slice_dist(), xsh_slice_offset_create(), and xsh_slice_offset_load().

cpl_propertylist* xsh_slice_offset_get_header ( xsh_slice_offset list  ) 

Get header of the table.

Parameters:
[in] list The slice_offset
Returns:
The header associated to the table

Definition at line 158 of file xsh_data_slice_offset.c.

References xsh_slice_offset::header, and XSH_ASSURE_NOT_NULL.

xsh_slice_offset* xsh_slice_offset_load ( cpl_frame *  frame  ) 

Load a slice_offset from a frame.

Parameters:
[in] frame The table wich contains polynomials coefficients of the orders
Returns:
The slice_offset structure

Definition at line 93 of file xsh_data_slice_offset.c.

References xsh_slice_offset::cen_down, xsh_slice_offset::cen_up, check, xsh_slice_offset::header, XSH_ASSURE_NOT_NULL, xsh_error_msg, xsh_free_propertylist(), xsh_get_table_value(), xsh_slice_offset_create(), xsh_slice_offset_free(), XSH_SLICE_OFFSET_TABLE_COLNAME_CEN_DOWN, XSH_SLICE_OFFSET_TABLE_COLNAME_CEN_UP, XSH_TABLE_FREE, and XSH_TABLE_LOAD.

cpl_frame* xsh_slice_offset_save ( xsh_slice_offset list,
const char *  filename,
xsh_instrument instrument 
)

Save an slice_offset list to a frame.

Parameters:
[in] list The slice_offset structure
[in] filename The name of the save file on disk
instrument instrument arm setting
Returns:
a newly allocated frame

Definition at line 182 of file xsh_data_slice_offset.c.

References xsh_slice_offset::cen_down, xsh_slice_offset::cen_up, check, xsh_slice_offset::header, XSH_ASSURE_NOT_NULL, xsh_frame_product(), XSH_GET_TAG_FROM_ARM, XSH_SLICE_OFFSET, XSH_SLICE_OFFSET_TABLE_COLNAME_CEN_DOWN, XSH_SLICE_OFFSET_TABLE_COLNAME_CEN_UP, XSH_SLICE_OFFSET_TABLE_UNIT_CEN_DOWN, XSH_SLICE_OFFSET_TABLE_UNIT_CEN_UP, XSH_TABLE_FREE, and XSH_TABLE_NEW_COL.

Referenced by xsh_compute_slice_dist().


Generated on 13 Mar 2013 for X-shooter Pipeline Reference Manual by  doxygen 1.6.1