GIRAFFE Pipeline Reference Manual

Miscellaneous Utilities


Functions

const cxchar * giraffe_get_license (void)
 Get the pipeline copyright and license.
GiInstrumentMode giraffe_get_mode (cpl_propertylist *properties)
 Determines the instrument mode from a property list.
cxchar * giraffe_path_get_basename (const cxchar *path)
 Gets the name of a file without any leading directory components.
cxchar * giraffe_localtime_iso8601 (void)
 Get the current date and time in ISO 8601 format.
cxint giraffe_add_recipe_info (cpl_propertylist *plist, const GiRecipeInfo *info)
 Add recipe specific information to a property list.
cxint giraffe_add_frameset_info (cpl_propertylist *plist, const cpl_frameset *set, cxint sequence)
 Add frameset specific information to a property list.
cxint giraffe_propertylist_update (cpl_propertylist *self, cpl_propertylist *properties, const cxchar *regexp)
 Update a property list.
cxint giraffe_propertylist_copy (cpl_propertylist *self, const cxchar *name, const cpl_propertylist *other, const cxchar *othername)
 Copy a property from one list to another.
cxint giraffe_propertylist_update_wcs (cpl_propertylist *properties, cxsize naxis, const cxdouble *crpix, const cxdouble *crval, const cxchar **ctype, const cxchar **cunit, const cpl_matrix *cd)
cxint giraffe_frameset_set_groups (cpl_frameset *set, GiGroupInfo *groups)

Detailed Description

TBD

Function Documentation

cxint giraffe_add_frameset_info cpl_propertylist *  plist,
const cpl_frameset *  set,
cxint  sequence
 

Add frameset specific information to a property list.

TBD

Definition at line 571 of file giutils.c.

References giraffe_path_get_basename().

Referenced by giraffe_image_add_info(), and giraffe_table_add_info().

cxint giraffe_add_recipe_info cpl_propertylist *  plist,
const GiRecipeInfo info
 

Add recipe specific information to a property list.

TBD

Definition at line 487 of file giutils.c.

References GiRecipeInfo::sequence, and GiRecipeInfo::start.

Referenced by giraffe_image_add_info(), and giraffe_table_add_info().

const cxchar* giraffe_get_license void   ) 
 

Get the pipeline copyright and license.

Returns:
The copyright and license string.
The function returns a pointer to the statically allocated license string. This string should not be modified using the returned pointer.

Definition at line 282 of file giutils.c.

GiInstrumentMode giraffe_get_mode cpl_propertylist *  properties  ) 
 

Determines the instrument mode from a property list.

Parameters:
properties The property list to query.
Returns:
The function returns the used instrument mode, or GIMODE_NONE if the mode cannot be determined or an error occurs.
The function determines the instrument mode by querying the properties properties.

Definition at line 304 of file giutils.c.

References gi_warning().

Referenced by giraffe_fiberlist_create(), giraffe_grating_create(), giraffe_localize_spectra(), giraffe_reconstruction_build(), and giraffe_slitgeometry_load().

cxchar* giraffe_localtime_iso8601 void   ) 
 

Get the current date and time in ISO 8601 format.

Returns:
The string containing the current date and time in the ISO 8601 format. If an error occurs the function returns NULL.
The function formats the current date and the local system time according to the ISO 8601 format and puts both together in a string. The returned string must be deallocated using cx_free().

Definition at line 444 of file giutils.c.

cxchar* giraffe_path_get_basename const cxchar *  path  ) 
 

Gets the name of a file without any leading directory components.

Parameters:
path The name of the file path.
Returns:
The name of the file with any leading directory components removed.
Gets the name of the file without any leading directory components. The function allocates a buffer containing the stripped file name. The returned string should be deallocated using cx_free() when it is no longer needed.

Definition at line 382 of file giutils.c.

Referenced by giraffe_add_frameset_info().

cxint giraffe_propertylist_copy cpl_propertylist *  self,
const cxchar *  name,
const cpl_propertylist *  other,
const cxchar *  othername
 

Copy a property from one list to another.

TBD

Definition at line 819 of file giutils.c.

cxint giraffe_propertylist_update cpl_propertylist *  self,
cpl_propertylist *  properties,
const cxchar *  regexp
 

Update a property list.

Parameters:
self The property list to update.
properties The source property list.
regexp A property name pattern.
Returns:
The function returns 0 on success and a non-zero value in case an error occurred. In the latter case an error code is also set.
The function updates the target property list with properties from the source list properties, which are not present in self. If a pattern string is given only properties with names matching the given pattern regexp are taken into account when self is updated. If a pattern is given, it must be a valid regular expression. If the pattern string is either NULL or the empty string, the whole source list is considered during the update operation.

Definition at line 728 of file giutils.c.


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