ossimH5ImageDataset Class Reference

Class encapsulates a HDF5 Data set that can be loaded as an image. More...

#include <ossimH5ImageDataset.h>

Public Member Functions
	ossimH5ImageDataset ()
	default constructor More...
	ossimH5ImageDataset (const ossimH5ImageDataset &obj)
	copy constructor More...
	~ossimH5ImageDataset ()
	destructor More...
void	close ()
	Calls H5::DataSet::close then deletes data set. More...
const ossimH5ImageDataset &	operator= (const ossimH5ImageDataset &rhs)
bool	initialize (const H5::DataSet &dataset, const std::string &datasetName)
	Opens datasetName and initializes all data members on success. More...
const H5::DataSet *	getDataset () const
	Get const pointer to dataset. More...
H5::DataSet *	getDataset ()
	Get pointer to dataset. More...
const std::string &	getName () const
ossimScalarType	getScalarType () const
ossim_uint32	getNumberOfBands () const
ossim_uint32	getNumberOfLines () const
ossim_uint32	getNumberOfSamples () const
bool	getSwapFlag () const
const ossimIpt &	getSubImageOffset () const
const ossimIrect &	getValidImageRect () const
void	getTileBuf (void *buffer, const ossimIrect &rect, ossim_uint32 band)
	Method to grab a tile(rectangle) from image. More...
std::ostream &	print (std::ostream &out) const
	print method. More...

Private Attributes
H5::DataSet *	m_dataset
std::string	m_datasetName
ossimScalarType	m_scalar
ossim_uint32	m_bands
ossim_uint32	m_lines
ossim_uint32	m_samples
ossimIrect	m_validRect
	Zero based image rect: More...
ossimEndian *	m_endian

Friends
OSSIMDLLEXPORT std::ostream &	operator<< (std::ostream &out, const ossimH5ImageDataset &obj)

Detailed Description

Class encapsulates a HDF5 Data set that can be loaded as an image.

Definition at line 36 of file ossimH5ImageDataset.h.

Constructor & Destructor Documentation

ossimH5ImageDataset() [1/2]

ossimH5ImageDataset::ossimH5ImageDataset

(

)

default constructor

Definition at line 33 of file ossimH5ImageDataset.cpp.

   :
   m_dataset(0),
   m_datasetName(),
   m_scalar(OSSIM_SCALAR_UNKNOWN),
   m_bands(1),
   m_lines(0),
   m_samples(0),
   m_validRect(),
   m_endian(0)
{   
}

ossimH5ImageDataset() [2/2]

ossimH5ImageDataset::ossimH5ImageDataset

(

const ossimH5ImageDataset &

obj

)

copy constructor

Definition at line 46 of file ossimH5ImageDataset.cpp.

References m_dataset.

   :
   m_dataset( ( (obj.m_dataset)?new H5::DataSet(*(obj.m_dataset)):0 ) ),
   m_datasetName(obj.m_datasetName),
   m_scalar(obj.m_scalar),
   m_bands(obj.m_bands),
   m_lines(obj.m_lines),
   m_samples(obj.m_samples),
   m_validRect(obj.m_validRect),
   m_endian( obj.m_endian ? new ossimEndian() : 0 )
{
   if ( obj.m_dataset )
   {
      m_dataset = new H5::DataSet( *(obj.m_dataset) );
   }
}

~ossimH5ImageDataset()

ossimH5ImageDataset::~ossimH5ImageDataset

(

)

destructor

Definition at line 63 of file ossimH5ImageDataset.cpp.

References close().

{
   close();
}

Member Function Documentation

close()

void ossimH5ImageDataset::close

(

)

Calls H5::DataSet::close then deletes data set.

Definition at line 151 of file ossimH5ImageDataset.cpp.

References m_dataset, and m_endian.

Referenced by initialize(), and ~ossimH5ImageDataset().

{
   if ( m_dataset )
   {
      m_dataset->close();
      delete m_dataset;
      m_dataset = 0;
   }
   if ( m_endian )
   {
      delete m_endian;
      m_endian = 0;
   }
}

getDataset() [1/2]

const H5::DataSet * ossimH5ImageDataset::getDataset

(

)

const

Get const pointer to dataset.

This can be null if not open.

Returns

const pointer to dataset.

Definition at line 166 of file ossimH5ImageDataset.cpp.

References m_dataset.

{
   return m_dataset;
}

getDataset() [2/2]

H5::DataSet * ossimH5ImageDataset::getDataset

(

)

Get pointer to dataset.

This can be null if not open.

Returns

pointer to dataset.

Definition at line 171 of file ossimH5ImageDataset.cpp.

References m_dataset.

{
   return m_dataset;
}

getName()

const std::string & ossimH5ImageDataset::getName

(

)

const

Returns

The dataset name. This is the full path used for open.

Definition at line 176 of file ossimH5ImageDataset.cpp.

References m_datasetName.

{
   return m_datasetName;
}

getNumberOfBands()

ossim_uint32 ossimH5ImageDataset::getNumberOfBands

(

)

const

Returns

the number of .

Definition at line 186 of file ossimH5ImageDataset.cpp.

References m_bands.

{
   return m_bands;
}

getNumberOfLines()

ossim_uint32 ossimH5ImageDataset::getNumberOfLines

(

)

const

Returns

The number of lines.

Definition at line 191 of file ossimH5ImageDataset.cpp.

References ossimIrect::height(), and m_validRect.

{
   return m_validRect.height();
}

getNumberOfSamples()

ossim_uint32 ossimH5ImageDataset::getNumberOfSamples

(

)

const

Returns

The number of samples.

Definition at line 196 of file ossimH5ImageDataset.cpp.

References m_validRect, and ossimIrect::width().

{
   return m_validRect.width();
}

getScalarType()

ossimScalarType ossimH5ImageDataset::getScalarType

(

)

const

Returns

The output scalar type.

Definition at line 181 of file ossimH5ImageDataset.cpp.

References m_scalar.

{
   return m_scalar;
}

getSubImageOffset()

const ossimIpt & ossimH5ImageDataset::getSubImageOffset

(

)

const

Definition at line 206 of file ossimH5ImageDataset.cpp.

References m_validRect, and ossimIrect::ul().

{
   return m_validRect.ul();
}

getSwapFlag()

bool ossimH5ImageDataset::getSwapFlag

(

)

const

Returns

The swap flag.

Definition at line 201 of file ossimH5ImageDataset.cpp.

References m_endian.

{
   return (m_endian ? true: false);
}

getTileBuf()

void ossimH5ImageDataset::getTileBuf	(	void *	buffer,
		const ossimIrect &	rect,
		ossim_uint32	band
	)

Method to grab a tile(rectangle) from image.

Parameters

buffer	Buffer for data for this method to copy data to. Should be the size of rect * bytes_per_pixel for scalar type.
rect	The zero based rectangle to grab. Rectangle is relative to any sub image offset. E.g. A request for 0,0 is the upper left corner of the valid image rect.
band

Definition at line 216 of file ossimH5ImageDataset.cpp.

References ossimIrect::area(), ossimIrect::height(), m_dataset, m_endian, m_scalar, m_validRect, ossimNotify(), ossimNotifyLevel_WARN, ossimEndian::swap(), ossimIrect::ul(), ossimIrect::width(), ossimIpt::x, and ossimIpt::y.

{
   static const char MODULE[] = "ossimH5ImageDataset::getTileBuf";

   if ( m_dataset )
   {
      try
      {
         // Shift rectangle by the sub image offse (if any) from the m_validRect.
         ossimIrect irect = rect + m_validRect.ul();
         
         //--
         // Turn off the auto-printing when failure occurs so that we can
         // handle the errors appropriately
         //---
         // H5::Exception::dontPrint();

         // NOTE: rank == array dimensions in hdf5 documentation lingo.

         // Get dataspace of the dataset.
         H5::DataSpace imageDataSpace = m_dataset->getSpace();
      
         // Number of dimensions of the input dataspace.:
         const ossim_int32 IN_DIM_COUNT = imageDataSpace.getSimpleExtentNdims();

         // Native type:
         H5::DataType dataType = m_dataset->getDataType();
      
         std::vector<hsize_t> inputCount(IN_DIM_COUNT);
         std::vector<hsize_t> inputOffset(IN_DIM_COUNT);

         if ( IN_DIM_COUNT == 2 )
         {
            inputOffset[0] = irect.ul().y;
            inputOffset[1] = irect.ul().x;
         
            inputCount[0] = irect.height();
            inputCount[1] = irect.width();
         }
         else
         {
            inputOffset[0] = band;
            inputOffset[1] = irect.ul().y;
            inputOffset[2] = irect.ul().x;
         
            inputCount[0] = 1;
            inputCount[1] = irect.height();
            inputCount[2] = irect.width();
         }
      
         // Define hyperslab in the dataset; implicitly giving strike strike and block NULL.
         imageDataSpace.selectHyperslab( H5S_SELECT_SET,
                                         &inputCount.front(),
                                         &inputOffset.front() );
      
         // Output dataspace dimensions.
         const ossim_int32 OUT_DIM_COUNT = 3;
         std::vector<hsize_t> outputCount(OUT_DIM_COUNT);
         outputCount[0] = 1;             // single band
         outputCount[1] = irect.height(); // lines
         outputCount[2] = irect.width();  // samples

         // Output dataspace offset.
         std::vector<hsize_t> outputOffset(OUT_DIM_COUNT);
         outputOffset[0] = 0;
         outputOffset[1] = 0;
         outputOffset[2] = 0;
      
         // Output dataspace.
         H5::DataSpace bufferDataSpace( OUT_DIM_COUNT, &outputCount.front());
         bufferDataSpace.selectHyperslab( H5S_SELECT_SET,
                                          &outputCount.front(),
                                          &outputOffset.front() );
      
         // Read data from file into the buffer.
         m_dataset->read( buffer, dataType, bufferDataSpace, imageDataSpace );

         if ( m_endian )
         {
            // If the m_endian pointer is initialized(not zero) swap the bytes.
            m_endian->swap( m_scalar, buffer, irect.area() );
         }
      
         // Cleanup:
         bufferDataSpace.close();
         dataType.close();
         imageDataSpace.close();
         
         // memSpace.close();
         // dataType.close();
         // dataSpace.close();
      }
      catch( const H5::FileIException& error )
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << MODULE << " caught H5::FileIException!" << std::endl;
         error.printError();
      }
   
      // catch failure caused by the DataSet operations
      catch( const H5::DataSetIException& error )
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << MODULE << " caught H5::DataSetIException!" << std::endl;
         error.printError();
      }
   
      // catch failure caused by the DataSpace operations
      catch( const H5::DataSpaceIException& error )
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << MODULE << " caught H5::DataSpaceIException!" << std::endl;
         error.printError();
      }
   
      // catch failure caused by the DataSpace operations
      catch( const H5::DataTypeIException& error )
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << MODULE << " caught H5::DataTypeIException!" << std::endl;
         error.printError();
      }
      catch( ... )
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << MODULE << " caught unknown exception !" << std::endl;
      }
      
   } // Matches: if ( m_dataset )
   
} // End: ossimH5ImageDataset::getTileBuf

getValidImageRect()

const ossimIrect & ossimH5ImageDataset::getValidImageRect

(

)

const

Definition at line 211 of file ossimH5ImageDataset.cpp.

References m_validRect.

{
   return m_validRect;
}

initialize()

bool ossimH5ImageDataset::initialize	(	const H5::DataSet &	dataset,
		const std::string &	datasetName
	)

Opens datasetName and initializes all data members on success.

Returns

true on success, false on error.

Definition at line 95 of file ossimH5ImageDataset.cpp.

References ossim::byteOrder(), close(), ossim_hdf5::getByteOrder(), ossim_hdf5::getExtents(), ossim_hdf5::getScalarType(), ossim_hdf5::getValidBoundingRect(), m_bands, m_dataset, m_datasetName, m_endian, m_lines, m_samples, m_scalar, m_validRect, OSSIM_SCALAR_UNKNOWN, and ossim::scalarSizeInBytes().

Referenced by ossimH5ImageHandler::addImageDatasetEntries().

{
   bool result = false;
   
   // Clear old stuff.
   close();
   
   m_dataset = new H5::DataSet( dataset );
   m_datasetName = datasetName;

   if ( ossim_hdf5::getValidBoundingRect( *m_dataset, m_datasetName, m_validRect ) )
   {
      // Get the extents:
      std::vector<ossim_uint32> extents;
      ossim_hdf5::getExtents( m_dataset, extents );
      if ( extents.size() >= 2 )
      {
         m_samples = extents[1];
         m_lines   = extents[0];
         if ( extents.size() >= 3 )
         {
            m_bands = extents[2];
         }
         else
         {
            m_bands = 1;
         }
         
         // Scalar type:
         m_scalar = ossim_hdf5::getScalarType( m_dataset );
         
         if ( m_scalar != OSSIM_SCALAR_UNKNOWN )
         {
            result = true;
            
            // Byte swapping logic:
            if ( ( ossim::scalarSizeInBytes( m_scalar ) > 1 ) &&
                 ( ossim::byteOrder() != ossim_hdf5::getByteOrder( m_dataset ) ) )
            {
               m_endian = new ossimEndian();
            }
         }
      }
   }

   if ( !result )
   {
      // One dimensional dataset:
      close();
   }

   return result;
   
} // End: ossimH5ImageDataset::initialize

operator=()

const ossimH5ImageDataset & ossimH5ImageDataset::operator=

(

const ossimH5ImageDataset &

rhs

)

Definition at line 68 of file ossimH5ImageDataset.cpp.

References m_bands, m_dataset, m_datasetName, m_endian, m_lines, m_samples, m_scalar, and m_validRect.

{
   if ( this != &rhs )
   {
      if ( m_dataset )
      {
         delete m_dataset;
      }
      if ( rhs.m_dataset )
      {
         m_dataset = new H5::DataSet( *(rhs.m_dataset) );
      }
      else
      {
         m_dataset = 0;
      }
      m_datasetName = rhs.m_datasetName;
      m_scalar      = rhs.m_scalar;
      m_bands       = rhs.m_bands;
      m_lines       = rhs.m_lines;
      m_samples     = rhs.m_samples;
      m_validRect   = rhs.m_validRect;
      m_endian      = ( rhs.m_endian ? new ossimEndian() : 0 );
   }
   return *this;
}

print()

std::ostream & ossimH5ImageDataset::print

(

std::ostream &

out

)

const

print method.

Returns

std::ostream&

Definition at line 349 of file ossimH5ImageDataset.cpp.

References ossimLookUpTable::getEntryString(), ossimScalarTypeLut::instance(), m_bands, m_dataset, m_datasetName, m_endian, m_lines, m_samples, m_scalar, and m_validRect.

Referenced by operator<<().

{
   out << "ossimH5ImageDataset: "
       << "\nH5::DataSet::id: " << (m_dataset?m_dataset->getId():0)
       << "\nname:            " << m_datasetName
       << "\nscalar:          " << ossimScalarTypeLut::instance()->getEntryString( m_scalar )
       << "\nbands:           " << m_bands
       << "\nlines:           " << m_lines
       << "\nsamples:         " << m_samples
       << "\nvalid rect:      " << m_validRect
       << "\nswap_flage:      " << (m_endian?"true":"false")
       << std::endl;
   return out;
}

Friends And Related Function Documentation

operator<<

OSSIMDLLEXPORT std::ostream& operator<< ( std::ostream &  out, const ossimH5ImageDataset &  obj  )

friend

Definition at line 364 of file ossimH5ImageDataset.cpp.

{
   return obj.print( out );
}

Member Data Documentation

m_bands

ossim_uint32 ossimH5ImageDataset::m_bands

private

Definition at line 126 of file ossimH5ImageDataset.h.

Referenced by getNumberOfBands(), initialize(), operator=(), and print().

m_dataset

H5::DataSet* ossimH5ImageDataset::m_dataset

private

Definition at line 123 of file ossimH5ImageDataset.h.

Referenced by close(), getDataset(), getTileBuf(), initialize(), operator=(), ossimH5ImageDataset(), and print().

m_datasetName

std::string ossimH5ImageDataset::m_datasetName

private

Definition at line 124 of file ossimH5ImageDataset.h.

Referenced by getName(), initialize(), operator=(), and print().

m_endian

ossimEndian* ossimH5ImageDataset::m_endian

private

Definition at line 138 of file ossimH5ImageDataset.h.

Referenced by close(), getSwapFlag(), getTileBuf(), initialize(), operator=(), and print().

m_lines

ossim_uint32 ossimH5ImageDataset::m_lines

private

Definition at line 127 of file ossimH5ImageDataset.h.

Referenced by initialize(), operator=(), and print().

m_samples

ossim_uint32 ossimH5ImageDataset::m_samples

private

Definition at line 128 of file ossimH5ImageDataset.h.

Referenced by initialize(), operator=(), and print().

m_scalar

ossimScalarType ossimH5ImageDataset::m_scalar

private

Definition at line 125 of file ossimH5ImageDataset.h.

Referenced by getScalarType(), getTileBuf(), initialize(), operator=(), and print().

m_validRect

ossimIrect ossimH5ImageDataset::m_validRect

private

Zero based image rect:

H5 data can have null rows on the front or end. The valid rect is the scanned rectangle disregarding leading or trailing nulls. This does not handle null rows in the middle of the image.

Definition at line 137 of file ossimH5ImageDataset.h.

Referenced by getNumberOfLines(), getNumberOfSamples(), getSubImageOffset(), getTileBuf(), getValidImageRect(), initialize(), operator=(), and print().

---

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

• ossimH5ImageDataset.h
• ossimH5ImageDataset.cpp