Spectrum Extraction
Typedefs | |
typedef enum GiProfileId | GiProfileId |
typedef GiExtractOptimalConfig | GiExtractOptimalConfig |
typedef GiExtractHorneConfig | GiExtractHorneConfig |
typedef GiExtractionData | GiExtractionData |
typedef GiExtractionSlice | GiExtractionSlice |
typedef GiExtractionPsfLimits | GiExtractionPsfLimits |
typedef GiExtractionWorkspace | GiExtractionWorkspace |
typedef GiVirtualSlit | GiVirtualSlit |
Enumerations | |
enum | GiProfileId |
Functions | |
cxint | giraffe_extract_spectra (GiExtraction *result, GiImage *image, GiTable *fibers, GiLocalization *sloc, GiImage *bpixel, GiImage *slight, GiExtractConfig *config) |
Extracts the spectra from a preprocessed frame. | |
GiExtractConfig * | giraffe_extract_config_create (cpl_parameterlist *list) |
Creates a setup structure for the spectrum extraction. | |
void | giraffe_extract_config_destroy (GiExtractConfig *config) |
Destroys a spectrum extraction setup structure. | |
void | giraffe_extract_config_add (cpl_parameterlist *list) |
Adds parameters for the spectrum extraction. |
Detailed Description
TBDFunction Documentation
void giraffe_extract_config_add | ( | cpl_parameterlist * | list | ) |
Adds parameters for the spectrum extraction.
- Parameters:
-
list Parameter list to which parameters are added.
- Returns:
- Nothing.
Definition at line 3511 of file giextract.c.
GiExtractConfig* giraffe_extract_config_create | ( | cpl_parameterlist * | list | ) |
Creates a setup structure for the spectrum extraction.
- 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 3407 of file giextract.c.
void giraffe_extract_config_destroy | ( | GiExtractConfig * | config | ) |
Destroys a spectrum extraction setup structure.
- Parameters:
-
config The setup structure to destroy.
- Returns:
- Nothing.
Definition at line 3481 of file giextract.c.
References GiExtractConfig::model, and GiExtractConfig::psf.
cxint giraffe_extract_spectra | ( | GiExtraction * | result, | |
GiImage * | image, | |||
GiTable * | fibers, | |||
GiLocalization * | sloc, | |||
GiImage * | bpixel, | |||
GiImage * | slight, | |||
GiExtractConfig * | config | |||
) |
Extracts the spectra from a preprocessed frame.
- Parameters:
-
result The result of the spectrum extraction task. image The image from which the spectra are extracted. fibers The fibers/spectra to be extracted. sloc Spectrum localization data for the spectra to extract. bpixel Bad pixel map to use. slight Scattered light model to use. config Setup parameters for the spectrum extraction task.
- Returns:
- The fuction returns 0 on success and 1 in case of errors.
Definition at line 2483 of file giextract.c.
References GiExtractConfig::bkgorder, GiExtraction::centroid, GiExtractConfig::emethod, GiExtraction::error, GiExtractConfig::ewidth, GiExtractConfig::fraction, gi_message(), gi_warning(), giraffe_image_create(), giraffe_image_delete(), giraffe_image_get(), giraffe_image_get_properties(), giraffe_image_set_properties(), giraffe_propertylist_get_ron(), giraffe_propertylist_update(), giraffe_table_get(), GiExtractConfig::horne, GiExtractConfig::iterations, GiLocalization::locw, GiLocalization::locy, GiExtractConfig::mingood, GiExtraction::model, GiExtractConfig::model, GiExtraction::npixels, GiExtractConfig::optimal, GiLocalization::psf, GiExtractConfig::psf, GiExtractConfig::ron, GiExtractConfig::sigma, GiExtraction::spectra, GiExtractConfig::wfactor, GiWindow::x0, GiWindow::x1, GiWindow::y0, and GiWindow::y1.