ossimJ2kSizRecord Class Reference

#include <ossimJ2kSizRecord.h>

Public Member Functions
	ossimJ2kSizRecord ()
	default constructor More...
	~ossimJ2kSizRecord ()
	destructor More...
void	parseStream (ossim::istream &in)
	Parse method. More...
void	writeStream (std::ostream &out)
	Write method. More...
ossimScalarType	getScalarType () const
	Gets the scalar type. 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...

Public Attributes
ossim_uint16	m_marker
	segmet marker 0xff51 (big endian) More...
ossim_uint16	m_Lsiz
	length of segment minus marker More...
ossim_uint16	m_Rsiz
	profile More...
ossim_uint32	m_Xsiz
	width of reference grid More...
ossim_uint32	m_Ysiz
	height of reference grid More...
ossim_uint32	m_XOsiz
	Horizontal offset from the orgin of reference grid to the left side of image. More...
ossim_uint32	m_YOsiz
	Vertical offset from the orgin of reference grid to the top of image. More...
ossim_uint32	m_XTsiz
	width of one reference tile More...
ossim_uint32	m_YTsiz
	height of one reference tile More...
ossim_uint32	m_XTOsiz
	Horizontal offset from the orgin of reference grid to the left edge of first tile. More...
ossim_uint32	m_YTOsiz
	Vertical offset from the orgin of reference grid to the top edge of first tile. More...
ossim_uint16	m_Csiz
	number of component in the image More...
std::vector< ossim_uint8 >	m_Ssiz
	One for each component: More...
std::vector< ossim_uint8 >	m_XRsiz
	One for each component: More...
std::vector< ossim_uint8 >	m_YRsiz
	One for each component: More...

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

Detailed Description

Definition at line 16 of file ossimJ2kSizRecord.h.

Constructor & Destructor Documentation

ossimJ2kSizRecord()

ossimJ2kSizRecord::ossimJ2kSizRecord

(

)

default constructor

Definition at line 23 of file ossimJ2kSizRecord.cpp.

   :
   m_marker(0xff51),
   m_Lsiz(0),
   m_Rsiz(0),
   m_Xsiz(0),
   m_Ysiz(0),
   m_XOsiz(0),
   m_YOsiz(0),
   m_XTsiz(0),
   m_YTsiz(0),
   m_XTOsiz(0),
   m_YTOsiz(0),
   m_Csiz(0),
   m_Ssiz(0),
   m_XRsiz(0),
   m_YRsiz(0)
{
}

~ossimJ2kSizRecord()

ossimJ2kSizRecord::~ossimJ2kSizRecord

(

)

destructor

Definition at line 43 of file ossimJ2kSizRecord.cpp.

{
}

Member Function Documentation

getScalarType()

ossimScalarType ossimJ2kSizRecord::getScalarType

(

)

const

Gets the scalar type.

Currently assumes all components are the same scalar type. I.e., only looks at first component.

Returns

scalar type based on bit depth and signed bit from theSsiz.

Definition at line 157 of file ossimJ2kSizRecord.cpp.

References ossim::isSigned(), m_Ssiz, OSSIM_SCALAR_UNKNOWN, OSSIM_SINT16, OSSIM_SINT8, OSSIM_UINT16, OSSIM_UINT8, OSSIM_USHORT11, OSSIM_USHORT12, OSSIM_USHORT13, OSSIM_USHORT14, and OSSIM_USHORT15.

Referenced by ossimKakaduJ2kReader::getOutputScalarType(), and ossimOpjJp2Reader::getOutputScalarType().

{
   // Currently assumes all components the same scalar type.
   
   ossimScalarType result = OSSIM_SCALAR_UNKNOWN;

   if ( m_Ssiz.size() )
   {
      // Bits per pixel first seven bits plus one.
      ossim_uint8 bpp = ( m_Ssiz[0] & 0x3f ) + 1;
      
      // Signed bit is msb.
      bool isSigned = ( m_Ssiz[0] & 0x80 ) ? true : false;
      
      if ( bpp <= 8 )
      {
         if ( isSigned == 0 )
         {
            result = OSSIM_UINT8;
         }
         else if (isSigned == 1)
         {
            result = OSSIM_SINT8;
         }
      }
      else if ( bpp == 11 )
      {
         if ( isSigned == 0 )
         {
            result = OSSIM_USHORT11;
         }
         else
         {
            result = OSSIM_SINT16;
         }
      }
      else if ( bpp == 12 )
      {
         if ( isSigned == 0 )
         {
            result = OSSIM_USHORT12;
         }
         else
         {
            result = OSSIM_SINT16;
         }
      }
      else if ( bpp == 13 )
      {
         if ( isSigned == 0 )
         {
            result = OSSIM_USHORT13;
         }
         else
         {
            result = OSSIM_SINT16;
         }
      }
      else if ( bpp == 14 )
      {
         if ( isSigned == 0 )
         {
            result = OSSIM_USHORT14;
         }
         else
         {
            result = OSSIM_SINT16;
         }
      }
      else if ( bpp == 15 )
      {
         if ( isSigned == 0 )
         {
            result = OSSIM_USHORT15;
         }
         else
         {
            result = OSSIM_SINT16;
         }
      }
      else if( bpp <= 16 )
      {
         if( isSigned == 0 )
         {
            result = OSSIM_UINT16;
         }
         else if( isSigned == 1 )
         {
            result = OSSIM_SINT16;
         }
      }
   }
   return result;
}

parseStream()

void ossimJ2kSizRecord::parseStream

(

ossim::istream &

in

)

Parse method.

Performs byte swapping as needed.

Parameters

in	Stream to parse.

Note

SIZ Marker (0xff51) is not read.

Definition at line 47 of file ossimJ2kSizRecord.cpp.

References ossim::byteOrder(), m_Csiz, m_Lsiz, m_Rsiz, m_Ssiz, m_XOsiz, m_XRsiz, m_Xsiz, m_XTOsiz, m_XTsiz, m_YOsiz, m_YRsiz, m_Ysiz, m_YTOsiz, m_YTsiz, OSSIM_LITTLE_ENDIAN, and ossimEndian::swap().

Referenced by ossimKakaduNitfReader::dumpTiles(), ossimOpjJp2Reader::initSizRecord(), and ossimJ2kInfo::printSizMarker().

{
   // Note: Marker is not read.
   in.read((char*)&m_Lsiz,      2);
   in.read((char*)&m_Rsiz,      2);
   in.read((char*)&m_Xsiz,      4);
   in.read((char*)&m_Ysiz,      4);
   in.read((char*)&m_XOsiz,     4);
   in.read((char*)&m_YOsiz,     4);
   in.read((char*)&m_XTsiz,     4);
   in.read((char*)&m_YTsiz,     4);
   in.read((char*)&m_XTOsiz,    4);
   in.read((char*)&m_YTOsiz,    4);
   in.read((char*)&m_Csiz,      2);

   if (ossim::byteOrder() == OSSIM_LITTLE_ENDIAN)
   {
      // Stored in file big endian, must swap.
      ossimEndian s;
      s.swap(m_Lsiz);
      s.swap(m_Rsiz);
      s.swap(m_Xsiz);
      s.swap(m_Ysiz);
      s.swap(m_XOsiz);
      s.swap(m_YOsiz);
      s.swap(m_XTsiz);
      s.swap(m_YTsiz);
      s.swap(m_XTOsiz);
      s.swap(m_YTOsiz);
      s.swap(m_Csiz);
   }

   m_Ssiz.resize( m_Csiz );
   in.read((char*)&m_Ssiz.front(), m_Csiz);
   
   m_XRsiz.resize( m_Csiz );
   in.read((char*)&m_XRsiz.front(), m_Csiz);
   
   m_YRsiz.resize( m_Csiz );
   in.read((char*)&m_YRsiz.front(), m_Csiz);
}

print()

std::ostream & ossimJ2kSizRecord::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 252 of file ossimJ2kSizRecord.cpp.

References m_Csiz, m_Lsiz, m_marker, m_Rsiz, m_Ssiz, m_XOsiz, m_XRsiz, m_Xsiz, m_XTOsiz, m_XTsiz, m_YOsiz, m_YRsiz, m_Ysiz, m_YTOsiz, and m_YTsiz.

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

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

   std::string pfx = prefix;
   pfx += "siz.";
   
   out.setf(std::ios_base::hex, std::ios_base::basefield);
   out << pfx << "marker: 0x" << m_marker << "\n";
   out.setf(std::ios_base::fmtflags(0), std::ios_base::basefield);

   out << pfx << "Lsiz:   " << m_Lsiz       << "\n"
       << pfx << "Rsiz:   " << m_Rsiz       << "\n"
       << pfx << "Xsiz:   " << m_Xsiz       << "\n"
       << pfx << "Yziz:   " << m_Ysiz       << "\n"
       << pfx << "XOsiz:  " << m_XOsiz      << "\n"
       << pfx << "YOsiz:  " << m_YOsiz      << "\n"
       << pfx << "XTsiz:  " << m_XTsiz      << "\n"
       << pfx << "YTsiz:  " << m_YTsiz      << "\n"
       << pfx << "XTOsiz: " << m_XTOsiz     << "\n"
       << pfx << "YTOsiz: " << m_YTOsiz     << "\n"
       << pfx << "Csiz:   " << m_Csiz       << "\n";
   
   for ( ossim_uint16 i = 0; i < m_Csiz; ++i )
   {
      out << pfx << "Ssiz[" << i  << "]:  " << int(m_Ssiz[i])  << "\n"
          << pfx << "XRsiz[" << i << "]:  " << int(m_XRsiz[i]) << "\n"
          << pfx << "YRsiz[" << i << "]:  " << int(m_YRsiz[i]) << "\n";
   }

   out.flush();

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

   return out;
}

writeStream()

void ossimJ2kSizRecord::writeStream

(

std::ostream &

out

)

Write method.

Parameters

out	Stream to write to.

Definition at line 89 of file ossimJ2kSizRecord.cpp.

References ossim::byteOrder(), m_Csiz, m_Lsiz, m_Rsiz, m_Ssiz, m_XOsiz, m_XRsiz, m_Xsiz, m_XTOsiz, m_XTsiz, m_YOsiz, m_YRsiz, m_Ysiz, m_YTOsiz, m_YTsiz, OSSIM_LITTLE_ENDIAN, and ossimEndian::swap().

{
   // Length of this marker segment(marker not included):
   m_Lsiz = 38 + 3*m_Csiz;

   // Grab component count before swapping:
   ossim_uint16 components = m_Csiz;

   ossimEndian* s = 0;
   
   if (ossim::byteOrder() == OSSIM_LITTLE_ENDIAN)
   {
      // Stored in file big endian, must swap.
      s = new ossimEndian();
      s->swap(m_Lsiz);
      s->swap(m_Rsiz);
      s->swap(m_Xsiz);
      s->swap(m_Ysiz);
      s->swap(m_XOsiz);
      s->swap(m_YOsiz);
      s->swap(m_XTsiz);
      s->swap(m_YTsiz);
      s->swap(m_XTOsiz);
      s->swap(m_YTOsiz);
      s->swap(m_Csiz);
   }

   out.put( 0xff );
   out.put( 0x51 );
   // out.write( (char*)&m_marker, 2 );
   
   out.write((char*)&m_Lsiz,    2);
   out.write((char*)&m_Rsiz,    2);
   out.write((char*)&m_Xsiz,    4);
   out.write((char*)&m_Ysiz,    4);
   out.write((char*)&m_XOsiz,   4);
   out.write((char*)&m_YOsiz,   4);
   out.write((char*)&m_XTsiz,   4);
   out.write((char*)&m_YTsiz,   4);
   out.write((char*)&m_XTOsiz,  4);
   out.write((char*)&m_YTOsiz,  4);
   out.write((char*)&m_Csiz,    2);

   out.write((char*)&m_Ssiz.front(),  components);
   out.write((char*)&m_XRsiz.front(), components);
   out.write((char*)&m_YRsiz.front(), components);

   if ( s )
   {
      // Swap it back to native.
      s->swap(m_Lsiz);
      s->swap(m_Rsiz);
      s->swap(m_Xsiz);
      s->swap(m_Ysiz);
      s->swap(m_XOsiz);
      s->swap(m_YOsiz);
      s->swap(m_XTsiz);
      s->swap(m_YTsiz);
      s->swap(m_XTOsiz);
      s->swap(m_YTOsiz);
      s->swap(m_Csiz);

      // Cleanup:
      delete s;
      s = 0;
   }   
}

Friends And Related Function Documentation

operator<<

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

friend

operator<<

Definition at line 292 of file ossimJ2kSizRecord.cpp.

{
   return obj.print(out);
}

Member Data Documentation

m_Csiz

ossim_uint16 ossimJ2kSizRecord::m_Csiz

number of component in the image

Definition at line 114 of file ossimJ2kSizRecord.h.

Referenced by ossimOpjJp2Reader::getNumberOfInputBands(), ossimKakaduJ2kReader::getNumberOfInputBands(), ossimOpjJp2Reader::getNumberOfOutputBands(), ossimKakaduJ2kReader::getNumberOfOutputBands(), parseStream(), print(), and writeStream().

m_Lsiz

ossim_uint16 ossimJ2kSizRecord::m_Lsiz

length of segment minus marker

Definition at line 72 of file ossimJ2kSizRecord.h.

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

m_marker

ossim_uint16 ossimJ2kSizRecord::m_marker

segmet marker 0xff51 (big endian)

Definition at line 69 of file ossimJ2kSizRecord.h.

Referenced by print().

m_Rsiz

ossim_uint16 ossimJ2kSizRecord::m_Rsiz

profile

Definition at line 75 of file ossimJ2kSizRecord.h.

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

m_Ssiz

std::vector<ossim_uint8> ossimJ2kSizRecord::m_Ssiz

One for each component:

sign bit and bit depth of data unsigned = 0xxx xxxx (msb == 0) signed = 1xxx xxxx (msb == 1) bit depth = x000 0000 + 1 (first seven bits plus one)

Definition at line 124 of file ossimJ2kSizRecord.h.

Referenced by getScalarType(), parseStream(), print(), and writeStream().

m_XOsiz

ossim_uint32 ossimJ2kSizRecord::m_XOsiz

Horizontal offset from the orgin of reference grid to the left side of image.

Definition at line 87 of file ossimJ2kSizRecord.h.

Referenced by ossimOpjJp2Reader::getNumberOfSamples(), ossimOpjJp2Reader::getOverviewTile(), parseStream(), print(), and writeStream().

m_XRsiz

std::vector<ossim_uint8> ossimJ2kSizRecord::m_XRsiz

One for each component:

Horizontal separation of a sample of the component with respect to the reference grid.

Definition at line 132 of file ossimJ2kSizRecord.h.

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

m_Xsiz

ossim_uint32 ossimJ2kSizRecord::m_Xsiz

width of reference grid

Definition at line 78 of file ossimJ2kSizRecord.h.

Referenced by ossimOpjJp2Reader::getNumberOfSamples(), ossimKakaduJ2kReader::getNumberOfSamples(), parseStream(), print(), and writeStream().

m_XTOsiz

ossim_uint32 ossimJ2kSizRecord::m_XTOsiz

Horizontal offset from the orgin of reference grid to the left edge of first tile.

Definition at line 105 of file ossimJ2kSizRecord.h.

Referenced by ossimOpjJp2Reader::getImageTileWidth(), parseStream(), print(), and writeStream().

m_XTsiz

ossim_uint32 ossimJ2kSizRecord::m_XTsiz

width of one reference tile

Definition at line 96 of file ossimJ2kSizRecord.h.

Referenced by ossimKakaduJ2kReader::getImageTileHeight(), ossimKakaduJ2kReader::getImageTileWidth(), ossimOpjJp2Reader::getImageTileWidth(), parseStream(), print(), and writeStream().

m_YOsiz

ossim_uint32 ossimJ2kSizRecord::m_YOsiz

Vertical offset from the orgin of reference grid to the top of image.

Definition at line 93 of file ossimJ2kSizRecord.h.

Referenced by ossimOpjJp2Reader::getNumberOfLines(), ossimOpjJp2Reader::getOverviewTile(), parseStream(), print(), and writeStream().

m_YRsiz

std::vector<ossim_uint8> ossimJ2kSizRecord::m_YRsiz

One for each component:

Vertical separation of a sample of the component with respect to the reference grid.

Definition at line 140 of file ossimJ2kSizRecord.h.

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

m_Ysiz

ossim_uint32 ossimJ2kSizRecord::m_Ysiz

height of reference grid

Definition at line 81 of file ossimJ2kSizRecord.h.

Referenced by ossimOpjJp2Reader::getNumberOfLines(), ossimKakaduJ2kReader::getNumberOfLines(), parseStream(), print(), and writeStream().

m_YTOsiz

ossim_uint32 ossimJ2kSizRecord::m_YTOsiz

Vertical offset from the orgin of reference grid to the top edge of first tile.

Definition at line 111 of file ossimJ2kSizRecord.h.

Referenced by ossimOpjJp2Reader::getImageTileHeight(), parseStream(), print(), and writeStream().

m_YTsiz

ossim_uint32 ossimJ2kSizRecord::m_YTsiz

height of one reference tile

Definition at line 99 of file ossimJ2kSizRecord.h.

Referenced by ossimKakaduJ2kReader::getImageTileHeight(), ossimOpjJp2Reader::getImageTileHeight(), ossimKakaduJ2kReader::getImageTileWidth(), parseStream(), print(), and writeStream().

---

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

• ossimJ2kSizRecord.h
• ossimJ2kSizRecord.cpp