Localization
[Data Format Handling functions]

Functions

xsh_localizationxsh_localization_create (void)
 Create an empty localization list.
xsh_localizationxsh_localization_load (cpl_frame *frame)
 Load a localization list from a frame.
void xsh_localization_free (xsh_localization **list)
 free memory associated to a localization_list
cpl_propertylist * xsh_localization_get_header (xsh_localization *list)
 get header of the table
cpl_frame * xsh_localization_save (xsh_localization *list, const char *filename, xsh_instrument *instrument)
 save a localization to a frame

Function Documentation

xsh_localization* xsh_localization_create ( void   ) 

Create an empty localization list.

Returns:
The order list structure

Definition at line 65 of file xsh_data_localization.c.

References xsh_localization::header, XSH_CALLOC, xsh_localization_free(), and XSH_NEW_PROPERTYLIST.

Referenced by xsh_localization_load(), xsh_localize_obj_auto(), and xsh_localize_obj_manual().

void xsh_localization_free ( xsh_localization **  list  ) 
cpl_propertylist* xsh_localization_get_header ( xsh_localization list  ) 

get header of the table

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

Definition at line 183 of file xsh_data_localization.c.

References xsh_localization::header, and XSH_ASSURE_NOT_NULL.

xsh_localization* xsh_localization_load ( cpl_frame *  frame  ) 
cpl_frame* xsh_localization_save ( xsh_localization list,
const char *  filename,
xsh_instrument instrument 
)

save a localization to a frame

Parameters:
[in] list the localization_list structure wich contains polynomials coefficients of the orders
[in] filename the name of the save file on disk
[in] instrument instrument (arm) setting
Returns:
a newly allocated frame

Definition at line 209 of file xsh_data_localization.c.

References xsh_localization::cenpoly, check, xsh_localization::edglopoly, xsh_localization::edguppoly, xsh_localization::header, xsh_localization::pol_degree, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, xsh_frame_product(), XSH_GET_TAG_FROM_ARM, XSH_LOCALIZATION, XSH_LOCALIZATION_TABLE_COLNAME_CENTER, XSH_LOCALIZATION_TABLE_COLNAME_EDGLO, XSH_LOCALIZATION_TABLE_COLNAME_EDGUP, XSH_LOCALIZATION_TABLE_DEGPOL, and XSH_TABLE_FREE.

Referenced by xsh_localize_obj().


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