casacore::HDF5DataSet Class Reference

A class representing an HDF5 data set. More...

#include <HDF5DataSet.h>

Inheritance diagram for casacore::HDF5DataSet:

Public Member Functions
	HDF5DataSet (const HDF5Object &, const String &, const IPosition &shape, const IPosition &tileShape, const Bool *)
	Create an HDF5 data set in the given hid (file or group).
	HDF5DataSet (const HDF5Object &, const String &, const IPosition &shape, const IPosition &tileShape, const uChar *)
	HDF5DataSet (const HDF5Object &, const String &, const IPosition &shape, const IPosition &tileShape, const Int *)
	HDF5DataSet (const HDF5Object &, const String &, const IPosition &shape, const IPosition &tileShape, const Int64 *)
	HDF5DataSet (const HDF5Object &, const String &, const IPosition &shape, const IPosition &tileShape, const Float *)
	HDF5DataSet (const HDF5Object &, const String &, const IPosition &shape, const IPosition &tileShape, const Double *)
	HDF5DataSet (const HDF5Object &, const String &, const IPosition &shape, const IPosition &tileShape, const Complex *)
	HDF5DataSet (const HDF5Object &, const String &, const IPosition &shape, const IPosition &tileShape, const DComplex *)
	HDF5DataSet (const HDF5Object &, const String &, const Bool *)
	Open an existing HDF5 data set in the given hid (file or group).
	HDF5DataSet (const HDF5Object &, const String &, const uChar *)
	HDF5DataSet (const HDF5Object &, const String &, const Int *)
	HDF5DataSet (const HDF5Object &, const String &, const Int64 *)
	HDF5DataSet (const HDF5Object &, const String &, const Float *)
	HDF5DataSet (const HDF5Object &, const String &, const Double *)
	HDF5DataSet (const HDF5Object &, const String &, const Complex *)
	HDF5DataSet (const HDF5Object &, const String &, const DComplex *)
	~HDF5DataSet ()
	The destructor closes the HDF5 dataset object.
virtual void	close ()
	Close the hid if valid.
void	setCacheSize (uInt nchunks)
	Set the cache size (in chunks) for the data set.
const IPosition &	shape () const
	Get the shape.
const IPosition &	tileShape () const
	Get the tile (chunk) shape.
void	get (const Slicer &, void *buf)
	Get a section of data.
void	put (const Slicer &, const void *buf)
	Put a section of data.
void	extend (const IPosition &shape)
	Extend the dataset if an axis in the new shape is larger.
Static Public Member Functions
static DataType	getDataType (hid_t, const String &name)
	Get the data type for the data set with the given name.
static Block< hsize_t >	fromShape (const IPosition &shape)
	Helper functions to convert shapes.
static IPosition	toShape (const Block< hsize_t > &b)
Private Member Functions
	HDF5DataSet (const HDF5DataSet &that)
	Copy constructor cannot be used.
HDF5DataSet &	operator= (const HDF5DataSet &that)
	Assignment cannot be used.
void	create (const HDF5Object &, const String &, const IPosition &shape, const IPosition &tileShape)
	Create the data set.
void	open (const HDF5Object &, const String &)
	Open the data set and check if the external data type matches.
void	closeDataSet ()
	Close the dataset (but not other hids).
Private Attributes
HDF5HidDataSpace	itsDSid
HDF5HidProperty	itsPLid
HDF5HidProperty	itsDaplid
IPosition	itsShape
IPosition	itsTileShape
HDF5DataType	itsDataType
const HDF5Object *	itsParent

Detailed Description

A class representing an HDF5 data set.

Intended use:

Public interface

Review Status

Test programs:: tHDF5DataSet

Prerequisite

HDF5 system

Synopsis

This class wraps the HDF5 functions to create and open a data set. It is meant to be used in class HDF5Array, but can be used in itself as well. Only a limited number of data types are supported. They are: boolean (stored as chars), 4-byte integer, and single and double precision real and complex.
The data set has a fixed shape, thus cannot be extended nor resized. It can be stored in a tiled (chunked) way by specifying the tile shape when creating it.
It is possible to read or write a section of the data set by using an appropriate Slicer object. Note that the Slicer object must be fully filled; it does not infer missing info from the array shape.

Casacore arrays are in Fortran order, while HDF5 uses C order. Therefore array axes are reversed, thus axes in shapes, slicers, etc.

Motivation

It was overkill to use the HDF5 C++ interface. Instead little wrappers have been written. HDF5DataSet can be embedded in a shared pointer making it possible to share an HDF5 data set amongst various HDF5Array objects and close (i.e. destruct) the HDF5 data set object when needed.

Definition at line 85 of file HDF5DataSet.h.

Constructor & Destructor Documentation

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const IPosition &	shape,
		const IPosition &	tileShape,
		const Bool *
	)

Create an HDF5 data set in the given hid (file or group).

It gets the given name, shape (also tile shape), and data type.

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const IPosition &	shape,
		const IPosition &	tileShape,
		const uChar *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const IPosition &	shape,
		const IPosition &	tileShape,
		const Int *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const IPosition &	shape,
		const IPosition &	tileShape,
		const Int64 *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const IPosition &	shape,
		const IPosition &	tileShape,
		const Float *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const IPosition &	shape,
		const IPosition &	tileShape,
		const Double *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const IPosition &	shape,
		const IPosition &	tileShape,
		const Complex *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const IPosition &	shape,
		const IPosition &	tileShape,
		const DComplex *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const Bool *
	)

Open an existing HDF5 data set in the given hid (file or group).

It checks if the internal type matches the given type.

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const uChar *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const Int *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const Int64 *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const Float *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const Double *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const Complex *
	)

casacore::HDF5DataSet::HDF5DataSet	(	const HDF5Object &	,
		const String &	,
		const DComplex *
	)

casacore::HDF5DataSet::~HDF5DataSet ( )

The destructor closes the HDF5 dataset object.

casacore::HDF5DataSet::HDF5DataSet ( const HDF5DataSet & that ) [private]

Copy constructor cannot be used.

Member Function Documentation

virtual void casacore::HDF5DataSet::close ( ) [virtual]

Close the hid if valid.

Implements casacore::HDF5Object.

void casacore::HDF5DataSet::closeDataSet ( ) [private]

Close the dataset (but not other hids).

void casacore::HDF5DataSet::create	(	const HDF5Object &	,
		const String &	,
		const IPosition &	shape,
		const IPosition &	tileShape
	)			`[private]`

Create the data set.

void casacore::HDF5DataSet::extend ( const IPosition & shape )

Extend the dataset if an axis in the new shape is larger.

static Block<hsize_t> casacore::HDF5DataSet::fromShape ( const IPosition & shape ) [static]

Helper functions to convert shapes.

It reverses the axes, because HDF5 uses C-order.

void casacore::HDF5DataSet::get	(	const Slicer &	,
		void *	buf
	)

Get a section of data.

The buffer must be large enough to hold the section.

static DataType casacore::HDF5DataSet::getDataType	(	hid_t	,
		const String &	name
	)			`[static]`

Get the data type for the data set with the given name.

void casacore::HDF5DataSet::open	(	const HDF5Object &	,
		const String &
	)			`[private]`

Open the data set and check if the external data type matches.

HDF5DataSet& casacore::HDF5DataSet::operator= ( const HDF5DataSet & that ) [private]

Assignment cannot be used.

Reimplemented from casacore::HDF5Object.

void casacore::HDF5DataSet::put	(	const Slicer &	,
		const void *	buf
	)

Put a section of data.

void casacore::HDF5DataSet::setCacheSize ( uInt nchunks )

Set the cache size (in chunks) for the data set.

It needs to close and reopen the DataSet to take effect.

const IPosition& casacore::HDF5DataSet::shape ( ) const [inline]

Get the shape.

Definition at line 136 of file HDF5DataSet.h.

References itsShape.

const IPosition& casacore::HDF5DataSet::tileShape ( ) const [inline]

Get the tile (chunk) shape.

Definition at line 140 of file HDF5DataSet.h.

References itsTileShape.

static IPosition casacore::HDF5DataSet::toShape ( const Block< hsize_t > & b ) [static]

Member Data Documentation

HDF5HidProperty casacore::HDF5DataSet::itsDaplid [private]

Definition at line 178 of file HDF5DataSet.h.

HDF5DataType casacore::HDF5DataSet::itsDataType [private]

Definition at line 181 of file HDF5DataSet.h.

HDF5HidDataSpace casacore::HDF5DataSet::itsDSid [private]

Definition at line 176 of file HDF5DataSet.h.

const HDF5Object* casacore::HDF5DataSet::itsParent [private]

Definition at line 182 of file HDF5DataSet.h.

HDF5HidProperty casacore::HDF5DataSet::itsPLid [private]

Definition at line 177 of file HDF5DataSet.h.

IPosition casacore::HDF5DataSet::itsShape [private]

Definition at line 179 of file HDF5DataSet.h.

Referenced by shape().

IPosition casacore::HDF5DataSet::itsTileShape [private]

Definition at line 180 of file HDF5DataSet.h.

Referenced by tileShape().

The documentation for this class was generated from the following file:

casacore/casa/HDF5/HDF5DataSet.h