Spectral wavelength limit by orders

Functions
void	xsh_spectralformat_list_dump (xsh_spectralformat_list *list, const char *fname)
	Dump main info about an order table (for each order of the list)
xsh_spectralformat_list *	xsh_spectralformat_list_create (int size, xsh_instrument *instr)
	Create an empty spectralformat list.
xsh_spectralformat_list *	xsh_spectralformat_list_load (cpl_frame *frame, xsh_instrument *instr)
	Load a spectralformat list from a frame.
void	xsh_spectralformat_list_free (xsh_spectralformat_list **list)
	Free memory associated to an spactralformat_list.
cpl_propertylist *	xsh_spectralformat_list_get_header (xsh_spectralformat_list *list)
	Get header of the table.
float	xsh_spectralformat_list_get_lambda_min (xsh_spectralformat_list *list, int absorder)
	Returns lambda min for a given absolute order.
const char *	xsh_spectralformat_list_get_lamp (xsh_spectralformat_list *list, int absorder)
float	xsh_spectralformat_list_get_lambda_max (xsh_spectralformat_list *list, int absorder)
cpl_vector *	xsh_spectralformat_list_get_orders (xsh_spectralformat_list *list, float lambda)
	Returns list of absolute orders containing lambda.
void	xsh_spectralformat_check_wlimit (xsh_spectralformat_list *spectralformat, xsh_order_list *orderlist, xsh_wavesol *wavesol, xsh_xs_3 *model, xsh_instrument *instr)

Detailed Description

Function Documentation

xsh_spectralformat_check_wlimit()

void xsh_spectralformat_check_wlimit	(	xsh_spectralformat_list *	spectralformat,
		xsh_order_list *	orderlist,
		xsh_wavesol *	wavesol,
		xsh_xs_3 *	model,
		xsh_instrument *	instr
	)

Definition at line 400 of file xsh_data_spectralformat.c.

References xsh_spectralformat::absorder, check, xsh_order::endy, xsh_spectralformat::lambda_max, xsh_spectralformat::lambda_min, xsh_order_list::list, xsh_spectralformat_list::list, xsh_spectralformat_list::size, xsh_order::starty, x, XSH_ASSURE_NOT_NULL, xsh_model_get_xy(), xsh_msg_warning, and xsh_wavesol_eval_poly().

Referenced by xsh_data_check_spectralformat().

xsh_spectralformat_list_create()

xsh_spectralformat_list * xsh_spectralformat_list_create	(	int	size,
		xsh_instrument *	instr
	)

Create an empty spectralformat list.

Parameters

[in]	size	size of list
[in]	instr	The instrument in use

Returns

The spectralformat list structure

Definition at line 97 of file xsh_data_spectralformat.c.

References xsh_spectralformat_list::header, xsh_spectralformat_list::instrument, xsh_spectralformat_list::list, xsh_spectralformat_list::size, size, XSH_ASSURE_NOT_ILLEGAL, XSH_CALLOC, XSH_NEW_PROPERTYLIST, and xsh_spectralformat_list_free().

Referenced by xsh_spectralformat_list_load().

xsh_spectralformat_list_dump()

void xsh_spectralformat_list_dump	(	xsh_spectralformat_list *	list,
		const char *	fname
	)

Dump main info about an order table (for each order of the list)

Parameters

[in]	list	Pointer to table list
[in]	fname	File name

Definition at line 67 of file xsh_data_spectralformat.c.

References xsh_spectralformat::absorder, xsh_spectralformat::lambda_max, xsh_spectralformat::lambda_min, xsh_spectralformat_list::list, and xsh_spectralformat_list::size.

xsh_spectralformat_list_free()

void xsh_spectralformat_list_free

(

xsh_spectralformat_list **

list

)

Free memory associated to an spactralformat_list.

Parameters

[in]

list

The spectralformat_list to free

Definition at line 233 of file xsh_data_spectralformat.c.

References xsh_free_propertylist().

Referenced by clean_arclist_data(), compute_abs_order(), xsh_afcthetab_create(), xsh_create_dispersol_physmod(), xsh_create_order_table(), xsh_create_poly_wavemap(), xsh_data_check_spectralformat(), xsh_detect_arclines(), xsh_detect_arclines_dan(), xsh_instrument_update_from_spectralformat(), xsh_opt_extract_orders(), xsh_order_split_qth_d2(), xsh_rectify_orders(), xsh_spectralformat_list_create(), xsh_spectralformat_list_load(), and xsh_wavesol_create().

xsh_spectralformat_list_get_header()

cpl_propertylist * xsh_spectralformat_list_get_header

(

xsh_spectralformat_list *

list

)

Get header of the table.

Parameters

[in]

list

The spectralformat_list

Returns

The header associated to the table

Definition at line 259 of file xsh_data_spectralformat.c.

References xsh_spectralformat_list::header, and XSH_ASSURE_NOT_NULL.

xsh_spectralformat_list_get_lambda_max()

float xsh_spectralformat_list_get_lambda_max	(	xsh_spectralformat_list *	list,
		int	absorder
	)

Returns lambda max for a given absolute order.

Parameters

list	Pointer to spectralformat structure
absorder	Absolute order number

Returns

Lambda max of this order

Definition at line 333 of file xsh_data_spectralformat.c.

References xsh_spectralformat::absorder, xsh_spectralformat::lambda_max, xsh_spectralformat_list::list, xsh_spectralformat_list::size, and XSH_ASSURE_NOT_NULL.

Referenced by xsh_wavemap_lambda_range().

xsh_spectralformat_list_get_lambda_min()

float xsh_spectralformat_list_get_lambda_min	(	xsh_spectralformat_list *	list,
		int	absorder
	)

Returns lambda min for a given absolute order.

Parameters

[in]	list	Pointer to spectralformat structure
[in]	absorder	Absolute order number

Returns

Lambda min of this order

Definition at line 283 of file xsh_data_spectralformat.c.

References xsh_spectralformat::absorder, xsh_spectralformat::lambda_min, xsh_spectralformat_list::list, xsh_spectralformat_list::size, and XSH_ASSURE_NOT_NULL.

Referenced by xsh_wavemap_lambda_range().

xsh_spectralformat_list_get_lamp()

const char * xsh_spectralformat_list_get_lamp	(	xsh_spectralformat_list *	list,
		int	absorder
	)

Definition at line 304 of file xsh_data_spectralformat.c.

References xsh_spectralformat::absorder, xsh_spectralformat::lamp, xsh_spectralformat_list::list, xsh_spectralformat_list::size, and XSH_ASSURE_NOT_NULL.

Referenced by xsh_order_split_qth_d2().

xsh_spectralformat_list_get_orders()

cpl_vector * xsh_spectralformat_list_get_orders	(	xsh_spectralformat_list *	list,
		float	lambda
	)

Returns list of absolute orders containing lambda.

Parameters

[in]	list	Pointer to spectralformat structure
[in]	lambda	Wavelength in nm to search

Returns

Vector containing absolute orders matching with given lambda

Definition at line 363 of file xsh_data_spectralformat.c.

References xsh_spectralformat::absorder, check, xsh_spectralformat::lambda_max_full, xsh_spectralformat::lambda_min_full, xsh_spectralformat_list::list, max, xsh_spectralformat_list::size, size, XSH_ASSURE_NOT_NULL, xsh_free_vector(), and xsh_msg_dbg_high.

Referenced by clean_arclist_data(), theo_tab_model(), and xsh_afcthetab_create().

xsh_spectralformat_list_load()

xsh_spectralformat_list * xsh_spectralformat_list_load	(	cpl_frame *	frame,
		xsh_instrument *	instr
	)

Load a spectralformat list from a frame.

Parameters

[in]	frame	The table wich contains the spectral format
[in]	instr	The instrument in use

Returns

The spectralformat list structure

Definition at line 132 of file xsh_data_spectralformat.c.

References xsh_spectralformat::absorder, check, xsh_spectralformat::flsr, xsh_spectralformat_list::header, xsh_spectralformat::lambda_max, xsh_spectralformat::lambda_max_full, xsh_spectralformat::lambda_min, xsh_spectralformat::lambda_min_full, xsh_spectralformat::lamp, xsh_spectralformat_list::list, xsh_spectralformat_list::size, size, xsh_spectralformat::ufsr, xsh_spectralformat::xmax, xsh_spectralformat::xmin, XSH_ASSURE_NOT_NULL, xsh_error_msg, xsh_free_propertylist(), xsh_get_table_value(), xsh_spectralformat_list_create(), xsh_spectralformat_list_free(), XSH_SPECTRALFORMAT_TABLE_COLNAME_FLSR, XSH_SPECTRALFORMAT_TABLE_COLNAME_LAMP, XSH_SPECTRALFORMAT_TABLE_COLNAME_ORDER, XSH_SPECTRALFORMAT_TABLE_COLNAME_UFSR, XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMAX, XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMAXFUL, XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMIN, XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMINFUL, XSH_SPECTRALFORMAT_TABLE_COLNAME_XMAX, XSH_SPECTRALFORMAT_TABLE_COLNAME_XMIN, XSH_SPECTRALFORMAT_TABLE_COLNAME_YMAX, XSH_SPECTRALFORMAT_TABLE_COLNAME_YMIN, XSH_TABLE_FREE, XSH_TABLE_LOAD, xsh_spectralformat::ymax, and xsh_spectralformat::ymin.

Referenced by clean_arclist_data(), compute_abs_order(), xsh_afcthetab_create(), xsh_create_dispersol_physmod(), xsh_create_order_table(), xsh_create_poly_wavemap(), xsh_data_check_spectralformat(), xsh_detect_arclines(), xsh_detect_arclines_dan(), xsh_instrument_update_from_spectralformat(), xsh_opt_extract_orders(), xsh_order_split_qth_d2(), xsh_rectify_orders(), and xsh_wavesol_create().