marray::hdf5 Namespace Reference

HDF5 import/export support. More...

Enumerations
enum	FileAccessMode { READ_ONLY, READ_WRITE }
enum	HDF5Version { DEFAULT_HDF5_VERSION, LATEST_HDF5_VERSION }
Functions
hid_t	createFile (const std::string &filename, HDF5Version hdf5version)
	Create an HDF5 file.
hid_t	openFile (const std::string &filename, FileAccessMode fileAccessMode, HDF5Version hdf5version)
	Open an HDF5 file.
void	closeFile (const hid_t &handle)
	Close an HDF5 file.
hid_t	createGroup (const hid_t &parentHandle, const std::string &groupName)
	Create an HDF5 group.
hid_t	openGroup (const hid_t &parentHandle, const std::string &groupName)
	Open an HDF5 group.
void	closeGroup (const hid_t &handle)
	Close an HDF5 group.
template<class T >
void	save (const hid_t &groupHandle, const std::string &datasetName, const Marray< T > &in)
	Save an Marray as an HDF5 dataset.
template<class T , bool isConst>
void	save (const hid_t &groupHandle, const std::string &datasetName, const View< T, isConst > &in)
	Save a View as an HDF5 dataset.
template<class T >
void	save (const hid_t &groupHandle, const std::string &datasetName, const std::vector< T > &in)
	Save an std::vector as an HDF5 dataset.
template<class T , class BaseIterator , class ShapeIterator >
void	saveHyperslab (const hid_t &groupHandle, const std::string &datasetName, BaseIterator baseBegin, BaseIterator baseEnd, ShapeIterator shapeBegin, const Marray< T > &in)
	Save an Marray as a hyperslab into an HDF5 dataset.
template<class T , class ShapeIterator >
void	create (const hid_t &groupHandle, const std::string &datasetName, ShapeIterator begin, ShapeIterator end, CoordinateOrder coordinateOrder)
	Create and close an HDF5 dataset to store Marray data.
template<class T >
void	load (const hid_t &groupHandle, const std::string &datasetName, Marray< T > &out)
	Load an Marray from an HDF5 dataset.
template<class T >
void	loadShape (const hid_t &groupHandle, const std::string &datasetName, Vector< T > &out)
	Load the shape of an HDF5 dataset.
template<class T , class BaseIterator , class ShapeIterator >
void	loadHyperslab (const hid_t &groupHandle, const std::string &datasetName, BaseIterator baseBegin, BaseIterator baseEnd, ShapeIterator shapeBegin, Marray< T > &out)
	Load a hyperslab from an HDF5 dataset into an Marray.
Variables
const char	reverseShapeAttributeName [14] = "reverse-shape"

---

Detailed Description

HDF5 import/export support.

---

Enumeration Type Documentation

enum marray::hdf5::FileAccessMode

Enumerator:

READ_ONLY
READ_WRITE

Definition at line 45 of file marray_hdf5.hxx.

enum marray::hdf5::HDF5Version

Enumerator:

DEFAULT_HDF5_VERSION
LATEST_HDF5_VERSION

Definition at line 46 of file marray_hdf5.hxx.

---

Function Documentation

void marray::hdf5::closeFile

(

const hid_t &

handle

)

[inline]

Close an HDF5 file.

Parameters:

handle

Handle to the HDF5 file.

See also:

openFile(), createFile()

Definition at line 804 of file marray_hdf5.hxx.

Here is the caller graph for this function:

void marray::hdf5::closeGroup

(

const hid_t &

handle

)

[inline]

Close an HDF5 group.

Parameters:

handle

HDF5 handle on group to close.

See also:

openGroup(), createGroup()

Definition at line 864 of file marray_hdf5.hxx.

Here is the caller graph for this function:

template<class T , class ShapeIterator >

void marray::hdf5::create	(	const hid_t &	groupHandle,
		const std::string &	datasetName,
		ShapeIterator	begin,
		ShapeIterator	end,
		CoordinateOrder	coordinateOrder
	)			[inline]

Create and close an HDF5 dataset to store Marray data.

Parameters:

	groupHandle	Handle of the parent HDF5 file or group.
	datasetName	Name of the HDF5 dataset.
	begin	Iterator to the beginning of a sequence that determines the shape of the dataset.
	end	Iterator to the end of a sequence that determines the shape of the dataset.
	coordinateOrder	Coordinate order of the Marray.

See also:

save(), saveHyperslab()

Definition at line 168 of file marray_hdf5.hxx.

hid_t marray::hdf5::createFile	(	const std::string &	filename,
		HDF5Version	hdf5version
	)			[inline]

Create an HDF5 file.

Parameters:

	filename	Name of the file.
	hdf5version	HDF5 version tag.

Returns:

HDF5 handle

See also:

openFile(), closeFile()

Definition at line 741 of file marray_hdf5.hxx.

Here is the caller graph for this function:

hid_t marray::hdf5::createGroup	(	const hid_t &	parentHandle,
		const std::string &	groupName
	)			[inline]

Create an HDF5 group.

Parameters:

	parentHandle	HDF5 handle on the parent group or file.
	groupName	Name of the group.

Returns:

HDF5 handle on the created group

See also:

openGroup(), closeGroup()

Definition at line 821 of file marray_hdf5.hxx.

Here is the caller graph for this function:

template<class T >

void marray::hdf5::load	(	const hid_t &	groupHandle,
		const std::string &	datasetName,
		Marray< T > &	out
	)			[inline]

Load an Marray from an HDF5 dataset.

Parameters:

	groupHandle	Handle of the parent HDF5 file or group.
	datasetName	Name of the HDF5 dataset.
	out	Marray.

See also:

loadHyperslab()

Definition at line 390 of file marray_hdf5.hxx.

template<class T , class BaseIterator , class ShapeIterator >

void marray::hdf5::loadHyperslab	(	const hid_t &	groupHandle,
		const std::string &	datasetName,
		BaseIterator	baseBegin,
		BaseIterator	baseEnd,
		ShapeIterator	shapeBegin,
		Marray< T > &	out
	)			[inline]

Load a hyperslab from an HDF5 dataset into an Marray.

Parameters:

	groupHandle	Handle of the parent HDF5 file or group.
	datasetName	Name of the HDF5 dataset.
	baseBegin	Iterator to the beginning of the sequence that determines the first coordinate of the hyperslab.
	baseEnd	Iterator to the end of the sequence that determines the first coordinate of the hyperslab.
	shapeBegin	Iterator to the beginning of the sequence that determines the shape of the hyperslab.
	out	Marray.

See also:

saveHyperslab(), create()

Definition at line 520 of file marray_hdf5.hxx.

template<class T >

void marray::hdf5::loadShape	(	const hid_t &	groupHandle,
		const std::string &	datasetName,
		Vector< T > &	out
	)			[inline]

Load the shape of an HDF5 dataset.

Parameters:

	groupHandle	Handle of the parent HDF5 file or group.
	datasetName	Name of the HDF5 dataset.
	out	Shape.

See also:

load()

Definition at line 464 of file marray_hdf5.hxx.

hid_t marray::hdf5::openFile	(	const std::string &	filename,
		FileAccessMode	fileAccessMode,
		HDF5Version	hdf5version
	)			[inline]

Open an HDF5 file.

Parameters:

	filename	Name of the file.
	fileAccessMode	File access mode.
	hdf5version	HDF5 version tag.

Returns:

HDF5 handle

See also:

closeFile(), createFile()

Definition at line 772 of file marray_hdf5.hxx.

Here is the caller graph for this function:

hid_t marray::hdf5::openGroup	(	const hid_t &	parentHandle,
		const std::string &	groupName
	)			[inline]

Open an HDF5 group.

Parameters:

	parentHandle	HDF5 handle on the parent group or file.
	groupName	Name of the group.

Returns:

HDF5 handle on the opened group.

See also:

createGroup(), closeGroup()

Definition at line 844 of file marray_hdf5.hxx.

Here is the caller graph for this function:

template<class T >

void marray::hdf5::save	(	const hid_t &	groupHandle,
		const std::string &	datasetName,
		const std::vector< T > &	in
	)			[inline]

Save an std::vector as an HDF5 dataset.

Parameters:

	groupHandle	Handle of the parent HDF5 file or group.
	datasetName	Name of the HDF5 dataset.
	in	std::vector.

See also:

saveHyperslab()

Definition at line 368 of file marray_hdf5.hxx.

template<class T , bool isConst>

void marray::hdf5::save	(	const hid_t &	groupHandle,
		const std::string &	datasetName,
		const View< T, isConst > &	in
	)			[inline]

Save a View as an HDF5 dataset.

Parameters:

	groupHandle	Handle of the parent HDF5 file or group.
	datasetName	Name of the HDF5 dataset.
	in	View.

See also:

saveHyperslab()

Definition at line 350 of file marray_hdf5.hxx.

template<class T >

void marray::hdf5::save	(	const hid_t &	groupHandle,
		const std::string &	datasetName,
		const Marray< T > &	in
	)			[inline]

Save an Marray as an HDF5 dataset.

Parameters:

	groupHandle	Handle of the parent HDF5 file or group.
	datasetName	Name of the HDF5 dataset.
	in	Marray.

See also:

saveHyperslab()

Definition at line 259 of file marray_hdf5.hxx.

Here is the caller graph for this function:

template<class T , class BaseIterator , class ShapeIterator >

void marray::hdf5::saveHyperslab	(	const hid_t &	groupHandle,
		const std::string &	datasetName,
		BaseIterator	baseBegin,
		BaseIterator	baseEnd,
		ShapeIterator	shapeBegin,
		const Marray< T > &	in
	)			[inline]

Save an Marray as a hyperslab into an HDF5 dataset.

Parameters:

	groupHandle	Handle of the parent HDF5 file or group.
	datasetName	Name of the HDF5 dataset.
	baseBegin	Iterator to the beginning of the sequence that determines the first coordinate of the hyperslab.
	baseEnd	Iterator to the end of the sequence that determines the first coordinate of the hyperslab.
	shapeBegin	Iterator to the beginning of the sequence that determines the shape of the hyperslab.
	in	Marray.

See also:

loadHyperslab(), create()

Definition at line 635 of file marray_hdf5.hxx.

---

Variable Documentation

const char marray::hdf5::reverseShapeAttributeName[14] = "reverse-shape"

Definition at line 41 of file marray_hdf5.hxx.