GIRAFFE Pipeline Reference Manual

Image Reconstruction


Functions

cxint giraffe_reconstruction_build (GiReconstruction *result, GiRebinning *rebinning, GiTable *fibers, GiTable *wsolution, GiTable *grating, GiTable *slitgeometry, GiReconstructConfig *config)
 Create and image and a data cube from extracted and rebinned spectra.
GiReconstructiongiraffe_reconstruction_new (void)
 Creates an empty reconstruction results container.
void giraffe_reconstruction_delete (GiReconstruction *reconstruction)
 Destroys a reconstruction results container.
void giraffe_reconstruction_destroy (GiReconstruction *reconstruction)
 Destroys a reconstruction results container and its contents.
GiReconstructConfiggiraffe_reconstruct_config_create (cpl_parameterlist *list)
 Creates a setup structure for the spectrum reconstruction.
void giraffe_reconstruct_config_destroy (GiReconstructConfig *config)
 Destroys a reconstruction setup structure.
void giraffe_reconstruct_config_add (cpl_parameterlist *list)
 Adds parameters for the image and data cube construction.

Detailed Description

TBD

Function Documentation

void giraffe_reconstruct_config_add cpl_parameterlist *  list  ) 
 

Adds parameters for the image and data cube construction.

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

Definition at line 1175 of file gireconstruct.c.

GiReconstructConfig* giraffe_reconstruct_config_create cpl_parameterlist *  list  ) 
 

Creates a setup structure for the spectrum reconstruction.

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 1109 of file gireconstruct.c.

void giraffe_reconstruct_config_destroy GiReconstructConfig config  ) 
 

Destroys a reconstruction 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 1151 of file gireconstruct.c.

cxint giraffe_reconstruction_build GiReconstruction result,
GiRebinning rebinning,
GiTable *  fibers,
GiTable *  wsolution,
GiTable *  grating,
GiTable *  slitgeometry,
GiReconstructConfig config
 

Create and image and a data cube from extracted and rebinned spectra.

Parameters:
result The results of the image and data cube creation.
rebinning The extracted and rebinned spectra.
fibers The fiber setup
wsolution The dispersion solution
grating The grating table
slitgeometry The slit geometry
config Setup parameters for reconstruction task.
Returns:
The function returns 0 on success and a non-zero value otherwise.
The function creates an image from the extracted and rebinned spectra of an IFU or Argus observation. The rebinned spectra and errors are taken from the rebinning structure rebinning. The corresponding fiber setup is expected in the input table fibers. Configuration options are passed through the setup structure config.

Definition at line 617 of file gireconstruct.c.

References GiReconstructConfig::cube, GiReconstruction::cube_errors, GiReconstruction::cube_spectra, GiReconstruction::errors, GiRebinning::errors, gi_warning(), giraffe_cube_delete(), giraffe_get_mode(), giraffe_image_delete(), giraffe_image_duplicate(), giraffe_image_get(), giraffe_image_get_properties(), giraffe_integrate_flux(), giraffe_range_delete(), giraffe_range_get_max(), giraffe_range_get_min(), giraffe_range_set_max(), giraffe_range_set_min(), giraffe_rebin_get_wavelength_range(), giraffe_table_get(), GiRebinParams::log, GiReconstructConfig::maximum, GiReconstructConfig::minimum, GiReconstruction::spectra, and GiRebinning::spectra.

void giraffe_reconstruction_delete GiReconstruction reconstruction  ) 
 

Destroys a reconstruction results container.

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

Definition at line 1036 of file gireconstruct.c.

void giraffe_reconstruction_destroy GiReconstruction reconstruction  ) 
 

Destroys a reconstruction results container and its contents.

Parameters:
reconstruction The reconstruction results container to destroy.
Returns:
Nothing.
The function deallocates the memory used for the reconstruction results container reconstruction and each reconstruction component it possibly contains.

Definition at line 1063 of file gireconstruct.c.

References GiReconstruction::cube_errors, GiReconstruction::cube_spectra, GiReconstruction::errors, giraffe_cube_delete(), giraffe_image_delete(), and GiReconstruction::spectra.

GiReconstruction* giraffe_reconstruction_new void   ) 
 

Creates an empty reconstruction results container.

Returns:
A newly allocated reconstruction results container.
The function allocales memory for a reconstruction results container The container is initialized to be empty.

Definition at line 1004 of file gireconstruct.c.


This file is part of the GIRAFFE Pipeline Reference Manual 2.5.1.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Tue Mar 18 10:47:45 2008 by doxygen 1.4.6 written by Dimitri van Heesch, © 1997-2004