GIRAFFE Pipeline Reference Manual

Spectrum Extraction

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

TBD


Function 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.

TBD

Definition at line 3561 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 3457 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.

The function deallocates the memory used by the setup structure config.

Definition at line 3531 of file giextract.c.

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.

The function expects a preprocessed, i.e. bias corrected and optionally dark subtracted, as input image. The list of fibers to extract from image is passed by the table fibers. The localization mask position and half-width frames are passed as components of the localization sloc. Optionally a bad pixel map and the fitted scattered light may be provided by bpixel and slight respectively. The setup parameters for the spectrum extraction task have to be provided by the structure config.

Definition at line 2533 of file giextract.c.

References 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(), and giraffe_table_get().


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