ossimNitfVqCompressionHeader Class Reference

#include <ossimNitfVqCompressionHeader.h>

Inheritance diagram for ossimNitfVqCompressionHeader:

Public Member Functions
	ossimNitfVqCompressionHeader ()
virtual void	parseStream (std::istream &in)
virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...
virtual std::ostream &	print (std::ostream &out, const std::string &prefix) const
	print method that outputs a key/value type format adding prefix to keys. More...
virtual bool	saveState (ossimKeywordlist &kwl, const ossimString &prefix="") const
virtual ossim_uint32	getBlockSizeInBytes () const
virtual ossim_uint32	getNumberOfImageRows () const
virtual ossim_uint32	getNumberOfImageCodesPerRow () const
virtual ossim_uint32	getCompressionAlgorithmId () const
virtual ossim_uint32	getImageCodeBitLength () const
virtual ossim_uint32	getNumberOfTables () const
const std::vector< ossimNitfVqCompressionOffsetTableData > &	getTable () const
Public Member Functions inherited from ossimNitfCompressionHeader
virtual void	parseStream (ossim::istream &in)=0
Public Member Functions inherited from ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimObject *	dup () const
virtual ossimString	getShortName () const
virtual ossimString	getLongName () const
virtual ossimString	getDescription () const
virtual ossimString	getClassName () const
virtual RTTItypeid	getType () const
virtual bool	canCastTo (ossimObject *obj) const
virtual bool	canCastTo (const RTTItypeid &id) const
virtual bool	canCastTo (const ossimString &parentClassName) const
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
virtual void	accept (ossimVisitor &visitor)
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Protected Member Functions
void	clearFields ()
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
ossim_uint32	theNumberOfImageRows
ossim_uint32	theNumberOfImageCodesPerRow
ossim_uint8	theImageCodeBitLength
ossim_uint16	theCompressionAlgorithmId
ossim_uint16	theNumberOfCompressionLookupOffsetRecords
ossim_uint16	theNumberOfCompressionParameterOffsetRecords
ossim_uint32	theCompressionLookupOffsetTableOffset
ossim_uint16	theCompressionLookupTableOffsetRecordLength
std::vector< ossimNitfVqCompressionOffsetTableData >	theTable
Protected Attributes inherited from ossimNitfCompressionHeader
	TYPE_DATA

Detailed Description

Definition at line 37 of file ossimNitfVqCompressionHeader.h.

Constructor & Destructor Documentation

ossimNitfVqCompressionHeader()

ossimNitfVqCompressionHeader::ossimNitfVqCompressionHeader

(

)

Definition at line 148 of file ossimNitfVqCompressionHeader.cpp.

References clearFields().

{
   clearFields();
}

Member Function Documentation

clearFields()

void ossimNitfVqCompressionHeader::clearFields ( )

protected

Definition at line 340 of file ossimNitfVqCompressionHeader.cpp.

References theCompressionAlgorithmId, theCompressionLookupTableOffsetRecordLength, theImageCodeBitLength, theNumberOfCompressionLookupOffsetRecords, theNumberOfImageCodesPerRow, and theNumberOfImageRows.

Referenced by ossimNitfVqCompressionHeader().

{
   theNumberOfImageRows                        = 0;
   theNumberOfImageCodesPerRow                 = 0;
   theImageCodeBitLength                       = 0;
   theCompressionAlgorithmId                   = 0;
   theNumberOfCompressionLookupOffsetRecords   = 0;
   theCompressionLookupTableOffsetRecordLength = 0;
}

getBlockSizeInBytes()

ossim_uint32 ossimNitfVqCompressionHeader::getBlockSizeInBytes ( ) const

virtual

Definition at line 303 of file ossimNitfVqCompressionHeader.cpp.

References getImageCodeBitLength(), getNumberOfImageCodesPerRow(), and getNumberOfImageRows().

{
   return (getNumberOfImageRows()*
           getNumberOfImageCodesPerRow()*
           getImageCodeBitLength())/8;
}

getCompressionAlgorithmId()

ossim_uint32 ossimNitfVqCompressionHeader::getCompressionAlgorithmId ( ) const

virtual

Definition at line 320 of file ossimNitfVqCompressionHeader.cpp.

References theCompressionAlgorithmId.

Referenced by ossimNitfImageHeaderV2_0::parseStream().

{
   return theCompressionAlgorithmId;
}

getImageCodeBitLength()

ossim_uint32 ossimNitfVqCompressionHeader::getImageCodeBitLength ( ) const

virtual

Definition at line 325 of file ossimNitfVqCompressionHeader.cpp.

References theImageCodeBitLength.

Referenced by getBlockSizeInBytes(), ossimNitfTileSource::vqUncompressC4(), and ossimNitfTileSource::vqUncompressM4().

{
   return theImageCodeBitLength;
}

getNumberOfImageCodesPerRow()

ossim_uint32 ossimNitfVqCompressionHeader::getNumberOfImageCodesPerRow ( ) const

virtual

Definition at line 315 of file ossimNitfVqCompressionHeader.cpp.

References theNumberOfImageCodesPerRow.

Referenced by getBlockSizeInBytes(), ossimNitfTileSource::vqUncompressC4(), and ossimNitfTileSource::vqUncompressM4().

{
   return theNumberOfImageCodesPerRow;
}

getNumberOfImageRows()

ossim_uint32 ossimNitfVqCompressionHeader::getNumberOfImageRows ( ) const

virtual

Definition at line 310 of file ossimNitfVqCompressionHeader.cpp.

References theNumberOfImageRows.

Referenced by getBlockSizeInBytes(), ossimNitfTileSource::vqUncompressC4(), and ossimNitfTileSource::vqUncompressM4().

{
   return theNumberOfImageRows;
}

getNumberOfTables()

ossim_uint32 ossimNitfVqCompressionHeader::getNumberOfTables ( ) const

virtual

Definition at line 330 of file ossimNitfVqCompressionHeader.cpp.

References theTable.

{
   return (ossim_uint32)theTable.size();
}

getTable()

const std::vector< ossimNitfVqCompressionOffsetTableData > & ossimNitfVqCompressionHeader::getTable

(

)

const

Definition at line 335 of file ossimNitfVqCompressionHeader.cpp.

References theTable.

Referenced by ossimNitfTileSource::vqUncompressC4(), and ossimNitfTileSource::vqUncompressM4().

{
   return theTable;
}

parseStream()

void ossimNitfVqCompressionHeader::parseStream ( std::istream &  in )

virtual

Definition at line 153 of file ossimNitfVqCompressionHeader.cpp.

References ossimEndian::getSystemEndianType(), OSSIM_LITTLE_ENDIAN, ossimEndian::swap(), theCompressionAlgorithmId, theCompressionLookupOffsetTableOffset, theCompressionLookupTableOffsetRecordLength, theImageCodeBitLength, theNumberOfCompressionLookupOffsetRecords, theNumberOfCompressionParameterOffsetRecords, theNumberOfImageCodesPerRow, theNumberOfImageRows, and theTable.

Referenced by ossimNitfImageHeaderV2_0::parseStream().

{
   ossimEndian endian;

   in.read((char*)(&theNumberOfImageRows), 4);
   in.read((char*)(&theNumberOfImageCodesPerRow), 4);
   in.read((char*)(&theImageCodeBitLength), 1);
   in.read((char*)(&theCompressionAlgorithmId), 2);

   in.read((char*)(&theNumberOfCompressionLookupOffsetRecords), 2);
   in.read((char*)(&theNumberOfCompressionParameterOffsetRecords), 2);
   in.read((char*)(&theCompressionLookupOffsetTableOffset), 4);
   in.read((char*)(&theCompressionLookupTableOffsetRecordLength), 2);
   
   if(endian.getSystemEndianType() == OSSIM_LITTLE_ENDIAN)
   {
      endian.swap(theNumberOfImageRows);
      endian.swap(theNumberOfImageCodesPerRow);
      endian.swap(theCompressionAlgorithmId);
      endian.swap(theNumberOfCompressionLookupOffsetRecords);
      endian.swap(theNumberOfCompressionParameterOffsetRecords);
      endian.swap(theCompressionLookupOffsetTableOffset);
      endian.swap(theCompressionLookupTableOffsetRecordLength);
   }
   
   if((theNumberOfCompressionLookupOffsetRecords > 0)&&
      (theCompressionAlgorithmId == 1)) 
   {
      theTable.clear();
      theTable.resize(theNumberOfCompressionLookupOffsetRecords);

      ossim_uint32 idx = 0;

      for(idx = 0; idx < theNumberOfCompressionLookupOffsetRecords; ++idx)
      {
         theTable[idx].parseStream(in);
      }
      for(idx = 0; idx < theTable.size(); ++idx)
      {
         if(theTable[idx].theData)
         {
            delete [] theTable[idx].theData;
            theTable[idx].theData = 0;
         }
         if(theTable[idx].getDataLengthInBytes()>0)
         {
            theTable[idx].theData = new ossim_uint8[theTable[idx].getDataLengthInBytes()];
            in.read((char*)(theTable[idx].theData), theTable[idx].getDataLengthInBytes());
         }
      }
   }
}

print() [1/2]

std::ostream & ossimNitfVqCompressionHeader::print ( std::ostream &  out ) const

virtual

Generic print method.

Derived classes should re-implement as they see fit.

Returns

std::ostream&

Reimplemented from ossimObject.

Definition at line 206 of file ossimNitfVqCompressionHeader.cpp.

{
   return this->print(out, std::string(""));
}

print() [2/2]

std::ostream & ossimNitfVqCompressionHeader::print ( std::ostream &  out, const std::string &  prefix  ) const

virtual

print method that outputs a key/value type format adding prefix to keys.

Implements ossimNitfCompressionHeader.

Definition at line 211 of file ossimNitfVqCompressionHeader.cpp.

References ossimString::string(), theCompressionAlgorithmId, theCompressionLookupTableOffsetRecordLength, theImageCodeBitLength, theNumberOfCompressionLookupOffsetRecords, theNumberOfImageCodesPerRow, theNumberOfImageRows, theTable, and ossimString::toString().

{
   std::string pfx = prefix;
   pfx += "vq_header.";

   out << std::setiosflags(std::ios::left)
       << pfx << std::setw(24) << "image_rows:"
       << theNumberOfImageRows << "\n"
       << pfx << std::setw(24) << "codes_per_row:"
       << theNumberOfImageCodesPerRow << "\n"
       << pfx << std::setw(24) << "codebit_length:"
       << (ossim_uint32)theImageCodeBitLength << "\n"
       << pfx << std::setw(24) << "algorithm_id:"
       << theCompressionAlgorithmId << "\n"
       << pfx << std::setw(24)
       << "offset_records:"
       << theNumberOfCompressionLookupOffsetRecords << "\n"
       << pfx << std::setw(24)
       << "offset_record_length:"
       << theCompressionLookupTableOffsetRecordLength << "\n";

   if(theTable.size() > 0)
   {
      for(ossim_uint32 idx = 0; idx < theTable.size()-1; ++idx)
      {
         std::string tblPfx = pfx;
         tblPfx += "table";
         tblPfx += ossimString::toString(idx).string();
         tblPfx += ".";

         out << tblPfx << std::setw(24) << "id:"
             << theTable[idx].theTableId << "\n"
             << tblPfx << std::setw(24) << "lookup_records:"
             << theTable[idx].theNumberOfCompressionLookupRecords << "\n"
             << tblPfx << std::setw(24) << "values_per_lookup:"
             << theTable[idx].theNumberOfValuesPerCompressionLookup << "\n"
             << tblPfx << std::setw(24) << "lookup_bit_length:"
             << theTable[idx].theCompressionLookupValueBitLength << "\n"
             << tblPfx << std::setw(24) << "lookup_table_offset:"
             << theTable[idx].theCompressionLookupTableOffset << "\n";
      }

   }

   return out;
}

saveState()

bool ossimNitfVqCompressionHeader::saveState ( ossimKeywordlist &  kwl, const ossimString &  prefix = ""  ) const

virtual

Reimplemented from ossimNitfCompressionHeader.

Definition at line 259 of file ossimNitfVqCompressionHeader.cpp.

References ossimKeywordlist::add(), ossimKeywordlist::parseStream(), ossimNitfCompressionHeader::saveState(), ossimString::string(), theCompressionAlgorithmId, theCompressionLookupTableOffsetRecordLength, theImageCodeBitLength, theNumberOfCompressionLookupOffsetRecords, theNumberOfImageCodesPerRow, theNumberOfImageRows, theTable, and ossimString::toString().

{
   bool result = ossimNitfCompressionHeader::saveState(kwl, prefix);
   
   if(result)
   {
      std::ostringstream out;
      
      out << std::setiosflags(std::ios::left)
      << "image_rows:" << theNumberOfImageRows << "\n"
      << "codes_per_row:" << theNumberOfImageCodesPerRow << "\n"
      << "codebit_length:" << (ossim_uint32)theImageCodeBitLength << "\n"
      << "algorithm_id:" << theCompressionAlgorithmId << "\n"
      << "offset_records:" << theNumberOfCompressionLookupOffsetRecords << "\n"
      << "offset_record_length:" << theCompressionLookupTableOffsetRecordLength << "\n";
      
      if(theTable.size() > 0)
      {
         for(ossim_uint32 idx = 0; idx < theTable.size()-1; ++idx)
         {
            std::string tblPfx = "table";
            tblPfx += ossimString::toString(idx).string();
            tblPfx += ".";
            
            out << tblPfx<< "id:"
            << theTable[idx].theTableId << "\n"
            << tblPfx << "lookup_records:"<< theTable[idx].theNumberOfCompressionLookupRecords << "\n"
            << tblPfx <<"values_per_lookup:"<< theTable[idx].theNumberOfValuesPerCompressionLookup << "\n"
            << tblPfx << "lookup_bit_length:"<< theTable[idx].theCompressionLookupValueBitLength << "\n"
            << tblPfx << "lookup_table_offset:"<< theTable[idx].theCompressionLookupTableOffset << "\n";
         }
      }
      ossimKeywordlist kwlTemp;
      
      std::istringstream in(out.str());
      if(kwlTemp.parseStream(in))
      {
         kwl.add(prefix, kwlTemp);
      }
   }
   
   return result;
}

Member Data Documentation

theCompressionAlgorithmId

ossim_uint16 ossimNitfVqCompressionHeader::theCompressionAlgorithmId

protected

Definition at line 66 of file ossimNitfVqCompressionHeader.h.

Referenced by clearFields(), getCompressionAlgorithmId(), parseStream(), print(), and saveState().

theCompressionLookupOffsetTableOffset

ossim_uint32 ossimNitfVqCompressionHeader::theCompressionLookupOffsetTableOffset

protected

Definition at line 70 of file ossimNitfVqCompressionHeader.h.

Referenced by parseStream().

theCompressionLookupTableOffsetRecordLength

ossim_uint16 ossimNitfVqCompressionHeader::theCompressionLookupTableOffsetRecordLength

protected

Definition at line 71 of file ossimNitfVqCompressionHeader.h.

Referenced by clearFields(), parseStream(), print(), and saveState().

theImageCodeBitLength

ossim_uint8 ossimNitfVqCompressionHeader::theImageCodeBitLength

protected

Definition at line 64 of file ossimNitfVqCompressionHeader.h.

Referenced by clearFields(), getImageCodeBitLength(), parseStream(), print(), and saveState().

theNumberOfCompressionLookupOffsetRecords

ossim_uint16 ossimNitfVqCompressionHeader::theNumberOfCompressionLookupOffsetRecords

protected

Definition at line 67 of file ossimNitfVqCompressionHeader.h.

Referenced by clearFields(), parseStream(), print(), and saveState().

theNumberOfCompressionParameterOffsetRecords

ossim_uint16 ossimNitfVqCompressionHeader::theNumberOfCompressionParameterOffsetRecords

protected

Definition at line 68 of file ossimNitfVqCompressionHeader.h.

Referenced by parseStream().

theNumberOfImageCodesPerRow

ossim_uint32 ossimNitfVqCompressionHeader::theNumberOfImageCodesPerRow

protected

Definition at line 63 of file ossimNitfVqCompressionHeader.h.

Referenced by clearFields(), getNumberOfImageCodesPerRow(), parseStream(), print(), and saveState().

theNumberOfImageRows

ossim_uint32 ossimNitfVqCompressionHeader::theNumberOfImageRows

protected

Definition at line 62 of file ossimNitfVqCompressionHeader.h.

Referenced by clearFields(), getNumberOfImageRows(), parseStream(), print(), and saveState().

theTable

std::vector<ossimNitfVqCompressionOffsetTableData> ossimNitfVqCompressionHeader::theTable

protected

Definition at line 73 of file ossimNitfVqCompressionHeader.h.

Referenced by getNumberOfTables(), getTable(), parseStream(), print(), and saveState().

---

The documentation for this class was generated from the following files:

• ossimNitfVqCompressionHeader.h
• ossimNitfVqCompressionHeader.cpp