Spectrum Localization
Typedefs | |
typedef enum GiLocalizeMethod | GiLocalizeMethod |
typedef enum GiThresholdMethod | GiThresholdMethod |
Enumerations | |
enum | GiLocalizeMethod |
enum | GiThresholdMethod |
Functions | |
cxint | giraffe_localize_spectra (GiLocalization *result, GiImage *image, GiTable *fibers, GiLocalization *master, GiImage *badpixels, GiLocalizeConfig *config) |
Finds the location of spectra in a Giraffe observation. | |
GiLocalizeConfig * | giraffe_localize_config_create (cpl_parameterlist *list) |
Creates a setup structure for the spectrum localization. | |
void | giraffe_localize_config_destroy (GiLocalizeConfig *config) |
Destroys a spectrum localization setup structure. | |
void | giraffe_localize_config_add (cpl_parameterlist *list) |
Adds parameters for the spectrum localization. |
Detailed Description
TBDFunction Documentation
void giraffe_localize_config_add | ( | cpl_parameterlist * | list | ) |
Adds parameters for the spectrum localization.
- Parameters:
-
list Parameter list to which parameters are added.
- Returns:
- Nothing.
Definition at line 3317 of file gilocalize.c.
GiLocalizeConfig* giraffe_localize_config_create | ( | cpl_parameterlist * | list | ) |
Creates a setup structure for the spectrum localization.
- 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 3186 of file gilocalize.c.
void giraffe_localize_config_destroy | ( | GiLocalizeConfig * | config | ) |
Destroys a spectrum localization setup structure.
- Parameters:
-
config The setup structure to destroy.
- Returns:
- Nothing.
Definition at line 3293 of file gilocalize.c.
cxint giraffe_localize_spectra | ( | GiLocalization * | result, | |
GiImage * | image, | |||
GiTable * | fibers, | |||
GiLocalization * | master, | |||
GiImage * | badpixels, | |||
GiLocalizeConfig * | config | |||
) |
Finds the location of spectra in a Giraffe observation.
- Parameters:
-
result The results of the spectrum localization task. image The image where spectra are searched. fibers The fibers/spectra to be localized. master An existing localization to use as first guess. badpixels The bad pixel map to use. config Setup parameters for the localization task.
- Returns:
- The function returns 0 on succes, or 1 otherwise.
NULL
the flagged pixels in the map are not used during the processing (not yet implemented, currently the bad pixel map is simply ignored).If the localization should only be done on the simultaneous calibration fibers a `master' localization master must be passed to the function. This is then used as a first guess.
The fiber setup, i.e. the configuration of the fibers used during the observation is expected to be present in the fiber table fibers. The fibers listed in this table will be searched in the image image.
Definition at line 2559 of file gilocalize.c.
References GiLocalizeConfig::binsize, GiLocalizeConfig::centroid, GiMaskParameters::ckdata, GiMaskParameters::count, GiMaskParameters::ewid, GiLocalizeConfig::ewidth, GiLocalizeConfig::fraction, GiLocalizeConfig::full, giraffe_get_mode(), giraffe_image_copy_matrix(), giraffe_image_create(), giraffe_image_get(), giraffe_image_get_properties(), giraffe_image_set_properties(), giraffe_propertylist_get_ron(), giraffe_table_copy_matrix(), giraffe_table_create(), giraffe_table_get(), giraffe_table_get_properties(), GiMaskParameters::height, GiLocalizeConfig::iterations, GiLocalization::locc, GiLocalization::locw, GiLocalization::locy, GiMaskParameters::method, GiMaskParameters::mfrac, GiMaskPosition::mw, GiMaskPosition::my, GiMaskParameters::niter, GiLocalizeConfig::noise, GiLocalizeConfig::normalize, GiLocalization::psf, GiLocalizeConfig::retries, GiMaskParameters::retry, GiLocalizeConfig::ron, GiMaskParameters::sigma, GiLocalizeConfig::sigma, GiLocalizeConfig::start, GiMaskParameters::start, GiLocalizeConfig::threshold, GiMaskParameters::threshold, GiMaskPosition::type, GiMaskParameters::wavg, GiMaskParameters::wdeg, GiMaskParameters::width, GiLocalizeConfig::worder, GiMaskParameters::xbin, GiMaskParameters::ydeg, GiLocalizeConfig::yorder, GiLocalizeConfig::ywidth, and GiMaskParameters::ywidth.