ossimH5ImageDataset.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// License:  LGPL
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Author:  David Burken
//
// Description: OSSIM HDF5 Image DataSet.
//
//----------------------------------------------------------------------------
// $Id

#ifndef ossimH5ImageDataset_HEADER
#define ossimH5ImageDataset_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimIrect.h>
#include <iosfwd>
#include <string>

// Forward class declarations:
class ossimImageData;
class ossimEndian;
class ossimIpt;
class ossimIrect;
namespace H5
{
   class DataSet;
   class H5File;
}

class ossimH5ImageDataset
{
public:
   ossimH5ImageDataset();
   
   ossimH5ImageDataset( const ossimH5ImageDataset& obj );
   
   ~ossimH5ImageDataset();

   void close();

   const ossimH5ImageDataset& operator=( const ossimH5ImageDataset& rhs );

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

   const H5::DataSet* getDataset() const;
   
   H5::DataSet* getDataset();

   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);   

   std::ostream& print(std::ostream& out) const;

   friend OSSIMDLLEXPORT std::ostream& operator<<(std::ostream& out,
                                                  const ossimH5ImageDataset& obj);
private:
   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:
   ossimEndian*    m_endian; // For byte swapping if needed.
   
}; // End: class ossimH5ImageDataset

#endif /* #ifndef ossimH5ImageDataset_HEADER */