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

Go to the source code of this file.

Data Structures

struct  xsh_spectralformat
 
struct  xsh_spectralformat_list
 

Macros

#define XSH_SPECTRALFORMAT_TABLE_NB_UVB_ROWS   11
 
#define XSH_SPECTRALFORMAT_TABLE_NB_VIS_ROWS   14
 
#define XSH_SPECTRALFORMAT_TABLE_NB_NIR_ROWS   16
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_ORDER   "ORDER"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_LAMP   "LAMP"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMINFUL   "WLMINFUL"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMIN   "WLMIN"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMAX   "WLMAX"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMAXFUL   "WLMAXFUL"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_DISP_MIN   "DISP_MIN"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_DISP_MAX   "DISP_MAX"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_FLSR   "LFSR"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_UFSR   "UFSR"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_XMIN   "XMIN"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_XMAX   "XMAX"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_YMIN   "YMIN"
 
#define XSH_SPECTRALFORMAT_TABLE_COLNAME_YMAX   "YMAX"
 

Functions

xsh_spectralformat_listxsh_spectralformat_list_create (int size, xsh_instrument *instr)
 Create an empty spectralformat list.
 
xsh_spectralformat_listxsh_spectralformat_list_load (cpl_frame *frame, xsh_instrument *instr)
 Load a spectralformat list from a frame.
 
void xsh_spectralformat_list_free (xsh_spectralformat_list **list)
 Free memory associated to an spactralformat_list.
 
void xsh_spectralformat_list_dump (xsh_spectralformat_list *list, const char *fname)
 Dump main info about an order table (for each order of the list)
 
float xsh_spectralformat_list_get_lambda_min (xsh_spectralformat_list *list, int absorder)
 Returns lambda min for a given absolute order.
 
float xsh_spectralformat_list_get_lambda_max (xsh_spectralformat_list *list, int absorder)
 
const char * xsh_spectralformat_list_get_lamp (xsh_spectralformat_list *list, int absorder)
 
cpl_propertylist * xsh_spectralformat_list_get_header (xsh_spectralformat_list *list)
 Get header of the table.
 
cpl_vector * xsh_spectralformat_list_get_orders (xsh_spectralformat_list *list, float lambda)
 Returns list of absolute orders containing lambda.
 
int xsh_spectralformat_list_get_dist_order (xsh_spectralformat_list *list)
 
void xsh_spectralformat_check_wlimit (xsh_spectralformat_list *list, xsh_order_list *order, xsh_wavesol *w, xsh_xs_3 *model, xsh_instrument *instr)
 

Macro Definition Documentation

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_DISP_MAX

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_DISP_MAX   "DISP_MAX"

Definition at line 46 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_DISP_MIN

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_DISP_MIN   "DISP_MIN"

Definition at line 45 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_FLSR

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_FLSR   "LFSR"

Definition at line 47 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_LAMP

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_LAMP   "LAMP"

Definition at line 39 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_ORDER

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_ORDER   "ORDER"

Definition at line 38 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_UFSR

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_UFSR   "UFSR"

Definition at line 48 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMAX

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMAX   "WLMAX"

Definition at line 42 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMAXFUL

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMAXFUL   "WLMAXFUL"

Definition at line 43 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMIN

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMIN   "WLMIN"

Definition at line 41 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMINFUL

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_WLMINFUL   "WLMINFUL"

Definition at line 40 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_XMAX

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_XMAX   "XMAX"

Definition at line 51 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_XMIN

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_XMIN   "XMIN"

Definition at line 50 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_YMAX

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_YMAX   "YMAX"

Definition at line 54 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_COLNAME_YMIN

#define XSH_SPECTRALFORMAT_TABLE_COLNAME_YMIN   "YMIN"

Definition at line 53 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_NB_NIR_ROWS

#define XSH_SPECTRALFORMAT_TABLE_NB_NIR_ROWS   16

Definition at line 36 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_NB_UVB_ROWS

#define XSH_SPECTRALFORMAT_TABLE_NB_UVB_ROWS   11

Definition at line 34 of file xsh_data_spectralformat.h.

◆ XSH_SPECTRALFORMAT_TABLE_NB_VIS_ROWS

#define XSH_SPECTRALFORMAT_TABLE_NB_VIS_ROWS   14

Definition at line 35 of file xsh_data_spectralformat.h.

Function Documentation

◆ xsh_spectralformat_list_get_dist_order()

int xsh_spectralformat_list_get_dist_order ( xsh_spectralformat_list list)