ossimGdalTileSource.h

Go to the documentation of this file.

//*******************************************************************
//
// License:  LGPL
//
// See LICENSE.txt file in the top level directory for more details.
//
// Author:  Garrett Potts
//
// Description:
//
// Contains class definition for the class "ossimGdalTileSource".
//
//*******************************************************************
//  $Id: ossimGdalTileSource.h 22960 2014-11-06 15:42:13Z okramer $

#ifndef ossimGdalTileSource_HEADER
#define ossimGdalTileSource_HEADER 1

#include <ossim/imaging/ossimImageHandler.h>
#include "ossim/plugin/ossimPluginConstants.h"
#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimIrect.h>
#include <ossim/base/ossimString.h>
#include <ossim/imaging/ossimImageData.h>
#include <gdal.h>
#include <vector>
#include <ossim/imaging/ossimAppFixedTileCache.h>

class ossimImageData;

class OSSIM_PLUGINS_DLL ossimGdalTileSource : public ossimImageHandler
{
public:
   ossimGdalTileSource();
   virtual ~ossimGdalTileSource();

   virtual ossimString getShortName()const;
   
   virtual ossimString getLongName()const;
   virtual ossimString getClassName()const;

   virtual void close();

   virtual bool open();

   virtual ossimRefPtr<ossimImageData> getTile(const ossimIrect& tileRect,
                                   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 ossim_uint32 getNumberOfDecimationLevels() 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 ossimRefPtr<ossimImageGeometry> getImageGeometry();
   
   virtual ossimRefPtr<ossimImageGeometry> getInternalImageGeometry() const;

   virtual ossimScalarType getOutputScalarType() const;

   ossimScalarType getInputScalarType() const;

   virtual ossim_uint32 getTileWidth() const;
   
   virtual ossim_uint32 getTileHeight() const;

   virtual ossim_uint32 getImageTileWidth() const;

   virtual ossim_uint32 getImageTileHeight() const;

   virtual ossim_uint32 getCurrentEntry()const;
   
   virtual bool setCurrentEntry(ossim_uint32 entryIdx);

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

   virtual void getEntryNames(
      std::vector<ossimString>& entryStringList) const;
   
   virtual bool isOpen()const;
   
   virtual double getNullPixelValue(ossim_uint32 band=0)const;
   virtual double getMinPixelValue(ossim_uint32 band=0)const;
   virtual double getMaxPixelValue(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 getDecimationFactor(ossim_uint32 resLevel,
                                    ossimDpt& result) const;

   GDALDriverH getDriver();

   virtual bool setOutputBandList(const std::vector<ossim_uint32>& band_list);

   void setPreservePaletteIndexesFlag(bool flag);

   bool getPreservePaletteIndexesFlag() const;

   virtual bool isIndexedData() const;
   
private:

   ossimRefPtr<ossimImageData> getTileBlockRead(const ossimIrect& tileRect,
                                                ossim_uint32 resLevel);

   ossimString filterSubDatasetsString(const ossimString& subString) const;
   
   void computeMinMax();
   void loadIndexTo3BandTile(const ossimIrect& clipRect,
                             ossim_uint32 aGdalBandStart = 1,
                             ossim_uint32 anOssimBandStart = 0);
   template<class InputType, class OutputType>
   void loadIndexTo3BandTileTemplate(InputType in,
                                     OutputType out,
                                     const ossimIrect& clipRect,
                                     ossim_uint32 aGdalBandStart = 1,
                                     ossim_uint32 anOssimBandStart = 0);
   
   bool isIndexTo3Band(int bandNumber = 1)const;
   bool isIndexTo1Band(int bandNumber = 1)const;
   ossim_uint32 getIndexBandOutputNumber(int bandNumber)const;
   bool isIndexed(int aGdalBandNumber = 1)const;
   void getMaxSize(ossim_uint32 resLevel,
                   int& maxX,
                   int& maxY)const;
   bool isBlocked(int band)const;
   void populateLut();

   GDALRasterBandH resolveRasterBand( ossim_uint32 resLevel,
                                      int gdalBandIndex ) const;

   ossimRefPtr<ossimImageGeometry> getExternalImageGeometryFromXml() const;
   void deleteRlevelCache();
   void setRlevelCache();
   void getDefaults();  
   
   GDALDatasetH        theDataset;
   GDALDriverH         theDriver;

   ossimRefPtr<ossimImageData> theTile;
   ossimRefPtr<ossimImageData> theSingleBandTile;
   std::vector<ossim_uint8>    theGdalBuffer;
   ossimIrect                  theImageBound;
   mutable GDALDataType        theGdtType;
   mutable GDALDataType        theOutputGdtType;
   double*                     theMinPixValues;
   double*                     theMaxPixValues;
   double*                     theNullPixValues;
   ossim_uint32                theEntryNumberToRender;
   std::vector<ossimString>    theSubDatasets;
   bool                        theIsComplexFlag;
   bool                        theAlphaChannelFlag;
   bool                        m_preservePaletteIndexesFlag;
   vector<ossim_uint32>        m_outputBandList;
   bool                        m_isBlocked;

   std::vector<ossimAppFixedTileCache::ossimAppFixedCacheId> m_rlevelBlockCache;
  
TYPE_DATA
};

#endif