Rec

Functions
void	xsh_rec_list_dump (xsh_rec_list *list, const char *fname)
xsh_rec_list *	xsh_rec_list_create (xsh_instrument *instr)
	Create an empty order list.
xsh_rec_list *	xsh_rec_list_create_with_size (int size, xsh_instrument *instr)
	Create an empty order list.
void	xsh_rec_list_set_data_size (xsh_rec_list *list, int idx, int absorder, int nlambda, int ns)
	Allocate memory for the order idx of the rectify list.
xsh_rec_list *	xsh_rec_list_duplicate (xsh_rec_list *old, xsh_instrument *instrument)
xsh_rec_list *	xsh_rec_list_load (cpl_frame *frame, xsh_instrument *instrument)
	load an rec list from a frame
xsh_rec_list *	xsh_rec_list_load_eso (cpl_frame *frame, xsh_instrument *instrument)
xsh_rec_list *	xsh_rec_list_load_eso_1d (cpl_frame *frame, xsh_instrument *instrument)
cpl_frame *	xsh_rec_list_frame_invert (cpl_frame *rec_frame, const char *tag, xsh_instrument *instrument)
	Invert the rectified flux images of the input frame into a new frame.
void	xsh_rec_list_free (xsh_rec_list **list)
	free memory associated to a rec_list
cpl_propertylist *	xsh_rec_list_get_header (xsh_rec_list *list)
	get header of the table
int	xsh_rec_list_get_nslit (xsh_rec_list *list, int idx)
int	xsh_rec_list_get_order (xsh_rec_list *list, int idx)
int	xsh_rec_list_get_nlambda (xsh_rec_list *list, int idx)
float *	xsh_rec_list_get_slit (xsh_rec_list *list, int idx)
double	xsh_rec_list_get_slit_min (xsh_rec_list *list)
double	xsh_rec_list_get_slit_max (xsh_rec_list *list)
double	xsh_rec_list_get_lambda_min (xsh_rec_list *list)
double	xsh_rec_list_get_lambda_max (xsh_rec_list *list)
cpl_error_code	xsh_rec_list_set_slit_min (xsh_rec_list *list, const double val)
cpl_error_code	xsh_rec_list_set_slit_max (xsh_rec_list *list, const double val)
double *	xsh_rec_list_get_lambda (xsh_rec_list *list, int idx)
float *	xsh_rec_list_get_data1 (xsh_rec_list *list, int idx)
float *	xsh_rec_list_get_errs1 (xsh_rec_list *list, int idx)
int *	xsh_rec_list_get_qual1 (xsh_rec_list *list, int idx)
cpl_frame *	xsh_rec_list_save (xsh_rec_list *list, const char *filename, const char *tag, int is_temp)
	Save a rec list in a frame.
void	xsh_rec_list_update_header (xsh_rec_list *rec_list, xsh_pre *pre, xsh_rectify_param *rec_par, const char *pro_catg)
	Update header of rectified list writing mandatory KW.
cpl_frame *	xsh_rec_list_save_table (xsh_rec_list *list, const char *filename, const char *tag, int is_temp)
	Save a rec list in a frame.
cpl_frame *	xsh_rec_list1D_save_as_tab (xsh_rec_list *list, const char *filename, const char *tag)
	save an rec list to a frame
cpl_frame *	xsh_rec_list_save2 (xsh_rec_list *list, const char *filename, const char *tag)
	save an rec list to a frame
void	xsh_rec_get_nod_kw (cpl_frame *rec_frame, double *throw, double *jitter, double *reloffset, double *cumoffset)
cpl_error_code	xsh_rec_get_nod_extract_slit_min_max (xsh_rec_list *rlist, const double slit_step, double *smin, double *smax)

Detailed Description

Function Documentation

xsh_rec_get_nod_extract_slit_min_max()

cpl_error_code xsh_rec_get_nod_extract_slit_min_max	(	xsh_rec_list *	rlist,
		const double	slit_step,
		double *	smin,
		double *	smax
	)

Definition at line 1868 of file xsh_data_rec.c.

References xsh_rec_list::header, slit_step, xsh_pfits_get_nodthrow(), and xsh_rec_list_get_nslit().

Referenced by xsh_correct_scale(), xsh_correct_scale_w(), and xsh_find_image_scale_factors().

xsh_rec_get_nod_kw()

void xsh_rec_get_nod_kw	(	cpl_frame *	rec_frame,
		double *	throw,
		double *	jitter,
		double *	reloffset,
		double *	cumoffset
	)

Definition at line 1825 of file xsh_data_rec.c.

References check, XSH_ASSURE_NOT_NULL, xsh_free_propertylist(), xsh_pfits_get_nod_cumoffset(), xsh_pfits_get_nod_jitterwidth(), xsh_pfits_get_nod_reloffset(), and xsh_pfits_get_nodthrow().

xsh_rec_list1D_save_as_tab()

cpl_frame * xsh_rec_list1D_save_as_tab	(	xsh_rec_list *	list,
		const char *	filename,
		const char *	tag
	)

save an rec list to a frame

Parameters

list	the rec_list structure wich contains polynomials coefficients of the orders
filename	the name of the save file on disk
tag	rec list pro catg

Returns

two newly allocated frames

Definition at line 1453 of file xsh_data_rec.c.

References check, xsh_rec::data1, xsh_rec::errs1, xsh_rec_list::header, xsh_rec::lambda, xsh_rec_list::list, mode, xsh_rec::nlambda, xsh_rec::nslit, xsh_rec::order, order, xsh_rec::qual1, xsh_rec_list::size, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, XSH_BUNIT_FLUX_REL_C, XSH_BUNIT_NONE_C, xsh_frame_product(), xsh_free_array(), xsh_free_propertylist(), xsh_free_table(), xsh_msg, xsh_msg_dbg_high, xsh_pfits_set_bunit(), xsh_pfits_set_extname(), xsh_plist_set_extra_keys(), and XSH_TABLE_FREE.

Referenced by xsh_subtract_sky_single().

xsh_rec_list_create()

xsh_rec_list * xsh_rec_list_create

(

xsh_instrument *

instr

)

Create an empty order list.

Parameters

[in]

instr

The instrument in use

Returns

The order list structure

Definition at line 100 of file xsh_data_rec.c.

References check, xsh_instrument::config, XSH_INSTRCONFIG::orders, size, XSH_ARM_NIR, XSH_ARM_UVB, XSH_ARM_VIS, XSH_ASSURE_NOT_NULL, xsh_instrument_get_arm(), xsh_rec_list_create_with_size(), xsh_rec_list_free(), XSH_REC_TABLE_NB_NIR_ORDERS, XSH_REC_TABLE_NB_UVB_ORDERS, and XSH_REC_TABLE_NB_VIS_ORDERS.

Referenced by xsh_build_ifu_cube(), xsh_opt_extract_orders(), xsh_rec_list_duplicate(), xsh_rectify_orders(), and xsh_util_ifu_build_cube().

xsh_rec_list_create_with_size()

xsh_rec_list * xsh_rec_list_create_with_size	(	int	size,
		xsh_instrument *	instr
	)

Create an empty order list.

Parameters

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

Returns

The order list structure

Definition at line 147 of file xsh_data_rec.c.

References xsh_rec_list::header, xsh_rec_list::instrument, xsh_rec_list::list, xsh_rec_list::nslit, xsh_rec_list::size, size, xsh_rec_list::slit_max, xsh_rec_list::slit_min, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, XSH_CALLOC, XSH_NEW_PROPERTYLIST, and xsh_rec_list_free().

Referenced by xsh_combine_nod(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_rec_list_create(), xsh_wavemap_list_build_sky(), and xsh_wavemap_list_full_sky_save().

xsh_rec_list_dump()

void xsh_rec_list_dump	(	xsh_rec_list *	list,
		const char *	fname
	)

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

Parameters

list	pointer to table list
fname	File name

Definition at line 62 of file xsh_data_rec.c.

References xsh_rec_list::list, xsh_rec::nlambda, xsh_rec::nslit, xsh_rec::order, xsh_rec_list::size, and XSH_ASSURE_NOT_NULL.

xsh_rec_list_duplicate()

xsh_rec_list * xsh_rec_list_duplicate	(	xsh_rec_list *	old,
		xsh_instrument *	instrument
	)

Definition at line 226 of file xsh_data_rec.c.

References check, xsh_rec_list::header, instrument, xsh_rec_list::instrument, order, xsh_rec_list::size, xsh_free_propertylist(), xsh_instrument_duplicate(), xsh_rec_list_create(), xsh_rec_list_get_data1(), xsh_rec_list_get_errs1(), xsh_rec_list_get_lambda(), xsh_rec_list_get_nlambda(), xsh_rec_list_get_nslit(), xsh_rec_list_get_order(), xsh_rec_list_get_qual1(), xsh_rec_list_get_slit(), and xsh_rec_list_set_data_size().

xsh_rec_list_frame_invert()

cpl_frame * xsh_rec_list_frame_invert	(	cpl_frame *	rec_frame,
		const char *	tag,
		xsh_instrument *	instrument
	)

Invert the rectified flux images of the input frame into a new frame.

Parameters

rec_frame	In/out rectified frame
tag	Output Tag
instrument	Pointer to xsh_instrument structure

Returns

A new frame with all flux images inverted ( multiplied by -1)

Definition at line 713 of file xsh_data_rec.c.

References check, instrument, order, xsh_rec_list::size, XSH_ASSURE_NOT_NULL, xsh_rec_list_free(), xsh_rec_list_get_data1(), xsh_rec_list_get_nlambda(), xsh_rec_list_get_nslit(), xsh_rec_list_load(), and xsh_rec_list_save().

Referenced by main(), xsh_nod_rectify_and_shift_with_key(), and xsh_scired_slit_nod_accurate().

xsh_rec_list_free()

void xsh_rec_list_free

(

xsh_rec_list **

list

)

free memory associated to a rec_list

Parameters

list	the rec_list to free

Definition at line 760 of file xsh_data_rec.c.

References xsh_rec::data1, xsh_rec::errs1, xsh_rec::lambda, xsh_rec_list::list, xsh_rec::order, xsh_rec::qual1, xsh_rec_list::size, xsh_rec::slit, xsh_free_propertylist(), and xsh_msg_dbg_high.

Referenced by analyse_extraction(), analyse_rectify(), create_rectify_nod_list(), create_zero_rectify(), test_combine_lists(), xsh_build_ifu_cube(), xsh_combine_nod(), xsh_compute_slice_dist(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_merge_ord_with_tag(), xsh_nod_median_correct_list_per_wavelength(), xsh_opt_extract_orders(), xsh_rec_list_create(), xsh_rec_list_create_with_size(), xsh_rec_list_frame_invert(), xsh_rectify_orders(), xsh_shift(), xsh_subtract_sky_single(), xsh_util_ifu_build_cube(), xsh_wavemap_list_build_sky(), and xsh_wavemap_list_full_sky_save().

xsh_rec_list_get_data1()

float * xsh_rec_list_get_data1	(	xsh_rec_list *	list,
		int	idx
	)

Return the data1 buffer from a xsh_rec_list structure.

Parameters

list	Rectify structure pointer
idx	Index in the list

Returns

Pointer to data1 buffer

Definition at line 1045 of file xsh_data_rec.c.

References xsh_rec::data1, xsh_rec_list::list, and XSH_ASSURE_NOT_NULL.

Referenced by analyse_extraction(), analyse_rectify(), create_zero_rectify(), xsh_correct_scale(), xsh_correct_scale_w(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_find_image_scale_factors(), xsh_merge_ord_with_tag(), xsh_nod_median_correct_list_per_wavelength(), xsh_rec_list_add(), xsh_rec_list_duplicate(), xsh_rec_list_frame_invert(), xsh_rec_list_qc(), xsh_rec_list_rectify(), xsh_subtract_sky_on_obj_at_pix(), and xsh_wavemap_list_build_sky().

xsh_rec_list_get_errs1()

float * xsh_rec_list_get_errs1	(	xsh_rec_list *	list,
		int	idx
	)

Return the errs1 buffer from a xsh_rec_list structure.

Parameters

list	Rectify structure pointer
idx	Index in the list

Returns

Pointer to errs1 buffer

Definition at line 1064 of file xsh_data_rec.c.

References xsh_rec::errs1, xsh_rec_list::list, and XSH_ASSURE_NOT_NULL.

Referenced by analyse_extraction(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_find_image_scale_factors(), xsh_merge_ord_with_tag(), xsh_rec_list_add(), xsh_rec_list_duplicate(), xsh_rec_list_qc(), xsh_rec_list_rectify(), xsh_subtract_sky_on_obj_at_pix(), and xsh_wavemap_list_build_sky().

xsh_rec_list_get_header()

cpl_propertylist * xsh_rec_list_get_header

(

xsh_rec_list *

list

)

get header of the table

Parameters

list	the rec_list

Returns

the header associated to the table

Definition at line 809 of file xsh_data_rec.c.

References xsh_rec_list::header, and XSH_ASSURE_NOT_NULL.

Referenced by test_combine_lists(), and xsh_combine_nod().

xsh_rec_list_get_lambda()

double * xsh_rec_list_get_lambda	(	xsh_rec_list *	list,
		int	idx
	)

Return the lambda buffer from a xsh_rec_list structure.

Parameters

list	Rectify structure pointer
idx	Index in the list

Returns

Pointer to lambda buffer

Definition at line 1026 of file xsh_data_rec.c.

References xsh_rec::lambda, xsh_rec_list::list, and XSH_ASSURE_NOT_NULL.

Referenced by analyse_extraction(), fill_rectified(), xsh_combine_nod(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_merge_ord_with_tag(), xsh_rec_list_duplicate(), xsh_subtract_sky_on_obj_at_pix(), and xsh_wavemap_list_build_sky().

xsh_rec_list_get_lambda_max()

double xsh_rec_list_get_lambda_max

(

xsh_rec_list *

list

)

Definition at line 957 of file xsh_data_rec.c.

References xsh_rec::lambda, xsh_rec_list::list, xsh_rec::nlambda, xsh_rec_list::size, and XSH_ASSURE_NOT_NULL.

Referenced by xsh_compute_slice_dist(), xsh_opt_extract_orders(), and xsh_rec_list_update_header().

xsh_rec_list_get_lambda_min()

double xsh_rec_list_get_lambda_min

(

xsh_rec_list *

list

)

Definition at line 935 of file xsh_data_rec.c.

References xsh_rec::lambda, xsh_rec_list::list, xsh_rec_list::size, and XSH_ASSURE_NOT_NULL.

Referenced by xsh_opt_extract_orders(), and xsh_rec_list_update_header().

xsh_rec_list_get_nlambda()

int xsh_rec_list_get_nlambda	(	xsh_rec_list *	list,
		int	idx
	)

Return the number of lambda from a xsh_rec_list structure.

Parameters

list	Rectify structure pointer
idx	Index in the list

Returns

nlambda

Definition at line 865 of file xsh_data_rec.c.

References xsh_rec_list::list, xsh_rec::nlambda, and XSH_ASSURE_NOT_NULL.

Referenced by analyse_extraction(), analyse_rectify(), create_zero_rectify(), fill_rectified(), xsh_combine_nod(), xsh_correct_scale(), xsh_correct_scale_w(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_find_image_scale_factors(), xsh_merge_ord_with_tag(), xsh_qual2tab_frames(), xsh_rec_list_add(), xsh_rec_list_duplicate(), xsh_rec_list_frame_invert(), xsh_rec_list_qc(), and xsh_subtract_sky_on_obj_at_pix().

xsh_rec_list_get_nslit()

int xsh_rec_list_get_nslit	(	xsh_rec_list *	list,
		int	idx
	)

Return the number of slit from a xsh_rec_list structure.

Parameters

list	Rectify structure pointer
idx	Index in the list

Returns

Nb of slit

Definition at line 827 of file xsh_data_rec.c.

References xsh_rec_list::list, xsh_rec::nslit, and XSH_ASSURE_NOT_NULL.

Referenced by analyse_rectify(), create_zero_rectify(), fill_rectified(), test_combine_lists(), xsh_combine_nod(), xsh_correct_scale(), xsh_correct_scale_w(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_find_image_scale_factors(), xsh_merge_ord_with_tag(), xsh_qual2tab_frames(), xsh_rec_get_nod_extract_slit_min_max(), xsh_rec_list_add(), xsh_rec_list_duplicate(), xsh_rec_list_frame_invert(), xsh_rec_list_qc(), and xsh_shift().

xsh_rec_list_get_order()

int xsh_rec_list_get_order	(	xsh_rec_list *	list,
		int	idx
	)

Return the order absolute number from a xsh_rec_list structure.

Parameters

list	Rectify structure pointer
idx	Index in the list

Returns

Nb of slit

Definition at line 846 of file xsh_data_rec.c.

References xsh_rec_list::list, xsh_rec::order, and XSH_ASSURE_NOT_NULL.

Referenced by analyse_extraction(), fill_rectified(), xsh_combine_nod(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), and xsh_rec_list_duplicate().

xsh_rec_list_get_qual1()

int * xsh_rec_list_get_qual1	(	xsh_rec_list *	list,
		int	idx
	)

Return the qual1 buffer from a xsh_rec_list structure.

Parameters

list	Rectify structure pointer
idx	Index in the list

Returns

Pointer to qual1 buffer

Definition at line 1083 of file xsh_data_rec.c.

References xsh_rec_list::list, xsh_rec::qual1, and XSH_ASSURE_NOT_NULL.

Referenced by xsh_correct_scale(), xsh_correct_scale_w(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_find_image_scale_factors(), xsh_merge_ord_with_tag(), xsh_qual2tab_frames(), xsh_rec_list_add(), xsh_rec_list_duplicate(), xsh_rec_list_qc(), xsh_rec_list_rectify(), and xsh_wavemap_list_build_sky().

xsh_rec_list_get_slit()

float * xsh_rec_list_get_slit	(	xsh_rec_list *	list,
		int	idx
	)

Return the slit buffer from a xsh_rec_list structure.

Parameters

list	Rectify structure pointer
idx	Index in the list

Returns

Pointer to slit buffer

Definition at line 884 of file xsh_data_rec.c.

References xsh_rec_list::list, xsh_rec::slit, and XSH_ASSURE_NOT_NULL.

Referenced by analyse_rectify(), fill_rectified(), test_combine_lists(), xsh_combine_nod(), xsh_compute_slit_index(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_rec_list_duplicate(), and xsh_shift().

xsh_rec_list_get_slit_max()

double xsh_rec_list_get_slit_max

(

xsh_rec_list *

list

)

Return the slit max from a xsh_rec_list structure.

Parameters

list	Rectify structure pointer

Returns

Pointer to slit buffer

Definition at line 923 of file xsh_data_rec.c.

References xsh_rec_list::slit_max, and XSH_ASSURE_NOT_NULL.

xsh_rec_list_get_slit_min()

double xsh_rec_list_get_slit_min

(

xsh_rec_list *

list

)

Return the slit min from a xsh_rec_list structure.

Parameters

list	Rectify structure pointer

Returns

Pointer to slit buffer

Definition at line 903 of file xsh_data_rec.c.

References xsh_rec_list::slit_min, and XSH_ASSURE_NOT_NULL.

xsh_rec_list_load()

xsh_rec_list * xsh_rec_list_load	(	cpl_frame *	frame,
		xsh_instrument *	instrument
	)

load an rec list from a frame

Parameters

frame	the table wich contains polynomials coefficients of the orders
instrument	instrument in use

Returns

the rec list structure

Definition at line 289 of file xsh_data_rec.c.

References check, xsh_rec::data1, xsh_rec::errs1, xsh_rec_list::header, instrument, xsh_rec_list::instrument, xsh_rec::lambda, xsh_rec_list::list, xsh_rec::nlambda, xsh_rec::nslit, xsh_rec::order, order, xsh_rec::qual1, xsh_rec_list::size, size, xsh_rec::slit, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, XSH_CALLOC, xsh_free_propertylist(), xsh_get_table_value(), xsh_msg_dbg_low, xsh_msg_dbg_medium, XSH_NEW_PROPERTYLIST, xsh_rec_list_set_data_size(), XSH_REC_TABLE_COLNAME_ERRS1, XSH_REC_TABLE_COLNAME_FLUX1, XSH_REC_TABLE_COLNAME_LAMBDA, XSH_REC_TABLE_COLNAME_NLAMBDA, XSH_REC_TABLE_COLNAME_NSLIT, XSH_REC_TABLE_COLNAME_ORDER, XSH_REC_TABLE_COLNAME_QUAL1, XSH_REC_TABLE_COLNAME_SLIT, xsh_table_get_array_double(), and xsh_table_get_array_float().

Referenced by analyse_extraction(), analyse_rectify(), create_zero_rectify(), xsh_combine_nod(), xsh_compute_slice_dist(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_merge_ord_with_tag(), xsh_nod_median_correct_list_per_wavelength(), xsh_rec_list_frame_invert(), and xsh_shift().

xsh_rec_list_load_eso()

xsh_rec_list * xsh_rec_list_load_eso	(	cpl_frame *	frame,
		xsh_instrument *	instrument
	)

Definition at line 407 of file xsh_data_rec.c.

References check, xsh_rec::data1, xsh_rec::errs1, xsh_rec_list::header, instrument, xsh_rec_list::instrument, xsh_rec::lambda, xsh_rec_list::list, xsh_rec::nlambda, xsh_rec::nslit, xsh_rec::order, order, xsh_rec::qual1, xsh_rec_list::size, size, xsh_rec::slit, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, XSH_CALLOC, xsh_free_image(), xsh_free_propertylist(), xsh_msg_dbg_low, xsh_msg_dbg_medium, XSH_NEW_PROPERTYLIST, xsh_pfits_get_cdelt1(), xsh_pfits_get_cdelt2(), xsh_pfits_get_crval1(), xsh_pfits_get_crval2(), xsh_pfits_get_extname(), xsh_pfits_get_naxis1(), xsh_pfits_get_naxis2(), XSH_PRE_DATA_TYPE, XSH_PRE_ERRS_TYPE, XSH_PRE_QUAL_TYPE, and xsh_rec_list_set_data_size().

Referenced by test_xsh_create_list_from_image(), and xsh_merge_ord_with_tag().

xsh_rec_list_load_eso_1d()

xsh_rec_list * xsh_rec_list_load_eso_1d	(	cpl_frame *	frame,
		xsh_instrument *	instrument
	)

Definition at line 563 of file xsh_data_rec.c.

References check, xsh_rec::data1, xsh_rec::errs1, xsh_rec_list::header, instrument, xsh_rec_list::instrument, xsh_rec::lambda, xsh_rec_list::list, xsh_rec::nlambda, xsh_rec::order, order, xsh_rec::qual1, xsh_rec_list::size, size, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, XSH_CALLOC, xsh_free_propertylist(), xsh_free_vector(), xsh_msg_dbg_low, xsh_msg_dbg_medium, XSH_NEW_PROPERTYLIST, xsh_pfits_get_cdelt1(), xsh_pfits_get_crval1(), xsh_pfits_get_extname(), xsh_pfits_get_naxis1(), and xsh_rec_list_set_data_size().

Referenced by xsh_merge_ord_with_tag().

xsh_rec_list_save()

cpl_frame * xsh_rec_list_save	(	xsh_rec_list *	list,
		const char *	filename,
		const char *	tag,
		int	is_temp
	)

Save a rec list in a frame.

Parameters

list	The rec_list structure wich contains polynomials coefficients of the orders
filename	The name of the save file on disk
tag	The list pro catg
is_temp	CPl_TRUE if temporary file, CPL_FALSE otherwise

Returns

a newly allocated frame

Definition at line 1112 of file xsh_data_rec.c.

References check, xsh_rec::data1, xsh_rec::errs1, xsh_rec_list::header, xsh_rec::lambda, xsh_rec_list::list, mode, xsh_rec::nlambda, xsh_rec::nslit, xsh_rec::order, order, xsh_rec::qual1, xsh_rec_list::size, xsh_rec::slit, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, XSH_BUNIT_FLUX_REL_C, xsh_frame_product(), xsh_free_array(), xsh_pfits_set_bunit(), XSH_REC_TABLE_COLNAME_ERRS1, XSH_REC_TABLE_COLNAME_FLUX1, XSH_REC_TABLE_COLNAME_LAMBDA, XSH_REC_TABLE_COLNAME_NLAMBDA, XSH_REC_TABLE_COLNAME_NSLIT, XSH_REC_TABLE_COLNAME_ORDER, XSH_REC_TABLE_COLNAME_QUAL1, XSH_REC_TABLE_COLNAME_SLIT, and XSH_TABLE_FREE.

Referenced by create_rectify_nod_list(), create_zero_rectify(), xsh_combine_nod(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_nod_median_correct_list_per_wavelength(), xsh_opt_extract_orders(), xsh_rec_list_frame_invert(), xsh_rectify_orders(), xsh_shift(), and xsh_subtract_sky_single().

xsh_rec_list_save2()

cpl_frame * xsh_rec_list_save2	(	xsh_rec_list *	list,
		const char *	filename,
		const char *	tag
	)

save an rec list to a frame

Parameters

list	the rec_list structure wich contains polynomials coefficients of the orders
filename	the name of the save file on disk
tag	rec list pro catg

Returns

two newly allocated frames

Definition at line 1607 of file xsh_data_rec.c.

References check, xsh_rec::data1, xsh_rec::errs1, xsh_rec_list::header, xsh_rec::lambda, xsh_rec_list::list, mode, xsh_rec::nlambda, xsh_rec::nslit, xsh_rec::order, order, xsh_rec::qual1, xsh_rec_list::size, xsh_rec::slit, xsh_rec_list::slit_max, xsh_rec_list::slit_min, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, XSH_BUNIT_FLUX_REL_C, XSH_BUNIT_NONE_C, xsh_frame_product(), xsh_free_array(), xsh_free_image(), xsh_free_propertylist(), xsh_free_vector(), xsh_msg_dbg_high, xsh_pfits_set_bunit(), xsh_pfits_set_extname(), xsh_pfits_set_extract_slit_max(), xsh_pfits_set_extract_slit_min(), xsh_pfits_set_wcs(), xsh_pfits_set_wcs1(), xsh_plist_set_extra_keys(), XSH_PRE_QUAL_BPP, and XSH_TABLE_FREE.

Referenced by test_combine_lists(), test_xsh_create_list_from_image(), xsh_combine_nod(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_opt_extract_orders(), xsh_rec_list_qc(), xsh_rectify_orders(), and xsh_shift().

xsh_rec_list_save_table()

cpl_frame * xsh_rec_list_save_table	(	xsh_rec_list *	list,
		const char *	filename,
		const char *	tag,
		int	is_temp
	)

Save a rec list in a frame.

Parameters

list	The rec_list structure wich contains polynomials coefficients of the orders
filename	The name of the save file on disk
tag	The pro catg of the save file on disk
is_temp	CPl_TRUE if temporary file, CPL_FALSE otherwise

Returns

a newly allocated frame

Definition at line 1332 of file xsh_data_rec.c.

References check, xsh_rec_list::header, xsh_rec::lambda, xsh_rec_list::list, mode, xsh_rec::nlambda, xsh_rec::nslit, xsh_rec::order, order, xsh_rec_list::size, xsh_rec::slit, xsh_add_temporary_file(), XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, xsh_frame_product(), xsh_free_array(), XSH_REC_TABLE_COLNAME_LAMBDA, XSH_REC_TABLE_COLNAME_NLAMBDA, XSH_REC_TABLE_COLNAME_NSLIT, XSH_REC_TABLE_COLNAME_ORDER, XSH_REC_TABLE_COLNAME_SLIT, and XSH_TABLE_FREE.

Referenced by xsh_rectify_orders().

xsh_rec_list_set_data_size()

void xsh_rec_list_set_data_size	(	xsh_rec_list *	list,
		int	idx,
		int	absorder,
		int	nlambda,
		int	ns
	)

Allocate memory for the order idx of the rectify list.

Parameters

[in]	list	The rectify list
[in]	idx	The index of the order in the list
[in]	absorder	The absorder of the order
[in]	nlambda	The number of lambda values
[in]	ns	The number of slit values

Definition at line 191 of file xsh_data_rec.c.

References xsh_rec::data1, xsh_rec::errs1, xsh_rec::lambda, xsh_rec_list::list, xsh_rec::nlambda, xsh_rec::nslit, xsh_rec::order, xsh_rec::qual1, xsh_rec_list::size, size, xsh_rec::slit, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, XSH_CALLOC, XSH_CMP_INT, and xsh_msg_dbg_high.

Referenced by xsh_combine_nod(), xsh_extract_clean_with_tag(), xsh_extract_with_tag(), xsh_opt_extract_orders(), xsh_rec_list_duplicate(), xsh_rec_list_load(), xsh_rec_list_load_eso(), xsh_rec_list_load_eso_1d(), xsh_rectify_orders(), and xsh_wavemap_list_build_sky().

xsh_rec_list_set_slit_max()

cpl_error_code xsh_rec_list_set_slit_max	(	xsh_rec_list *	list,
		const double	val
	)

Set the slit max val in the xsh_rec_list structure.

Parameters

list	Rectify structure pointer
val	slit value to set

Returns

Pointer to slit buffer

Definition at line 1007 of file xsh_data_rec.c.

References xsh_rec_list::slit_max, and XSH_ASSURE_NOT_NULL.

xsh_rec_list_set_slit_min()

cpl_error_code xsh_rec_list_set_slit_min	(	xsh_rec_list *	list,
		const double	val
	)

Set the slit min val in the xsh_rec_list structure.

Parameters

list	Rectify structure pointer
val	slit value to set

Returns

Pointer to slit buffer

Definition at line 987 of file xsh_data_rec.c.

References xsh_rec_list::slit_min, and XSH_ASSURE_NOT_NULL.

xsh_rec_list_update_header()

void xsh_rec_list_update_header	(	xsh_rec_list *	rec_list,
		xsh_pre *	pre,
		xsh_rectify_param *	rec_par,
		const char *	pro_catg
	)

Update header of rectified list writing mandatory KW.

Parameters

rec_list	The rectified list to update
pre	the pre image used to build rectified list
rec_par	The rectify parameters
pro_catg	The given pro catg

Definition at line 1276 of file xsh_data_rec.c.

References check, xsh_pre::data_header, xsh_rec_list::header, xsh_rectify_param::rectif_bin_lambda, xsh_rectify_param::rectif_bin_space, xsh_rec_list::slit_max, xsh_rec_list::slit_min, XSH_ASSURE_NOT_NULL, xsh_pfits_set_pcatg(), xsh_pfits_set_rectify_bin_lambda(), xsh_pfits_set_rectify_bin_space(), xsh_pfits_set_rectify_lambda_max(), xsh_pfits_set_rectify_lambda_min(), xsh_pfits_set_rectify_space_max(), xsh_pfits_set_rectify_space_min(), xsh_rec_list_get_lambda_max(), and xsh_rec_list_get_lambda_min().

Referenced by xsh_rectify_orders().