X-shooter Pipeline Reference Manual 3.8.15
Data Structures | Macros | Functions
xsh_data_order.h File Reference
#include <cpl.h>
#include <xsh_data_instrument.h>

Go to the source code of this file.

Data Structures

struct  xsh_order
 
struct  xsh_order_list
 
struct  ORDERPOS_QC_PARAM
 

Macros

#define XSH_ORDER_TABLE_COLNAME_ORDER   "ORDER"
 
#define XSH_ORDER_TABLE_COLNAME_ABSORDER   "ABSORDER"
 
#define XSH_ORDER_TABLE_COLNAME_CENTER   "CENCOEF"
 
#define XSH_ORDER_TABLE_COLNAME_EDGUP   "EDGUPCOEF"
 
#define XSH_ORDER_TABLE_COLNAME_EDGLO   "EDGLOCOEF"
 
#define XSH_ORDER_TABLE_COLNAME_SLICUP   "SLICUPCOEF"
 
#define XSH_ORDER_TABLE_COLNAME_SLICLO   "SLICLOCOEF"
 
#define XSH_ORDER_TABLE_DEGY   "DEGY"
 
#define XSH_ORDER_TABLE_COLNAME_STARTY   "STARTY"
 
#define XSH_ORDER_TABLE_COLNAME_ENDY   "ENDY"
 
#define XSH_ORDER_TABLE_COLNAME_CENTERX   "CENTER_X"
 
#define XSH_ORDER_TABLE_COLNAME_CENTERY   "CENTER_Y"
 
#define XSH_ORDER_TABLE_COLNAME_EDGUPX   "EDG_UP_X"
 
#define XSH_ORDER_TABLE_COLNAME_EDGUPY   "EDG_UP_Y"
 
#define XSH_ORDER_TABLE_COLNAME_EDGLOX   "EDG_LO_X"
 
#define XSH_ORDER_TABLE_COLNAME_EDGLOY   "EDG_LO_Y"
 
#define XSH_ORDER_TABLE_COLNAME_SLICLOX   "SLIC_LO_X"
 
#define XSH_ORDER_TABLE_COLNAME_SLICLOY   "SLIC_LO_Y"
 
#define XSH_ORDER_TABLE_COLNAME_SLICUPX   "SLIC_UP_X"
 
#define XSH_ORDER_TABLE_COLNAME_SLICUPY   "SLIC_UP_Y"
 

Functions

xsh_order_listxsh_order_list_new (int size)
 Create a new order list from size (no check)
 
xsh_order_listxsh_order_list_create (xsh_instrument *instr)
 create an empty order list
 
xsh_order_listxsh_order_list_load (cpl_frame *frame, xsh_instrument *instr)
 load an order list from a frame
 
cpl_propertylist * xsh_order_list_get_header (xsh_order_list *list)
 get header of the table
 
void xsh_order_list_set_starty (xsh_order_list *list, int i, int starty)
 
void xsh_order_list_set_endy (xsh_order_list *list, int i, int endy)
 
int xsh_order_list_get_starty (xsh_order_list *list, int i)
 get position on Y axis of first pixel detected on order
 
int xsh_order_list_get_endy (xsh_order_list *list, int i)
 get position on Y axis of last pixel detected on order
 
int xsh_order_list_get_index_by_absorder (xsh_order_list *list, double absorder)
 
void xsh_order_list_free (xsh_order_list **list)
 free memory associated to an order_list
 
xsh_order_listxsh_order_list_merge (xsh_order_list *lista, xsh_order_list *listb)
 
cpl_frame * xsh_order_list_save (xsh_order_list *list, xsh_instrument *instrument, const char *filename, const char *tag, const int ny)
 Save an order list to a frame.
 
void xsh_order_list_set_bin_x (xsh_order_list *list, int bin)
 Set the bin of image in x.
 
void xsh_order_list_set_bin_y (xsh_order_list *list, int bin)
 Set the bin of image in y.
 
double xsh_order_list_eval (xsh_order_list *list, cpl_polynomial *poly, double y)
 Evaluate an order list poly.
 
int xsh_order_list_eval_int (xsh_order_list *list, cpl_polynomial *poly, double y)
 Evaluate an order list poly but return the central pixel position rounding the polynomial.
 
void xsh_order_list_dump (xsh_order_list *list, const char *fname)
 
void xsh_order_list_fit (xsh_order_list *list, int size, double *vorderdata, double *posx, double *posy, int deg_poly)
 fit the polynomial solution of given points
 
int xsh_order_list_get_order (xsh_order_list *list, int absorder)
 
void xsh_order_list_verify (xsh_order_list *list, int ny)
 
void xsh_order_list_apply_shift (xsh_order_list *list, double xshift, double yshift)
 Shift a order list.
 
void xsh_order_split_qth_d2 (cpl_frame *order_tab_frame, cpl_frame *spectrum_format_frame, cpl_frame **qth_order_tab_frame, cpl_frame **d2_order_tab_frame, xsh_instrument *instr)
 

Macro Definition Documentation

◆ XSH_ORDER_TABLE_COLNAME_ABSORDER

#define XSH_ORDER_TABLE_COLNAME_ABSORDER   "ABSORDER"

Definition at line 33 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_CENTER

#define XSH_ORDER_TABLE_COLNAME_CENTER   "CENCOEF"

Definition at line 34 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_CENTERX

#define XSH_ORDER_TABLE_COLNAME_CENTERX   "CENTER_X"

Definition at line 43 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_CENTERY

#define XSH_ORDER_TABLE_COLNAME_CENTERY   "CENTER_Y"

Definition at line 44 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_EDGLO

#define XSH_ORDER_TABLE_COLNAME_EDGLO   "EDGLOCOEF"

Definition at line 36 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_EDGLOX

#define XSH_ORDER_TABLE_COLNAME_EDGLOX   "EDG_LO_X"

Definition at line 47 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_EDGLOY

#define XSH_ORDER_TABLE_COLNAME_EDGLOY   "EDG_LO_Y"

Definition at line 48 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_EDGUP

#define XSH_ORDER_TABLE_COLNAME_EDGUP   "EDGUPCOEF"

Definition at line 35 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_EDGUPX

#define XSH_ORDER_TABLE_COLNAME_EDGUPX   "EDG_UP_X"

Definition at line 45 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_EDGUPY

#define XSH_ORDER_TABLE_COLNAME_EDGUPY   "EDG_UP_Y"

Definition at line 46 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_ENDY

#define XSH_ORDER_TABLE_COLNAME_ENDY   "ENDY"

Definition at line 41 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_ORDER

#define XSH_ORDER_TABLE_COLNAME_ORDER   "ORDER"

Definition at line 32 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_SLICLO

#define XSH_ORDER_TABLE_COLNAME_SLICLO   "SLICLOCOEF"

Definition at line 38 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_SLICLOX

#define XSH_ORDER_TABLE_COLNAME_SLICLOX   "SLIC_LO_X"

Definition at line 49 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_SLICLOY

#define XSH_ORDER_TABLE_COLNAME_SLICLOY   "SLIC_LO_Y"

Definition at line 50 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_SLICUP

#define XSH_ORDER_TABLE_COLNAME_SLICUP   "SLICUPCOEF"

Definition at line 37 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_SLICUPX

#define XSH_ORDER_TABLE_COLNAME_SLICUPX   "SLIC_UP_X"

Definition at line 51 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_SLICUPY

#define XSH_ORDER_TABLE_COLNAME_SLICUPY   "SLIC_UP_Y"

Definition at line 52 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_COLNAME_STARTY

#define XSH_ORDER_TABLE_COLNAME_STARTY   "STARTY"

Definition at line 40 of file xsh_data_order.h.

◆ XSH_ORDER_TABLE_DEGY

#define XSH_ORDER_TABLE_DEGY   "DEGY"

Definition at line 39 of file xsh_data_order.h.

Function Documentation

◆ xsh_order_list_set_endy()

void xsh_order_list_set_endy ( xsh_order_list list,
int  i,
int  endy 
)

◆ xsh_order_list_set_starty()

void xsh_order_list_set_starty ( xsh_order_list list,
int  i,
int  starty 
)