ossimHdf5ImageDataset.h

Go to the documentation of this file.

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

#ifndef ossimHdf5ImageDataset_HEADER
#define ossimHdf5ImageDataset_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimIrect.h>
#include <iosfwd>
#include <string>
#include <ossim/hdf5/ossimHdf5.h>
#include <ossim/base/ossimReferenced.h>
#include <ossim/base/ossimRefPtr.h>

// Forward class declarations:
class ossimImageData;
class ossimEndian;
class ossimIpt;
class ossimIrect;
class ossimHdf5ImageHandler;

class OSSIM_DLL ossimHdf5ImageDataset : public ossimReferenced
{
public:
   ossimHdf5ImageDataset(ossimHdf5ImageHandler* owner=0);
   
   ossimHdf5ImageDataset( const ossimHdf5ImageDataset& obj );
   
   ~ossimHdf5ImageDataset();

   void close();

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

   bool initialize( const H5::DataSet& dataset);

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

   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;

   double getMaxPixelValue(ossim_uint32 band=0) const;
   double getMinPixelValue(ossim_uint32 band=0) const;

   bool isMinPixelSet()const;
   bool isMaxPixelSet()const;
   
   void getTileBuf(void* buffer, const ossimIrect& rect, ossim_uint32 band, bool scale=true);


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

   friend OSSIMDLLEXPORT std::ostream& operator<<(std::ostream& out,
                                                  const ossimHdf5ImageDataset& obj);
private:
   bool determineExtents();
   bool scanForValidImageRect();
   bool determineScalarType();
   bool scanForMinMax();
   
   ossimRefPtr<ossimHdf5ImageHandler> m_handler;
   ossimRefPtr<ossimHdf5> m_hdf5;
   H5::DataSet     m_dataset;
   H5::DataSpace   m_dataSpace;
   ossimScalarType m_scalar;
   ossim_uint32    m_bands;   
   ossim_uint32    m_lines;
   ossim_uint32    m_samples;
   ossimEndian*    m_endian; // For byte swapping if needed.
   std::vector<ossim_float32> m_minValue;
   std::vector<ossim_float32> m_maxValue;


   ossimIrect      m_validRect; // image rect offset relative to full image
   
}; // End: class ossimH5ImageDataset

#endif /* #ifndef ossimH5ImageDataset_HEADER */