ossimplugins::Noise Class Reference

This class represents an Noise. More...

#include <Noise.h>

Public Member Functions
	Noise ()
	Constructor. More...
virtual	~Noise ()
	Destructor. More...
	Noise (const Noise &rhs)
	Copy constructor. More...
Noise &	operator= (const Noise &rhs)
	Affectation operator. More...
bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
	Method to save object state to a keyword list. More...
bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
	Method to the load (recreate) the state of the object from a keyword list. More...
virtual std::ostream &	print (std::ostream &out) const
void	set_numberOfNoiseRecords (const ossim_int32 &numberOfNoiseRecords)
void	set_imageNoise (const std::vector< ImageNoise > &image_noise)
const std::vector< ImageNoise > &	get_imageNoise () const
void	set_imagePolarisation (const ossimString &polarisation)
const ossimString &	get_imagePolarisation () const

Protected Attributes
ossim_uint32	_numberOfNoiseRecords
	Image Noise. More...
std::vector< ImageNoise >	_tabImageNoise
	Image Noise. More...
ossimString	_polarisation
	Noise Polarisation Layer. More...

Detailed Description

This class represents an Noise.

Definition at line 28 of file Noise.h.

Constructor & Destructor Documentation

Noise() [1/2]

ossimplugins::Noise::Noise

(

)

Constructor.

Definition at line 25 of file Noise.cpp.

            :
  _numberOfNoiseRecords(0),
  _tabImageNoise(),
  _polarisation("UNDEFINED")
{
}

~Noise()

ossimplugins::Noise::~Noise ( )

virtual

Destructor.

Definition at line 32 of file Noise.cpp.

{
}

Noise() [2/2]

ossimplugins::Noise::Noise

(

const Noise &

rhs

)

Copy constructor.

Definition at line 37 of file Noise.cpp.

                            :
  _numberOfNoiseRecords(rhs._numberOfNoiseRecords),
  _tabImageNoise(rhs._tabImageNoise),
  _polarisation(rhs._polarisation)
{
}

Member Function Documentation

get_imageNoise()

const std::vector<ImageNoise>& ossimplugins::Noise::get_imageNoise ( ) const

inline

Definition at line 80 of file Noise.h.

  {
    return _tabImageNoise;
  }

get_imagePolarisation()

const ossimString& ossimplugins::Noise::get_imagePolarisation ( ) const

inline

Definition at line 89 of file Noise.h.

  {
    return _polarisation;
  }

loadState()

bool ossimplugins::Noise::loadState	(	const ossimKeywordlist &	kwl,
		const char *	prefix = 0
	)

Method to the load (recreate) the state of the object from a keyword list.

Return true if ok or false on error.

Returns

true if load OK, false on error

Definition at line 77 of file Noise.cpp.

References _numberOfNoiseRecords, _polarisation, _tabImageNoise, ossimString::c_str(), ossimKeywordlist::find(), ossimplugins::ImageNoise::loadState(), ossimNotify(), ossimNotifyLevel_WARN, ossimString::toString(), and ossimString::toUInt32().

{
   static const char MODULE[] = "Noise::loadState";

   bool result = true;

   std::string pfx("");
   if (prefix)
   {
      pfx = prefix;
   }
   pfx += NOISE;

   ossimString s;
   const char* lookup = 0;
   std::string s1 = pfx + ".";

  lookup = kwl.find(s1.c_str(), NAME_OF_NOISE_POLARISATION_KW);
  if (lookup)
  {
    _polarisation = lookup;
  }
  else
  {
    ossimNotify(ossimNotifyLevel_WARN)
         << MODULE << " Keyword not found: " << NAME_OF_NOISE_POLARISATION_KW << "\n";
    result = false;
  }

  lookup = kwl.find(s1.c_str(), NUMBER_OF_NOISE_RECORDS_KW);
  if (lookup)
  {
    s = lookup;
    _numberOfNoiseRecords = s.toUInt32();
  }
  else
  {
    ossimNotify(ossimNotifyLevel_WARN)
         << MODULE << " Keyword not found: " << NUMBER_OF_NOISE_RECORDS_KW << "\n";
    result = false;
  }

   _tabImageNoise.clear();
   for (unsigned int i = 0; i < _numberOfNoiseRecords; ++i)
   {
      std::string s2 = pfx + "[" + ossimString::toString(i).c_str() + "]";
      ImageNoise in;
      result = in.loadState(kwl, s2.c_str());
      _tabImageNoise.push_back(in);
   }
   if( _numberOfNoiseRecords != _tabImageNoise.size() )
   {
    ossimNotify(ossimNotifyLevel_WARN)
         << MODULE << " Keyword " << NUMBER_OF_NOISE_RECORDS_KW << " is different with the number of ImageNoise nodes \n";
   }
   return result;
}

operator=()

Noise & ossimplugins::Noise::operator=

(

const Noise &

rhs

)

Affectation operator.

Definition at line 44 of file Noise.cpp.

References _numberOfNoiseRecords, _polarisation, and _tabImageNoise.

{
  _numberOfNoiseRecords = rhs._numberOfNoiseRecords;
  _tabImageNoise = rhs._tabImageNoise;
  _polarisation = rhs._polarisation;
  return *this;
}

print()

std::ostream & ossimplugins::Noise::print ( std::ostream &  out ) const

virtual

METHOD: print() Fulfills base-class pure virtual. Dumps contents of object to ostream.

Definition at line 136 of file Noise.cpp.

References _numberOfNoiseRecords, _polarisation, _tabImageNoise, ossimKeywordlist::add(), ossimString::c_str(), ossimString::chars(), and ossimString::toString().

{
   out << setprecision(15) << setiosflags(ios::fixed)
       << "\n Noise class data members:\n";

   const char* prefix = 0;
   ossimKeywordlist kwl;
   ossimString pfx;
   pfx += NOISE;
   ossimString s = pfx + "." + NUMBER_OF_NOISE_RECORDS_KW;
   kwl.add(prefix, s.c_str(), _numberOfNoiseRecords);
   s = pfx + "." + NAME_OF_NOISE_POLARISATION_KW;
   kwl.add(prefix, s.chars(), _polarisation);
   for (unsigned int i = 0; i < _tabImageNoise.size(); ++i)
   {
     ossimString s2 = pfx + "[" + ossimString::toString(i).c_str() + "]";
     _tabImageNoise[i].saveState(kwl, s2.c_str());
   }

   out << kwl;

   return out;
}

saveState()

bool ossimplugins::Noise::saveState	(	ossimKeywordlist &	kwl,
		const char *	prefix = 0
	)		const

Method to save object state to a keyword list.

Parameters

kwl	Keyword list to save to.
prefix	added to keys when saved.

Returns

true on success, false on error.

Definition at line 52 of file Noise.cpp.

References _numberOfNoiseRecords, _polarisation, _tabImageNoise, ossimKeywordlist::add(), ossimString::c_str(), and ossimString::toString().

{
   std::string pfx;
   if (prefix)
   {
      pfx = prefix;
   }
   pfx += NOISE;
   

   std::string s = pfx + "." + NAME_OF_NOISE_POLARISATION_KW;
   kwl.add(prefix, s.c_str(), _polarisation);
   
   s = pfx + "." + NUMBER_OF_NOISE_RECORDS_KW;
   kwl.add(prefix, s.c_str(), _numberOfNoiseRecords);
   
   for (unsigned int i = 0; i < _tabImageNoise.size(); ++i)
   {
     ossimString s2 = pfx + "[" + ossimString::toString(i).c_str() + "]";
      _tabImageNoise[i].saveState(kwl, s2.c_str());
   }

   return true;
}

set_imageNoise()

void ossimplugins::Noise::set_imageNoise ( const std::vector< ImageNoise > &  image_noise )

inline

Definition at line 75 of file Noise.h.

Referenced by ossimplugins::ossimTerraSarModel::getNoiseAtGivenNode(), and ossimplugins::ossimTerraSarProductDoc::initNoise().

  {
    _tabImageNoise = image_noise;
  }

set_imagePolarisation()

void ossimplugins::Noise::set_imagePolarisation ( const ossimString &  polarisation )

inline

Definition at line 84 of file Noise.h.

  {
    _polarisation = polarisation;
  }

set_numberOfNoiseRecords()

void ossimplugins::Noise::set_numberOfNoiseRecords ( const ossim_int32 &  numberOfNoiseRecords )

inline

Definition at line 71 of file Noise.h.

Referenced by ossimplugins::ossimTerraSarModel::getNoiseAtGivenNode(), and ossimplugins::ossimTerraSarProductDoc::initNoise().

  {
    _numberOfNoiseRecords = numberOfNoiseRecords;
  }

Member Data Documentation

_numberOfNoiseRecords

ossim_uint32 ossimplugins::Noise::_numberOfNoiseRecords

protected

Image Noise.

Definition at line 102 of file Noise.h.

Referenced by loadState(), operator=(), print(), and saveState().

_polarisation

ossimString ossimplugins::Noise::_polarisation

protected

Noise Polarisation Layer.

Definition at line 111 of file Noise.h.

Referenced by loadState(), operator=(), print(), and saveState().

_tabImageNoise

std::vector<ImageNoise> ossimplugins::Noise::_tabImageNoise

protected

Image Noise.

Definition at line 106 of file Noise.h.

Referenced by loadState(), operator=(), print(), and saveState().

---

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

• Noise.h
• Noise.cpp