ossimJ2kCodRecord Class Reference

#include <ossimJ2kCodRecord.h>

Public Member Functions
	ossimJ2kCodRecord ()
	default constructor More...
	~ossimJ2kCodRecord ()
	destructor More...
void	parseStream (std::istream &in)
	Parse method. More...
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...
std::string	getProgressionOrderAsString (ossim_uint8 progressionOrder) const
ossim_uint8	getProgressionOrder () const

Public Attributes
ossim_uint16	m_marker
	segmet marker 0xff52 (big endian) More...
ossim_uint16	m_lcod
	length of segment minus marker More...
ossim_uint8	m_scod
	Coding style. More...
ossim_uint8	m_progressionOrder
	SGcod - Progression order. More...
ossim_uint16	m_numberOfLayers
	SGcod - Number of layers. More...
ossim_uint8	m_multipleComponentTransform
	SGcod - Multiple component transform. More...
ossim_uint8	m_numberOfDecompositionLevels
	SPcod - Number of decomposition levels. More...
ossim_uint8	m_codeBlockWidth
	SPcod - Code-block width. More...
ossim_uint8	m_codeBlockHeight
	SPcod - Code-block height. More...
ossim_uint8	m_codeBlockStyle
	SPcod - Code-block height. More...
ossim_uint8	m_transformation
	SPcod - transformation (wavelet filter) More...
ossim_uint8	m_precinctSize
	SPcod - precinct size (only is defined, Scod = xxxx xxx1) More...

Friends
OSSIM_DLL std::ostream &	operator<< (std::ostream &out, const ossimJ2kCodRecord &obj)
	operator<< More...

Detailed Description

Definition at line 23 of file ossimJ2kCodRecord.h.

Constructor & Destructor Documentation

ossimJ2kCodRecord()

ossimJ2kCodRecord::ossimJ2kCodRecord

(

)

default constructor

Definition at line 23 of file ossimJ2kCodRecord.cpp.

   :
   m_marker(0xff52),
   m_lcod(0),
   m_scod(0),
   m_progressionOrder(0),
   m_numberOfLayers(0),
   m_multipleComponentTransform(0),
   m_numberOfDecompositionLevels(0),
   m_codeBlockWidth(0),
   m_codeBlockHeight(0),
   m_codeBlockStyle(0),
   m_transformation(0),
   m_precinctSize(0)
{
}

~ossimJ2kCodRecord()

ossimJ2kCodRecord::~ossimJ2kCodRecord

(

)

destructor

Definition at line 40 of file ossimJ2kCodRecord.cpp.

{
}

Member Function Documentation

getProgressionOrder()

ossim_uint8 ossimJ2kCodRecord::getProgressionOrder

(

)

const

Definition at line 151 of file ossimJ2kCodRecord.cpp.

References m_progressionOrder.

{
   return m_progressionOrder;
}

getProgressionOrderAsString()

std::string ossimJ2kCodRecord::getProgressionOrderAsString

(

ossim_uint8

progressionOrder

)

const

Returns

LRCP, RLCP, RPCL, PCRL, CPRL or unknown.

Definition at line 119 of file ossimJ2kCodRecord.cpp.

Referenced by print().

{
   std::string result;
   
   if ( progressionOrder == 0x00 )
   {
      result = "LRCP";
   }
   else if ( progressionOrder == 0x01 )
   {
      result = "RLCP";
   }
   else if ( progressionOrder == 0x02 )
   {
      result = "RPCL";
   }
   else if ( progressionOrder == 0x03 )
   {
      result = "PCRL";
   }
   else if ( progressionOrder == 0x04 )
   {
      result = "CPRL";
   }
   else
   {
      result = "unknown";
   }
   
   return result;
}

parseStream()

void ossimJ2kCodRecord::parseStream

(

std::istream &

in

)

Parse method.

Performs byte swapping as needed.

Parameters

in	Stream to parse.

Note

COD Marker (0xff52) is not read.

Definition at line 44 of file ossimJ2kCodRecord.cpp.

References ossim::byteOrder(), m_codeBlockHeight, m_codeBlockStyle, m_codeBlockWidth, m_lcod, m_multipleComponentTransform, m_numberOfDecompositionLevels, m_numberOfLayers, m_precinctSize, m_progressionOrder, m_scod, m_transformation, OSSIM_LITTLE_ENDIAN, and ossimEndian::swap().

Referenced by ossimKakaduNitfReader::dumpTiles(), ossimOpjJp2Reader::initCodRecord(), and ossimJ2kInfo::printCodMarker().

{
   // Get the stream posistion.
   std::streamoff pos = in.tellg();

   // Note: Marker is not read.
   in.read((char*)&m_lcod, 2);
   in.read((char*)&m_scod, 1);
   in.read((char*)&m_progressionOrder, 1);
   in.read((char*)&m_numberOfLayers, 2);
   in.read((char*)&m_multipleComponentTransform, 1);
   in.read((char*)&m_numberOfDecompositionLevels, 1);
   in.read((char*)&m_codeBlockWidth, 1);
   in.read((char*)&m_codeBlockHeight, 1);
   in.read((char*)&m_codeBlockStyle, 1);
   in.read((char*)&m_transformation, 1);

   //---
   // SPcod - precinct size (only is defined, Scod = xxxx xxx1)
   //---   
   if ( 0 )
   {
      in.read((char*)&m_precinctSize, 1);
   }

   if (ossim::byteOrder() == OSSIM_LITTLE_ENDIAN)
   {
      // Stored big endian, must swap.
      ossimEndian s;
      s.swap(m_lcod);
      s.swap(m_numberOfLayers);
   }

   //---
   // Seek to next record.  This is needed because there are sometimes extra
   // bytes.
   //---
   in.seekg(pos + m_lcod, std::ios_base::beg);
}

print()

std::ostream & ossimJ2kCodRecord::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 = "j2k." and key is "file_name" key becomes: "nitf.file_name:"

Returns

output stream.

Definition at line 84 of file ossimJ2kCodRecord.cpp.

References getProgressionOrderAsString(), m_codeBlockHeight, m_codeBlockStyle, m_codeBlockWidth, m_lcod, m_multipleComponentTransform, m_numberOfDecompositionLevels, m_numberOfLayers, m_precinctSize, m_progressionOrder, m_scod, and m_transformation.

Referenced by ossimKakaduNitfReader::dumpTiles(), operator<<(), and ossimJ2kInfo::printCodMarker().

{
   // Capture the original flags.
   std::ios_base::fmtflags f = out.flags();

   std::string pfx = prefix;
   pfx += "cod.";

   out.setf(std::ios_base::hex, std::ios_base::basefield);
   out << pfx << "marker: 0xff90\n";
   out.setf(std::ios_base::fmtflags(0), std::ios_base::basefield);

   out << pfx << "Lcod: " << m_lcod       << "\n"
       << pfx << "Scod: " << int(m_scod)  << "\n"
       << pfx << "SGcod_progression_order:  "
       << getProgressionOrderAsString(m_progressionOrder) << "\n"
       << pfx << "SGcod_number_of_layers:  " << m_numberOfLayers << "\n"
       << pfx << "SGcod_multiple_component_transform:  "
       << int(m_multipleComponentTransform) << "\n"
       << pfx << "SPcod_mumber_of_decomposition_levels: "
       << int(m_numberOfDecompositionLevels) << "\n"
       << pfx << "SPcod_code_block_width: " << int(m_codeBlockWidth) << "\n"
       << pfx << "SPcod_code_block_height: " << int(m_codeBlockHeight) << "\n"
       << pfx << "SPcod_code_block_style: " << int(m_codeBlockStyle) << "\n"
       << pfx << "SPcod_transformation: " << int(m_transformation) << "\n"
       << pfx << "SPcod_precinct_size: " << int(m_precinctSize)
       << std::endl;

   // Reset flags.
   out.setf(f);

   return out;
}

Friends And Related Function Documentation

operator<<

OSSIM_DLL std::ostream& operator<< ( std::ostream &  out, const ossimJ2kCodRecord &  obj  )

friend

operator<<

Definition at line 156 of file ossimJ2kCodRecord.cpp.

{
   return obj.print(out);
}

Member Data Documentation

m_codeBlockHeight

ossim_uint8 ossimJ2kCodRecord::m_codeBlockHeight

SPcod - Code-block height.

Definition at line 91 of file ossimJ2kCodRecord.h.

Referenced by parseStream(), and print().

m_codeBlockStyle

ossim_uint8 ossimJ2kCodRecord::m_codeBlockStyle

SPcod - Code-block height.

Definition at line 94 of file ossimJ2kCodRecord.h.

Referenced by parseStream(), and print().

m_codeBlockWidth

ossim_uint8 ossimJ2kCodRecord::m_codeBlockWidth

SPcod - Code-block width.

Definition at line 88 of file ossimJ2kCodRecord.h.

Referenced by parseStream(), and print().

m_lcod

ossim_uint16 ossimJ2kCodRecord::m_lcod

length of segment minus marker

Definition at line 70 of file ossimJ2kCodRecord.h.

Referenced by parseStream(), and print().

m_marker

ossim_uint16 ossimJ2kCodRecord::m_marker

segmet marker 0xff52 (big endian)

Definition at line 67 of file ossimJ2kCodRecord.h.

m_multipleComponentTransform

ossim_uint8 ossimJ2kCodRecord::m_multipleComponentTransform

SGcod - Multiple component transform.

Definition at line 82 of file ossimJ2kCodRecord.h.

Referenced by parseStream(), and print().

m_numberOfDecompositionLevels

ossim_uint8 ossimJ2kCodRecord::m_numberOfDecompositionLevels

SPcod - Number of decomposition levels.

Definition at line 85 of file ossimJ2kCodRecord.h.

Referenced by parseStream(), and print().

m_numberOfLayers

ossim_uint16 ossimJ2kCodRecord::m_numberOfLayers

SGcod - Number of layers.

Definition at line 79 of file ossimJ2kCodRecord.h.

Referenced by parseStream(), and print().

m_precinctSize

ossim_uint8 ossimJ2kCodRecord::m_precinctSize

SPcod - precinct size (only is defined, Scod = xxxx xxx1)

Definition at line 100 of file ossimJ2kCodRecord.h.

Referenced by parseStream(), and print().

m_progressionOrder

ossim_uint8 ossimJ2kCodRecord::m_progressionOrder

SGcod - Progression order.

Definition at line 76 of file ossimJ2kCodRecord.h.

Referenced by getProgressionOrder(), parseStream(), and print().

m_scod

ossim_uint8 ossimJ2kCodRecord::m_scod

Coding style.

Definition at line 73 of file ossimJ2kCodRecord.h.

Referenced by parseStream(), and print().

m_transformation

ossim_uint8 ossimJ2kCodRecord::m_transformation

SPcod - transformation (wavelet filter)

Definition at line 97 of file ossimJ2kCodRecord.h.

Referenced by parseStream(), and print().

---

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

• ossimJ2kCodRecord.h
• ossimJ2kCodRecord.cpp