Grating Data
Functions | |
GiGrating * | giraffe_grating_new (void) |
Create a new GiGrating. | |
GiGrating * | giraffe_grating_create (const GiImage *spectra, const GiTable *grating) |
Create a GiGrating from a reference image. | |
void | giraffe_grating_delete (GiGrating *self) |
Destroys an GiGrating object. | |
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
TBDFunction 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.
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, GiGrating::setup, 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 object.
- Parameters:
-
self The GiGrating object to destroy
- Returns:
- Nothing.
Definition at line 429 of file gigrating.c.
References GiGrating::filter, GiGrating::name, GiGrating::setup, and GiGrating::slit.
Referenced by giraffe_calibrate_slit(), giraffe_calibrate_wavelength(), giraffe_compute_offsets(), giraffe_grating_create(), and giraffe_transmission_compute().
void giraffe_grating_dump | ( | const GiGrating * | grating | ) |
Dump the the information contained in a GiGrating to output.
- Parameters:
-
grating GiGrating to dump
Definition at line 730 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
Definition at line 194 of file gigrating.c.
References GiGrating::name.
Referenced by giraffe_grating_create().
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
- 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 482 of file gigrating.c.
References GiGrating::band, GiGrating::fcoll, GiGrating::filter, GiGrating::gcam, GIFITS_KEYWORD_MISSING_MSG, giraffe_get_mode(), giraffe_image_get_properties(), giraffe_table_get(), GiGrating::name, GiGrating::order, GiGrating::resol, GiGrating::sdx, GiGrating::sdy, GiGrating::setup, GiGrating::slit, GiGrating::space, GiGrating::sphi, GiGrating::theta, GiGrating::wlen0, GiGrating::wlenmax, and GiGrating::wlenmin.