ossimNitfImageBandV2_0 Class Reference

#include <ossimNitfImageBandV2_0.h>

Inheritance diagram for ossimNitfImageBandV2_0:

Public Member Functions
	ossimNitfImageBandV2_0 ()
	default constructor More...
virtual	~ossimNitfImageBandV2_0 ()
	virtual destructory More...
virtual void	parseStream (ossim::istream &in)
virtual void	writeStream (ossim::ostream &out)
virtual std::ostream &	print (std::ostream &out, const std::string &prefix=std::string(), ossim_uint32 band=0) const
	print method that outputs a key/value type format adding prefix to keys. More...
virtual ossim_uint32	getNumberOfLuts () const
virtual const ossimRefPtr< ossimNitfImageLut >	getLut (ossim_uint32 idx) const
virtual ossimRefPtr< ossimNitfImageLut >	getLut (ossim_uint32 idx)
virtual ossimString	getBandRepresentation () const
virtual void	setBandRepresentation (const ossimString &rep)
	Sets the band representation. More...
virtual ossimString	getBandSignificance () const
virtual void	setBandSignificance (const ossimString &rep)
	Sets the band significance. More...
bool	loadState (const ossimKeywordlist &kwl, const char *prefix, ossim_uint32 index=0)
Public Member Functions inherited from ossimNitfImageBand
	ossimNitfImageBand ()
virtual	~ossimNitfImageBand ()
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 std::ostream &	print (std::ostream &out) const
	Generic print method. More...
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 ()
void	printLookupTables (std::ostream &out) const
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
char	theBandRepresentation [3]
char	theBandSignificance [7]
char	theBandImageFilterCondition [2]
char	theBandStandardImageFilterCode [4]
char	theBandNumberOfLuts [2]
char	theBandNumberOfLutEntries [6]
std::vector< ossimRefPtr< ossimNitfImageLut > >	theLookupTables

Additional Inherited Members
Public Attributes inherited from ossimNitfImageBand
	TYPE_DATA

Detailed Description

Definition at line 23 of file ossimNitfImageBandV2_0.h.

Constructor & Destructor Documentation

ossimNitfImageBandV2_0()

ossimNitfImageBandV2_0::ossimNitfImageBandV2_0

(

)

default constructor

Definition at line 20 of file ossimNitfImageBandV2_0.cpp.

References clearFields().

{
   clearFields();
}

~ossimNitfImageBandV2_0()

ossimNitfImageBandV2_0::~ossimNitfImageBandV2_0 ( )

virtual

virtual destructory

Definition at line 25 of file ossimNitfImageBandV2_0.cpp.

{
}

Member Function Documentation

clearFields()

void ossimNitfImageBandV2_0::clearFields ( )

protected

Definition at line 187 of file ossimNitfImageBandV2_0.cpp.

References theBandImageFilterCondition, theBandNumberOfLutEntries, theBandNumberOfLuts, theBandRepresentation, theBandSignificance, theBandStandardImageFilterCode, and theLookupTables.

Referenced by ossimNitfImageBandV2_0().

{
   memset(theBandRepresentation, ' ', 2);
   memset(theBandSignificance, ' ', 6);
   memset(theBandImageFilterCondition, 'N', 1);
   memset(theBandStandardImageFilterCode, ' ', 3);
   memset(theBandNumberOfLutEntries, ' ', 5);
   
   theLookupTables.clear();
   theBandRepresentation[2] = '\0';
   theBandSignificance[6] = '\0';
   theBandImageFilterCondition[1] = '\0';
   theBandStandardImageFilterCode[3] = '\0';
   theBandNumberOfLuts[0] = 0x30;
   theBandNumberOfLuts[1] = '\0';
   theBandNumberOfLutEntries[5] = '\0';
}

getBandRepresentation()

ossimString ossimNitfImageBandV2_0::getBandRepresentation ( ) const

virtual

Returns

The band representation as an ossimString.

Implements ossimNitfImageBand.

Definition at line 154 of file ossimNitfImageBandV2_0.cpp.

References theBandRepresentation.

{
   return ossimString(theBandRepresentation);
}

getBandSignificance()

ossimString ossimNitfImageBandV2_0::getBandSignificance ( ) const

virtual

Returns

The band significance as an ossimString.

Definition at line 171 of file ossimNitfImageBandV2_0.cpp.

References theBandSignificance.

{
   return ossimString(theBandSignificance);
}

getLut() [1/2]

const ossimRefPtr< ossimNitfImageLut > ossimNitfImageBandV2_0::getLut ( ossim_uint32  idx ) const

virtual

Implements ossimNitfImageBand.

Definition at line 134 of file ossimNitfImageBandV2_0.cpp.

References getNumberOfLuts(), and theLookupTables.

{
   if(idx < getNumberOfLuts())
   {
      return theLookupTables[idx];
   }
   
   return NULL;
}

getLut() [2/2]

ossimRefPtr< ossimNitfImageLut > ossimNitfImageBandV2_0::getLut ( ossim_uint32  idx )

virtual

Implements ossimNitfImageBand.

Definition at line 144 of file ossimNitfImageBandV2_0.cpp.

References getNumberOfLuts(), and theLookupTables.

{
   if(idx < getNumberOfLuts())
   {
      return theLookupTables[idx];
   }
   
   return NULL;
}

getNumberOfLuts()

ossim_uint32 ossimNitfImageBandV2_0::getNumberOfLuts ( ) const

virtual

Implements ossimNitfImageBand.

Definition at line 129 of file ossimNitfImageBandV2_0.cpp.

References theLookupTables.

Referenced by getLut().

{
   return static_cast<ossim_uint32>(theLookupTables.size());
}

loadState()

bool ossimNitfImageBandV2_0::loadState	(	const ossimKeywordlist &	kwl,
		const char *	prefix,
		ossim_uint32	index = 0
	)

parseStream()

void ossimNitfImageBandV2_0::parseStream ( ossim::istream &  in )

virtual

Implements ossimNitfImageBand.

Definition at line 29 of file ossimNitfImageBandV2_0.cpp.

References theBandImageFilterCondition, theBandNumberOfLutEntries, theBandNumberOfLuts, theBandRepresentation, theBandSignificance, theBandStandardImageFilterCode, theLookupTables, and ossimString::toLong().

{
   theLookupTables.clear();
   if(in)
   {      
      theLookupTables.clear();
      in.read(theBandRepresentation, 2);
      in.read(theBandSignificance, 6);
      in.read(theBandImageFilterCondition, 1);
      in.read(theBandStandardImageFilterCode, 3);
      in.read(theBandNumberOfLuts, 1);

      long numberOfLuts = ossimString(theBandNumberOfLuts).toLong();

      if(numberOfLuts > 0)
      {
         theLookupTables.resize(numberOfLuts);
         in.read(theBandNumberOfLutEntries, 5);
         
         ossim_uint32 numberOfLutsIndex = numberOfLuts;
         ossim_uint32 numberOfLutEntries = ossimString(theBandNumberOfLutEntries).toLong();
         ossim_uint32 idx = 0;

         while(idx < numberOfLutsIndex)
         {
            theLookupTables[idx] = new ossimNitfImageLutV2_0; 
            theLookupTables[idx]->setNumberOfEntries(numberOfLutEntries);
            theLookupTables[idx]->parseStream(in);
            
            ++idx;
         }
      }
   }   
}

print()

std::ostream & ossimNitfImageBandV2_0::print ( std::ostream &  out, const std::string &  prefix = std::string(), ossim_uint32  band = 0  ) const

virtual

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

Parameters

out	Stream to output to.
prefix	Like "image0."
band	zero based band.

Implements ossimNitfImageBand.

Definition at line 78 of file ossimNitfImageBandV2_0.cpp.

References theBandImageFilterCondition, theBandNumberOfLutEntries, theBandNumberOfLuts, theBandRepresentation, theBandSignificance, theBandStandardImageFilterCode, and theLookupTables.

{
   std::ostringstream os;
   os << std::setw(3) << std::setfill('0') << (band+1) << ":";

   ossimString tmpStr = "IREPBAND";
   tmpStr += os.str();
   
   out << prefix << std::setw(24)
       << tmpStr << theBandRepresentation << "\n";

   tmpStr = "ISUBCAT";
   tmpStr += os.str();
   
   out << prefix << std::setw(24)
       << tmpStr << theBandSignificance << "\n";

   tmpStr = "IFC";
   tmpStr += os.str();
   
   out << prefix << std::setw(24)
       << tmpStr << theBandImageFilterCondition << "\n";

   tmpStr = "IMFLT";
   tmpStr += os.str();

   out << prefix << std::setw(24)
       << tmpStr << theBandStandardImageFilterCode << "\n";

   tmpStr = "NLUTS";
   tmpStr += os.str();

   out << prefix << std::setw(24)
       << tmpStr << theBandNumberOfLuts << "\n";

   tmpStr = "NELUTS";
   tmpStr += os.str();

   out << prefix << std::setw(24)
       << tmpStr << theBandNumberOfLutEntries << "\n";

   for(ossim_uint32 idx = 0; idx < theLookupTables.size(); ++idx)
   {
      out << *theLookupTables[idx] << std::endl;
   }
   
   return out;
}

printLookupTables()

void ossimNitfImageBandV2_0::printLookupTables ( std::ostream &  out ) const

protected

Definition at line 205 of file ossimNitfImageBandV2_0.cpp.

References theLookupTables.

{
   std::vector<ossimRefPtr<ossimNitfImageLut> >::const_iterator tables;

   tables = theLookupTables.begin();
   while(tables != theLookupTables.end())
   {
      if((*tables).valid())
      {
         out << *((*tables).get());
      }
      ++tables;
      if(tables != theLookupTables.end())
      {
         out << std::endl;
      }
   }
}

setBandRepresentation()

void ossimNitfImageBandV2_0::setBandRepresentation ( const ossimString &  rep )

virtual

Sets the band representation.

Parameters

rep	The band representation.

Definition at line 159 of file ossimNitfImageBandV2_0.cpp.

References ossimString::c_str(), and theBandRepresentation.

Referenced by ossimNitf20Writer::writeBlockBandSeparate(), ossimNitfWriter::writeBlockBandSeparate(), ossimNitf20Writer::writeBlockBandSequential(), and ossimNitfWriter::writeBlockBandSequential().

{
   std::ostringstream out;

   out << std::setw(2)
       << std::setfill(' ')
       << std::setiosflags(std::ios::left)
       << rep.c_str();

   memcpy(theBandRepresentation, out.str().c_str(), 2);
}

setBandSignificance()

void ossimNitfImageBandV2_0::setBandSignificance ( const ossimString &  rep )

virtual

Sets the band significance.

Parameters

rep	The band significance.

Definition at line 176 of file ossimNitfImageBandV2_0.cpp.

References ossimString::c_str(), and theBandSignificance.

{
   std::ostringstream out;
   
   out << std::setw(6)
       << std::setfill(' ')
       << rep.c_str();

   memcpy(theBandSignificance, out.str().c_str(), 6);
}

writeStream()

void ossimNitfImageBandV2_0::writeStream ( ossim::ostream &  out )

virtual

Implements ossimNitfImageBand.

Definition at line 64 of file ossimNitfImageBandV2_0.cpp.

References theBandImageFilterCondition, theBandNumberOfLuts, theBandRepresentation, theBandSignificance, and theBandStandardImageFilterCode.

{
   out.write(theBandRepresentation, 2);
   out.write(theBandSignificance, 6);
   out.write(theBandImageFilterCondition, 1);
   out.write(theBandStandardImageFilterCode, 3);
   out.write(theBandNumberOfLuts, 1);

   if(ossimString(theBandNumberOfLuts).toUInt32() > 0)
   {
      // lut output not supported currently
   }
}

Member Data Documentation

theBandImageFilterCondition

char ossimNitfImageBandV2_0::theBandImageFilterCondition[2]

protected

FIELD: IFCnn Is an required 1 byte field. Will be N

Definition at line 93 of file ossimNitfImageBandV2_0.h.

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

theBandNumberOfLutEntries

char ossimNitfImageBandV2_0::theBandNumberOfLutEntries[6]

protected

NELUTnn This is a conditional field.

Definition at line 111 of file ossimNitfImageBandV2_0.h.

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

theBandNumberOfLuts

char ossimNitfImageBandV2_0::theBandNumberOfLuts[2]

protected

FIELD: NLUTSnn This is a required 1 byte field. Has value 0-4

Definition at line 105 of file ossimNitfImageBandV2_0.h.

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

theBandRepresentation

char ossimNitfImageBandV2_0::theBandRepresentation[3]

protected

FIELD: IREPBAND,, Is a required 2 byte field. When theNumberOfBands is 1 this field will contain all spaces.

Definition at line 81 of file ossimNitfImageBandV2_0.h.

Referenced by clearFields(), getBandRepresentation(), parseStream(), print(), setBandRepresentation(), and writeStream().

theBandSignificance

char ossimNitfImageBandV2_0::theBandSignificance[7]

protected

FIELD: ISUBCATnn Is a required 6 byte field.

Definition at line 87 of file ossimNitfImageBandV2_0.h.

Referenced by clearFields(), getBandSignificance(), parseStream(), print(), setBandSignificance(), and writeStream().

theBandStandardImageFilterCode

char ossimNitfImageBandV2_0::theBandStandardImageFilterCode[4]

protected

FIELD: IMFLTnn is a required 3 byte field. This is a reserved field

Definition at line 99 of file ossimNitfImageBandV2_0.h.

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

theLookupTables

std::vector<ossimRefPtr<ossimNitfImageLut> > ossimNitfImageBandV2_0::theLookupTables

protected

Definition at line 113 of file ossimNitfImageBandV2_0.h.

Referenced by clearFields(), getLut(), getNumberOfLuts(), parseStream(), print(), and printLookupTables().

---

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

• ossimNitfImageBandV2_0.h
• ossimNitfImageBandV2_0.cpp