GiWcalConfig Struct Reference
Structure to handle wavecalibration configuration information. More...
#include <giwavecalib.h>
Data Fields | |
cpl_matrix * | line_widths |
cxdouble | flux_ratio |
cxdouble | bright_threshold |
cxint32 | bright_count |
cxdouble | line_threshold |
cxdouble | line_offset |
cxint32 | line_niter |
cxint32 | line_ntest |
lmrq_model_id | line_model |
cxdouble | line_dchsq |
cxdouble | line_reswidratio |
cxdouble | line_widexpo |
cxbool | opt_solution |
cxint | opt_direction |
lmrq_model_id | opt_model |
cxbool | fit_subslits |
cxint | opt_mod_niter |
cxint | opt_mod_ntest |
cxdouble | opt_mod_dchsq |
cxdouble | xws_clip_level |
cxint | xws_clip_niter |
cxdouble | xws_clip_mfrac |
cxdouble | pxw_clip_level |
cxint | pxw_clip_niter |
cxdouble | pxw_clip_mfrac |
cxint32 | pxw_poly_x_deg |
cxint32 | pxw_poly_y_deg |
cxint32 | xws_poly_x_deg |
cxint32 | xws_poly_y_deg |
cxdouble | range_wlen_min |
cxdouble | range_wlen_max |
Detailed Description
Structure to handle wavecalibration configuration information.
Structure contains wavecalibration configuration control information
Definition at line 49 of file giwavecalib.h.
Field Documentation
cxint32 bright_count |
If set, i.e. bright_count != CX_MAXINT, then only bright_count lines with highest nominal brightness are taken into account. If bright_count is set, bright_threshold must be set to CX_MAXDOUBLE
Definition at line 80 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create().
cxdouble bright_threshold |
If set, i.e. bright_threshold != CX_MAXDOUBLE, then only lines with nominal intensity > bright_threshold will be taken into account. If bright_threshold is set, bright_count must be set to CX_MAXINT
Definition at line 71 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create().
cxbool fit_subslits |
Use subslit geometry (TRUE) or whold slit (FALSE) during optical model fit
Definition at line 166 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxdouble flux_ratio |
Only lines with neighbours having a relative intensity < 1./flux_ratio are accepted
Definition at line 62 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxdouble line_dchsq |
Chi Square difference used by the Sigma Clipping algorithm used during the line detection fit
Definition at line 123 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
lmrq_model_id line_model |
Line model used during the line detection fit:
- psfexp,
- psfexp2, or
- gaussum
Definition at line 116 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxint32 line_niter |
Maximum number of iterations of the Sigma Clipping algorithm used during the line detection fit
Definition at line 100 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxint32 line_ntest |
Maximum number of tests performed by the Sigma Clipping algorithm used during the line detection fit
Definition at line 107 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxdouble line_offset |
Accepted difference : position of (raw maximum - fit)
Definition at line 93 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxdouble line_reswidratio |
Maximum line_width/resolution_width ratio used during the line detection fit
Definition at line 130 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxdouble line_threshold |
Line detection threshold during the line fitting (multiple of BIAS sigma)
Definition at line 87 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxdouble line_widexpo |
Exponential line profile exponent used during the line detection fit
Definition at line 137 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cpl_matrix* line_widths |
Line widths, values are stored in column order
Definition at line 55 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), giraffe_wavecalibration_config_destroy(), and giraffe_wavelength_calibration().
cxint opt_direction |
Optical dispersion direction: 1 or -1
Definition at line 150 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxdouble opt_mod_dchsq |
Chi Square difference used by the Sigma Clipping algorithm used during the optical model fit
Definition at line 187 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxint opt_mod_niter |
Maximum number of iterations of the Sigma Clipping algorithm used during the optical model fit
Definition at line 173 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxint opt_mod_ntest |
Maximum number of tests performed by the Sigma Clipping algorithm used during the optical model fit
Definition at line 180 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
lmrq_model_id opt_model |
Optical Model to use for the x direction fit during the physical optical model fit:
- xoptmod or
- xoptmod2
Definition at line 159 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxbool opt_solution |
Find optimal physical optical model using a fit of them (TRUE/FALSE)
Definition at line 144 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxdouble pxw_clip_level |
Maximum number of sigma levels used by the Sigma Clipping algorithm used during the PSF width fit
Definition at line 215 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxdouble pxw_clip_mfrac |
Minimum fraction of rejected data points used by the Sigma Clipping algorithm used during the PSF width fit [0.0..1.0]
Definition at line 229 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxint pxw_clip_niter |
Maximum number of iterations of the Sigma Clipping algorithm used during the PSF width fit
Definition at line 222 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxint32 pxw_poly_x_deg |
X polynomial order used during the PSF width fit
Definition at line 235 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxint32 pxw_poly_y_deg |
Y polynomial order used during the PSF width fit
Definition at line 241 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxdouble range_wlen_max |
Maximum wavelength to be used during line elimination [nm]
Definition at line 265 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create().
cxdouble range_wlen_min |
Minimum wavelength to be used during line elimination [nm]
Definition at line 259 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create().
cxdouble xws_clip_level |
Maximum number of sigma levels used by the Sigma Clipping algorithm used during the wavelength solution fit
Definition at line 194 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxdouble xws_clip_mfrac |
Minimum fraction of rejected data points used by the Sigma Clipping algorithm used during the optical model fit [0.0..1.0]
Definition at line 208 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxint xws_clip_niter |
Maximum number of iterations of the Sigma Clipping algorithm used during the wavelength solution fit
Definition at line 201 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxint32 xws_poly_x_deg |
X polynomial order used during the X residuals fit
Definition at line 247 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
cxint32 xws_poly_y_deg |
Y polynomial order used during the X residuals fit
Definition at line 253 of file giwavecalib.h.
Referenced by giraffe_wavecalibration_config_create(), and giraffe_wavelength_calibration().
The documentation for this struct was generated from the following file: