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

Go to the source code of this file.

Data Structures

struct  xsh_resid_order_tab
 

Macros

#define XSH_RESID_ORDER_TABLE_NB_COL   4
 
#define XSH_RESID_ORDER_TABLE_COLNAME_ORDER   "Order"
 
#define XSH_RESID_ORDER_TABLE_UNIT_ORDER   "none"
 
#define XSH_RESID_ORDER_TABLE_COLNAME_POSX   "X"
 
#define XSH_RESID_ORDER_TABLE_UNIT_POSX   "pixel"
 
#define XSH_RESID_ORDER_TABLE_COLNAME_POSY   "Y"
 
#define XSH_RESID_ORDER_TABLE_UNIT_POSY   "pixel"
 
#define XSH_RESID_ORDER_TABLE_COLNAME_RESX   "RESX"
 
#define XSH_RESID_ORDER_TABLE_UNIT_RESX   "pixel"
 
#define XSH_RESID_ORDER_TABLE_COLNAME_POLX   "POLX"
 
#define XSH_RESID_ORDER_TABLE_UNIT_POLX   "pixel"
 
#define PROPERTY_GET(OBJECT, PROPERTY, TYPE, DEFAULT)
 
#define RESID_ORDER_PROPERTY_GET(PROPERTY, TYPE, DEFAULT)    PROPERTY_GET( xsh_resid_tab, PROPERTY, TYPE, DEFAULT)
 

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
 

Macro Definition Documentation

◆ PROPERTY_GET

#define PROPERTY_GET (   OBJECT,
  PROPERTY,
  TYPE,
  DEFAULT 
)
Value:
TYPE OBJECT##_get_##PROPERTY( OBJECT* obj)\
{\
TYPE result = DEFAULT;\
\
XSH_ASSURE_NOT_NULL( obj);\
result = obj->PROPERTY;\
\
cleanup:\
return result;\
}

Definition at line 48 of file xsh_data_order_resid_tab.h.

◆ RESID_ORDER_PROPERTY_GET

#define RESID_ORDER_PROPERTY_GET (   PROPERTY,
  TYPE,
  DEFAULT 
)     PROPERTY_GET( xsh_resid_tab, PROPERTY, TYPE, DEFAULT)

Definition at line 61 of file xsh_data_order_resid_tab.h.

◆ XSH_RESID_ORDER_TABLE_COLNAME_ORDER

#define XSH_RESID_ORDER_TABLE_COLNAME_ORDER   "Order"

Definition at line 33 of file xsh_data_order_resid_tab.h.

◆ XSH_RESID_ORDER_TABLE_COLNAME_POLX

#define XSH_RESID_ORDER_TABLE_COLNAME_POLX   "POLX"

Definition at line 44 of file xsh_data_order_resid_tab.h.

◆ XSH_RESID_ORDER_TABLE_COLNAME_POSX

#define XSH_RESID_ORDER_TABLE_COLNAME_POSX   "X"

Definition at line 36 of file xsh_data_order_resid_tab.h.

◆ XSH_RESID_ORDER_TABLE_COLNAME_POSY

#define XSH_RESID_ORDER_TABLE_COLNAME_POSY   "Y"

Definition at line 38 of file xsh_data_order_resid_tab.h.

◆ XSH_RESID_ORDER_TABLE_COLNAME_RESX

#define XSH_RESID_ORDER_TABLE_COLNAME_RESX   "RESX"

Definition at line 41 of file xsh_data_order_resid_tab.h.

◆ XSH_RESID_ORDER_TABLE_NB_COL

#define XSH_RESID_ORDER_TABLE_NB_COL   4

Definition at line 31 of file xsh_data_order_resid_tab.h.

◆ XSH_RESID_ORDER_TABLE_UNIT_ORDER

#define XSH_RESID_ORDER_TABLE_UNIT_ORDER   "none"

Definition at line 34 of file xsh_data_order_resid_tab.h.

◆ XSH_RESID_ORDER_TABLE_UNIT_POLX

#define XSH_RESID_ORDER_TABLE_UNIT_POLX   "pixel"

Definition at line 45 of file xsh_data_order_resid_tab.h.

◆ XSH_RESID_ORDER_TABLE_UNIT_POSX

#define XSH_RESID_ORDER_TABLE_UNIT_POSX   "pixel"

Definition at line 37 of file xsh_data_order_resid_tab.h.

◆ XSH_RESID_ORDER_TABLE_UNIT_POSY

#define XSH_RESID_ORDER_TABLE_UNIT_POSY   "pixel"

Definition at line 39 of file xsh_data_order_resid_tab.h.

◆ XSH_RESID_ORDER_TABLE_UNIT_RESX

#define XSH_RESID_ORDER_TABLE_UNIT_RESX   "pixel"

Definition at line 42 of file xsh_data_order_resid_tab.h.