ossimImageCacheBase.h

Go to the documentation of this file.

//-----------------------------------------------------------------------
//
// License:  See top level LICENSE.txt file.
//
// Author: Mingjie Su
//
// Description: This class give the capability to access tiles from the
//              input frames.
//
//-----------------------------------------------------------------------
//$Id: ossimImageCacheBase.h 2685 2011-06-07 16:24:41Z david.burken $
#ifndef ossimImageCacheBase_HEADER
#define ossimImageCacheBase_HEADER 1
#include <ossim/imaging/ossimImageHandler.h>
#include <ossim/support_data/ossimRpfFrameEntry.h>

class ossimRpfToc;
class ossimRpfTocEntry;
class ossimRpfFrame;

class OSSIMDLLEXPORT ossimImageCacheBase : public ossimImageHandler
{
public:

   ossimImageCacheBase();

   virtual void close();
   
   virtual bool open() = 0;

   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 ossim_uint32 getNumberOfInputBands()const;

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

   virtual ossim_uint32 getImageTileWidth() const;

   virtual ossim_uint32 getImageTileHeight() const;

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

   bool isOpen()const;

   virtual ossimRefPtr<ossimImageGeometry> getImageGeometry();

protected:
   virtual ~ossimImageCacheBase();
   
   void setActualImageRect();

   void checkLongitude(ossim_float64& leftLon,  const ossim_float64& rightLon) const;
   
   struct ossimFrameEntryData
   {
      ossimFrameEntryData()
         :theRow(-1),
          theCol(-1),
          thePixelRow(-1),
          thePixelCol(-1)
         {}
      ossimFrameEntryData(ossim_int32 row,
                          ossim_int32 col,
                          ossim_int32 pixelRow,
                          ossim_int32 pixelCol,
                          const ossimRpfFrameEntry& entry)
         :theRow(row),
          theCol(col),
          thePixelRow(pixelRow),
          thePixelCol(pixelCol),
          theFrameEntry(entry)
         {}
      ossimFrameEntryData(const ossimFrameEntryData& rhs)
         :theRow(rhs.theRow),
          theCol(rhs.theCol),
          thePixelRow(rhs.thePixelRow),
          thePixelCol(rhs.thePixelCol),
          theFrameEntry(rhs.theFrameEntry)
         {}
      ossim_int32 theRow;
      ossim_int32 theCol;
      ossim_int32 thePixelRow;
      ossim_int32 thePixelCol;
      ossimRpfFrameEntry theFrameEntry;
   };


   vector<ossimFrameEntryData> getIntersectingEntries(const ossimIrect& rect);

   void deleteAll();

   bool buildFrameEntryArray(ossimFilename imageFile, ossim_uint32 frameWidth, ossim_uint32 frameHeight);
   virtual void establishDecimationFactors();
   
   ossimIrect                  m_actualImageRect;
   
   ossim_uint32                m_numberOfLines;

   ossim_uint32                m_numberOfSamples;

   ossim_uint32                m_numberOfBands;

   std::vector<ossimString> m_fileNames;
  
   ossimIpt                     m_tileSize;
   
   mutable ossimRpfFrame*       m_workFrame;

   // data to use in property retrieval

   ossim_float64 m_bBox_LL_Lon;
   ossim_float64 m_bBox_LL_Lat;
   ossim_float64 m_bBox_UR_Lon;
   ossim_float64 m_bBox_UR_Lat;
   ossim_uint32  m_numOfFramesVertical;
   ossim_uint32  m_numOfFramesHorizontal;
   ossim_uint32  m_frame_width;
   ossim_uint32  m_frame_height;

   std::vector< std::vector<ossimRpfFrameEntry> > m_frameEntryArray;
    
TYPE_DATA
};

#endif /* #ifndef ossimImageCacheBase_HEADER */