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

TBD

Function Documentation

giraffe_grating_create()

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 221 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, GiGrating::slit, and GiGrating::space.

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

giraffe_grating_delete()

void giraffe_grating_delete

(

GiGrating *

self

)

Destroys an GiGrating object.

Parameters

self	The GiGrating object to destroy

Returns

Nothing.

Destroys a GiGrating grating and frees all associated memory.

Definition at line 424 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(), and giraffe_grating_create().

giraffe_grating_dump()

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 725 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.

giraffe_grating_new()

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 189 of file gigrating.c.

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

Referenced by giraffe_grating_create().

giraffe_grating_setup()

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 477 of file gigrating.c.

References GiGrating::band, GiGrating::fcoll, GiGrating::filter, GiGrating::gcam, 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.