ossimRpfFrame.h

Go to the documentation of this file.

//*******************************************************************
//
// License:  MIT
//
// See LICENSE.txt file in the top level directory for more details.
// 
// Author: Garrett Potts
// 
// Description: This class give the capability to access tiles from an
//              rpf file.
//
//********************************************************************
// $Id: ossimRpfFrame.h 20324 2011-12-06 22:25:23Z dburken $

#ifndef ossimRpfFrame_HEADER
#define ossimRpfFrame_HEADER 1

#include <ossim/base/ossimReferenced.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/base/ossimFilename.h>
#include <ossim/base/ossimErrorCodes.h>
#include <ossim/support_data/ossimNitfFile.h>
#include <ossim/support_data/ossimRpfColorGrayscaleTable.h>
#include <ossim/support_data/ossimRpfReplaceUpdateTable.h>
#include <iosfwd>
#include <vector>

class ossimRpfHeader;
class ossimRpfAttributes;
class ossimRpfCoverageSection;
class ossimRpfImageDescriptionSubheader;
class ossimRpfImageDisplayParameterSubheader;
class ossimRpfMaskSubheader;
class ossimRpfCompressionSection;
class ossimRpfColorGrayscaleSubheader;
class ossimRpfColorConverterSubsection;

class OSSIM_DLL ossimRpfFrame : public ossimReferenced
{
public:
   friend std::ostream& operator <<(std::ostream& out,
                                    const ossimRpfFrame& data);
   ossimRpfFrame();
   ~ossimRpfFrame();
   
   std::ostream& print(std::ostream& out,
                       const std::string& prefix=std::string()) const;  

   ossimErrorCode parseFile(const ossimFilename& filename,
                            bool minimalParse = false);
   
   const ossimRpfHeader* getRpfHeader()const{return theHeader;}

   bool hasSubframeMaskTable()const;

   const vector< vector<ossim_uint32> >& getSubFrameMask(
      ossim_uint32 spectralGroup)
   {
      return theSubframeMaskTable[spectralGroup];
   }
   
   bool fillSubFrameBuffer(ossim_uint8* buffer,
                           ossim_uint32 spectralGroup,
                           ossim_uint32 row,
                           ossim_uint32 col)const;
   
   const ossimRpfCompressionSection* getCompressionSection()const
   {
      return theCompressionSection;
   }
   const vector<ossimRpfColorGrayscaleTable>& getColorGrayscaleTable()const
   {
      return theColorGrayscaleTable;
   }
   const ossimRpfColorConverterSubsection* getColorConverterSubsection()const
   {
      return theColorConverterSubsection;
   }
   const ossimRpfAttributes* getAttributes()const
   {
      return theAttributes;
   }
   const ossimNitfFile* getNitfFile()const
   {
      return theNitfFile.get();
   }

   ossimRefPtr<ossimRpfReplaceUpdateTable> getRpfReplaceUpdateTable() const;

private:
   void clearFields();
   void deleteAll();
   ossimErrorCode populateCoverageSection(std::istream& in);
   ossimErrorCode populateCompressionSection(std::istream& in);
   ossimErrorCode populateImageSection(std::istream& in);
   ossimErrorCode populateAttributeSection(std::istream& in);
   ossimErrorCode populateColorGrayscaleSection(std::istream& in);
   ossimErrorCode populateMasks(std::istream& in);
   ossimErrorCode populateReplaceUpdateTable(std::istream& in);

   ossimRpfHeader *theHeader;

   ossimFilename   theFilename;

   ossimRpfCoverageSection* theCoverage;

   ossimRpfAttributes *theAttributes;

   ossimRpfImageDescriptionSubheader* theImageDescriptionSubheader;

   ossimRpfMaskSubheader* theMaskSubheader;
   
   ossimRpfImageDisplayParameterSubheader* theImageDisplayParameterSubheader;

   ossimRpfCompressionSection*             theCompressionSection;
   
   ossimRpfColorGrayscaleSubheader*        theColorGrayscaleSubheader;

   ossimRpfColorConverterSubsection*       theColorConverterSubsection;

   vector<ossimRpfColorGrayscaleTable>     theColorGrayscaleTable;

   ossimRefPtr<ossimNitfFile>              theNitfFile;

   vector< vector< vector< ossim_uint32> > > theSubframeMaskTable;

   vector< vector< vector< ossim_uint32> > > theSubframeTransparencyMaskTable;

   ossimRefPtr<ossimRpfReplaceUpdateTable> theReplaceUpdateTable;

};

#endif