GIRAFFE Pipeline Reference Manual

Rebinning

Enumerations

enum  GiLocDataType { , GILOCDATATYPE_UNDEFINED, GILOCDATATYPE_FITTED_DATA, GILOCDATATYPE_FIT_COEFFS }

Functions

GiRange * giraffe_rebin_get_wavelength_range (GiImage *spectra, GiTable *wlsolution, GiTable *grating, GiTable *slitgeometry, cxbool common)
 Compute the wavelenght range of spectra.
cxint giraffe_rebin_spectra (GiRebinning *rebinning, const GiExtraction *extraction, const GiTable *fibers, const GiLocalization *localization, const GiTable *grating, const GiTable *slitgeo, const GiTable *solution, const GiRebinConfig *config)
 Rebin an Extracted Spectra Frame and associated Errors Frame.
GiRebinning * giraffe_rebinning_new (void)
 Create an empty rebinning results container.
GiRebinning * giraffe_rebinning_create (GiImage *spectra, GiImage *errors)
 Fills a rebinning results container.
void giraffe_rebinning_delete (GiRebinning *rebinning)
 Destroys a rebinning results container.
void giraffe_rebinning_destroy (GiRebinning *rebinning)
 Destroys a rebinning results container and its contents.
GiRebinConfig * giraffe_rebin_config_create (cpl_parameterlist *list)
 Creates a setup structure for the rebinning.
void giraffe_rebin_config_destroy (GiRebinConfig *config)
 Destroys a spectrum extraction setup structure.
void giraffe_rebin_config_add (cpl_parameterlist *list)
 Adds parameters for the rebinning.

Detailed Description

TBD


Enumeration Type Documentation

Enumerator:
GILOCDATATYPE_UNDEFINED 

Undefined

GILOCDATATYPE_FITTED_DATA 

matrices of fitted values

GILOCDATATYPE_FIT_COEFFS 

matrices of Chebyshev coefficients

Definition at line 68 of file girebinning.c.


Function Documentation

void giraffe_rebin_config_add ( cpl_parameterlist *  list  ) 

Adds parameters for the rebinning.

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

Definition at line 4941 of file girebinning.c.

GiRebinConfig* giraffe_rebin_config_create ( cpl_parameterlist *  list  ) 

Creates a setup structure for the rebinning.

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.
Description :
Creates a setup structure for the rebinning

Definition at line 4817 of file girebinning.c.

void giraffe_rebin_config_destroy ( GiRebinConfig *  config  ) 

Destroys a spectrum extraction setup structure.

Parameters:
config The setup structure to destroy.
Returns:
Nothing.
Description :
The function deallocates the memory used by the setup structure config and all components contained in it.

Definition at line 4917 of file girebinning.c.

GiRange* giraffe_rebin_get_wavelength_range ( GiImage *  spectra,
GiTable *  wlsolution,
GiTable *  grating,
GiTable *  slitgeometry,
cxbool  common 
)

Compute the wavelenght range of spectra.

TBD

Definition at line 3905 of file girebinning.c.

References giraffe_range_create().

Referenced by giraffe_fov_build().

cxint giraffe_rebin_spectra ( GiRebinning *  rebinning,
const GiExtraction *  extraction,
const GiTable *  fibers,
const GiLocalization *  localization,
const GiTable *  grating,
const GiTable *  slitgeo,
const GiTable *  solution,
const GiRebinConfig *  config 
)

Rebin an Extracted Spectra Frame and associated Errors Frame.

Parameters:
rebinning Rebinned Extracted Spectrum and associated errors
extraction Extraction containing Extracted Spectrum and associated errors.
fibers Table of available fibers
localization Fiber spectra centroid positions and half-width.
grating Grating data table.
slitgeo Slit geometry table.
solution Wavelength calibration solution.
config Rebinning configuration data
Returns:
The function returns 0 on succes, and a value larger than 0 if an error occured.

TBD

Status Description :
1 - Input parameter empty (NULL value) 2 - Missing FITS keyword in input frame 3 - Unable to retrieve Grating Data 4 - No wavelength calibration solution present in input 5 - Invalid optical model in wavelength calibration solution 6 - Error in optical model in wavelength calibration solution 7 - Unable to retrieve Slit Geometry 8 - Error during rebinning 9 - Error converting wavelength calibration corrections.

Definition at line 4043 of file girebinning.c.

References giraffe_image_get_properties(), giraffe_table_get(), and giraffe_table_get_properties().

Referenced by giraffe_calibrate_slit().

GiRebinning* giraffe_rebinning_create ( GiImage *  spectra,
GiImage *  errors 
)

Fills a rebinning results container.

Parameters:
spectra - Extracted spectra.
errors - Errors of the extracted spectra.
Returns:
A newly allocated rebinning results container or NULL if an error occured
Description :
The function allocales memory for a rebinning results container, and initializes it's values using the parameters given. Only a reference is stored!

Definition at line 4714 of file girebinning.c.

References giraffe_rebinning_new().

void giraffe_rebinning_delete ( GiRebinning *  rebinning  ) 

Destroys a rebinning results container.

Parameters:
rebinning - The rebinning results container to destroy.
Returns:
Nothing.
Description :
The function deallocates the memory used for the rebinning results container rebinning. Only the container itself is destroyed by calling this function. Since the container stores only references to the rebinning components its contents is left untouched and it is the responsibility of the caller to ensure that other references for the stored rebinning components exist.

Definition at line 4751 of file girebinning.c.

void giraffe_rebinning_destroy ( GiRebinning *  rebinning  ) 

Destroys a rebinning results container and its contents.

Parameters:
rebinning The rebinning results container to destroy.
Returns:
Nothing.
Description :
The function deallocates the memory used for the rebinning results container rebinning and each rebinning component it may contain.

Definition at line 4779 of file girebinning.c.

References giraffe_image_delete().

Referenced by giraffe_calibrate_slit().

GiRebinning* giraffe_rebinning_new ( void   ) 

Create an empty rebinning results container.

Returns:
A newly allocated rebinning results container or NULL if an error occured
Description :
The function allocales memory for a rebinning results container, and initializes it's values to denote an empty container.

Definition at line 4685 of file girebinning.c.

Referenced by giraffe_calibrate_slit(), and giraffe_rebinning_create().


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