casacore
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::HDF5DataSet Class Reference

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

#include <HDF5DataSet.h>

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). More...
 
 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). More...
 
 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. More...
 
virtual void close ()
 Close the hid if valid. More...
 
void setCacheSize (uInt nchunks)
 Set the cache size (in chunks) for the data set. More...
 
const IPositionshape () const
 Get the shape. More...
 
const IPositiontileShape () const
 Get the tile (chunk) shape. More...
 
void get (const Slicer &, void *buf)
 Get a section of data. More...
 
void put (const Slicer &, const void *buf)
 Put a section of data. More...
 
void extend (const IPosition &shape)
 Extend the dataset if an axis in the new shape is larger. More...
 
- Public Member Functions inherited from casacore::HDF5Object
 HDF5Object ()
 Default constructor sets to invalid hid. More...
 
virtual ~HDF5Object ()
 The destructor in a derived class should close the hid appropriately. More...
 
bool isValid () const
 Is it a valid hid? More...
 
hid_t getHid () const
 Get the hid. More...
 
 operator hid_t () const
 Convert automatically to hid_t. More...
 
void setName (const String &name)
 Get or set the name. More...
 
const StringgetName () const
 

Static Public Member Functions

static DataType getDataType (hid_t, const String &name)
 Get the data type for the data set with the given name. More...
 
static Block< hsize_t > fromShape (const IPosition &shape)
 Helper functions to convert shapes. More...
 
static IPosition toShape (const Block< hsize_t > &b)
 
- Static Public Member Functions inherited from casacore::HDF5Object
static Bool hasHDF5Support ()
 Check if there is HDF5 support compiled in. More...
 
static void throwNoHDF5 ()
 If no HDF5, throw an exception that HDF5 is not supported. More...
 

Private Member Functions

 HDF5DataSet (const HDF5DataSet &that)
 Copy constructor cannot be used. More...
 
HDF5DataSetoperator= (const HDF5DataSet &that)
 Assignment cannot be used. More...
 
void create (const HDF5Object &, const String &, const IPosition &shape, const IPosition &tileShape)
 Create the data set. More...
 
void open (const HDF5Object &, const String &)
 Open the data set and check if the external data type matches. More...
 
void closeDataSet ()
 Close the dataset (but not other hids). More...
 

Private Attributes

HDF5HidDataSpace itsDSid
 
HDF5HidProperty itsPLid
 
HDF5HidProperty itsDaplid
 
IPosition itsShape
 
IPosition itsTileShape
 
HDF5DataType itsDataType
 
const HDF5ObjectitsParent
 

Additional Inherited Members

- Protected Member Functions inherited from casacore::HDF5Object
void setHid (hid_t hid)
 Set the hid. More...
 
void clearHid ()
 Clear the hid (set to invalid). More...
 

Detailed Description

A class representing an HDF5 data set.

Intended use:

Public interface

Review Status

Test programs:
tHDF5DataSet

Prerequisite

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

§ HDF5DataSet() [1/17]

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.

Referenced by tileShape().

§ HDF5DataSet() [2/17]

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

§ HDF5DataSet() [3/17]

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

§ HDF5DataSet() [4/17]

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

§ HDF5DataSet() [5/17]

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

§ HDF5DataSet() [6/17]

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

§ HDF5DataSet() [7/17]

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

§ HDF5DataSet() [8/17]

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

§ HDF5DataSet() [9/17]

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.

§ HDF5DataSet() [10/17]

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

§ HDF5DataSet() [11/17]

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

§ HDF5DataSet() [12/17]

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

§ HDF5DataSet() [13/17]

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

§ HDF5DataSet() [14/17]

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

§ HDF5DataSet() [15/17]

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

§ HDF5DataSet() [16/17]

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

§ ~HDF5DataSet()

casacore::HDF5DataSet::~HDF5DataSet ( )

The destructor closes the HDF5 dataset object.

§ HDF5DataSet() [17/17]

casacore::HDF5DataSet::HDF5DataSet ( const HDF5DataSet that)
private

Copy constructor cannot be used.

Member Function Documentation

§ close()

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

Close the hid if valid.

Implements casacore::HDF5Object.

§ closeDataSet()

void casacore::HDF5DataSet::closeDataSet ( )
private

Close the dataset (but not other hids).

Referenced by tileShape().

§ create()

void casacore::HDF5DataSet::create ( const HDF5Object ,
const String ,
const IPosition shape,
const IPosition tileShape 
)
private

Create the data set.

Referenced by tileShape().

§ extend()

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

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

Referenced by tileShape().

§ fromShape()

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.

Referenced by tileShape().

§ get()

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

Get a section of data.

The buffer must be large enough to hold the section.

§ getDataType()

static DataType casacore::HDF5DataSet::getDataType ( hid_t  ,
const String name 
)
static

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

§ open()

void casacore::HDF5DataSet::open ( const HDF5Object ,
const String  
)
private

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

Referenced by tileShape().

§ operator=()

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

Assignment cannot be used.

Referenced by tileShape().

§ put()

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

Put a section of data.

Referenced by tileShape().

§ setCacheSize()

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.

§ shape()

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

Get the shape.

Definition at line 136 of file HDF5DataSet.h.

References itsShape.

§ tileShape()

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

Get the tile (chunk) shape.

Definition at line 140 of file HDF5DataSet.h.

References closeDataSet(), create(), extend(), fromShape(), HDF5DataSet(), itsTileShape, open(), operator=(), put(), and toShape().

§ toShape()

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

Referenced by tileShape().

Member Data Documentation

§ itsDaplid

HDF5HidProperty casacore::HDF5DataSet::itsDaplid
private

Definition at line 178 of file HDF5DataSet.h.

§ itsDataType

HDF5DataType casacore::HDF5DataSet::itsDataType
private

Definition at line 181 of file HDF5DataSet.h.

§ itsDSid

HDF5HidDataSpace casacore::HDF5DataSet::itsDSid
private

Definition at line 176 of file HDF5DataSet.h.

§ itsParent

const HDF5Object* casacore::HDF5DataSet::itsParent
private

Definition at line 182 of file HDF5DataSet.h.

§ itsPLid

HDF5HidProperty casacore::HDF5DataSet::itsPLid
private

Definition at line 177 of file HDF5DataSet.h.

§ itsShape

IPosition casacore::HDF5DataSet::itsShape
private

Definition at line 179 of file HDF5DataSet.h.

Referenced by shape().

§ itsTileShape

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: