ossimHdf5ImageHandler.h

Go to the documentation of this file.

/*****************************************************************************
 *                                                                            *
 *                                 O S S I M                                  *
 *            Open Source, Geospatial Image Processing Project                *
 *          License: MIT, see LICENSE at the top-level directory              *
 *                                                                            *
 *****************************************************************************/

#ifndef ossimHdf5ImageHandler_HEADER
#define ossimHdf5ImageHandler_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimIrect.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/imaging/ossimImageHandler.h>
#include <ossim/hdf5/ossimHdf5.h>
#include <ossim/hdf5/ossimHdf5ImageDataset.h>
#include <vector>
#include <string>
#include <mutex>
class OSSIM_DLL ossimHdf5ImageHandler : public ossimImageHandler
{
   friend class ossimHdf5ImageDataset;

public:

   ossimHdf5ImageHandler();

   virtual ~ossimHdf5ImageHandler();

   virtual ossimString getShortName() const;

   virtual ossimString getLongName()  const;

   virtual ossimString getClassName()    const;

   virtual ossimRefPtr<ossimImageData> getTile(const  ossimIrect& rect,
                                               ossim_uint32 resLevel=0);
   virtual bool getTile(ossimImageData* result, ossim_uint32 resLevel=0);

   virtual ossim_uint32 getNumberOfInputBands() const;

   virtual ossim_uint32 getNumberOfOutputBands()const;

   virtual ossim_uint32 getNumberOfLines(ossim_uint32 reduced_res_level = 0) const;

   virtual ossim_uint32 getNumberOfSamples(ossim_uint32 reduced_res_level = 0) const;

   virtual ossimIrect getImageRectangle(ossim_uint32 reduced_res_level = 0) const;

   virtual bool saveState(ossimKeywordlist& kwl,
                          const char* prefix=0)const;

   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix=0);

   virtual ossimScalarType getOutputScalarType() const;

   virtual ossim_uint32 getImageTileWidth() const;

   virtual ossim_uint32 getImageTileHeight() const;

   virtual bool isOpen() const;

   virtual void close();
   virtual void loadMetaData();
   virtual ossim_uint32 getNumberOfEntries()const;

   virtual void getEntryNames(std::vector<ossimString>& entryNames) const;

   virtual void getEntryList(std::vector<ossim_uint32>& entryList) const;

   virtual bool setCurrentEntry(ossim_uint32 entryIdx);

   virtual ossim_uint32 getCurrentEntry() const;

   ossimRefPtr<ossimHdf5ImageDataset> getCurrentDataset();

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

   virtual void setProperty(ossimRefPtr<ossimProperty> property);

   virtual ossimRefPtr<ossimProperty> getProperty(const ossimString& name) const;

   virtual void getPropertyNames(std::vector<ossimString>& propertyNames) const;

   virtual bool open();

   const std::vector<ossimString>& getRenderableSetNames() { return m_renderableNames; }

   void addRenderable(const ossimString& datasetName) { m_renderableNames.push_back(datasetName); }

protected:
   void allocate();

   std::vector<ossimString>         m_renderableNames;
   ossimRefPtr<ossimHdf5>           m_hdf5;
   std::vector<ossimRefPtr<ossimHdf5ImageDataset> > m_entries;
   ossim_uint32                     m_currentEntry;
   ossimRefPtr<ossimImageData>      m_tile;
   std::mutex                       m_mutex;

   TYPE_DATA
};

#endif /* #ifndef ossimH5Reader_HEADER */