GIRAFFE Pipeline Reference Manual

Slit Geometry


Functions

GiSlitGeometrygiraffe_slitgeometry_new (void)
 Create a new GiSlitGeometry.
GiSlitGeometrygiraffe_slitgeometry_duplicate (GiSlitGeometry *other)
 Creates a (deep) copy of the GiSlitGeometry.
GiSlitGeometrygiraffe_slitgeometry_create (GiTable *slitgeometry, cxbool subslits)
 Create a slit geometry object from a slit geometry table.
void giraffe_slitgeometry_delete (GiSlitGeometry *self)
 Destroy an GiSlitGeometry.
cxint giraffe_slitgeometry_size (GiSlitGeometry *self)
 Returns current size of a GiSlitGeometry.
void giraffe_slitgeometry_resize (GiSlitGeometry *self, cxint size)
 Destructive resize of a GiSlitGeometry.
void giraffe_slitgeometry_set (GiSlitGeometry *self, cxint pos, cpl_matrix *nm)
 Sets (copies) a cpl_matrix to a specified position of the GiSlitGeometry.
cpl_matrix * giraffe_slitgeometry_get (GiSlitGeometry *self, cxint pos)
 Gets a reference to the matrix at a specified position.
void giraffe_slitgeometry_print (GiSlitGeometry *self)
 Dump the the information contained in a GiSlitGeometry to output.
GiTable * giraffe_slitgeometry_load (const GiTable *fibers, const cxchar *filename, cxint pos, const cxchar *tag)
 Load the slit geometry information for a given fiber setup.
cpl_frame * giraffe_slitgeometry_save (const GiTable *slitgeometry)

Detailed Description

TBD

Function Documentation

GiSlitGeometry* giraffe_slitgeometry_create GiTable *  slitgeometry,
cxbool  subslits
 

Create a slit geometry object from a slit geometry table.

Parameters:
self Slit geometry setup to initialize.
slitgeometry Slit geometry table.
subslits Flag controlling the fitting of subslits.
Returns:
The function returns the newly created slit geometry, or NULL if an error occurred.
Function retrieves subslit information based on slitgeo and fitsubslit. xfibre and yfibre contain the x and y position of the individual fibers inside the slit. If fitsubslit is TRUE subslits contains a list of matrices, with each matrix i containing the fibre numbers in the i'th subslit. The size of the list of matrices is equal to the number of subslits. If fitsubslit is FALSE all fibers are contained in a single matrix and the size of the list of matrices is 1.

See also:
GiSlitGeometry

Definition at line 194 of file gislitgeometry.c.

References GiSlitGeometry::fps, giraffe_fiberlist_query_index(), giraffe_slitgeometry_new(), giraffe_table_get(), GiSlitGeometry::rindex, GiSlitGeometry::xf, and GiSlitGeometry::yf.

Referenced by giraffe_wavelength_calibration().

void giraffe_slitgeometry_delete GiSlitGeometry self  ) 
 

Destroy an GiSlitGeometry.

Parameters:
self GiSlitGeometry to destroy
Returns:
Nothing.
Destroys an GiSlitGeometry and frees all associated memory

Definition at line 359 of file gislitgeometry.c.

References GiSlitGeometry::subslits.

Referenced by giraffe_wavelength_calibration(), giraffe_wcalsolution_create(), and giraffe_wcalsolution_delete().

GiSlitGeometry* giraffe_slitgeometry_duplicate GiSlitGeometry other  ) 
 

Creates a (deep) copy of the GiSlitGeometry.

Parameters:
other GiSlitGeometry to copy
Returns:
Pointer to new GiSlitGeometry or NULL if an error occured
Returns a pointer to a (deep)copy of the input GiSlitGeometry other.

Definition at line 132 of file gislitgeometry.c.

References giraffe_slitgeometry_get(), giraffe_slitgeometry_set(), GiSlitGeometry::nsubslits, and GiSlitGeometry::subslits.

cpl_matrix* giraffe_slitgeometry_get GiSlitGeometry self,
cxint  pos
 

Gets a reference to the matrix at a specified position.

Parameters:
self GiSlitGeometry from which to retrieve the reference
pos Position from which to retrieve it
Returns:
Pointer to cpl_matrix or NULL if an error occured
Returns a reference i.e. a pointer to a cpl_matrix contained in the GiSlitGeometry self at position pos.

Definition at line 519 of file gislitgeometry.c.

References GiSlitGeometry::nsubslits, and GiSlitGeometry::subslits.

Referenced by giraffe_slitgeometry_duplicate(), giraffe_slitgeometry_print(), and giraffe_wcalsolution_dump().

GiTable* giraffe_slitgeometry_load const GiTable *  fibers,
const cxchar *  filename,
cxint  pos,
const cxchar *  tag
 

Load the slit geometry information for a given fiber setup.

Parameters:
fibers Table of fibers for which the slit geometry is needed.
filename The name of the file containing the slit geometry.
pos The data set index of the slit geometry within the file.
tag The data set name of the slit geometry.
Returns:
The function returns a table containing the slit geometry for the given fiber setup if no error occurred, or NULL otherwise.
The function creates the slit geometry table for the fiber setup specified by the fiber table fibers. The slit geometry information is read from the data set pos of the file filename. If the data set identifier tag is not NULL, it is used to validate the data set with the number pos to contain a valid slit geometry. In this case tag must match the name of the data set pos.

Definition at line 609 of file gislitgeometry.c.

References giraffe_error_pop(), giraffe_error_push(), giraffe_get_mode(), giraffe_table_delete(), giraffe_table_get(), giraffe_table_load(), and giraffe_table_new().

GiSlitGeometry* giraffe_slitgeometry_new void   ) 
 

Create a new GiSlitGeometry.

Returns:
Pointer to newly created GiSlitGeometry or if an error occured
Creates a new slit geometry setup object.

Definition at line 103 of file gislitgeometry.c.

Referenced by giraffe_slitgeometry_create(), and giraffe_wcalsolution_create().

void giraffe_slitgeometry_print GiSlitGeometry self  ) 
 

Dump the the information contained in a GiSlitGeometry to output.

Parameters:
self GiSlitGeometry to dump
Dump the information contained in a GiSlitGeometry self using the CPL messaging subsystem.

Definition at line 550 of file gislitgeometry.c.

References gi_message(), giraffe_matrix_dump(), giraffe_slitgeometry_get(), and GiSlitGeometry::subslits.

void giraffe_slitgeometry_resize GiSlitGeometry self,
cxint  size
 

Destructive resize of a GiSlitGeometry.

Parameters:
self GiSlitGeometry which to destory
size New size
Resizes the GiSlitGeometry self by first deallocating the old informatin contained in it. Afterwards new memory is allocated for the size given

Definition at line 426 of file gislitgeometry.c.

References GiSlitGeometry::nsubslits, and GiSlitGeometry::subslits.

Referenced by giraffe_wcalsolution_create().

void giraffe_slitgeometry_set GiSlitGeometry self,
cxint  pos,
cpl_matrix *  nm
 

Sets (copies) a cpl_matrix to a specified position of the GiSlitGeometry.

Parameters:
self GiSlitGeometry to copy matrix into
pos Position to which to copy the matrix
nm Matrix to copy
Copies a cpl_matrix nm to position pos inside the GiSlitGeometry self. If a cpl_matrix is already present at position pos, it is properly deallocated first. nm can be NULL, in that case the matrix at position pos is deleted and the position is marked as being empty.

Definition at line 473 of file gislitgeometry.c.

References GiSlitGeometry::nsubslits, and GiSlitGeometry::subslits.

Referenced by giraffe_slitgeometry_duplicate().

cxint giraffe_slitgeometry_size GiSlitGeometry self  ) 
 

Returns current size of a GiSlitGeometry.

Parameters:
self GiSlitGeometry for which to return the size
Returns the current size of the GiSlitGeometry i.e. how many matrices can be stored in it/are stored in it.

Returns:
Maximum number of cpl_matrix to store in GiSlitGeometry or <0 if an error occured

Definition at line 397 of file gislitgeometry.c.

References GiSlitGeometry::subslits.

Referenced by giraffe_wcalsolution_dump().


This file is part of the GIRAFFE Pipeline Reference Manual 2.5.3.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Fri Jul 18 09:49:50 2008 by doxygen 1.4.6 written by Dimitri van Heesch, © 1997-2004