Localization

Functions
xsh_localization *	xsh_localization_create (void)
	Create an empty localization list.
xsh_localization *	xsh_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

Detailed Description

Function Documentation

xsh_localization_create()

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().

xsh_localization_free()

void xsh_localization_free

(

xsh_localization **

list

)

free memory associated to a localization_list

Parameters

[in]

list

the localization_list to free

Definition at line 157 of file xsh_data_localization.c.

References xsh_free_polynomial(), and xsh_free_propertylist().

Referenced by analyse_localization(), compute_shift_with_localization(), xsh_compute_slice_dist(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_localization_create(), xsh_localization_load(), xsh_localize_obj(), xsh_object_localize(), and xsh_subtract_sky_single().

xsh_localization_get_header()

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_load()

xsh_localization * xsh_localization_load

(

cpl_frame *

frame

)

Load a localization list from a frame.

Parameters

[in]

frame

The table wich contains polynomials coefficients of the orders

Returns

The localization list structure

Definition at line 91 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_NULL, xsh_error_msg, xsh_free_propertylist(), xsh_get_table_value(), xsh_localization_create(), xsh_localization_free(), XSH_LOCALIZATION_TABLE_COLNAME_CENTER, XSH_LOCALIZATION_TABLE_COLNAME_EDGLO, XSH_LOCALIZATION_TABLE_COLNAME_EDGUP, XSH_LOCALIZATION_TABLE_DEGPOL, XSH_TABLE_FREE, and XSH_TABLE_LOAD.

Referenced by analyse_localization(), compute_shift_with_localization(), xsh_compute_slice_dist(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_object_localize(), and xsh_subtract_sky_single().

xsh_localization_save()

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, instrument, 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().