GIRAFFE Pipeline Reference Manual

Fiber Selection

Functions

GiTable * giraffe_fibers_select (const cpl_frame *frame, const GiTable *reference, 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
listParameter list to which parameters are added.
Returns
Nothing.

TBD

Definition at line 399 of file gifibers.c.

GiFibersConfig* giraffe_fibers_config_create ( cpl_parameterlist *  list)

Creates a setup structure for the fiber selection.

Parameters
listParameter 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 323 of file gifibers.c.

void giraffe_fibers_config_destroy ( GiFibersConfig *  config)

Destroys a fibers setup structure.

Parameters
configThe setup structure to destroy.
Returns
Nothing.

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

Definition at line 371 of file gifibers.c.

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

Selects the spectra to process.

Parameters
frameA frame containing an Ozpoz and a FLAMES fibers table.
referenceSlit geometry for the current setup defining active fibers.
configSetup 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 be processed in subsequent reduction steps from the Ozpoz and the FLAMES Fibers table in frame and a selection of spectra given by config. The selection may be given as the number of spectra (treated as a continuous range from 1 to the given number), as a list of spectra, or from the column "FPS" of the table reference. The final table will contains all the fibers that satisfy all selection criteria.

If NULL is passed as fiber_setup, or config the respective parameter has no effect on 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 80 of file gifibers.c.

References giraffe_create_spectrum_selection(), 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
frameFrame for which the fiber list is built.
referenceFrame 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 226 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.12.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Mon Mar 24 2014 11:43:53 by doxygen 1.8.2 written by Dimitri van Heesch, © 1997-2004