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

Go to the source code of this file.

Data Structures

struct  xsh_clipping_param
 
struct  xsh_detect_order_param
 
struct  xsh_d2_detect_order_param
 
struct  xsh_detect_continuum_param
 
struct  xsh_background_param
 
struct  xsh_follow_arclines_param
 
struct  xsh_detect_arclines_param
 
struct  xsh_remove_crh_single_param
 
struct  xsh_rectify_param
 
struct  xsh_localize_obj_param
 
struct  xsh_localize_ifu_param
 
struct  xsh_extract_param
 
struct  xsh_interpolate_bp_param
 
struct  xsh_merge_param
 
struct  xsh_subtract_sky_single_param
 
struct  xsh_dispersol_param
 
struct  xsh_combine_nod_param
 
struct  xsh_subtract_nod_param
 
struct  xsh_opt_extract_param
 
struct  xsh_hot_cold_pix_param
 
struct  xsh_fpn_param
 
struct  xsh_pd_noise_param
 
struct  xsh_ron_param
 
struct  xsh_stack_param
 
struct  xsh_prescan_param
 
struct  xsh_overscan_param
 
struct  xsh_ref_param
 
struct  xsh_struct_param
 
struct  xsh_ron_dark_param
 
struct  xsh_slit_limit_param
 
struct  xsh_compute_response_param
 
struct  xsh_bary_corr_param
 

Macros

#define DETECT_CONTINUUM_POLYNOMIAL_DEGREE   5
 
#define WAVECAL_RANGE_DEFAULT   13
 
#define WAVECAL_MARGIN_DEFAULT   3
 
#define DETECT_ARCLINES_POLYNOMIAL_DEGREE   5
 
#define RECTIFY_KERNEL_PRINT(method)
 
#define LOCALIZE_METHOD_PRINT(method)
 
#define EXTRACT_METHOD_PRINT(method)
 
#define MERGE_METHOD_PRINT(merge_method)
 
#define SUBTRACT_SKY_SINGLE_NBKPTS   1000
 
#define SKY_METHOD_PRINT(method)
 
#define BSPLINE_SAMPLING_PRINT(method)
 
#define COMBINE_METHOD_PRINT(method)
 
#define OPTEXTRACT_METHOD_PRINT(method)
 
#define BARY_CORR_METHOD_PRINT(corr_method)
 
#define DECODE_BP_FLAG_MAX   2147483647
 
#define DECODE_BP_FLAG_ALL   2146435071
 
#define DECODE_BP_FLAG_DEF   2140143615
 
#define DECODE_BP_FLAG_NOD   1737490431
 

Enumerations

enum  xsh_find_center_method { XSH_GAUSSIAN_METHOD , XSH_BARYCENTER_METHOD }
 
enum  localize_method { LOC_MANUAL_METHOD , LOC_MAXIMUM_METHOD , LOC_GAUSSIAN_METHOD }
 
enum  extract_method { LOCALIZATION_METHOD , FULL_METHOD , NOD_METHOD , CLEAN_METHOD }
 
enum  merge_method { WEIGHTED_MERGE_METHOD , MEAN_MERGE_METHOD }
 
enum  sky_method {
  MEDIAN_METHOD , BSPLINE_METHOD , BSPLINE_METHOD1 , BSPLINE_METHOD2 ,
  BSPLINE_METHOD3 , BSPLINE_METHOD4 , BSPLINE_METHOD5
}
 
enum  bspline_sampling { UNIFORM , FINE }
 
enum  combine_method { COMBINE_MEDIAN_METHOD , COMBINE_MEAN_METHOD }
 
enum  optextract_method { GAUSS_METHOD , GENERAL_METHOD }
 
enum  bary_corr_method { BARY_CORR_NONE , BARY_CORR_BARY , BARY_CORR_HELIO }
 

Functions

cpl_parameter * xsh_parameters_find (cpl_parameterlist *list, const char *recipe_id, const char *name)
 find a parameter
 
void xsh_parameters_ron_dark_create (const char *recipe_id, cpl_parameterlist *list, xsh_ron_dark_param p)
 create the RON determination parameters in a parameters list
 
void xsh_parameters_prescan_create (const char *recipe_id, cpl_parameterlist *list, xsh_prescan_param p)
 
void xsh_parameters_overscan_create (const char *recipe_id, cpl_parameterlist *list, xsh_overscan_param p)
 
void xsh_parameters_struct_create (const char *recipe_id, cpl_parameterlist *list, xsh_struct_param p)
 create the structX/Y region definition parameters in a parameters list
 
void xsh_parameters_ref1_create (const char *recipe_id, cpl_parameterlist *list, xsh_ref_param p)
 create the reference region definition parameters in a parameters list
 
void xsh_parameters_ref2_create (const char *recipe_id, cpl_parameterlist *list, xsh_ref_param p)
 create the reference region definition parameters in a parameters list
 
void xsh_parameters_ron_create (const char *recipe_id, cpl_parameterlist *list, xsh_ron_param p)
 create the RON determination parameters in a parameters list
 
void xsh_parameters_pd_noise_create (const char *recipe_id, cpl_parameterlist *list, xsh_pd_noise_param p)
 create the FPN parameters in a parameters list
 
void xsh_parameters_fpn_create (const char *recipe_id, cpl_parameterlist *list, xsh_fpn_param p)
 create the FPN parameters in a parameters list
 
void xsh_parameters_hot_cold_pix_create (const char *recipe_id, cpl_parameterlist *list, xsh_hot_cold_pix_param p)
 create the crh clipping parameters in a parameters list
 
void xsh_parameters_new_int (cpl_parameterlist *list, const char *recipe_id, const char *name, int value, const char *comment)
 
void xsh_parameters_new_double (cpl_parameterlist *list, const char *recipe_id, const char *name, double value, const char *comment)
 
void xsh_parameters_new_string (cpl_parameterlist *list, const char *recipe_id, const char *name, const char *value, const char *comment)
 
void xsh_parameters_new_boolean (cpl_parameterlist *list, const char *recipe_id, const char *name, int value, const char *comment)
 
int xsh_parameters_get_boolean (const cpl_parameterlist *list, const char *recipe_id, const char *name)
 
int xsh_parameters_get_int (const cpl_parameterlist *list, const char *recipe_id, const char *name)
 
double xsh_parameters_get_double (const cpl_parameterlist *list, const char *recipe_id, const char *name)
 
char * xsh_parameters_get_string (const cpl_parameterlist *list, const char *recipe_id, const char *name)
 
void xsh_parameters_generic (const char *recipe_id, cpl_parameterlist *plist)
 
void xsh_parameters_pre_overscan (const char *recipe_id, cpl_parameterlist *plist)
 
int xsh_parameters_get_temporary (const char *recipe_id, const cpl_parameterlist *list)
 
int xsh_parameters_debug_level_get (const char *recipe_id, const cpl_parameterlist *list)
 
char * xsh_parameters_test_mode_get (const char *recipe_id, const cpl_parameterlist *list)
 
int xsh_parameters_time_stamp_get (const char *recipe_id, const cpl_parameterlist *list)
 
int xsh_parameters_cut_uvb_spectrum_get (const char *recipe_id, const cpl_parameterlist *list)
 
XSH_ARM xsh_parameters_get_arm (const char *recipe_id, const cpl_parameterlist *list)
 
void xsh_parameters_use_model_create (const char *recipe_id, cpl_parameterlist *list)
 
int xsh_parameters_use_model_get (const char *recipe_id, const cpl_parameterlist *list)
 
void xsh_parameters_clipping_noise_create (const char *recipe_id, cpl_parameterlist *list, xsh_clipping_param noise_clip_param)
 create the crh noise clipping parameters in a parameters list
 
xsh_clipping_paramxsh_parameters_clipping_noise_get (const char *recipe_id, cpl_parameterlist *list)
 get the noise clipping parameters in a parameters list
 
void xsh_parameters_clipping_dcn_create (const char *recipe_id, cpl_parameterlist *list)
 create the DetectContiNuum clipping parameters in a parameters list
 
xsh_clipping_paramxsh_parameters_clipping_dcn_get (const char *recipe_id, cpl_parameterlist *list)
 Get the detectcontinuum clipping parameters in a parameters list.
 
void xsh_parameters_detect_continuum_create (const char *recipe_id, cpl_parameterlist *list, xsh_detect_continuum_param par)
 create the detect continuum parameter "window" in a parameters list
 
xsh_detect_continuum_paramxsh_parameters_detect_continuum_get (const char *recipe_id, cpl_parameterlist *list)
 Get the detect continuum parameters in a parameters list.
 
xsh_interpolate_bp_paramxsh_parameters_interpolate_bp_get (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_clipping_crh_create (const char *recipe_id, cpl_parameterlist *list, xsh_clipping_param p)
 create the crh clipping parameters in a parameters list
 
xsh_clipping_paramxsh_parameters_clipping_crh_get (const char *recipe_id, cpl_parameterlist *list)
 get the crh clipping parameters in a parameters list
 
void xsh_parameters_detect_order_create (const char *recipe_id, cpl_parameterlist *list)
 Create the detect order parameters in a parameters list.
 
xsh_detect_order_paramxsh_parameters_detect_order_get (const char *recipe_id, cpl_parameterlist *list, cpl_parameterlist *drs)
 Get the detect orders parameters in a parameters list.
 
void xsh_parameters_d2_detect_order_create (const char *recipe_id, cpl_parameterlist *list)
 Create the d2 detect order parameters in a parameters list.
 
xsh_d2_detect_order_paramxsh_parameters_d2_detect_order_get (const char *recipe_id, cpl_parameterlist *list)
 Get the d2 detect orders parameters in a parameters list.
 
void xsh_parameters_clipping_detect_arclines_create (const char *recipe_id, cpl_parameterlist *list, xsh_clipping_param p)
 Create the arclines clipping parameters in a parameters list.
 
xsh_clipping_paramxsh_parameters_clipping_detect_arclines_get (const char *recipe_id, cpl_parameterlist *list)
 Get the arclines clipping parameters in a parameters list.
 
void xsh_parameters_detect_arclines_create (const char *recipe_id, cpl_parameterlist *list, xsh_detect_arclines_param p)
 create the detect arclines parameters in a parameters list
 
xsh_detect_arclines_paramxsh_parameters_detect_arclines_get (const char *recipe_id, cpl_parameterlist *list)
 get the detect arclines parameters in a parameters list
 
void xsh_parameters_background_create (const char *recipe_id, cpl_parameterlist *list)
 create the subtract background parameters in a parameters list
 
xsh_background_paramxsh_parameters_background_get (const char *recipe_id, cpl_parameterlist *list)
 get the background parameters in a parameters list
 
void xsh_parameters_clipping_tilt_create (const char *recipe_id, cpl_parameterlist *list)
 create the xsh_wavecal (function follow_arclines) clipping parameters in a parameters list
 
xsh_clipping_paramxsh_parameters_clipping_tilt_get (const char *recipe_id, cpl_parameterlist *list)
 get the xsh_wavecal (follow_arclines) clipping parameters in a parameters list
 
void xsh_parameters_clipping_specres_create (const char *recipe_id, cpl_parameterlist *list)
 create the xsh_wavecal (function follow_arclines) clipping parameters in a parameters list
 
xsh_clipping_paramxsh_parameters_clipping_specres_get (const char *recipe_id, cpl_parameterlist *list)
 get the xsh_wavecal (follow_arclines) clipping parameters in a parameters list
 
void xsh_parameters_wavecal_range_create (const char *recipe_id, cpl_parameterlist *list)
 
int xsh_parameters_wavecal_range_get (const char *recipe_id, cpl_parameterlist *list)
 
int xsh_parameters_wavecal_margin_get (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_wavecal_margin_create (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_wavecal_s_n_create (const char *recipe_id, cpl_parameterlist *list)
 
double xsh_parameters_wavecal_s_n_get (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_remove_crh_single_create (const char *recipe_id, cpl_parameterlist *plist, xsh_remove_crh_single_param p)
 
xsh_remove_crh_single_paramxsh_parameters_remove_crh_single_get (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_stack_create (const char *recipe_id, cpl_parameterlist *list, xsh_stack_param sp)
 create the RON determination parameters in a parameters list
 
void xsh_parameters_rectify_create (const char *recipe_id, cpl_parameterlist *plist, xsh_rectify_param p)
 
xsh_rectify_paramxsh_parameters_rectify_get (const char *recipe_id, cpl_parameterlist *list)
 
int xsh_parameters_rectify_fast_get (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_compute_response_create (const char *recipe_id, cpl_parameterlist *plist, xsh_compute_response_param p)
 
xsh_compute_response_paramxsh_parameters_compute_response_get (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_localize_obj_create (const char *recipe_id, cpl_parameterlist *plist, xsh_localize_obj_param p)
 
xsh_localize_obj_paramxsh_parameters_localize_obj_get (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_localize_ifu_create (const char *recipe_id, cpl_parameterlist *plist, xsh_localize_ifu_param p)
 
xsh_localize_ifu_paramxsh_parameters_localize_ifu_get (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_extract_create (const char *recipe_id, cpl_parameterlist *plist, xsh_extract_param p, enum extract_method method)
 
void xsh_parameters_interpolate_bp_create (const char *recipe_id, cpl_parameterlist *plist, xsh_interpolate_bp_param p)
 
xsh_extract_paramxsh_parameters_extract_get (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_subtract_sky_single_create (const char *recipe_id, cpl_parameterlist *plist, xsh_subtract_sky_single_param p)
 
xsh_subtract_sky_single_paramxsh_parameters_subtract_sky_single_get (const char *recipe_id, cpl_parameterlist *list)
 
int xsh_parameters_subtract_sky_single_get_first (const char *recipe_id, cpl_parameterlist *list)
 
int xsh_parameters_subtract_sky_single_get_second (const char *recipe_id, cpl_parameterlist *list)
 
int xsh_parameters_subtract_sky_single_get_niter (const char *recipe_id, cpl_parameterlist *list)
 
double xsh_parameters_subtract_sky_single_get_kappa (const char *recipe_id, cpl_parameterlist *list)
 
int xsh_parameters_subtract_sky_single_get_true (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_dosky_domap_get (const char *recipe_id, cpl_parameterlist *list, cpl_frame *wavemap_frame, cpl_frame *slitmap_frame, int *dosky, int *domap)
 
void xsh_parameters_merge_ord_create (const char *recipe_id, cpl_parameterlist *plist, int p)
 
xsh_merge_paramxsh_parameters_merge_ord_get (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_optimal_extract_create (const char *recipe_id, cpl_parameterlist *plist, int p)
 
double xsh_parameters_optimal_extract_get_kappa (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_dispersol_create (const char *recipe_id, cpl_parameterlist *list, xsh_dispersol_param p)
 Create the dispersol compute parameters in a parameters list.
 
xsh_dispersol_paramxsh_parameters_dispersol_get (const char *recipe_id, cpl_parameterlist *list)
 Get the dispersion solution compute parameters in a parameters list.
 
void xsh_parameters_combine_nod_create (const char *recipe_id, cpl_parameterlist *list, xsh_combine_nod_param p)
 create the crh clipping parameters in a parameters list
 
xsh_combine_nod_paramxsh_parameters_combine_nod_get (const char *recipe_id, cpl_parameterlist *list)
 get the combine nod parameters in a parameters list
 
void xsh_parameters_bary_corr_create (const char *recipe_id, cpl_parameterlist *list, xsh_bary_corr_param p)
 create the barycentric correction parameters in a parameters list
 
xsh_bary_corr_paramxsh_parameters_bary_corr_get (const char *recipe_id, cpl_parameterlist *list)
 get the barycentric correction parameters in a parameters list
 
void xsh_parameters_opt_extract_create (const char *recipe_id, cpl_parameterlist *list, xsh_opt_extract_param opt_extract_par)
 Create the optimal extraction parameters in a parameters list.
 
xsh_opt_extract_paramxsh_parameters_opt_extract_get (const char *recipe_id, cpl_parameterlist *list)
 Get the optimal extraction parameters in a parameters list.
 
void xsh_parameters_slit_limit_create (const char *recipe_id, cpl_parameterlist *list, xsh_slit_limit_param p)
 
xsh_slit_limit_paramxsh_parameters_slit_limit_get (const char *recipe_id, cpl_parameterlist *list)
 
void xsh_parameters_geom_ifu_mode_create (const char *recipe_id, cpl_parameterlist *list)
 
int xsh_parameters_geom_ifu_mode_get (const char *recipe_id, cpl_parameterlist *list)
 
cpl_parameterlist * xsh_parameters_create_from_drs_table (const cpl_table *tab)
 
cpl_error_code xsh_recipe_params_check (cpl_parameterlist *parameters, xsh_instrument *instrument, const char *rec_id)
 
cpl_error_code xsh_recipe_params_drs_check (cpl_parameterlist *parameters, xsh_instrument *instrument, const char *rec_id)
 
xsh_stack_paramxsh_stack_frames_get (const char *recipe_id, cpl_parameterlist *list)
 get the detect arclines parameters in a parameters list
 
cpl_error_code xsh_parameters_decode_bp_set (const char *recipe_id, cpl_parameterlist *plist, const int ival)
 
cpl_error_code xsh_parameters_decode_bp (const char *recipe_id, cpl_parameterlist *plist, const int ival)
 

Macro Definition Documentation

◆ BARY_CORR_METHOD_PRINT

#define BARY_CORR_METHOD_PRINT (   corr_method)
Value:
(corr_method) == BARY_CORR_BARY ? "bary" : \
(corr_method) == BARY_CORR_HELIO ? "helio" : \
(corr_method) == BARY_CORR_NONE ? "none" : "????"
@ BARY_CORR_NONE
@ BARY_CORR_HELIO
@ BARY_CORR_BARY

Definition at line 556 of file xsh_parameters.h.

◆ BSPLINE_SAMPLING_PRINT

#define BSPLINE_SAMPLING_PRINT (   method)
Value:
(method) == UNIFORM ? "UNIFORM" : \
(method) == FINE ? "FINE" : "????"
const char * method
Definition: xsh_detmon_lg.c:78
@ UNIFORM
@ FINE

Definition at line 346 of file xsh_parameters.h.

◆ COMBINE_METHOD_PRINT

#define COMBINE_METHOD_PRINT (   method)
Value:
(method) == COMBINE_MEDIAN_METHOD ? "MEDIAN" : \
(method) == COMBINE_MEAN_METHOD ? "MEAN" : "????"
@ COMBINE_MEAN_METHOD
@ COMBINE_MEDIAN_METHOD

Definition at line 386 of file xsh_parameters.h.

◆ DECODE_BP_FLAG_ALL

#define DECODE_BP_FLAG_ALL   2146435071

Definition at line 566 of file xsh_parameters.h.

◆ DECODE_BP_FLAG_DEF

#define DECODE_BP_FLAG_DEF   2140143615

Definition at line 568 of file xsh_parameters.h.

◆ DECODE_BP_FLAG_MAX

#define DECODE_BP_FLAG_MAX   2147483647

Definition at line 565 of file xsh_parameters.h.

◆ DECODE_BP_FLAG_NOD

#define DECODE_BP_FLAG_NOD   1737490431

Definition at line 571 of file xsh_parameters.h.

◆ DETECT_ARCLINES_POLYNOMIAL_DEGREE

#define DETECT_ARCLINES_POLYNOMIAL_DEGREE   5

Definition at line 158 of file xsh_parameters.h.

◆ DETECT_CONTINUUM_POLYNOMIAL_DEGREE

#define DETECT_CONTINUUM_POLYNOMIAL_DEGREE   5

Definition at line 98 of file xsh_parameters.h.

◆ EXTRACT_METHOD_PRINT

#define EXTRACT_METHOD_PRINT (   method)
Value:
(method) == LOCALIZATION_METHOD ? "LOCALIZATION" : \
(method) == FULL_METHOD ? "FULL" : \
(method) == CLEAN_METHOD ? "CLEAN" : \
(method) == NOD_METHOD ? "NOD" : "????"
@ FULL_METHOD
@ NOD_METHOD
@ LOCALIZATION_METHOD
@ CLEAN_METHOD

Definition at line 286 of file xsh_parameters.h.

◆ LOCALIZE_METHOD_PRINT

#define LOCALIZE_METHOD_PRINT (   method)
Value:
(method) == LOC_MANUAL_METHOD ? "MANUAL" : \
(method) == LOC_MAXIMUM_METHOD ? "MAXIMUM" : \
(method) == LOC_GAUSSIAN_METHOD ? "GAUSSIAN" :"????"
@ LOC_MAXIMUM_METHOD
@ LOC_GAUSSIAN_METHOD
@ LOC_MANUAL_METHOD

Definition at line 240 of file xsh_parameters.h.

◆ MERGE_METHOD_PRINT

#define MERGE_METHOD_PRINT (   merge_method)
Value:
(merge_method) == WEIGHTED_MERGE_METHOD ? "WEIGHT" : \
(merge_method) == FULL_METHOD ? "MEAN" : "????"
merge_method
@ WEIGHTED_MERGE_METHOD

Definition at line 307 of file xsh_parameters.h.

◆ OPTEXTRACT_METHOD_PRINT

#define OPTEXTRACT_METHOD_PRINT (   method)
Value:
(method) == GAUSS_METHOD ? "GAUSSIAN" : \
(method) == GENERAL_METHOD ? "GENERAL" : "????"
@ GENERAL_METHOD
@ GAUSS_METHOD

Definition at line 421 of file xsh_parameters.h.

◆ RECTIFY_KERNEL_PRINT

#define RECTIFY_KERNEL_PRINT (   method)
Value:
(method) == CPL_KERNEL_TANH ? "TANH" : \
(method) == CPL_KERNEL_SINC ? "SINC" : \
(method) == CPL_KERNEL_SINC2 ? "SINC2" : \
(method) == CPL_KERNEL_LANCZOS ? "LANCZOS" : \
(method) == CPL_KERNEL_HAMMING ? "HAMMING" : \
(method) == CPL_KERNEL_HANN ? "HANN" :"????"

Definition at line 200 of file xsh_parameters.h.

◆ SKY_METHOD_PRINT

#define SKY_METHOD_PRINT (   method)
Value:
(method) == BSPLINE_METHOD ? "BSPLINE" : \
(method) == BSPLINE_METHOD1 ? "BSPLINE1" : \
(method) == BSPLINE_METHOD2 ? "BSPLINE2" : \
(method) == BSPLINE_METHOD3 ? "BSPLINE3" : \
(method) == BSPLINE_METHOD4 ? "BSPLINE4" : \
(method) == BSPLINE_METHOD5 ? "BSPLINE5" : \
(method) == MEDIAN_METHOD ? "MEDIAN" : "????"
@ BSPLINE_METHOD4
@ MEDIAN_METHOD
@ BSPLINE_METHOD2
@ BSPLINE_METHOD
@ BSPLINE_METHOD5
@ BSPLINE_METHOD1
@ BSPLINE_METHOD3

Definition at line 336 of file xsh_parameters.h.

◆ SUBTRACT_SKY_SINGLE_NBKPTS

#define SUBTRACT_SKY_SINGLE_NBKPTS   1000

Definition at line 317 of file xsh_parameters.h.

◆ WAVECAL_MARGIN_DEFAULT

#define WAVECAL_MARGIN_DEFAULT   3

Definition at line 143 of file xsh_parameters.h.

◆ WAVECAL_RANGE_DEFAULT

#define WAVECAL_RANGE_DEFAULT   13

Definition at line 142 of file xsh_parameters.h.

Enumeration Type Documentation

◆ bary_corr_method

Enumerator
BARY_CORR_NONE 
BARY_CORR_BARY 
BARY_CORR_HELIO 

Definition at line 550 of file xsh_parameters.h.

◆ bspline_sampling

Enumerator
UNIFORM 
FINE 

Definition at line 330 of file xsh_parameters.h.

◆ combine_method

Enumerator
COMBINE_MEDIAN_METHOD 
COMBINE_MEAN_METHOD 

Definition at line 381 of file xsh_parameters.h.

◆ extract_method

Enumerator
LOCALIZATION_METHOD 
FULL_METHOD 
NOD_METHOD 
CLEAN_METHOD 

Definition at line 279 of file xsh_parameters.h.

◆ localize_method

Enumerator
LOC_MANUAL_METHOD 
LOC_MAXIMUM_METHOD 
LOC_GAUSSIAN_METHOD 

Definition at line 235 of file xsh_parameters.h.

◆ merge_method

Enumerator
WEIGHTED_MERGE_METHOD 
MEAN_MERGE_METHOD 

Definition at line 302 of file xsh_parameters.h.

◆ optextract_method

Enumerator
GAUSS_METHOD 
GENERAL_METHOD 

Definition at line 417 of file xsh_parameters.h.

◆ sky_method

enum sky_method
Enumerator
MEDIAN_METHOD 
BSPLINE_METHOD 
BSPLINE_METHOD1 
BSPLINE_METHOD2 
BSPLINE_METHOD3 
BSPLINE_METHOD4 
BSPLINE_METHOD5 

Definition at line 319 of file xsh_parameters.h.

◆ xsh_find_center_method

Enumerator
XSH_GAUSSIAN_METHOD 
XSH_BARYCENTER_METHOD 

Definition at line 160 of file xsh_parameters.h.

Function Documentation

◆ xsh_parameters_background_create()

void xsh_parameters_background_create ( const char *  recipe_id,
cpl_parameterlist *  list 
)

create the subtract background parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update

Definition at line 1217 of file xsh_parameters.c.

References assure, check, XSH_ASSURE_NOT_NULL, xsh_parameters_new_range_double(), and xsh_parameters_new_range_int().

Referenced by xsh_absorp_create(), xsh_geom_ifu_create(), xsh_mflat_create(), xsh_respon_slit_stare_create(), xsh_scired_ifu_offset_create(), xsh_scired_ifu_stare_create(), and xsh_scired_slit_stare_create().

◆ xsh_parameters_background_get()

xsh_background_param * xsh_parameters_background_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

get the background parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to search
Returns
a NEWLY allocated structure of background parameters

Definition at line 1271 of file xsh_parameters.c.

References check, xsh_background_param::debug, xsh_background_param::edges_margin, xsh_background_param::poly_deg_x, xsh_background_param::poly_deg_y, xsh_background_param::poly_kappa, XSH_ASSURE_NOT_NULL, XSH_FREE, XSH_MALLOC, xsh_parameters_get_double(), and xsh_parameters_get_int().

Referenced by xsh_geom_ifu(), xsh_mflat(), xsh_scired_ifu_offset(), xsh_scired_ifu_stare(), and xsh_slit_stare_get_params().

◆ xsh_parameters_bary_corr_create()

void xsh_parameters_bary_corr_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_bary_corr_param  p 
)

create the barycentric correction parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
pbary corr parameters structure

Definition at line 4726 of file xsh_parameters.c.

References assure, BARY_CORR_METHOD_PRINT, check, xsh_bary_corr_param::corr_method, and xsh_parameters_new_string().

Referenced by xsh_scired_ifu_offset_create(), xsh_scired_ifu_stare_create(), xsh_scired_slit_nod_create(), xsh_scired_slit_offset_create(), and xsh_scired_slit_stare_create().

◆ xsh_parameters_bary_corr_get()

xsh_bary_corr_param * xsh_parameters_bary_corr_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

get the barycentric correction parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to search
Returns
a NEWLY allocated structure of bary corr parameters

Definition at line 4752 of file xsh_parameters.c.

References assure, BARY_CORR_BARY, BARY_CORR_HELIO, BARY_CORR_METHOD_PRINT, BARY_CORR_NONE, check, xsh_bary_corr_param::corr_method, xsh_error_msg, XSH_MALLOC, and xsh_parameters_get_string().

Referenced by xsh_add_product_image(), xsh_add_product_orders_spectrum(), xsh_add_product_pre(), xsh_add_product_spectrum(), xsh_scired_ifu_offset(), xsh_scired_ifu_stare(), xsh_scired_slit_nod(), xsh_scired_slit_offset(), and xsh_scired_slit_stare().

◆ xsh_parameters_clipping_crh_create()

void xsh_parameters_clipping_crh_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_clipping_param  p 
)

create the crh clipping parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
pCRH clipping parameters structure

Definition at line 540 of file xsh_parameters.c.

References assure, check, xsh_clipping_param::frac, xsh_clipping_param::niter, xsh_clipping_param::sigma, xsh_parameters_new_double(), and xsh_parameters_new_int().

Referenced by main(), xsh_absorp_create(), xsh_geom_ifu_create(), xsh_mdark_create(), xsh_scired_ifu_offset_create(), and xsh_scired_ifu_stare_create().

◆ xsh_parameters_clipping_crh_get()

xsh_clipping_param * xsh_parameters_clipping_crh_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

get the crh clipping parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to search
Returns
a NEWLY allocated structure of clipping parameters

Definition at line 882 of file xsh_parameters.c.

References assure, check, xsh_clipping_param::frac, xsh_clipping_param::niter, xsh_clipping_param::sigma, xsh_parameters_get_double(), and xsh_parameters_get_int().

Referenced by xsh_geom_ifu(), xsh_mdark(), and xsh_scired_ifu_stare().

◆ xsh_parameters_clipping_dcn_create()

void xsh_parameters_clipping_dcn_create ( const char *  recipe_id,
cpl_parameterlist *  list 
)

create the DetectContiNuum clipping parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update

Definition at line 1586 of file xsh_parameters.c.

References check, XSH_ASSURE_NOT_NULL, xsh_parameters_new_double(), xsh_parameters_new_int(), and xsh_parameters_new_range_double().

Referenced by xsh_orderpos_create().

◆ xsh_parameters_clipping_dcn_get()

xsh_clipping_param * xsh_parameters_clipping_dcn_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Get the detectcontinuum clipping parameters in a parameters list.

Parameters
[in]recipe_idThe current recipe in use
[in]listThe parameters list to search
Returns
A NEWLY allocated structure of clipping parameters

Definition at line 1630 of file xsh_parameters.c.

References check, xsh_clipping_param::frac, xsh_clipping_param::niter, xsh_clipping_param::res_max, xsh_clipping_param::sigma, XSH_ASSURE_NOT_NULL, XSH_MALLOC, xsh_parameters_get_double(), and xsh_parameters_get_int().

Referenced by xsh_orderpos().

◆ xsh_parameters_clipping_detect_arclines_create()

void xsh_parameters_clipping_detect_arclines_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_clipping_param  p 
)

Create the arclines clipping parameters in a parameters list.

Parameters
[in]recipe_idThe current recipe in use
[in]listThe parameters list to update
[in]pClipping parameters structure

Definition at line 1512 of file xsh_parameters.c.

References check, xsh_clipping_param::frac, xsh_clipping_param::niter, xsh_clipping_param::sigma, XSH_ASSURE_NOT_NULL, xsh_parameters_new_double(), and xsh_parameters_new_int().

Referenced by xsh_2dmap_create(), xsh_flexcomp_create(), and xsh_predict_create().

◆ xsh_parameters_clipping_detect_arclines_get()

xsh_clipping_param * xsh_parameters_clipping_detect_arclines_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Get the arclines clipping parameters in a parameters list.

Parameters
[in]recipe_idThe current recipe in use
[in]listThe parameters list to search
Returns
A NEWLY allocated structure of clipping parameters

Definition at line 1551 of file xsh_parameters.c.

References check, xsh_clipping_param::frac, xsh_clipping_param::niter, xsh_clipping_param::sigma, XSH_ASSURE_NOT_NULL, XSH_FREE, XSH_MALLOC, xsh_parameters_get_double(), and xsh_parameters_get_int().

Referenced by xsh_2dmap(), xsh_flexcomp(), and xsh_predict().

◆ xsh_parameters_clipping_noise_create()

void xsh_parameters_clipping_noise_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_clipping_param  noise_param 
)

create the crh noise clipping parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
noise_paramstructure describing noise params

Definition at line 925 of file xsh_parameters.c.

References assure, check, xsh_clipping_param::diff, xsh_clipping_param::frac, xsh_clipping_param::niter, xsh_clipping_param::sigma, xsh_parameters_new_double(), and xsh_parameters_new_int().

Referenced by xsh_mdark_create().

◆ xsh_parameters_clipping_noise_get()

xsh_clipping_param * xsh_parameters_clipping_noise_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

get the noise clipping parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to search
Returns
a NEWLY allocated structure of clipping parameters

Definition at line 962 of file xsh_parameters.c.

References assure, check, xsh_clipping_param::diff, xsh_clipping_param::frac, xsh_clipping_param::niter, xsh_clipping_param::sigma, xsh_parameters_get_double(), and xsh_parameters_get_int().

Referenced by xsh_mdark().

◆ xsh_parameters_clipping_specres_create()

void xsh_parameters_clipping_specres_create ( const char *  recipe_id,
cpl_parameterlist *  list 
)

create the xsh_wavecal (function follow_arclines) clipping parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update

Definition at line 1877 of file xsh_parameters.c.

References check, XSH_ASSURE_NOT_NULL, xsh_parameters_new_double(), and xsh_parameters_new_int().

Referenced by xsh_wavecal_create().

◆ xsh_parameters_clipping_specres_get()

xsh_clipping_param * xsh_parameters_clipping_specres_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

get the xsh_wavecal (follow_arclines) clipping parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to search
Returns
a NEWLY allocated structure of clipping parameters

Definition at line 1909 of file xsh_parameters.c.

References assure, check, xsh_clipping_param::frac, xsh_clipping_param::niter, xsh_clipping_param::sigma, xsh_parameters_get_double(), and xsh_parameters_get_int().

Referenced by xsh_wavecal_get_parameters().

◆ xsh_parameters_clipping_tilt_create()

void xsh_parameters_clipping_tilt_create ( const char *  recipe_id,
cpl_parameterlist *  list 
)

create the xsh_wavecal (function follow_arclines) clipping parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update

Definition at line 1806 of file xsh_parameters.c.

References check, XSH_ASSURE_NOT_NULL, xsh_parameters_new_double(), and xsh_parameters_new_int().

Referenced by xsh_wavecal_create().

◆ xsh_parameters_clipping_tilt_get()

xsh_clipping_param * xsh_parameters_clipping_tilt_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

get the xsh_wavecal (follow_arclines) clipping parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to search
Returns
a NEWLY allocated structure of clipping parameters

Definition at line 1838 of file xsh_parameters.c.

References assure, check, xsh_clipping_param::frac, xsh_clipping_param::niter, xsh_clipping_param::sigma, xsh_parameters_get_double(), and xsh_parameters_get_int().

Referenced by xsh_wavecal_get_parameters().

◆ xsh_parameters_combine_nod_create()

void xsh_parameters_combine_nod_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_combine_nod_param  p 
)

create the crh clipping parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
pcombine nod parameters structure

Definition at line 3160 of file xsh_parameters.c.

References assure, check, COMBINE_METHOD_PRINT, xsh_combine_nod_param::method, xsh_combine_nod_param::throwname, and xsh_parameters_new_string().

Referenced by xsh_respon_slit_nod_create(), xsh_respon_slit_offset_create(), xsh_scired_slit_nod_create(), and xsh_scired_slit_offset_create().

◆ xsh_parameters_combine_nod_get()

xsh_combine_nod_param * xsh_parameters_combine_nod_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

get the combine nod parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to search
Returns
a NEWLY allocated structure of combine nod parameters

Definition at line 3206 of file xsh_parameters.c.

References assure, check, COMBINE_MEAN_METHOD, COMBINE_MEDIAN_METHOD, COMBINE_METHOD_PRINT, xsh_combine_nod_param::method, xsh_combine_nod_param::throwname, xsh_error_msg, and xsh_parameters_get_string().

Referenced by xsh_scired_nod_get_parameters(), and xsh_slit_offset_get_params().

◆ xsh_parameters_compute_response_create()

void xsh_parameters_compute_response_create ( const char *  recipe_id,
cpl_parameterlist *  plist,
xsh_compute_response_param  p 
)

◆ xsh_parameters_compute_response_get()

xsh_compute_response_param * xsh_parameters_compute_response_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_create_from_drs_table()

cpl_parameterlist * xsh_parameters_create_from_drs_table ( const cpl_table *  tab)

◆ xsh_parameters_cut_uvb_spectrum_get()

int xsh_parameters_cut_uvb_spectrum_get ( const char *  recipe_id,
const cpl_parameterlist *  list 
)

◆ xsh_parameters_d2_detect_order_create()

void xsh_parameters_d2_detect_order_create ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Create the d2 detect order parameters in a parameters list.

Parameters
[in]recipe_idThe current recipe in use
listThe parameters list to update

Definition at line 1154 of file xsh_parameters.c.

References check, XSH_ASSURE_NOT_NULL, and xsh_parameters_new_range_double().

Referenced by xsh_mflat_create().

◆ xsh_parameters_d2_detect_order_get()

xsh_d2_detect_order_param * xsh_parameters_d2_detect_order_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Get the d2 detect orders parameters in a parameters list.

Parameters
recipe_idThe current recipe in use
listThe parameters list to search
Returns
A NEWLY allocated structure of d2 detect orders parameters

Definition at line 1186 of file xsh_parameters.c.

References check, xsh_d2_detect_order_param::min_sn, XSH_ASSURE_NOT_NULL, XSH_FREE, XSH_MALLOC, and xsh_parameters_get_double().

Referenced by xsh_mflat().

◆ xsh_parameters_debug_level_get()

int xsh_parameters_debug_level_get ( const char *  recipe_id,
const cpl_parameterlist *  list 
)

◆ xsh_parameters_decode_bp()

cpl_error_code xsh_parameters_decode_bp ( const char *  recipe_id,
cpl_parameterlist *  plist,
const int  ival 
)

◆ xsh_parameters_decode_bp_set()

cpl_error_code xsh_parameters_decode_bp_set ( const char *  recipe_id,
cpl_parameterlist *  plist,
const int  ival 
)

Definition at line 453 of file xsh_parameters.c.

References xsh_parameters_find().

◆ xsh_parameters_detect_arclines_create()

void xsh_parameters_detect_arclines_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_detect_arclines_param  p 
)

◆ xsh_parameters_detect_arclines_get()

xsh_detect_arclines_param * xsh_parameters_detect_arclines_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_detect_continuum_create()

void xsh_parameters_detect_continuum_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_detect_continuum_param  par 
)

create the detect continuum parameter "window" in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
parthe structure containing relevant params to be created

Definition at line 1667 of file xsh_parameters.c.

References check, xsh_detect_continuum_param::fit_threshold, xsh_detect_continuum_param::fit_window, xsh_detect_continuum_param::poly_degree, xsh_detect_continuum_param::poly_step, xsh_detect_continuum_param::running_window, xsh_detect_continuum_param::search_window, XSH_ASSURE_NOT_NULL, xsh_parameters_new_double(), and xsh_parameters_new_int().

Referenced by xsh_orderpos_create().

◆ xsh_parameters_detect_continuum_get()

xsh_detect_continuum_param * xsh_parameters_detect_continuum_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Get the detect continuum parameters in a parameters list.

Parameters
recipe_idThe current recipe in use
listThe parameters list to search
Returns
A NEWLY allocated structure of detect continuum parameters

Definition at line 1754 of file xsh_parameters.c.

References check, xsh_detect_continuum_param::fit_threshold, xsh_detect_continuum_param::fit_window, xsh_detect_continuum_param::poly_degree, xsh_detect_continuum_param::poly_step, xsh_detect_continuum_param::running_window, xsh_detect_continuum_param::search_window, XSH_ASSURE_NOT_NULL, XSH_FREE, XSH_MALLOC, xsh_parameters_get_double(), and xsh_parameters_get_int().

Referenced by xsh_orderpos().

◆ xsh_parameters_detect_order_create()

void xsh_parameters_detect_order_create ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Create the detect order parameters in a parameters list.

Parameters
[in]recipe_idThe current recipe in use
listThe parameters list to update

Definition at line 1005 of file xsh_parameters.c.

References assure, check, XSH_ASSURE_NOT_NULL, xsh_parameters_new_boolean(), xsh_parameters_new_double(), and xsh_parameters_new_int().

Referenced by xsh_mflat_create().

◆ xsh_parameters_detect_order_get()

xsh_detect_order_param * xsh_parameters_detect_order_get ( const char *  recipe_id,
cpl_parameterlist *  list,
cpl_parameterlist *  drs 
)

◆ xsh_parameters_dispersol_create()

void xsh_parameters_dispersol_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_dispersol_param  p 
)

Create the dispersol compute parameters in a parameters list.

Parameters
recipe_idThe current recipe in use
listThe parameters list to update
pThe dispersol parameters structure

Definition at line 3094 of file xsh_parameters.c.

References check, xsh_dispersol_param::deg_x, xsh_dispersol_param::deg_y, XSH_ASSURE_NOT_NULL, and xsh_parameters_new_int().

Referenced by xsh_2dmap_create(), and xsh_flexcomp_create().

◆ xsh_parameters_dispersol_get()

xsh_dispersol_param * xsh_parameters_dispersol_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Get the dispersion solution compute parameters in a parameters list.

Parameters
recipe_idThe current recipe in use
listThe parameters list to search
Returns
a NEWLY allocated structure of wavemap parameters

Definition at line 3127 of file xsh_parameters.c.

References check, xsh_dispersol_param::deg_x, xsh_dispersol_param::deg_y, XSH_ASSURE_NOT_NULL, XSH_FREE, XSH_MALLOC, and xsh_parameters_get_int().

Referenced by xsh_2dmap(), and xsh_flexcomp().

◆ xsh_parameters_dosky_domap_get()

void xsh_parameters_dosky_domap_get ( const char *  recipe_id,
cpl_parameterlist *  list,
cpl_frame *  wavemap_frame,
cpl_frame *  slitmap_frame,
int *  dosky,
int *  domap 
)

◆ xsh_parameters_extract_create()

void xsh_parameters_extract_create ( const char *  recipe_id,
cpl_parameterlist *  plist,
xsh_extract_param  p,
enum extract_method  method 
)

◆ xsh_parameters_extract_get()

xsh_extract_param * xsh_parameters_extract_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_find()

cpl_parameter * xsh_parameters_find ( cpl_parameterlist *  list,
const char *  recipe_id,
const char *  name 
)

◆ xsh_parameters_fpn_create()

void xsh_parameters_fpn_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_fpn_param  p 
)

create the FPN parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
pFixed Pattern Noise parameters structure

Definition at line 842 of file xsh_parameters.c.

References xsh_fpn_param::fpn_hsize, xsh_fpn_param::fpn_llx, xsh_fpn_param::fpn_lly, xsh_fpn_param::fpn_nsamples, xsh_fpn_param::fpn_urx, xsh_fpn_param::fpn_ury, and xsh_parameters_new_int().

Referenced by main(), xsh_mbias_create(), and xsh_mdark_create().

◆ xsh_parameters_generic()

void xsh_parameters_generic ( const char *  recipe_id,
cpl_parameterlist *  plist 
)

◆ xsh_parameters_geom_ifu_mode_create()

void xsh_parameters_geom_ifu_mode_create ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 3414 of file xsh_parameters.c.

References check, XSH_ASSURE_NOT_NULL, and xsh_parameters_new_boolean().

◆ xsh_parameters_geom_ifu_mode_get()

int xsh_parameters_geom_ifu_mode_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 3429 of file xsh_parameters.c.

References XSH_ASSURE_NOT_NULL, and xsh_parameters_get_boolean().

◆ xsh_parameters_get_arm()

XSH_ARM xsh_parameters_get_arm ( const char *  recipe_id,
const cpl_parameterlist *  list 
)

◆ xsh_parameters_get_boolean()

int xsh_parameters_get_boolean ( const cpl_parameterlist *  list,
const char *  recipe_id,
const char *  name 
)

◆ xsh_parameters_get_double()

double xsh_parameters_get_double ( const cpl_parameterlist *  list,
const char *  recipe_id,
const char *  name 
)

◆ xsh_parameters_get_int()

int xsh_parameters_get_int ( const cpl_parameterlist *  list,
const char *  recipe_id,
const char *  name 
)

Definition at line 295 of file xsh_parameters.c.

References assure, and check.

Referenced by xsh_2dmap(), xsh_absorp(), xsh_add_sdp_product_spectrum(), xsh_flexcomp(), xsh_geom_ifu(), xsh_mdark(), xsh_mdark_get_contam(), xsh_mdark_get_median_stdev(), xsh_mdark_get_ron(), xsh_mdark_measure_fpn(), xsh_mdark_measure_ron(), xsh_mflat(), xsh_orderpos(), xsh_parameter_check_int(), xsh_parameters_background_get(), xsh_parameters_clipping_crh_get(), xsh_parameters_clipping_dcn_get(), xsh_parameters_clipping_detect_arclines_get(), xsh_parameters_clipping_noise_get(), xsh_parameters_clipping_specres_get(), xsh_parameters_clipping_tilt_get(), xsh_parameters_detect_arclines_get(), xsh_parameters_detect_continuum_get(), xsh_parameters_detect_order_get(), xsh_parameters_dispersol_get(), xsh_parameters_interpolate_bp_get(), xsh_parameters_localize_ifu_get(), xsh_parameters_localize_obj_get(), xsh_parameters_merge_ord_get(), xsh_parameters_opt_extract_get(), xsh_parameters_remove_crh_single_get(), xsh_parameters_subtract_sky_single_get(), xsh_parameters_subtract_sky_single_get_first(), xsh_parameters_subtract_sky_single_get_niter(), xsh_parameters_subtract_sky_single_get_second(), xsh_parameters_wavecal_margin_get(), xsh_parameters_wavecal_range_get(), xsh_params_compute_fpn_check(), xsh_params_compute_ron_mbias_set3_check(), xsh_params_compute_ron_mdark_check(), xsh_predict(), xsh_respon_slit_nod(), xsh_respon_slit_offset(), xsh_respon_slit_stare(), xsh_scired_ifu_stare(), xsh_scired_nod_get_parameters(), xsh_scired_slit_nod(), xsh_scired_slit_offset(), xsh_scired_slit_stare(), and xsh_slit_stare_get_params().

◆ xsh_parameters_get_string()

char * xsh_parameters_get_string ( const cpl_parameterlist *  list,
const char *  recipe_id,
const char *  name 
)

◆ xsh_parameters_get_temporary()

int xsh_parameters_get_temporary ( const char *  recipe_id,
const cpl_parameterlist *  list 
)

Definition at line 464 of file xsh_parameters.c.

References xsh_msg, and xsh_parameters_get_string().

Referenced by xsh_begin(), and xsh_end().

◆ xsh_parameters_hot_cold_pix_create()

void xsh_parameters_hot_cold_pix_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_hot_cold_pix_param  p 
)

create the crh clipping parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
phot-cold pix detection parameters structure

Definition at line 578 of file xsh_parameters.c.

References assure, check, xsh_hot_cold_pix_param::cold_pix_kappa, xsh_hot_cold_pix_param::cold_pix_niter, xsh_hot_cold_pix_param::hot_cold_pix_search, xsh_hot_cold_pix_param::hot_pix_kappa, xsh_hot_cold_pix_param::hot_pix_niter, xsh_parameters_new_boolean(), xsh_parameters_new_double(), and xsh_parameters_new_range_int().

Referenced by main().

◆ xsh_parameters_interpolate_bp_create()

void xsh_parameters_interpolate_bp_create ( const char *  recipe_id,
cpl_parameterlist *  plist,
xsh_interpolate_bp_param  p 
)

◆ xsh_parameters_interpolate_bp_get()

xsh_interpolate_bp_param * xsh_parameters_interpolate_bp_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_localize_ifu_create()

void xsh_parameters_localize_ifu_create ( const char *  recipe_id,
cpl_parameterlist *  plist,
xsh_localize_ifu_param  p 
)

◆ xsh_parameters_localize_ifu_get()

xsh_localize_ifu_param * xsh_parameters_localize_ifu_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_localize_obj_create()

void xsh_parameters_localize_obj_create ( const char *  recipe_id,
cpl_parameterlist *  plist,
xsh_localize_obj_param  p 
)

◆ xsh_parameters_localize_obj_get()

xsh_localize_obj_param * xsh_parameters_localize_obj_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_merge_ord_create()

void xsh_parameters_merge_ord_create ( const char *  recipe_id,
cpl_parameterlist *  plist,
int  p 
)

Definition at line 3006 of file xsh_parameters.c.

References check, XSH_ASSURE_NOT_NULL, and xsh_parameters_new_int().

◆ xsh_parameters_merge_ord_get()

xsh_merge_param * xsh_parameters_merge_ord_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_new_boolean()

void xsh_parameters_new_boolean ( cpl_parameterlist *  list,
const char *  recipe_id,
const char *  name,
int  value,
const char *  comment 
)

◆ xsh_parameters_new_double()

void xsh_parameters_new_double ( cpl_parameterlist *  list,
const char *  recipe_id,
const char *  name,
double  value,
const char *  comment 
)

◆ xsh_parameters_new_int()

void xsh_parameters_new_int ( cpl_parameterlist *  list,
const char *  recipe_id,
const char *  name,
int  value,
const char *  comment 
)

◆ xsh_parameters_new_string()

void xsh_parameters_new_string ( cpl_parameterlist *  list,
const char *  recipe_id,
const char *  name,
const char *  value,
const char *  comment 
)

◆ xsh_parameters_opt_extract_create()

void xsh_parameters_opt_extract_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_opt_extract_param  p 
)

◆ xsh_parameters_opt_extract_get()

xsh_opt_extract_param * xsh_parameters_opt_extract_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_optimal_extract_create()

void xsh_parameters_optimal_extract_create ( const char *  recipe_id,
cpl_parameterlist *  plist,
int  p 
)

Definition at line 3049 of file xsh_parameters.c.

References check, XSH_ASSURE_NOT_NULL, and xsh_parameters_new_double().

◆ xsh_parameters_optimal_extract_get_kappa()

double xsh_parameters_optimal_extract_get_kappa ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 3065 of file xsh_parameters.c.

References assure, check, and xsh_parameters_get_double().

◆ xsh_parameters_overscan_create()

void xsh_parameters_overscan_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_overscan_param  p 
)

◆ xsh_parameters_pd_noise_create()

void xsh_parameters_pd_noise_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_pd_noise_param  p 
)

create the FPN parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
pFixed Pattern Noise parameters structure

Definition at line 816 of file xsh_parameters.c.

References xsh_pd_noise_param::pd_compute, xsh_parameters_new_bool(), and xsh_parameters_new_range_int().

Referenced by xsh_mbias_create().

◆ xsh_parameters_pre_overscan()

void xsh_parameters_pre_overscan ( const char *  recipe_id,
cpl_parameterlist *  plist 
)

◆ xsh_parameters_prescan_create()

void xsh_parameters_prescan_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_prescan_param  p 
)

◆ xsh_parameters_rectify_create()

void xsh_parameters_rectify_create ( const char *  recipe_id,
cpl_parameterlist *  plist,
xsh_rectify_param  p 
)

◆ xsh_parameters_rectify_fast_get()

int xsh_parameters_rectify_fast_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 2246 of file xsh_parameters.c.

References assure, check, and xsh_parameters_get_boolean().

Referenced by xsh_scired_nod_get_parameters().

◆ xsh_parameters_rectify_get()

xsh_rectify_param * xsh_parameters_rectify_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_ref1_create()

void xsh_parameters_ref1_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_ref_param  p 
)

create the reference region definition parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
preference region parameters structure

Definition at line 641 of file xsh_parameters.c.

References xsh_ref_param::ref_llx, xsh_ref_param::ref_lly, xsh_ref_param::ref_urx, xsh_ref_param::ref_ury, and xsh_parameters_new_int().

Referenced by xsh_mdark_create(), and xsh_parameters_ron_create().

◆ xsh_parameters_ref2_create()

void xsh_parameters_ref2_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_ref_param  p 
)

create the reference region definition parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
preference region parameters structure

Definition at line 669 of file xsh_parameters.c.

References xsh_ref_param::ref_llx, xsh_ref_param::ref_lly, xsh_ref_param::ref_urx, xsh_ref_param::ref_ury, and xsh_parameters_new_int().

Referenced by xsh_parameters_ron_create().

◆ xsh_parameters_remove_crh_single_create()

void xsh_parameters_remove_crh_single_create ( const char *  recipe_id,
cpl_parameterlist *  plist,
xsh_remove_crh_single_param  p 
)

◆ xsh_parameters_remove_crh_single_get()

xsh_remove_crh_single_param * xsh_parameters_remove_crh_single_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_ron_create()

void xsh_parameters_ron_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_ron_param  p 
)

◆ xsh_parameters_ron_dark_create()

void xsh_parameters_ron_dark_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_ron_dark_param  p 
)

create the RON determination parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
pRON parameters structure

Definition at line 697 of file xsh_parameters.c.

References xsh_ron_dark_param::ron_hsize, xsh_ron_dark_param::ron_llx, xsh_ron_dark_param::ron_lly, xsh_ron_dark_param::ron_nsamp, xsh_ron_dark_param::ron_urx, xsh_ron_dark_param::ron_ury, and xsh_parameters_new_int().

Referenced by xsh_mdark_create().

◆ xsh_parameters_slit_limit_create()

void xsh_parameters_slit_limit_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_slit_limit_param  p 
)

◆ xsh_parameters_slit_limit_get()

xsh_slit_limit_param * xsh_parameters_slit_limit_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_stack_create()

void xsh_parameters_stack_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_stack_param  sp 
)

create the RON determination parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
pRON parameters structure

Definition at line 735 of file xsh_parameters.c.

References xsh_stack_param::khigh, xsh_stack_param::klow, XSH_FREE, xsh_parameters_new_double(), and xsh_stringcat_any().

Referenced by xsh_absorp_create(), xsh_geom_ifu_create(), xsh_mbias_create(), xsh_mdark_create(), xsh_mflat_create(), xsh_respon_slit_nod_create(), xsh_scired_ifu_offset_create(), xsh_scired_ifu_stare_create(), xsh_scired_slit_nod_create(), and xsh_scired_slit_stare_create().

◆ xsh_parameters_struct_create()

void xsh_parameters_struct_create ( const char *  recipe_id,
cpl_parameterlist *  list,
xsh_struct_param  p 
)

create the structX/Y region definition parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to update
preference region parameters structure

Definition at line 619 of file xsh_parameters.c.

References xsh_struct_param::ref_x, xsh_struct_param::ref_y, and xsh_parameters_new_int().

Referenced by main(), and xsh_mbias_create().

◆ xsh_parameters_subtract_sky_single_create()

void xsh_parameters_subtract_sky_single_create ( const char *  recipe_id,
cpl_parameterlist *  plist,
xsh_subtract_sky_single_param  p 
)

◆ xsh_parameters_subtract_sky_single_get()

xsh_subtract_sky_single_param * xsh_parameters_subtract_sky_single_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_subtract_sky_single_get_first()

int xsh_parameters_subtract_sky_single_get_first ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 2934 of file xsh_parameters.c.

References assure, check, and xsh_parameters_get_int().

Referenced by xsh_slit_stare_get_params().

◆ xsh_parameters_subtract_sky_single_get_kappa()

double xsh_parameters_subtract_sky_single_get_kappa ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 2986 of file xsh_parameters.c.

References check, XSH_ASSURE_NOT_NULL, and xsh_parameters_get_double().

◆ xsh_parameters_subtract_sky_single_get_niter()

int xsh_parameters_subtract_sky_single_get_niter ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 2968 of file xsh_parameters.c.

References check, XSH_ASSURE_NOT_NULL, and xsh_parameters_get_int().

◆ xsh_parameters_subtract_sky_single_get_second()

int xsh_parameters_subtract_sky_single_get_second ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 2951 of file xsh_parameters.c.

References check, XSH_ASSURE_NOT_NULL, and xsh_parameters_get_int().

Referenced by xsh_slit_stare_get_params().

◆ xsh_parameters_subtract_sky_single_get_true()

int xsh_parameters_subtract_sky_single_get_true ( const char *  recipe_id,
cpl_parameterlist *  list 
)

◆ xsh_parameters_test_mode_get()

char * xsh_parameters_test_mode_get ( const char *  recipe_id,
const cpl_parameterlist *  list 
)

Definition at line 500 of file xsh_parameters.c.

References xsh_parameters_get_string().

◆ xsh_parameters_time_stamp_get()

int xsh_parameters_time_stamp_get ( const char *  recipe_id,
const cpl_parameterlist *  list 
)

Definition at line 510 of file xsh_parameters.c.

References xsh_parameters_get_boolean(), and xsh_time_stamp_set().

◆ xsh_parameters_use_model_create()

void xsh_parameters_use_model_create ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 2038 of file xsh_parameters.c.

References check, XSH_ASSURE_NOT_NULL, and xsh_parameters_new_string().

◆ xsh_parameters_use_model_get()

int xsh_parameters_use_model_get ( const char *  recipe_id,
const cpl_parameterlist *  list 
)

Definition at line 2052 of file xsh_parameters.c.

References XSH_ASSURE_NOT_NULL, and xsh_parameters_get_string().

◆ xsh_parameters_wavecal_margin_create()

void xsh_parameters_wavecal_margin_create ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 1972 of file xsh_parameters.c.

References assure, check, WAVECAL_MARGIN_DEFAULT, and xsh_parameters_new_range_int().

Referenced by xsh_wavecal_create().

◆ xsh_parameters_wavecal_margin_get()

int xsh_parameters_wavecal_margin_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 1990 of file xsh_parameters.c.

References assure, check, and xsh_parameters_get_int().

Referenced by xsh_wavecal_get_parameters().

◆ xsh_parameters_wavecal_range_create()

void xsh_parameters_wavecal_range_create ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 1940 of file xsh_parameters.c.

References assure, check, WAVECAL_RANGE_DEFAULT, and xsh_parameters_new_range_int().

Referenced by xsh_wavecal_create().

◆ xsh_parameters_wavecal_range_get()

int xsh_parameters_wavecal_range_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 1958 of file xsh_parameters.c.

References assure, check, and xsh_parameters_get_int().

Referenced by xsh_wavecal_get_parameters().

◆ xsh_parameters_wavecal_s_n_create()

void xsh_parameters_wavecal_s_n_create ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 2004 of file xsh_parameters.c.

References assure, check, and xsh_parameters_new_double().

Referenced by xsh_wavecal_create().

◆ xsh_parameters_wavecal_s_n_get()

double xsh_parameters_wavecal_s_n_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

Definition at line 2022 of file xsh_parameters.c.

References assure, check, and xsh_parameters_get_double().

Referenced by xsh_wavecal_get_parameters().

◆ xsh_recipe_params_check()

cpl_error_code xsh_recipe_params_check ( cpl_parameterlist *  parameters,
xsh_instrument instrument,
const char *  rec_id 
)

◆ xsh_recipe_params_drs_check()

cpl_error_code xsh_recipe_params_drs_check ( cpl_parameterlist *  parameters,
xsh_instrument instrument,
const char *  rec_id 
)

◆ xsh_stack_frames_get()

xsh_stack_param * xsh_stack_frames_get ( const char *  recipe_id,
cpl_parameterlist *  list 
)

get the detect arclines parameters in a parameters list

Parameters
recipe_idthe current recipe in use
listthe parameters list to search
Returns
a NEWLY allocated structure of detect orders parameters

Definition at line 1409 of file xsh_parameters.c.

References check, xsh_stack_param::khigh, xsh_stack_param::klow, xsh_stack_param::stack_method, XSH_ASSURE_NOT_NULL, XSH_MALLOC, xsh_parameters_get_double(), and xsh_parameters_get_string().

Referenced by xsh_absorp(), xsh_geom_ifu(), xsh_mbias(), xsh_mdark(), xsh_mflat(), xsh_respon_slit_nod(), xsh_scired_ifu_offset(), xsh_scired_ifu_stare(), xsh_scired_slit_nod(), and xsh_scired_slit_stare().