Line Tilt
[Data Format Handling functions]

Functions

xsh_linetilt_listxsh_linetilt_list_new (int size, cpl_propertylist *header)
void xsh_linetilt_list_free (xsh_linetilt_list **list)
 free memory associated to a arclist
void xsh_linetilt_free (xsh_linetilt **tilt)
 free memory associated to a linetilt
xsh_linetiltxsh_linetilt_new (void)
void xsh_linetilt_list_add (xsh_linetilt_list *list, xsh_linetilt *line, int idx)
cpl_frame * xsh_linetilt_list_save (xsh_linetilt_list *list, xsh_instrument *instr, const char *filename, const char *tag, const double kappa, const int niter)
 save a (ks clip clean) linetilt list to a frame
double * xsh_linetilt_list_get_posx (xsh_linetilt_list *list)
 get the X central positions. The returned array must be deallocated by the caller.
double * xsh_linetilt_list_get_posy (xsh_linetilt_list *list)
 get the Y central positions. The returned array must be deallocated by the caller.
double * xsh_linetilt_list_get_deltay (xsh_linetilt_list *list)
 get the Y Delta. The returned array must be deallocated by the caller.
double * xsh_linetilt_list_get_sigma_y (xsh_linetilt_list *list)
 get the Y sigma. The returned array must be deallocated by the caller.
double * xsh_linetilt_list_get_pre_posy (xsh_linetilt_list *list)
 get the previous Y positions. The returned array must be deallocated by the caller.
double * xsh_linetilt_list_get_orders (xsh_linetilt_list *list)
 get the orders . The returned array must be deallocated by the caller.
double * xsh_linetilt_list_get_wavelengths (xsh_linetilt_list *list)
 get the wavelength . The returned array must be deallocated by the caller.
double * xsh_linetilt_list_get_slits (xsh_linetilt_list *list)
 get the slits . The returned array must be deallocated by the caller.
int * xsh_linetilt_list_get_slit_index (xsh_linetilt_list *list)
 get the slit_index array . The returned array must be deallocated by the caller.
cpl_propertylist * xsh_linetilt_list_get_header (xsh_linetilt_list *list)
int xsh_linetilt_is_duplicate (xsh_linetilt_list *list, float lambda, int order)

Function Documentation

void xsh_linetilt_free ( xsh_linetilt **  tilt  ) 

free memory associated to a linetilt

Parameters:
tilt the linetilt to free

Definition at line 107 of file xsh_data_linetilt.c.

Referenced by xsh_linetilt_list_free().

int xsh_linetilt_is_duplicate ( xsh_linetilt_list list,
float  lambda,
int  order 
)

Check if a given wavelength/order pair is already in the list.

Parameters:
list Linetilt list
lambda Wavelength
order Order
Returns:
0 if the wavelength/order is already in the list, 1 otherwise

Definition at line 587 of file xsh_data_linetilt.c.

References xsh_linetilt_list::list, xsh_linetilt::order, xsh_linetilt_list::size, xsh_linetilt::wavelength, and XSH_ASSURE_NOT_NULL.

void xsh_linetilt_list_add ( xsh_linetilt_list list,
xsh_linetilt line,
int  idx 
)

Add a new entry to a linetilt list.

Parameters:
list Linetilt Liste
line Pointer to the linetilt to add
idx Index where to add the linetilt

Definition at line 135 of file xsh_data_linetilt.c.

References xsh_linetilt_list::list, xsh_linetilt_list::size, and XSH_ASSURE_NOT_NULL.

Referenced by xsh_follow_arclines().

void xsh_linetilt_list_free ( xsh_linetilt_list **  list  ) 

free memory associated to a arclist

Parameters:
list the arclist to free

Definition at line 84 of file xsh_data_linetilt.c.

References xsh_free_propertylist(), and xsh_linetilt_free().

Referenced by xsh_follow_arclines().

double* xsh_linetilt_list_get_deltay ( xsh_linetilt_list list  ) 

get the Y Delta. The returned array must be deallocated by the caller.

Parameters:
list The tilt-list
Returns:
return a created array of Y delta

Definition at line 399 of file xsh_data_linetilt.c.

References check, xsh_linetilt::deltay, xsh_linetilt_list::list, xsh_linetilt_list::size, size, and XSH_ASSURE_NOT_NULL.

cpl_propertylist* xsh_linetilt_list_get_header ( xsh_linetilt_list list  ) 

Returns a pointer to the propertylist. MUST not be deallocated directly by the caller (use xsh_linetilt_free).

Parameters:
list Linetilt List
Returns:
Pointer to the propertylist

Definition at line 566 of file xsh_data_linetilt.c.

References xsh_linetilt_list::header, and XSH_ASSURE_NOT_NULL.

double* xsh_linetilt_list_get_orders ( xsh_linetilt_list list  ) 

get the orders . The returned array must be deallocated by the caller.

Parameters:
list The tilt-list
Returns:
return a created array of orders

Definition at line 474 of file xsh_data_linetilt.c.

References check, xsh_linetilt_list::list, xsh_linetilt::order, xsh_linetilt_list::size, size, and XSH_ASSURE_NOT_NULL.

double* xsh_linetilt_list_get_posx ( xsh_linetilt_list list  ) 

get the X central positions. The returned array must be deallocated by the caller.

Parameters:
list The tilt-list
Returns:
return a created array of X positions

Definition at line 353 of file xsh_data_linetilt.c.

References xsh_linetilt::cenposx, check, xsh_linetilt_list::list, xsh_linetilt_list::size, size, and XSH_ASSURE_NOT_NULL.

double* xsh_linetilt_list_get_posy ( xsh_linetilt_list list  ) 

get the Y central positions. The returned array must be deallocated by the caller.

Parameters:
list The tilt-list
Returns:
return a created array of Y positions

Definition at line 376 of file xsh_data_linetilt.c.

References xsh_linetilt::cenposy, check, xsh_linetilt_list::list, xsh_linetilt_list::size, size, and XSH_ASSURE_NOT_NULL.

double* xsh_linetilt_list_get_pre_posy ( xsh_linetilt_list list  ) 

get the previous Y positions. The returned array must be deallocated by the caller.

Parameters:
list The tilt-list
Returns:
return a created array of previous Y positions

Definition at line 449 of file xsh_data_linetilt.c.

References check, xsh_linetilt_list::list, xsh_linetilt::pre_pos_y, xsh_linetilt_list::size, size, and XSH_ASSURE_NOT_NULL.

double* xsh_linetilt_list_get_sigma_y ( xsh_linetilt_list list  ) 

get the Y sigma. The returned array must be deallocated by the caller.

Parameters:
list The tilt-list
Returns:
return a created array of Y sigma

Definition at line 424 of file xsh_data_linetilt.c.

References check, xsh_linetilt::chisq, xsh_linetilt_list::list, xsh_linetilt_list::size, size, and XSH_ASSURE_NOT_NULL.

int* xsh_linetilt_list_get_slit_index ( xsh_linetilt_list list  ) 

get the slit_index array . The returned array must be deallocated by the caller.

Parameters:
list The tilt-list
Returns:
return a created array of slit indexes

Definition at line 543 of file xsh_data_linetilt.c.

References check, xsh_linetilt_list::list, xsh_linetilt_list::size, size, xsh_linetilt::slit_index, and XSH_ASSURE_NOT_NULL.

double* xsh_linetilt_list_get_slits ( xsh_linetilt_list list  ) 

get the slits . The returned array must be deallocated by the caller.

Parameters:
list The tilt-list
Returns:
return a created array of orders

Definition at line 520 of file xsh_data_linetilt.c.

References check, xsh_linetilt_list::list, xsh_linetilt_list::size, size, xsh_linetilt::slit, and XSH_ASSURE_NOT_NULL.

double* xsh_linetilt_list_get_wavelengths ( xsh_linetilt_list list  ) 

get the wavelength . The returned array must be deallocated by the caller.

Parameters:
list The tilt-list
Returns:
return a created array of orders

Definition at line 497 of file xsh_data_linetilt.c.

References check, xsh_linetilt_list::list, xsh_linetilt_list::size, size, xsh_linetilt::wavelength, and XSH_ASSURE_NOT_NULL.

xsh_linetilt_list* xsh_linetilt_list_new ( int  size,
cpl_propertylist *  header 
)
cpl_frame* xsh_linetilt_list_save ( xsh_linetilt_list list,
xsh_instrument instr,
const char *  filename,
const char *  tag,
const double  kappa,
const int  niter 
)

save a (ks clip clean) linetilt list to a frame

Parameters:
list the linetilt list structure to save
instr Pointer to instrument description structure
filename the name of the save file on disk
tag the pro catg of the save file on disk
kappa kappa value of ks clip
niter niter value of ks clip
Returns:
a newly allocated frame

Definition at line 158 of file xsh_data_linetilt.c.

References xsh_linetilt::area, xsh_linetilt::cenposx, xsh_linetilt::cenposy, check, xsh_linetilt::chisq, xsh_linetilt::deltay, xsh_linetilt::flag, xsh_linetilt_list::header, xsh_linetilt::intensity, xsh_linetilt_list::list, xsh_linetilt::name, xsh_linetilt::order, xsh_linetilt::pre_pos_y, xsh_linetilt::shift_y, xsh_linetilt_list::size, xsh_linetilt::specres, xsh_linetilt::tilt, xsh_linetilt::tilt_y, xsh_linetilt::wavelength, xsh_add_temporary_file(), XSH_ASSURE_NOT_NULL, xsh_frame_product(), XSH_GET_TAG_FROM_MODE, XSH_LINETILT_TABLE_COLNAME_CENPOSX, XSH_LINETILT_TABLE_COLNAME_CENPOSY, XSH_LINETILT_TABLE_COLNAME_CHISQ, XSH_LINETILT_TABLE_COLNAME_FLAG, XSH_LINETILT_TABLE_COLNAME_FLUX, XSH_LINETILT_TABLE_COLNAME_FWHM, XSH_LINETILT_TABLE_COLNAME_GAUSSY, XSH_LINETILT_TABLE_COLNAME_INTENSITY, XSH_LINETILT_TABLE_COLNAME_NAME, XSH_LINETILT_TABLE_COLNAME_ORDER, XSH_LINETILT_TABLE_COLNAME_SHIFTY, XSH_LINETILT_TABLE_COLNAME_SPECRES, XSH_LINETILT_TABLE_COLNAME_TILT, XSH_LINETILT_TABLE_COLNAME_TILTY, XSH_LINETILT_TABLE_COLNAME_WAVELENGTH, XSH_LINETILT_TABLE_NB_COL, XSH_LINETILT_TABLE_UNIT_CENPOSX, XSH_LINETILT_TABLE_UNIT_CENPOSY, XSH_LINETILT_TABLE_UNIT_CHISQ, XSH_LINETILT_TABLE_UNIT_FLAG, XSH_LINETILT_TABLE_UNIT_FLUX, XSH_LINETILT_TABLE_UNIT_FWHM, XSH_LINETILT_TABLE_UNIT_GAUSSY, XSH_LINETILT_TABLE_UNIT_INTENSITY, XSH_LINETILT_TABLE_UNIT_NAME, XSH_LINETILT_TABLE_UNIT_ORDER, XSH_LINETILT_TABLE_UNIT_SHIFTY, XSH_LINETILT_TABLE_UNIT_SPECRES, XSH_LINETILT_TABLE_UNIT_TILT, XSH_LINETILT_TABLE_UNIT_TILTY, XSH_LINETILT_TABLE_UNIT_WAVELENGTH, xsh_pfits_set_pcatg(), XSH_TABLE_FREE, and XSH_TILT_TAB.

Referenced by xsh_follow_arclines().

xsh_linetilt* xsh_linetilt_new ( void   ) 

Definition at line 118 of file xsh_data_linetilt.c.

References XSH_CALLOC.

Referenced by xsh_follow_arclines().


Generated on 9 Mar 2011 for X-shooter Pipeline Reference Manual by  doxygen 1.6.1