ossimRpfImageDescriptionSubheader Class Reference

#include <ossimRpfImageDescriptionSubheader.h>

Public Member Functions
	ossimRpfImageDescriptionSubheader ()
	~ossimRpfImageDescriptionSubheader ()
ossimErrorCode	parseStream (std::istream &in, ossimByteOrder byteOrder)
ossim_uint32	getStartOffset () const
ossim_uint32	getEndOffset () const
bool	isSubframeMaskTableOffsetNull () const
bool	isTransparencyMaskTableOffsetNull () const
ossim_uint16	getNumberOfSpectralGroups () const
ossim_uint16	getNumberOfSubframeTables () const
ossim_uint16	getNumberOfSpectralBandTables () const
ossim_uint16	getNumberOfSpectralBandLinesPerImageRow () const
ossim_uint16	getNumberOfSubframesHorizontal () const
ossim_uint16	getNumberOfSubframesVertical () const
ossim_uint32	getNumberOfOutputColumnsPerSubframe () const
ossim_uint32	getNumberOfOutputRowsPerSubframe () const
ossim_uint32	getSubframeMaskTableOffset () const
ossim_uint32	getTransparencyMaskTableOffset () const
std::ostream &	print (std::ostream &out, const std::string &prefix=std::string()) const
	print method that outputs a key/value type format adding prefix to keys. More...

Private Member Functions
void	clearFields ()

Private Attributes
ossim_uint32	theStartOffset
ossim_uint32	theEndOffset
ossim_uint16	theNumberOfSpectralGroups
ossim_uint16	theNumberOfSubframeTables
ossim_uint16	theNumberOfSpectralBandTables
ossim_uint16	theNumberOfSpectralBandLinesPerImageRow
ossim_uint16	theNumberOfSubframesHorizontal
ossim_uint16	theNumberOfSubframesVertical
ossim_uint32	theNumberOfOutputColumnsPerSubframe
ossim_uint32	theNumberOfOutputRowsPerSubframe
ossim_uint32	theSubframeMaskTableOffset
ossim_uint32	theTransparencyMaskTableOffset

Friends
std::ostream &	operator<< (std::ostream &out, const ossimRpfImageDescriptionSubheader &data)

Detailed Description

Definition at line 22 of file ossimRpfImageDescriptionSubheader.h.

Constructor & Destructor Documentation

ossimRpfImageDescriptionSubheader()

ossimRpfImageDescriptionSubheader::ossimRpfImageDescriptionSubheader

(

)

Definition at line 26 of file ossimRpfImageDescriptionSubheader.cpp.

References clearFields().

{
   clearFields();
}

~ossimRpfImageDescriptionSubheader()

ossimRpfImageDescriptionSubheader::~ossimRpfImageDescriptionSubheader ( )

inline

Definition at line 29 of file ossimRpfImageDescriptionSubheader.h.

{}

Member Function Documentation

clearFields()

void ossimRpfImageDescriptionSubheader::clearFields ( )

private

Definition at line 99 of file ossimRpfImageDescriptionSubheader.cpp.

References theEndOffset, theNumberOfOutputColumnsPerSubframe, theNumberOfOutputRowsPerSubframe, theNumberOfSpectralBandLinesPerImageRow, theNumberOfSpectralBandTables, theNumberOfSpectralGroups, theNumberOfSubframesHorizontal, theNumberOfSubframesVertical, theNumberOfSubframeTables, theStartOffset, theSubframeMaskTableOffset, and theTransparencyMaskTableOffset.

Referenced by ossimRpfImageDescriptionSubheader().

{
   theStartOffset                          = 0;
   theEndOffset                            = 0;
   
   theNumberOfSpectralGroups               = 0;
   theNumberOfSubframeTables               = 0;
   theNumberOfSpectralBandTables           = 0;
   theNumberOfSpectralBandLinesPerImageRow = 0;
   theNumberOfSubframesHorizontal          = 0;
   theNumberOfSubframesVertical            = 0;
   theNumberOfOutputColumnsPerSubframe     = 0;
   theNumberOfOutputRowsPerSubframe        = 0;
   theSubframeMaskTableOffset              = 0;
   theTransparencyMaskTableOffset          = 0;
}

getEndOffset()

ossim_uint32 ossimRpfImageDescriptionSubheader::getEndOffset ( ) const

inline

Definition at line 34 of file ossimRpfImageDescriptionSubheader.h.

References theEndOffset.

Referenced by ossimRpfFrame::populateImageSection().

{return theEndOffset;}

getNumberOfOutputColumnsPerSubframe()

ossim_uint32 ossimRpfImageDescriptionSubheader::getNumberOfOutputColumnsPerSubframe ( ) const

inline

Definition at line 68 of file ossimRpfImageDescriptionSubheader.h.

References theNumberOfOutputColumnsPerSubframe.

   {
      return theNumberOfOutputColumnsPerSubframe;
   }

getNumberOfOutputRowsPerSubframe()

ossim_uint32 ossimRpfImageDescriptionSubheader::getNumberOfOutputRowsPerSubframe ( ) const

inline

Definition at line 72 of file ossimRpfImageDescriptionSubheader.h.

References theNumberOfOutputRowsPerSubframe.

   {
      return theNumberOfOutputRowsPerSubframe;
   }

getNumberOfSpectralBandLinesPerImageRow()

ossim_uint16 ossimRpfImageDescriptionSubheader::getNumberOfSpectralBandLinesPerImageRow ( ) const

inline

Definition at line 56 of file ossimRpfImageDescriptionSubheader.h.

References theNumberOfSpectralBandLinesPerImageRow.

   {
      return theNumberOfSpectralBandLinesPerImageRow;
   }

getNumberOfSpectralBandTables()

ossim_uint16 ossimRpfImageDescriptionSubheader::getNumberOfSpectralBandTables ( ) const

inline

Definition at line 52 of file ossimRpfImageDescriptionSubheader.h.

References theNumberOfSpectralBandTables.

   {
      return theNumberOfSpectralBandTables;
   }

getNumberOfSpectralGroups()

ossim_uint16 ossimRpfImageDescriptionSubheader::getNumberOfSpectralGroups ( ) const

inline

Definition at line 44 of file ossimRpfImageDescriptionSubheader.h.

References theNumberOfSpectralGroups.

Referenced by ossimRpfFrame::populateMasks().

   {
      return theNumberOfSpectralGroups;
   }

getNumberOfSubframesHorizontal()

ossim_uint16 ossimRpfImageDescriptionSubheader::getNumberOfSubframesHorizontal ( ) const

inline

Definition at line 60 of file ossimRpfImageDescriptionSubheader.h.

References theNumberOfSubframesHorizontal.

Referenced by ossimRpfFrame::fillSubFrameBuffer(), and ossimRpfFrame::populateMasks().

   {
      return theNumberOfSubframesHorizontal;
   }

getNumberOfSubframesVertical()

ossim_uint16 ossimRpfImageDescriptionSubheader::getNumberOfSubframesVertical ( ) const

inline

Definition at line 64 of file ossimRpfImageDescriptionSubheader.h.

References theNumberOfSubframesVertical.

Referenced by ossimRpfFrame::populateMasks().

   {
      return theNumberOfSubframesVertical;
   }

getNumberOfSubframeTables()

ossim_uint16 ossimRpfImageDescriptionSubheader::getNumberOfSubframeTables ( ) const

inline

Definition at line 48 of file ossimRpfImageDescriptionSubheader.h.

References theNumberOfSubframeTables.

   {
      return theNumberOfSubframeTables;
   }

getStartOffset()

ossim_uint32 ossimRpfImageDescriptionSubheader::getStartOffset ( ) const

inline

Definition at line 33 of file ossimRpfImageDescriptionSubheader.h.

References theStartOffset.

{return theStartOffset;}

getSubframeMaskTableOffset()

ossim_uint32 ossimRpfImageDescriptionSubheader::getSubframeMaskTableOffset ( ) const

inline

Definition at line 76 of file ossimRpfImageDescriptionSubheader.h.

References theSubframeMaskTableOffset.

Referenced by ossimRpfFrame::populateImageSection(), and ossimRpfFrame::populateMasks().

   {
      return theSubframeMaskTableOffset;
   }

getTransparencyMaskTableOffset()

ossim_uint32 ossimRpfImageDescriptionSubheader::getTransparencyMaskTableOffset ( ) const

inline

Definition at line 80 of file ossimRpfImageDescriptionSubheader.h.

References theTransparencyMaskTableOffset.

Referenced by ossimRpfFrame::populateMasks().

   {
      return theTransparencyMaskTableOffset;
   }

isSubframeMaskTableOffsetNull()

bool ossimRpfImageDescriptionSubheader::isSubframeMaskTableOffsetNull ( ) const

inline

Definition at line 36 of file ossimRpfImageDescriptionSubheader.h.

References OSSIM_RPF_ULONG_NULL, and theSubframeMaskTableOffset.

Referenced by ossimRpfFrame::hasSubframeMaskTable(), ossimRpfFrame::populateImageSection(), and ossimRpfFrame::populateMasks().

   {
      return (theSubframeMaskTableOffset == OSSIM_RPF_ULONG_NULL);
   }

isTransparencyMaskTableOffsetNull()

bool ossimRpfImageDescriptionSubheader::isTransparencyMaskTableOffsetNull ( ) const

inline

Definition at line 40 of file ossimRpfImageDescriptionSubheader.h.

References OSSIM_RPF_ULONG_NULL, and theTransparencyMaskTableOffset.

Referenced by ossimRpfFrame::populateMasks().

   {
      return (theTransparencyMaskTableOffset == OSSIM_RPF_ULONG_NULL);
   }

parseStream()

ossimErrorCode ossimRpfImageDescriptionSubheader::parseStream	(	std::istream &	in,
		ossimByteOrder	byteOrder
	)

Definition at line 31 of file ossimRpfImageDescriptionSubheader.cpp.

References ossim::byteOrder(), ossimEndian::getSystemEndianType(), ossimErrorCodes::OSSIM_ERROR, ossimErrorCodes::OSSIM_OK, ossimEndian::swap(), theEndOffset, theNumberOfOutputColumnsPerSubframe, theNumberOfOutputRowsPerSubframe, theNumberOfSpectralBandLinesPerImageRow, theNumberOfSpectralBandTables, theNumberOfSpectralGroups, theNumberOfSubframesHorizontal, theNumberOfSubframesVertical, theNumberOfSubframeTables, theStartOffset, theSubframeMaskTableOffset, and theTransparencyMaskTableOffset.

Referenced by ossimRpfHeader::getNewImageDescriptionSubheader().

{
   if(in)
   {
      theStartOffset = in.tellg();
      in.read((char*)&theNumberOfSpectralGroups, 2);
      in.read((char*)&theNumberOfSubframeTables, 2);
      in.read((char*)&theNumberOfSpectralBandTables, 2);
      in.read((char*)&theNumberOfSpectralBandLinesPerImageRow, 2);
      in.read((char*)&theNumberOfSubframesHorizontal, 2);
      in.read((char*)&theNumberOfSubframesVertical, 2);
      in.read((char*)&theNumberOfOutputColumnsPerSubframe, 4);
      in.read((char*)&theNumberOfOutputRowsPerSubframe, 4);
      in.read((char*)&theSubframeMaskTableOffset, 4);
      in.read((char*)&theTransparencyMaskTableOffset, 4);

      theEndOffset = in.tellg();
      ossimEndian anEndian;

      if(anEndian.getSystemEndianType() != byteOrder)
      {
         anEndian.swap(theNumberOfSpectralGroups);
         anEndian.swap(theNumberOfSubframeTables);
         anEndian.swap(theNumberOfSpectralBandTables);
         anEndian.swap(theNumberOfSpectralBandLinesPerImageRow);
         anEndian.swap(theNumberOfSubframesHorizontal);
         anEndian.swap(theNumberOfSubframesVertical);
         anEndian.swap(theNumberOfOutputColumnsPerSubframe);
         anEndian.swap(theNumberOfOutputRowsPerSubframe);
         anEndian.swap(theSubframeMaskTableOffset);
         anEndian.swap(theTransparencyMaskTableOffset);
      }
   }
   else
   {
      return ossimErrorCodes::OSSIM_ERROR;
   }

   return ossimErrorCodes::OSSIM_OK;
}

print()

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

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

Parameters

out	String to output to.
prefix	This will be prepended to key. e.g. Where prefix = "nitf." and key is "file_name" key becomes: "nitf.file_name:"

Returns

output stream.

Definition at line 73 of file ossimRpfImageDescriptionSubheader.cpp.

References theNumberOfOutputColumnsPerSubframe, theNumberOfOutputRowsPerSubframe, theNumberOfSpectralBandLinesPerImageRow, theNumberOfSpectralBandTables, theNumberOfSpectralGroups, theNumberOfSubframesHorizontal, theNumberOfSubframesVertical, theNumberOfSubframeTables, theSubframeMaskTableOffset, and theTransparencyMaskTableOffset.

Referenced by operator<<().

{
   out << prefix << "NumberOfSpectralGroups: "
       << theNumberOfSpectralGroups << "\n"
       << prefix << "NumberOfSubframeTables: "
       << theNumberOfSubframeTables << "\n"
       << prefix << "NumberOfSpectralBandTables: "
       << theNumberOfSpectralBandTables << "\n"
       << prefix << "NumberOfSpectralBandLinesPerImageRow: "
       << theNumberOfSpectralBandLinesPerImageRow << "\n"
       << prefix << "NumberOfSubframesHorizontal: "
       << theNumberOfSubframesHorizontal << "\n"
       << prefix << "NumberOfSubframesVertical: "
       << theNumberOfSubframesVertical << "\n"
       << prefix << "NumberOfOutputColumnsPerSubframe: "
       << theNumberOfOutputColumnsPerSubframe << "\n"
       << prefix << "NumberOfOutputRowsPerSubframe: "
       << theNumberOfOutputRowsPerSubframe << "\n"
       << prefix << "SubframeMaskTableOffset: "
       << theSubframeMaskTableOffset << "\n"
       << prefix << "TransparencyMaskTableOffset: "
       << theTransparencyMaskTableOffset << std::endl;
   return out;
}

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const ossimRpfImageDescriptionSubheader &  data  )

friend

Definition at line 20 of file ossimRpfImageDescriptionSubheader.cpp.

{
   return data.print(out);
}

Member Data Documentation

theEndOffset

ossim_uint32 ossimRpfImageDescriptionSubheader::theEndOffset

private

Definition at line 101 of file ossimRpfImageDescriptionSubheader.h.

Referenced by clearFields(), getEndOffset(), and parseStream().

theNumberOfOutputColumnsPerSubframe

ossim_uint32 ossimRpfImageDescriptionSubheader::theNumberOfOutputColumnsPerSubframe

private

Definition at line 121 of file ossimRpfImageDescriptionSubheader.h.

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

theNumberOfOutputRowsPerSubframe

ossim_uint32 ossimRpfImageDescriptionSubheader::theNumberOfOutputRowsPerSubframe

private

Definition at line 122 of file ossimRpfImageDescriptionSubheader.h.

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

theNumberOfSpectralBandLinesPerImageRow

ossim_uint16 ossimRpfImageDescriptionSubheader::theNumberOfSpectralBandLinesPerImageRow

private

Definition at line 106 of file ossimRpfImageDescriptionSubheader.h.

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

theNumberOfSpectralBandTables

ossim_uint16 ossimRpfImageDescriptionSubheader::theNumberOfSpectralBandTables

private

Definition at line 105 of file ossimRpfImageDescriptionSubheader.h.

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

theNumberOfSpectralGroups

ossim_uint16 ossimRpfImageDescriptionSubheader::theNumberOfSpectralGroups

private

Definition at line 103 of file ossimRpfImageDescriptionSubheader.h.

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

theNumberOfSubframesHorizontal

ossim_uint16 ossimRpfImageDescriptionSubheader::theNumberOfSubframesHorizontal

private

Each frame file could be divided into sub frames. This identifies the number of subframes in the horizontal direction.

Definition at line 113 of file ossimRpfImageDescriptionSubheader.h.

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

theNumberOfSubframesVertical

ossim_uint16 ossimRpfImageDescriptionSubheader::theNumberOfSubframesVertical

private

Each frame file could be divided into sub frames. This identifies the number of subframes in the vertical direction.

Definition at line 120 of file ossimRpfImageDescriptionSubheader.h.

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

theNumberOfSubframeTables

ossim_uint16 ossimRpfImageDescriptionSubheader::theNumberOfSubframeTables

private

Definition at line 104 of file ossimRpfImageDescriptionSubheader.h.

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

theStartOffset

ossim_uint32 ossimRpfImageDescriptionSubheader::theStartOffset

private

Definition at line 100 of file ossimRpfImageDescriptionSubheader.h.

Referenced by clearFields(), getStartOffset(), and parseStream().

theSubframeMaskTableOffset

ossim_uint32 ossimRpfImageDescriptionSubheader::theSubframeMaskTableOffset

private

Definition at line 123 of file ossimRpfImageDescriptionSubheader.h.

Referenced by clearFields(), getSubframeMaskTableOffset(), isSubframeMaskTableOffsetNull(), parseStream(), and print().

theTransparencyMaskTableOffset

ossim_uint32 ossimRpfImageDescriptionSubheader::theTransparencyMaskTableOffset

private

Definition at line 124 of file ossimRpfImageDescriptionSubheader.h.

Referenced by clearFields(), getTransparencyMaskTableOffset(), isTransparencyMaskTableOffsetNull(), parseStream(), and print().

---

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

• ossimRpfImageDescriptionSubheader.h
• ossimRpfImageDescriptionSubheader.cpp