Lib.rave Namespace Reference

Classes
class	RAVE

Functions
	open (filename=None)
	get_metadata (filename=None)
	get_metadataXML (filename=None)
	get_metadataRAVE (filename=None)

Detailed Description

rave.py

Contains initialization functions for RAVE and fundamental class definitions,
along with methods for general product generation.

Function Documentation

get_metadata()

Lib.rave.get_metadata

(

filename = None

)

Same as the open() function, but only reads metadata.
Returns only INFO.
Much faster and more convenient for managing metadata.
This function calls rave_IO.get_metadata().

Arguments:
  string filename: file string

Returns: an INFO object

get_metadataRAVE()

Lib.rave.get_metadataRAVE

(

filename = None

)

Like get_metadata(), but returns a RAVE object containing the metadata
and a complete list of _h5nodes.
Suitable for reading metadata first and then deciding later which datasets
to read.
This function calls rave_IO.get_metadataRAVE().

Arguments:
  string filename: file string

Returns: a RAVE object

get_metadataXML()

Lib.rave.get_metadataXML

(

filename = None

)

Like get_metadata(), but returns the metadata as a single XML string.
Suitable for formatting metadata prior to communicating through a socket.
This function calls rave_IO.MetadataAsXML().

Arguments:
  string filename: file string

Returns: a Python string containing a pure XML representation of metadata.

open()

Lib.rave.open

(

filename = None

)

Opens a file and returns its content as a RAVE object.
Files must be in a recognized format, and file content must be organized
according to a known information model.

Arguments:

Returns: