GIRAFFE Pipeline Reference Manual

Relative Fiber Transmission Correction

Functions

cxint giraffe_transmission_attach (GiTable *fibers, const cxchar *filename)
 Load relative fiber transmission data from a file and add it to a fiber table.
GiTransmissionConfig * giraffe_transmission_config_create (cpl_parameterlist *list)
 Creates a setup structure for the relative transmission computation.
void giraffe_transmission_config_destroy (GiTransmissionConfig *config)
 Destroys a transmission field setup structure.
void giraffe_transmission_config_add (cpl_parameterlist *list)
 Adds parameters for the transmission correction computation.

Detailed Description

TBD


Function Documentation

cxint giraffe_transmission_attach ( GiTable *  fibers,
const cxchar *  filename 
)

Load relative fiber transmission data from a file and add it to a fiber table.

Parameters:
fibers The fiber table to which the relative transmission data is added.
filename The name of the file from which the data is loaded.
Returns:
The function returns 0 on success and a non zero value otherwise.

The function loads the fiber setup from filename. If the loaded fiber setup provides the relative transmission information it is added to the fiber table fibers. If no fiber setup is present in filename, or if it does not contain the relative fiber transmission data, the function returns an error.

Definition at line 553 of file gitransmission.c.

References giraffe_fiberlist_load(), and giraffe_table_delete().

void giraffe_transmission_config_add ( cpl_parameterlist *  list  ) 

Adds parameters for the transmission correction computation.

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

TBD

Definition at line 664 of file gitransmission.c.

GiTransmissionConfig* giraffe_transmission_config_create ( cpl_parameterlist *  list  ) 

Creates a setup structure for the relative transmission computation.

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.

TBD

Definition at line 609 of file gitransmission.c.

void giraffe_transmission_config_destroy ( GiTransmissionConfig *  config  ) 

Destroys a transmission field setup structure.

Parameters:
config The setup structure to destroy.
Returns:
Nothing.

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

TBD

Definition at line 641 of file gitransmission.c.


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