ossimH5Reader.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 Reader.
//
//----------------------------------------------------------------------------
// $Id

#ifndef ossimH5Reader_HEADER
#define ossimH5Reader_HEADER 1

#include <ossim/plugin/ossimPluginConstants.h>
#include <ossim/base/ossimIrect.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/base/ossimMetadataInterface.h>
#include <ossim/imaging/ossimImageData.h>
#include <ossim/imaging/ossimImageHandler.h>
#include "ossimH5ImageDataset.h"

#include <mutex>
#include <vector>

// Forward class declarations:
namespace H5
{
   class DataSet;
   class H5File;
}

class OSSIM_PLUGINS_DLL ossimH5ImageHandler : public ossimImageHandler, public ossimMetadataInterface
{
public:

   ossimH5ImageHandler();

   virtual ~ossimH5ImageHandler();

   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;

   bool isOpen()const;

   virtual void close();

   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;

   virtual ossimRefPtr<ossimImageGeometry> getImageGeometry();

   virtual double getNullPixelValue(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 void addMetadata( ossimKeywordlist* kwl,
                             const std::string& prefix ) const;

protected:

   virtual ossimRefPtr<ossimImageGeometry> getInternalImageGeometry();

   ossimRefPtr<ossimProjection> processCoarseGridProjection(
      H5::DataSet& latDataSet,
      H5::DataSet& lonDataSet,
      const ossimIrect& validRect ) const;

   bool getLatLonDatasetNames(  H5::H5File* h5File,
                                std::string& latName,
                                std::string& lonName ) const;
   bool getLatLonDatasets( H5::H5File* h5File,
                           H5::DataSet& latDataSet,
                           H5::DataSet& lonDataSet ) const; 
   
   bool getDataSetRect( std::string& name, std::string& lonName ) const;
   
   virtual bool open();

   void allocate();

   void addImageDatasetEntries(const std::vector<std::string>& names);

   bool isNppMission( H5::H5File* h5File ) const;
   
   H5::H5File*                      m_h5File;
   std::vector<ossimH5ImageDataset> m_entries;
   ossim_uint32                     m_currentEntry;
   ossimRefPtr<ossimImageData>      m_tile;
   ossimRefPtr<ossimProjection>     m_projection;
   std::mutex                       m_mutex;
   
TYPE_DATA
};

#endif /* #ifndef ossimH5Reader_HEADER */