ossimTiledImageHandler.h

Go to the documentation of this file.

//**************************************************************************************************
//
// License:  MIT
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Author: Oscar Kramer
// 
// Description:
//
// Image handler used  when the full image is distributed across multiple files,
// As is the case for tiled Quickbird imagery. This is not for use with band-separate formats,
// but only "spatially-separate" schemes. Throughout, MFT = multiple file tiles, the disk storage
// scheme handled by this class.
//
//**************************************************************************************************
// $Id: ossimTiledImageHandler.h 2644 2011-05-26 15:20:11Z oscar.kramer $
#ifndef ossimTiledImageHandler_HEADER
#define ossimTiledImageHandler_HEADER

#include <ossim/imaging/ossimImageHandler.h>

// Enable this flag to utilize the system of separate overviews for each tile-file
#define USING_SUB_OVRS 0

class OSSIMDLLEXPORT ossimTiledImageHandler : public ossimImageHandler
{
public:
   ossimTiledImageHandler();
   
   virtual ~ossimTiledImageHandler();
   
   virtual bool open() = 0;

   virtual void close();

   virtual bool isOpen()const;

   virtual ossim_uint32 getNumberOfInputBands() const;
   
   virtual ossim_uint32 getNumberOfLines(ossim_uint32 resLevel = 0) const;

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

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

   virtual bool isImageTiled() const;

   virtual ossim_uint32 getImageTileWidth() const;

   virtual ossim_uint32 getImageTileHeight() const;

   virtual ossimRefPtr<ossimImageData> getTile(const ossimIrect& rect, ossim_uint32 resLevel);

   virtual ossimScalarType getOutputScalarType() const;

   virtual ossimIrect getImageRectangle(ossim_uint32 resLevel = 0) const;

protected:

   class ossimTileFile
   {
   public:
      ossimTileFile() : overviewIsOpen(false) {}

      ossimFilename tileFilename;
      vector<ossimIrect>  subImageRects; // one rect per resolution level
      ossimRefPtr<ossimImageHandler> imageHandler;
      bool overviewIsOpen;
   };

   void allocate();

  vector<ossimTileFile> m_tileFiles;
  ossimRefPtr<ossimImageData> m_tile;
  ossimRefPtr<ossimImageData> m_blankTile;
  ossimIrect  m_fullImgRect;
  ossim_uint32 m_startOvrResLevel;

#if USING_SUB_OVRS
public:
   virtual bool buildOverview(
      ossimImageHandlerOverviewCompressionType compressionType = OSSIM_OVERVIEW_COMPRESSION_NONE,
      ossim_uint32 quality = 75,
      ossimFilterResampler::ossimFilterResamplerType resampleType = ossimFilterResampler::ossimFilterResampler_BOX,
      bool includeFullResFlag=false);

   virtual bool openOverview();
   virtual void closeOverview();

   virtual const ossimImageHandler* getOverview() const { return NULL; }

   virtual bool hasOverviews() const;
   
   virtual ossim_uint32 getNumberOfDecimationLevels() const;

protected:
   virtual void completeOpen();
  
   bool m_lockSubOvrs;

#endif /* #if USING_SUB_OVRS */

TYPE_DATA
};

#endif /* #ifndef ossimTiledImageHandler_HEADER */