GIRAFFE Pipeline Reference Manual

Field of View Reconstruction

Functions

cxint giraffe_fov_build (GiFieldOfView *result, GiRebinning *rebinning, GiTable *fibers, GiTable *wsolution, GiTable *grating, GiTable *slitgeometry, GiFieldOfViewConfig *config)
 Create and image and a data cube from extracted and rebinned spectra. More...
 
GiFieldOfView * giraffe_fov_new (void)
 Create an empty container for the results of the field of view reconstruction. More...
 
void giraffe_fov_clear (GiFieldOfView *self)
 Delete the contents of a field of view object. More...
 
void giraffe_fov_delete (GiFieldOfView *self)
 Deallocate a field of view object and its contents. More...
 
cxint giraffe_fov_save_cubes (const GiFieldOfView *self, cpl_propertylist *properties, const cxchar *filename, cxptr data)
 Write the cube components of a field-of-view object to a file. More...
 
cxint giraffe_fov_save_cubes_eso3d (const GiFieldOfView *self, cpl_propertylist *properties, const cxchar *filename, cxptr data)
 Write the cube components of a field-of-view object to a file. More...
 
GiFieldOfViewConfig * giraffe_fov_config_create (cpl_parameterlist *list)
 Creates a setup structure for the field of view reconstruction. More...
 
void giraffe_fov_config_destroy (GiFieldOfViewConfig *config)
 Destroys a field of view setup structure. More...
 
void giraffe_fov_config_add (cpl_parameterlist *list)
 Adds parameters for the image and data cube construction. More...
 

Detailed Description

The module provides the functions to create data cubes and field of view images, which are constructed from the resampled spectra images.

Function Documentation

cxint giraffe_fov_build ( GiFieldOfView *  result,
GiRebinning *  rebinning,
GiTable *  fibers,
GiTable *  wsolution,
GiTable *  grating,
GiTable *  slitgeometry,
GiFieldOfViewConfig *  config 
)

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

Parameters
resultThe results of the image and data cube creation.
rebinningThe extracted and rebinned spectra.
fibersThe fiber setup
wsolutionThe dispersion solution
gratingThe grating table
slitgeometryThe slit geometry
configSetup 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 436 of file gifov.c.

References giraffe_cube_delete(), giraffe_cube_get_height(), giraffe_cube_get_width(), giraffe_cube_get_zaxis(), giraffe_cube_set_wcs(), giraffe_cube_sqrt(), giraffe_fiberlist_get_subslits(), giraffe_fov_clear(), giraffe_get_mode(), giraffe_image_delete(), giraffe_image_duplicate(), giraffe_image_get(), giraffe_image_get_properties(), giraffe_image_new(), giraffe_image_set(), giraffe_image_set_properties(), giraffe_range_delete(), giraffe_range_get_max(), giraffe_range_get_min(), giraffe_range_set_max(), giraffe_range_set_min(), giraffe_rebin_get_wavelength_range(), and giraffe_table_get().

void giraffe_fov_clear ( GiFieldOfView *  self)

Delete the contents of a field of view object.

Parameters
selfThe field of view object to be emptied.
Returns
Nothing.

Definition at line 1435 of file gifov.c.

References giraffe_cube_delete(), and giraffe_image_delete().

Referenced by giraffe_fov_build(), and giraffe_fov_delete().

void giraffe_fov_config_add ( cpl_parameterlist *  list)

Adds parameters for the image and data cube construction.

Parameters
listParameter list to which parameters are added.
Returns
Nothing.

Definition at line 2097 of file gifov.c.

GiFieldOfViewConfig* giraffe_fov_config_create ( cpl_parameterlist *  list)

Creates a setup structure for the field of view reconstruction.

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 2020 of file gifov.c.

void giraffe_fov_config_destroy ( GiFieldOfViewConfig *  config)

Destroys a field of view setup structure.

Parameters
configThe setup structure to destroy.
Returns
Nothing.

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

Definition at line 2075 of file gifov.c.

void giraffe_fov_delete ( GiFieldOfView *  self)

Deallocate a field of view object and its contents.

Parameters
selfThe field of view object to destroy.
Returns
Nothing.

The function the field-of-view container object self, and all data components it possibly contains.

Definition at line 1502 of file gifov.c.

References giraffe_fov_clear().

GiFieldOfView* giraffe_fov_new ( void  )

Create an empty container for the results of the field of view reconstruction.

Returns
A newly allocated and empty field of view container.

The function allocates the memory for a field of view container and initializes the created object so that it is a valid empty container object.

Definition at line 1401 of file gifov.c.

cxint giraffe_fov_save_cubes ( const GiFieldOfView *  self,
cpl_propertylist *  properties,
const cxchar *  filename,
cxptr  data 
)

Write the cube components of a field-of-view object to a file.

Parameters
selfA field-of-view object
propertiesThe property list to save with the object
filenameThe name of the output file
dataPointer to an integer which specifies which cube component will be saved.
Returns
The function returns 0 on success, or a non-zero number in case an error occurred.

The function creates a file filename for a cube component of an field-of-view object. The cube components are either the spectrum cube, or its associated error cube. Which component is written is determined by the value of an integer variable referenced by data. If the value is 0 the spectrum cube will be saved, and the error cube is saved in case of a non-zero value.

Definition at line 1538 of file gifov.c.

References giraffe_cube_save().

cxint giraffe_fov_save_cubes_eso3d ( const GiFieldOfView *  self,
cpl_propertylist *  properties,
const cxchar *  filename,
cxptr  data 
)

Write the cube components of a field-of-view object to a file.

Parameters
selfA field-of-view object
propertiesThe property list to save with the object
filenameThe name of the output file
dataUnused.
Returns
The function returns 0 on success, or a non-zero number in case an error occurred.

The function creates a file filename for a cube component of an field-of-view object. The cube component may be one or more spectrum cubes and optionally their associated error cubes. If error cubes are present, they must be present for each spectrum cube.

Definition at line 1681 of file gifov.c.

References giraffe_cube_save().


This file is part of the GIRAFFE Pipeline Reference Manual 2.14.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Wed Mar 11 2015 13:19:42 by doxygen 1.8.9.1 written by Dimitri van Heesch, © 1997-2004