GIRAFFE Pipeline Reference Manual

GiWCalConfig Struct Reference

Wavelength calibration configuration data structure. More...

#include <giwlcalibration.h>

Data Fields

cxint line_nwidths
cxint * line_widths
cxdouble line_separation
cxdouble line_fluxratio
cxdouble line_brightness
cxint line_count
GiRange * line_wlrange
cxchar * line_model
cxchar * line_residuals
cxdouble line_threshold
cxdouble line_offset
cxint line_niter
cxint line_ntest
cxdouble line_dchisq
cxdouble line_rwidthratio
cxdouble line_widthexponent
cxdouble line_saturation
cxint16 slit_position
cxdouble slit_dx
cxdouble slit_dy
cxdouble slit_phi
cxchar * opt_model
cxint opt_direction
cxbool opt_solution
cxbool opt_subslits
cxint16 opt_flags
cxint opt_niter
cxint opt_ntest
cxdouble opt_dchisq
cxdouble pxw_cliplevel
cxint pxw_clipniter
cxdouble pxw_clipmfrac
cxint pxw_xorder
cxint pxw_yorder
cxdouble xws_cliplevel
cxint xws_clipniter
cxdouble xws_clipmfrac
cxint xws_xorder
cxint xws_yorder

Detailed Description

Wavelength calibration configuration data structure.

TBD

Definition at line 57 of file giwlcalibration.h.


Field Documentation

cxdouble line_brightness

Sets the lower limit of the line brightness. Only lines which are brighter than this limit are selected from the line catalog.

Definition at line 91 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create().

cxint line_count

The number of lines with the highest nominal brightness are selected from the line list.

Definition at line 98 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create().

cxdouble line_dchisq

Chi Square difference used by the Sigma Clipping algorithm used during the line detection fit

Definition at line 156 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create().

cxdouble line_fluxratio

Only lines with neighbours having a relative intensity less than 1./line_fluxratio are accepted

Definition at line 84 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create().

cxchar* line_model

Line model used during the line detection fit:

  • psfexp,
  • psfexp2, or
  • gaussian

Definition at line 114 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create(), and giraffe_wlcalibration_config_destroy().

cxint line_niter

Maximum number of iterations of the Sigma Clipping algorithm used during the line detection fit

Definition at line 142 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create().

cxint line_ntest

Maximum number of tests performed by the Sigma Clipping algorithm used during the line detection fit

Definition at line 149 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create().

cxint line_nwidths

Number of search windows

Definition at line 63 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxdouble line_offset

Accepted difference : position of (raw maximum - fit)

Definition at line 135 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create().

cxchar* line_residuals

Controls whether optical model residuals are used for the initial computation of the line positions. If this is enabled the residuals must be provided through a previous wavelength solution.

Definition at line 122 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), giraffe_wlcalibration_config_create(), and giraffe_wlcalibration_config_destroy().

cxdouble line_rwidthratio

Maximum line_width/resolution_width ratio used during the line detection fit

Definition at line 163 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create().

cxdouble line_saturation

Line saturation level.

Definition at line 176 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create().

cxdouble line_separation

Factor used to compute the minimal distance between adjacent lines from the search window width. During the line fit only lines with a larger separation are taken into account.

Definition at line 77 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create().

cxdouble line_threshold

Line detection threshold during the line fitting (multiple of BIAS sigma)

Definition at line 129 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create().

Exponential line profile exponent used during the line detection fit

Definition at line 170 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create().

cxint* line_widths

List of search window widths used for line selection and fit.

Definition at line 69 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), giraffe_wlcalibration_config_create(), and giraffe_wlcalibration_config_destroy().

GiRange* line_wlrange

Wavelength range used for line selection [nm]

Definition at line 104 of file giwlcalibration.h.

Referenced by giraffe_wlcalibration_config_create(), and giraffe_wlcalibration_config_destroy().

cxdouble opt_dchisq

Chi Square difference used by the Sigma Clipping algorithm used during the optical model fit

Definition at line 256 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

Optical dispersion direction: 1 or -1

Definition at line 215 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxint16 opt_flags

Flags defining the optical model free parameters

Definition at line 235 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxchar* opt_model

Optical Model to use for the x direction fit during the physical optical model fit:

  • xoptmod or
  • xoptmod2

Definition at line 209 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), giraffe_wlcalibration_config_create(), and giraffe_wlcalibration_config_destroy().

cxint opt_niter

Maximum number of iterations of the Sigma Clipping algorithm used during the optical model fit

Definition at line 242 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxint opt_ntest

Maximum number of tests performed by the Sigma Clipping algorithm used during the optical model fit

Definition at line 249 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxbool opt_solution

Find optimal physical optical model using a fit of them (TRUE/FALSE)

Definition at line 222 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxbool opt_subslits

If it is set to TRUE the subslit geometry is used for fitting the optical model. Otherwise the whole slit is used.

Definition at line 229 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxdouble pxw_cliplevel

Maximum number of sigma levels used by the Sigma Clipping algorithm used during the PSF width fit

Definition at line 263 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxdouble pxw_clipmfrac

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 277 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

Maximum number of iterations of the Sigma Clipping algorithm used during the PSF width fit

Definition at line 270 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxint pxw_xorder

X polynomial order used during the PSF width fit (spectral)

Definition at line 283 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxint pxw_yorder

Y polynomial order used during the PSF width fit (spatial)

Definition at line 289 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxdouble slit_dx

Slit offset along dispersion direction

Definition at line 188 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxdouble slit_dy

Slit offset along cross-dispersion direction

Definition at line 194 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxdouble slit_phi

Slit rotation

Definition at line 200 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxint16 slit_position

Slit offset configuration

Definition at line 182 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxdouble xws_cliplevel

Maximum number of sigma levels used by the Sigma Clipping algorithm used during the wavelength solution fit

Definition at line 296 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxdouble xws_clipmfrac

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 310 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

Maximum number of iterations of the Sigma Clipping algorithm used during the wavelength solution fit

Definition at line 303 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxint xws_xorder

X polynomial order used during the X residuals fit

Definition at line 316 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().

cxint xws_yorder

Y polynomial order used during the X residuals fit

Definition at line 322 of file giwlcalibration.h.

Referenced by giraffe_calibrate_wavelength(), and giraffe_wlcalibration_config_create().


The documentation for this struct was generated from the following file:

This file is part of the GIRAFFE Pipeline Reference Manual 2.9.0.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Thu Jan 26 14:20:30 2012 by doxygen 1.6.3 written by Dimitri van Heesch, © 1997-2004