GIRAFFE Pipeline Reference Manual

Grating Data


Functions

GiGratinggiraffe_grating_new (void)
 Create a new GiGrating.
GiGratinggiraffe_grating_create (const GiImage *spectra, const GiTable *grating)
 Create a GiGrating from a reference image.
void giraffe_grating_delete (GiGrating *self)
 Destroys an GiGrating.
cxint giraffe_grating_setup (GiTable *grating_table, GiImage *spectra, GiGrating *grating_setup)
 Retrieves grating information and returns it in a GiGrating structure.
void giraffe_grating_dump (const GiGrating *grating)
 Dump the the information contained in a GiGrating to output.

Detailed Description

TBD

Function Documentation

GiGrating* giraffe_grating_create const GiImage *  spectra,
const GiTable *  grating
 

Create a GiGrating from a reference image.

Parameters:
spectra Reference image
grating Master grating data table.
Returns:
The function returns a pointer to the created GiGrating object, or NULL in case of an error.
The function obtains the grating name, central wavelength, slit and filter name from the reference image spectra. This information is used to retrieve the grating parameters for this setup from the master grating data table grating.

Definition at line 226 of file gigrating.c.

References GiGrating::filter, giraffe_get_mode(), giraffe_grating_delete(), giraffe_grating_new(), giraffe_image_get_properties(), giraffe_table_get(), GiGrating::name, and GiGrating::slit.

Referenced by giraffe_calibrate_slit(), giraffe_calibrate_wavelength(), giraffe_compute_offsets(), and giraffe_transmission_compute().

void giraffe_grating_delete GiGrating self  ) 
 

Destroys an GiGrating.

Parameters:
grating GiGrating to destroy
Destroys a GiGrating grating and frees all associated memory.

Definition at line 426 of file gigrating.c.

References GiGrating::filter, GiGrating::name, GiGrating::setup, and GiGrating::slit.

Referenced by giraffe_calibrate_slit(), giraffe_calibrate_wavelength(), giraffe_grating_create(), giraffe_transmission_compute(), and giraffe_wavelength_calibration().

void giraffe_grating_dump const GiGrating grating  ) 
 

Dump the the information contained in a GiGrating to output.

Parameters:
grating GiGrating to dump
Dump the information contained in a GiGrating grating using the CPL messaging subsystem.

Definition at line 727 of file gigrating.c.

References GiGrating::band, GiGrating::fcoll, GiGrating::filter, GiGrating::gcam, GiGrating::name, GiGrating::order, GiGrating::resol, GiGrating::sdx, GiGrating::sdy, GiGrating::setup, GiGrating::space, GiGrating::sphi, GiGrating::theta, GiGrating::wlen0, GiGrating::wlenmax, and GiGrating::wlenmin.

GiGrating* giraffe_grating_new void   ) 
 

Create a new GiGrating.

Returns:
Pointer to newly created GiGrating or NULL if an error occured
Creates a new GiGrating

Definition at line 194 of file gigrating.c.

References GiGrating::name.

Referenced by giraffe_grating_create(), and giraffe_wavelength_calibration().

cxint giraffe_grating_setup GiTable *  grating_table,
GiImage *  spectra,
GiGrating grating_setup
 

Retrieves grating information and returns it in a GiGrating structure.

Parameters:
grating_table Table containing grating information
spectra Associated Image
grating_setup Grating setup belonging to spectra
Returns:
==0 if succesful, >0 if an error occured
Retrieves grating information from grating_table based on grating used in spectra and returns a newly allocate GiGrating structure.

Status Description :
1 - Input parameter empty (NULL value) 2 - Missing FITS keyword in spectra 3 - Central Wavelength could not be found in grating table
See also:
GiGrating

Definition at line 479 of file gigrating.c.

References GiGrating::filter, GIFITS_KEYWORD_MISSING_MSG, giraffe_image_get_properties(), giraffe_table_get(), GiGrating::name, and GiGrating::wlen0.

Referenced by giraffe_wavelength_calibration().


This file is part of the GIRAFFE Pipeline Reference Manual 2.5.2.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Fri Jun 13 14:36:26 2008 by doxygen 1.4.6 written by Dimitri van Heesch, © 1997-2004