X-shooter Pipeline Reference Manual 3.8.15
Functions
Residual table orderpos

Functions

xsh_resid_order_tabxsh_resid_order_create (int size, int *orders, double *posx, double *posy, double *resx, double *polx)
 Create a residual tab structure.
 
xsh_resid_order_tabxsh_resid_order_load (cpl_frame *resid_tab_frame)
 Load a residual tab from a frame.
 
void xsh_resid_order_free (xsh_resid_order_tab **resid)
 Free memory associated to a resid_tab.
 
cpl_frame * xsh_resid_order_save (xsh_resid_order_tab *resid, const char *filename, xsh_instrument *instrument, ORDERPOS_QC_PARAM *ord_qc_param, const char *tag)
 Save a residual tab to a frame.
 
cpl_table * xsh_resid_order_2tab (xsh_resid_order_tab *resid, xsh_instrument *instrument, ORDERPOS_QC_PARAM *ord_qc_param)
 convert a residual tab structure to a cpl_table
 

Detailed Description

Function Documentation

◆ xsh_resid_order_2tab()

cpl_table * xsh_resid_order_2tab ( xsh_resid_order_tab resid,
xsh_instrument instrument,
ORDERPOS_QC_PARAM ord_qc_param 
)

◆ xsh_resid_order_create()

xsh_resid_order_tab * xsh_resid_order_create ( int  size,
int *  orders,
double *  posx,
double *  posy,
double *  resx,
double *  polx 
)

Create a residual tab structure.

Parameters
[in]sizeThe numbers of rows in residual tab
[in]ordersArray of orders
[in]posxArray of X central position fitted
[in]posyArray of y position
[in]resxArray of difference with polynomial fitted by xsh_orderpos
[in]polxArray of polynomial fitted X position
Returns
The resid_tab allocated structure

Definition at line 78 of file xsh_data_order_resid_tab.c.

References check, xsh_resid_order_tab::header, xsh_resid_order_tab::order, xsh_resid_order_tab::pol_x, xsh_resid_order_tab::pos_x, xsh_resid_order_tab::pos_y, xsh_resid_order_tab::res_x, xsh_resid_order_tab::size, size, XSH_ASSURE_NOT_ILLEGAL, XSH_ASSURE_NOT_NULL, XSH_CALLOC, xsh_msg_dbg_low, and xsh_resid_order_free().

Referenced by create_resid_tab().

◆ xsh_resid_order_free()

void xsh_resid_order_free ( xsh_resid_order_tab **  resid)

Free memory associated to a resid_tab.

Parameters
[in,out]residThe resid_tab to free

Definition at line 204 of file xsh_data_order_resid_tab.c.

References XSH_FREE, and xsh_free_propertylist().

Referenced by create_resid_tab(), xsh_resid_order_create(), and xsh_resid_order_load().

◆ xsh_resid_order_load()

xsh_resid_order_tab * xsh_resid_order_load ( cpl_frame *  resid_tab_frame)

◆ xsh_resid_order_save()

cpl_frame * xsh_resid_order_save ( xsh_resid_order_tab resid,
const char *  filename,
xsh_instrument instrument,
ORDERPOS_QC_PARAM ord_qc_param,
const char *  tag 
)

Save a residual tab to a frame.

Parameters
residThe resid_tab structure to save
[in]filenameThe name of the save file on disk
instrumentThe instrument arm setting
ord_qc_paramThe qc parameter structure
tagorder list pro catg
Returns
A newly allocated residual tab frame

Definition at line 240 of file xsh_data_order_resid_tab.c.

References check, xsh_resid_order_tab::header, instrument, ORDERPOS_QC_PARAM::nposall, ORDERPOS_QC_PARAM::npossel, xsh_resid_order_tab::order, xsh_resid_order_tab::pol_x, xsh_resid_order_tab::pos_x, xsh_resid_order_tab::pos_y, QC_ORD_ORDERPOS_RESIDAVG, QC_ORD_ORDERPOS_RESIDAVG_SEL, QC_ORD_ORDERPOS_RESIDMAX, QC_ORD_ORDERPOS_RESIDMAX_SEL, QC_ORD_ORDERPOS_RESIDMIN, QC_ORD_ORDERPOS_RESIDMIN_SEL, QC_ORD_ORDERPOS_RESIDRMS, QC_ORD_ORDERPOS_RESIDRMS_SEL, xsh_resid_order_tab::res_x, xsh_resid_order_tab::residavg, xsh_resid_order_tab::residavg_sel, xsh_resid_order_tab::residmax, xsh_resid_order_tab::residmax_sel, xsh_resid_order_tab::residmin, xsh_resid_order_tab::residmin_sel, xsh_resid_order_tab::residrms, xsh_resid_order_tab::residrms_sel, xsh_resid_order_tab::size, XSH_ASSURE_NOT_NULL, xsh_frame_product(), xsh_free_frame(), xsh_msg_dbg_high, xsh_pfits_set_pcatg(), xsh_pfits_set_qc(), XSH_RESID_ORDER_TABLE_COLNAME_ORDER, XSH_RESID_ORDER_TABLE_COLNAME_POLX, XSH_RESID_ORDER_TABLE_COLNAME_POSX, XSH_RESID_ORDER_TABLE_COLNAME_POSY, XSH_RESID_ORDER_TABLE_COLNAME_RESX, XSH_RESID_ORDER_TABLE_NB_COL, XSH_RESID_ORDER_TABLE_UNIT_ORDER, XSH_RESID_ORDER_TABLE_UNIT_POLX, XSH_RESID_ORDER_TABLE_UNIT_POSX, XSH_RESID_ORDER_TABLE_UNIT_POSY, XSH_RESID_ORDER_TABLE_UNIT_RESX, XSH_RESIDX_THRESHOLD, XSH_TABLE_FREE, and XSH_TABLE_NEW_COL.

Referenced by create_resid_tab().