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

Go to the source code of this file.

Data Structures

struct  xsh_rec
 
struct  xsh_rec_list
 

Macros

#define XSH_REC_TABLE_NB_UVB_ORDERS   11
 
#define XSH_REC_TABLE_NB_VIS_ORDERS   14
 
#define XSH_REC_TABLE_NB_NIR_ORDERS   16
 
#define XSH_REC_TABLE_COLNAME_ORDER   "ORDER"
 
#define XSH_REC_TABLE_COLNAME_NLAMBDA   "NLAMBDA"
 
#define XSH_REC_TABLE_COLNAME_NSLIT   "NSLIT"
 
#define XSH_REC_TABLE_COLNAME_LAMBDA   "LAMBDA"
 
#define XSH_REC_TABLE_COLNAME_SLIT   "SLIT"
 
#define XSH_REC_TABLE_COLNAME_FLUX1   "FLUX1"
 
#define XSH_REC_TABLE_COLNAME_FLUX2   "FLUX2"
 
#define XSH_REC_TABLE_COLNAME_FLUX3   "FLUX3"
 
#define XSH_REC_TABLE_COLNAME_ERRS1   "ERRS1"
 
#define XSH_REC_TABLE_COLNAME_ERRS2   "ERRS2"
 
#define XSH_REC_TABLE_COLNAME_ERRS3   "ERRS3"
 
#define XSH_REC_TABLE_COLNAME_QUAL1   "QUAL1"
 
#define XSH_REC_TABLE_COLNAME_QUAL2   "QUAL2"
 
#define XSH_REC_TABLE_COLNAME_QUAL3   "QUAL3"
 

Functions

xsh_rec_listxsh_rec_list_create (xsh_instrument *instr)
 Create an empty order list.
 
xsh_rec_listxsh_rec_list_create_with_size (int size, xsh_instrument *instr)
 Create an empty order list.
 
xsh_rec_listxsh_rec_list_load (cpl_frame *frame, xsh_instrument *instr)
 load an rec list from a frame
 
xsh_rec_listxsh_rec_list_load_eso (cpl_frame *frame, xsh_instrument *instr)
 
xsh_rec_listxsh_rec_list_load_eso_1d (cpl_frame *frame, xsh_instrument *instr)
 
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.
 
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_list_save2 (xsh_rec_list *list, const char *filename, const char *tag)
 save an rec list to 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
 
void xsh_rec_list_free (xsh_rec_list **list)
 free memory associated to a rec_list
 
xsh_rec_listxsh_rec_list_duplicate (xsh_rec_list *old, 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_dump (xsh_rec_list *list, const char *fname)
 
void xsh_rec_list_set_data_size (xsh_rec_list *list, int idx, int ordnum, int nlambda, int ns)
 Allocate memory for the order idx of the rectify list.
 
void xsh_rec_list_update_header (xsh_rec_list *list, xsh_pre *pre, xsh_rectify_param *rec_par, const char *pro_catg)
 Update header of rectified list writing mandatory KW.
 
cpl_propertylist * xsh_rec_list_get_header (xsh_rec_list *list)
 get header of the table
 
float * xsh_rec_list_get_slit (xsh_rec_list *list, int idx)
 
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)
 
int xsh_rec_list_get_order (xsh_rec_list *list, int idx)
 
int xsh_rec_list_get_nslit (xsh_rec_list *list, int idx)
 
int xsh_rec_list_get_nlambda (xsh_rec_list *list, int idx)
 
void xsh_rec_get_nod_kw (cpl_frame *rec_frame, double *throw, double *jitter, double *reloffset, double *cumoffset)
 
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)
 
void xsh_compute_slit_index (float slit_min, float slit_step, xsh_rec_list **from, int *slit_index_tab, int size)
 
void xsh_rec_list_add (xsh_rec_list *dest, xsh_rec_list **from, int *slit_index, int nb_frames, int no, int method, const int decode_bp)
 
cpl_error_code xsh_rec_get_nod_extract_slit_min_max (xsh_rec_list *rlist, const double slit_step, double *smin, double *smax)
 

Macro Definition Documentation

◆ XSH_REC_TABLE_COLNAME_ERRS1

#define XSH_REC_TABLE_COLNAME_ERRS1   "ERRS1"

Definition at line 55 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_ERRS2

#define XSH_REC_TABLE_COLNAME_ERRS2   "ERRS2"

Definition at line 56 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_ERRS3

#define XSH_REC_TABLE_COLNAME_ERRS3   "ERRS3"

Definition at line 57 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_FLUX1

#define XSH_REC_TABLE_COLNAME_FLUX1   "FLUX1"

Definition at line 52 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_FLUX2

#define XSH_REC_TABLE_COLNAME_FLUX2   "FLUX2"

Definition at line 53 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_FLUX3

#define XSH_REC_TABLE_COLNAME_FLUX3   "FLUX3"

Definition at line 54 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_LAMBDA

#define XSH_REC_TABLE_COLNAME_LAMBDA   "LAMBDA"

Definition at line 46 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_NLAMBDA

#define XSH_REC_TABLE_COLNAME_NLAMBDA   "NLAMBDA"

Definition at line 40 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_NSLIT

#define XSH_REC_TABLE_COLNAME_NSLIT   "NSLIT"

Definition at line 41 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_ORDER

#define XSH_REC_TABLE_COLNAME_ORDER   "ORDER"

Definition at line 39 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_QUAL1

#define XSH_REC_TABLE_COLNAME_QUAL1   "QUAL1"

Definition at line 58 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_QUAL2

#define XSH_REC_TABLE_COLNAME_QUAL2   "QUAL2"

Definition at line 59 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_QUAL3

#define XSH_REC_TABLE_COLNAME_QUAL3   "QUAL3"

Definition at line 60 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_COLNAME_SLIT

#define XSH_REC_TABLE_COLNAME_SLIT   "SLIT"

Definition at line 47 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_NB_NIR_ORDERS

#define XSH_REC_TABLE_NB_NIR_ORDERS   16

Definition at line 36 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_NB_UVB_ORDERS

#define XSH_REC_TABLE_NB_UVB_ORDERS   11

Definition at line 34 of file xsh_data_rec.h.

◆ XSH_REC_TABLE_NB_VIS_ORDERS

#define XSH_REC_TABLE_NB_VIS_ORDERS   14

Definition at line 35 of file xsh_data_rec.h.