GIRAFFE Pipeline Reference Manual

A Range Data Type

Functions

GiRange * giraffe_range_new (void)
 Creates a new range.
GiRange * giraffe_range_create (cxdouble min, cxdouble max)
 Creates a new range from the given minimum and maximum values.
void giraffe_range_delete (GiRange *self)
 Destroys a range object.
void giraffe_range_set_min (GiRange *self, cxdouble min)
 Set the minimum of a range.
cxdouble giraffe_range_get_min (const GiRange *const self)
 Get the minimum of a range.
void giraffe_range_set_max (GiRange *self, cxdouble max)
 Set the maximum of a range.
cxdouble giraffe_range_get_max (const GiRange *const self)
 Get the maximum of a range.

Detailed Description

TBD


Function Documentation

GiRange* giraffe_range_create ( cxdouble  min,
cxdouble  max 
)

Creates a new range from the given minimum and maximum values.

Parameters:
min The minimum value of the range.
max The maximum value of the range.
Returns:
A newly allocated range if no errors occurred, or NULL otherwise.

The function creates a new range object. The minimum and maximum values of the created range are initialized with the given minimum value min and the maximum value max.

Definition at line 91 of file girange.c.

Referenced by giraffe_rebin_get_wavelength_range(), giraffe_sgcalibration_config_create(), and giraffe_wlcalibration_config_create().

void giraffe_range_delete ( GiRange *  self  ) 

Destroys a range object.

Parameters:
self The range to destroy.
Returns:
Nothing.

The function deallocates the memory used by the range object self.

Definition at line 126 of file girange.c.

Referenced by giraffe_fov_build(), giraffe_sgcalibration_config_destroy(), and giraffe_wlcalibration_config_destroy().

cxdouble giraffe_range_get_max ( const GiRange *const   self  ) 

Get the maximum of a range.

Parameters:
self The range to be queried.
Returns:
The current maximum of the range.

The function queries the maximum value of the given range self.

Definition at line 221 of file girange.c.

Referenced by giraffe_fov_build().

cxdouble giraffe_range_get_min ( const GiRange *const   self  ) 

Get the minimum of a range.

Parameters:
self The range to be queried.
Returns:
The current minimum of the range.

The function queries the minimum value of the given range self.

Definition at line 175 of file girange.c.

Referenced by giraffe_fov_build().

GiRange* giraffe_range_new ( void   ) 

Creates a new range.

Returns:
A newly allocated range if no errors occurred, or NULL otherwise.

The function creates a new range object. The minimum and maximum values of the created range are initialized to 0.0.

Definition at line 66 of file girange.c.

void giraffe_range_set_max ( GiRange *  self,
cxdouble  max 
)

Set the maximum of a range.

Parameters:
self The range to be updated.
max The value to be set as maximum.
Returns:
Nothing.

The function updates the maximum value of the given range self with max.

Definition at line 198 of file girange.c.

Referenced by giraffe_fov_build().

void giraffe_range_set_min ( GiRange *  self,
cxdouble  min 
)

Set the minimum of a range.

Parameters:
self The range to be updated.
min The value to be set as minimum.
Returns:
Nothing.

The function updates the minimum value of the given range self with min.

Definition at line 152 of file girange.c.

Referenced by giraffe_fov_build().


This file is part of the GIRAFFE Pipeline Reference Manual 2.8.8.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Fri Mar 4 10:50:29 2011 by doxygen 1.6.3 written by Dimitri van Heesch, © 1997-2004