Wavelength Calibration
Typedefs | |
typedef enum GiLineType | GiLineType |
typedef enum GiOpticalModelInfo | GiOpticalModelInfo |
typedef GiLineParams | GiLineParams |
typedef GiOpticalModelParams | GiOpticalModelParams |
typedef GiSCFitParams | GiSCFitParams |
typedef GiWCalInfo | GiWCalInfo |
Enumerations | |
enum | GiLineType |
enum | |
enum | |
enum | |
enum | GiOpticalModelInfo |
Functions | |
GiWCalData * | giraffe_wcaldata_new (void) |
void | giraffe_wcaldata_delete (GiWCalData *self) |
cxint | giraffe_calibrate_wavelength (GiWCalData *result, GiExtraction *extraction, GiLocalization *localization, GiTable *fibers, GiTable *slitgeometry, GiTable *grating, GiTable *lines, GiTable *initial, GiWCalConfig *config) |
Compute the wavelength solution for the given extracted arc-lamp spectra. | |
GiWCalConfig * | giraffe_wlcalibration_config_create (cpl_parameterlist *list) |
Creates a setup structure for the wavelength calibration. | |
void | giraffe_wlcalibration_config_destroy (GiWCalConfig *config) |
Destroys a wavelength calibration setup structure. | |
void | giraffe_wlcalibration_config_add (cpl_parameterlist *list) |
Adds parameters for the wavelength calibration. |
Detailed Description
TBDFunction Documentation
cxint giraffe_calibrate_wavelength | ( | GiWCalData * | result, | |
GiExtraction * | extraction, | |||
GiLocalization * | localization, | |||
GiTable * | fibers, | |||
GiTable * | slitgeometry, | |||
GiTable * | grating, | |||
GiTable * | lines, | |||
GiTable * | initial, | |||
GiWCalConfig * | config | |||
) |
Compute the wavelength solution for the given extracted arc-lamp spectra.
- Parameters:
-
result Container to store the wavelength calibration results extraction Extracted spectra localization Position of the fiber traces fibers List of available fibers slitgeometry List of fiber positions in the focal plane. grating Grating data lines Line catalog initial Initial guess of a wavelength solution config Wavelength calibration setup parameters.
- Returns:
- The function returns 0 on success or a non-zero value if an error occurred.
Definition at line 3217 of file giwlcalibration.c.
References GiWCalData::coeffs, GiExtraction::error, GiGrating::fcoll, GiGrating::gcam, giraffe_grating_create(), giraffe_grating_delete(), giraffe_image_get(), giraffe_image_get_properties(), giraffe_model_clone(), giraffe_model_delete(), giraffe_model_get_chisq(), giraffe_model_get_df(), giraffe_model_get_name(), giraffe_model_get_parameter(), giraffe_model_get_position(), giraffe_model_get_rsquare(), giraffe_model_get_sigma(), giraffe_table_delete(), giraffe_table_get(), giraffe_table_get_properties(), giraffe_table_new(), giraffe_wlresiduals_delete(), giraffe_wlresiduals_new(), giraffe_wlsolution_create(), giraffe_wlsolution_delete(), giraffe_wlsolution_get_residuals(), giraffe_wlsolution_get_subslits(), giraffe_wlsolution_model(), giraffe_wlsolution_name(), giraffe_wlsolution_new(), giraffe_wlsolution_set_residuals(), giraffe_wlsolution_set_subslits(), GiWCalConfig::line_nwidths, GiWCalConfig::line_residuals, GiWCalConfig::line_widths, GiWCalData::linedata, GiLocalization::locy, GiWCalConfig::opt_dchisq, GiWCalConfig::opt_direction, GiWCalConfig::opt_flags, GiWCalConfig::opt_model, GiWCalConfig::opt_niter, GiWCalConfig::opt_ntest, GiWCalConfig::opt_solution, GiWCalConfig::opt_subslits, GiGrating::order, GiWCalConfig::pxw_cliplevel, GiWCalConfig::pxw_clipmfrac, GiWCalConfig::pxw_clipniter, GiWCalConfig::pxw_xorder, GiWCalConfig::pxw_yorder, GiGrating::sdx, GiGrating::sdy, GiWCalConfig::slit_dx, GiWCalConfig::slit_dy, GiWCalConfig::slit_phi, GiWCalConfig::slit_position, GiGrating::space, GiExtraction::spectra, GiGrating::sphi, GiGrating::theta, GiGrating::wlenmax, GiGrating::wlenmin, GiWCalConfig::xws_cliplevel, GiWCalConfig::xws_clipmfrac, GiWCalConfig::xws_clipniter, GiWCalConfig::xws_xorder, and GiWCalConfig::xws_yorder.
void giraffe_wlcalibration_config_add | ( | cpl_parameterlist * | list | ) |
Adds parameters for the wavelength calibration.
- Parameters:
-
list Parameter list to which parameters are added.
- Returns:
- Nothing.
Definition at line 4766 of file giwlcalibration.c.
GiWCalConfig* giraffe_wlcalibration_config_create | ( | cpl_parameterlist * | list | ) |
Creates a setup structure for the wavelength calibration.
- Parameters:
-
list Parameter list from which the setup informations is read.
- Returns:
- A newly allocated and initialized setup structure if no errors occurred, or
NULL
otherwise.
Definition at line 4172 of file giwlcalibration.c.
References giraffe_range_create(), and giraffe_wlcalibration_config_destroy().
void giraffe_wlcalibration_config_destroy | ( | GiWCalConfig * | config | ) |
Destroys a wavelength calibration setup structure.
- Parameters:
-
config The setup structure to destroy.
- Returns:
- Nothing.
Definition at line 4722 of file giwlcalibration.c.
References giraffe_range_delete(), GiWCalConfig::line_model, GiWCalConfig::line_residuals, GiWCalConfig::line_widths, GiWCalConfig::line_wlrange, and GiWCalConfig::opt_model.
Referenced by giraffe_wlcalibration_config_create().