ossimCibCadrgTileSource.h

Go to the documentation of this file.

//-----------------------------------------------------------------------
// Copyright (C) 2000 ImageLinks Inc. 
//
// License:  See top level LICENSE.txt file.
//
// Author: Garrett Potts
//
// Description: This class give the capability to access tiles from an
//              CADRG file.
//
//-----------------------------------------------------------------------
//$Id: ossimCibCadrgTileSource.h 17954 2010-08-21 20:39:47Z dburken $
#ifndef ossimCibCadrgTileSource_HEADER
#define ossimCibCadrgTileSource_HEADER 1
#include <ossim/imaging/ossimImageHandler.h>
#include <ossim/support_data/ossimRpfFrameEntry.h>

class ossimRpfToc;
class ossimRpfTocEntry;
class ossimRpfFrame;

class OSSIMDLLEXPORT ossimCibCadrgTileSource : public ossimImageHandler
{
public:
   friend class ossimMultiEntryCibCadrg;

   enum ossimCibCadrgProductType
   {
      OSSIM_PRODUCT_TYPE_UNKNOWN = 0,
      OSSIM_PRODUCT_TYPE_CIB     = 1,
      OSSIM_PRODUCT_TYPE_CADRG   = 2
   };

   ossimCibCadrgTileSource();

   virtual ossimString getShortName()const;

   virtual ossimString getLongName()const;

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

   void setSkipEmptyCheck( bool bSkipEmptyCheck = false );

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

   virtual bool getTile(ossimImageData* result, ossim_uint32 resLevel=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 ossimRefPtr<ossimImageGeometry> getImageGeometry();
   
   virtual ossimScalarType getOutputScalarType() const;

   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 ossim_uint32 getCurrentEntry()const;
   virtual bool setCurrentEntry(ossim_uint32 entryIdx);
   virtual void getEntryList(std::vector<ossim_uint32>& entryList)const;
   

   virtual ossim_int32 getCurrentEntryIndex()const;
   
   virtual const ossimRpfTocEntry* getCurrentTocEntry()const;

   virtual const ossimRpfToc*      getToc()const;

   bool isValidRLevel(ossim_uint32 reduced_res_level) const;

   bool isOpen()const;

   bool isCib() const;

   bool isCadrg() const;

   ossimString getProductScale() const;

   vector<ossimString> getProductScaleList()const;

   vector<ossim_int32>      getProductEntryList(const ossimString& productScale)const;

   ossimString getSecurityClassification()const;
   
   virtual ossimRefPtr<ossimProperty> getProperty(const ossimString& name)const;
   
   virtual void getPropertyNames(std::vector<ossimString>& propertyNames)const;

   static const ossim_uint32 CIBCADRG_FRAME_WIDTH;
   
   static const ossim_uint32 CIBCADRG_FRAME_HEIGHT;
   

protected:
   virtual ~ossimCibCadrgTileSource();
   
   void updatePropertiesToFirstValidFrame();

   virtual void setTocEntryToRender(const ossimRpfTocEntry* entry);
   
   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;
   };

   virtual bool setEntryToRender(ossim_uint32 index);
   
   vector<ossimFrameEntryData> getIntersectingEntries(const ossimIrect& rect);

   void fillTile(const ossimIrect& tileRect,
                 const vector<ossimFrameEntryData>& framesInvolved,
                 ossimImageData* tile);

   void fillSubTileCib(const ossimRpfFrame& aFrame,
                       const ossimIrect& tileRect,
                       const ossimFrameEntryData& frameEntryData,
                       ossimImageData* tile);
   
   void fillSubTileCadrg(const ossimRpfFrame& aFrame,
                         const ossimIrect& tileRect,
                         const ossimFrameEntryData& frameEntryData,
                         ossimImageData* tile);
   
   void allocateForProduct();
   
   const ossimRpfTocEntry* findFirstFrame();

   void deleteAll();

   void populateLut();

   unsigned char*               theCompressedBuffer;

   unsigned char*               theUncompressedBuffer;
   
   ossim_uint32                theNumberOfLines;

   ossim_uint32                theNumberOfSamples;
   
   ossimRefPtr<ossimImageData>  theTile;

   ossimRpfToc*                 theTableOfContents;

   const ossimRpfTocEntry*      theEntryToRender;

   ossim_int32                  theEntryNumberToRender;
   
   ossimCibCadrgProductType     theProductType;
   
   mutable ossimRpfFrame*       theWorkFrame;

   bool                         theSkipEmptyCheck;

    // data to use in property retrieval
    
TYPE_DATA
};

#endif /* #ifndef ossimCibCadrgTileSource_HEADER */