X-shooter Pipeline Reference Manual 3.8.15
Macros | Enumerations | Functions | Variables
Test Object optimal extraction

Macros

#define MODULE_ID   "XSH_DATA_WAVEMAP"
 
#define SYNTAX
 
#define MODULE_ID   "XSH_LAMBDA_ERR"
 
#define MODULE_ID   "XSH_OPT_EXTRACT"
 

Enumerations

enum  { MIN_ORDER_OPT , MAX_ORDER_OPT , DEBUG_OPT , HELP_OPT }
 
enum  {
  OVERSAMPLE_OPT , BOX_HSIZE_OPT , CHUNK_SIZE_OPT , LAMBDA_STEP_OPT ,
  CLIP_KAPPA_OPT , CLIP_FRAC_OPT , CLIP_NITER_OPT , NITER_OPT ,
  METHOD_OPT , MIN_ORDER_OPT , MAX_ORDER_OPT , DEBUG_OPT ,
  HELP_OPT
}
 

Functions

int main (int argc, char **argv)
 Unit test of xsh_data_wavemap.
 
static void Help (void)
 
static void HandleOptions (int argc, char **argv, int *order_min, int *order_max)
 
static void HandleOptions (int argc, char **argv, xsh_opt_extract_param *opt_extract_par, int *order_min, int *order_max)
 

Variables

static struct option long_options []
 
static struct option long_options []
 

Detailed Description

Macro Definition Documentation

◆ MODULE_ID [1/3]

#define MODULE_ID   "XSH_DATA_WAVEMAP"

Definition at line 62 of file test-xsh_data_wavemap.c.

◆ MODULE_ID [2/3]

#define MODULE_ID   "XSH_LAMBDA_ERR"

Definition at line 64 of file test-xsh_lambda_err.c.

◆ MODULE_ID [3/3]

#define MODULE_ID   "XSH_OPT_EXTRACT"

Definition at line 63 of file test-xsh_opt_extract.c.

◆ SYNTAX

#define SYNTAX
Value:
"Test the wavemap (work only for vis for now)\n"\
"use : ./test_xsh_data_wavemap [OPTIONS] ORDER_TAB WAVESOL WAVEMAP"\
" SPECTRALFORMAT\n"\
"ORDER_TAB => the order table\n"\
"WAVESOL => the wavesolution table\n"\
"WAVEMAP => the wavemap frame\n"\
"SPECTRALFORMAT => the spectral format table\n"

Definition at line 64 of file test-xsh_data_wavemap.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
MIN_ORDER_OPT 
MAX_ORDER_OPT 
DEBUG_OPT 
HELP_OPT 

Definition at line 66 of file test-xsh_lambda_err.c.

◆ anonymous enum

anonymous enum
Enumerator
OVERSAMPLE_OPT 
BOX_HSIZE_OPT 
CHUNK_SIZE_OPT 
LAMBDA_STEP_OPT 
CLIP_KAPPA_OPT 
CLIP_FRAC_OPT 
CLIP_NITER_OPT 
NITER_OPT 
METHOD_OPT 
MIN_ORDER_OPT 
MAX_ORDER_OPT 
DEBUG_OPT 
HELP_OPT 

Definition at line 65 of file test-xsh_opt_extract.c.

Function Documentation

◆ HandleOptions() [1/2]

static void HandleOptions ( int  argc,
char **  argv,
int *  order_min,
int *  order_max 
)
static

◆ HandleOptions() [2/2]

static void HandleOptions ( int  argc,
char **  argv,
xsh_opt_extract_param opt_extract_par,
int *  order_min,
int *  order_max 
)
static

◆ Help()

static void Help ( void  )
static

Definition at line 78 of file test-xsh_lambda_err.c.

References TEST_END.

Referenced by HandleOptions().

◆ main()

int main ( int  argc,
char **  argv 
)

Variable Documentation

◆ long_options [1/2]

struct option long_options[]
static
Initial value:
= {
{"order-min", required_argument, 0, MIN_ORDER_OPT},
{"order-max", required_argument, 0, MAX_ORDER_OPT},
{"debug", required_argument, 0, DEBUG_OPT},
{"help", 0, 0, HELP_OPT},
{0, 0, 0, 0}
}
@ HELP_OPT
@ MAX_ORDER_OPT
@ DEBUG_OPT
@ MIN_ORDER_OPT

Definition at line 70 of file test-xsh_lambda_err.c.

Referenced by HandleOptions().

◆ long_options [2/2]

struct option long_options[]
static
Initial value:
= {
{"oversample", required_argument, 0, OVERSAMPLE_OPT},
{"box-hsize", required_argument, 0, BOX_HSIZE_OPT},
{"chunk-size", required_argument, 0, CHUNK_SIZE_OPT},
{"lambda-step", required_argument, 0, LAMBDA_STEP_OPT},
{"clip-kappa", required_argument, 0, CLIP_KAPPA_OPT},
{"clip-frac", required_argument, 0, CLIP_FRAC_OPT},
{"clip-niter", required_argument, 0, CLIP_NITER_OPT},
{"niter", required_argument, 0, NITER_OPT},
{"method", required_argument, 0, METHOD_OPT},
{"order-min", required_argument, 0, MIN_ORDER_OPT},
{"order-max", required_argument, 0, MAX_ORDER_OPT},
{"debug", required_argument, 0, DEBUG_OPT},
{"help", 0, 0, HELP_OPT},
{0, 0, 0, 0}
}
@ METHOD_OPT
@ HELP_OPT
@ BOX_HSIZE_OPT
@ OVERSAMPLE_OPT
@ CLIP_NITER_OPT
@ MAX_ORDER_OPT
@ LAMBDA_STEP_OPT
@ NITER_OPT
@ CLIP_FRAC_OPT
@ DEBUG_OPT
@ CHUNK_SIZE_OPT
@ MIN_ORDER_OPT
@ CLIP_KAPPA_OPT

Definition at line 71 of file test-xsh_opt_extract.c.

Referenced by HandleOptions().