GIRAFFE Pipeline Reference Manual

Fiber Selection

Functions

GiTable * giraffe_fibers_select (const cpl_frame *frame, GiFibersConfig *config)
 Selects the spectra to process.
GiTable * giraffe_fibers_setup (const cpl_frame *frame, const cpl_frame *reference)
 Setup a fiber list.
GiFibersConfig * giraffe_fibers_config_create (cpl_parameterlist *list)
 Creates a setup structure for the fiber selection.
void giraffe_fibers_config_destroy (GiFibersConfig *config)
 Destroys a fibers setup structure.
void giraffe_fibers_config_add (cpl_parameterlist *list)
 Adds parameters for the spectrum selection.

Detailed Description

TBD


Function Documentation

void giraffe_fibers_config_add ( cpl_parameterlist *  list  ) 

Adds parameters for the spectrum selection.

Parameters:
list Parameter list to which parameters are added.
Returns:
Nothing.

TBD

Definition at line 373 of file gifibers.c.

GiFibersConfig* giraffe_fibers_config_create ( cpl_parameterlist *  list  ) 

Creates a setup structure for the fiber selection.

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 297 of file gifibers.c.

void giraffe_fibers_config_destroy ( GiFibersConfig *  config  ) 

Destroys a fibers 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 345 of file gifibers.c.

GiTable* giraffe_fibers_select ( const cpl_frame *  frame,
GiFibersConfig *  config 
)

Selects the spectra to process.

Parameters:
frame A frame containing an Ozpoz and a FLAMES fibers table.
config Setup structure containing the selection of fibers.
Returns:
The function returns the table containing the spectra/fibers to process on success, or NULL otherwise.

The function creates a table of the fibers to process in subsequent reduction steps from the Ozpoz and the FLAMES Fibers table in frame and a number or a list of spectra given by config. The final table contains the intersection of all fiber selections given. If NULL is passed as config it is not used for the creation of the result table.

The function expects that frame contains an OzPoz and a fiber table. If this is not the case the function returns an error.

Definition at line 73 of file gifibers.c.

References giraffe_fiberlist_create(), giraffe_parse_spectrum_selection(), giraffe_table_new(), and giraffe_table_set().

GiTable* giraffe_fibers_setup ( const cpl_frame *  frame,
const cpl_frame *  reference 
)

Setup a fiber list.

Parameters:
frame Frame for which the fiber list is built.
reference Frame containing the reference fiber setup.
Returns:
The function returns the created fiber list on success, or NULL if an error occurred. In the latter case an appropriate error code is also set.

The function creates an initial fiber setup from the input frame frame and associates it to the fiber setup read from the reference frame reference.

See also:
giraffe_fiberlist_create(), giraffe_fiberlist_associate(),

Definition at line 200 of file gifibers.c.

References giraffe_fiberlist_associate(), giraffe_fiberlist_create(), giraffe_fiberlist_load(), giraffe_table_delete(), giraffe_table_new(), and giraffe_table_set().


This file is part of the GIRAFFE Pipeline Reference Manual 2.8.8.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Fri Mar 4 10:50:29 2011 by doxygen 1.6.3 written by Dimitri van Heesch, © 1997-2004