ossimplugins::RadarSat2NoiseLevel Class Reference

This class represents an Noise. More...

#include <RadarSat2NoiseLevel.h>

Public Member Functions
	RadarSat2NoiseLevel ()
	Constructor. More...
virtual	~RadarSat2NoiseLevel ()
	Destructor. More...
	RadarSat2NoiseLevel (const RadarSat2NoiseLevel &rhs)
	Copy constructor. More...
RadarSat2NoiseLevel &	operator= (const RadarSat2NoiseLevel &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_incidenceAngleCorrectionName (const ossimString &value)
void	set_pixelFirstNoiseValue (const ossim_uint32 &value)
void	set_stepSize (const ossim_uint32 &value)
void	set_numberOfNoiseLevelValues (const ossim_uint32 &value)
void	set_noiseLevelValues (const std::vector< ossim_float64 > &value)
void	set_units (const ossimString &value)
void	set_offset (const ossim_float64 &value)
void	set_gain (const ossimString &value)
const ossimString &	get_incidenceAngleCorrectionName () const
const ossimString &	get_gain () const

Protected Attributes
ossimString	_incidenceAngleCorrectionName
	Incidence Angle correction Name. More...
ossim_uint32	_pixelFirstNoiseValue
	pixel First Noise Value More...
ossim_uint32	_stepSize
	step Size More...
ossim_uint32	_numberOfNoiseLevelValues
	number Of Noise Level Values More...
std::vector< ossim_float64 >	_noiseLevelValues
	noise Level Values More...
ossimString	_units
	noise Level units More...
ossim_float64	_offset
	offset value More...
ossimString	_gain
	lookup table More...

Detailed Description

This class represents an Noise.

Definition at line 29 of file RadarSat2NoiseLevel.h.

Constructor & Destructor Documentation

RadarSat2NoiseLevel() [1/2]

ossimplugins::RadarSat2NoiseLevel::RadarSat2NoiseLevel

(

)

Constructor.

Definition at line 37 of file RadarSat2NoiseLevel.cpp.

                                        :
  _incidenceAngleCorrectionName("Unknown"), 
  _pixelFirstNoiseValue(0),
  _stepSize(0),
  _numberOfNoiseLevelValues(0),
  _noiseLevelValues(),
  _units("Unknown"),
  _offset(0.0),
  _gain()
{
}

~RadarSat2NoiseLevel()

ossimplugins::RadarSat2NoiseLevel::~RadarSat2NoiseLevel ( )

virtual

Destructor.

Definition at line 49 of file RadarSat2NoiseLevel.cpp.

{
}

RadarSat2NoiseLevel() [2/2]

ossimplugins::RadarSat2NoiseLevel::RadarSat2NoiseLevel

(

const RadarSat2NoiseLevel &

rhs

)

Copy constructor.

Definition at line 54 of file RadarSat2NoiseLevel.cpp.

                                                                      :
  _incidenceAngleCorrectionName(rhs._incidenceAngleCorrectionName), 
  _pixelFirstNoiseValue(rhs._pixelFirstNoiseValue),     
  _stepSize(rhs._stepSize),
  _numberOfNoiseLevelValues(rhs._numberOfNoiseLevelValues),
  _noiseLevelValues(rhs._noiseLevelValues),
  _units(rhs._units), 
  _offset(rhs._offset),
  _gain(rhs._gain)
{
}

Member Function Documentation

get_gain()

const ossimString& ossimplugins::RadarSat2NoiseLevel::get_gain ( ) const

inline

Definition at line 110 of file RadarSat2NoiseLevel.h.

   {
        return _gain;
   }

get_incidenceAngleCorrectionName()

const ossimString& ossimplugins::RadarSat2NoiseLevel::get_incidenceAngleCorrectionName ( ) const

inline

Definition at line 106 of file RadarSat2NoiseLevel.h.

Referenced by ossimplugins::ossimRadarSat2Model::InitLut().

   {
        return _incidenceAngleCorrectionName;
   }

loadState()

bool ossimplugins::RadarSat2NoiseLevel::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 133 of file RadarSat2NoiseLevel.cpp.

References _gain, _incidenceAngleCorrectionName, _noiseLevelValues, _numberOfNoiseLevelValues, _offset, _pixelFirstNoiseValue, _stepSize, _units, ossimString::c_str(), ossimKeywordlist::find(), ossimNotify(), ossimNotifyLevel_WARN, ossimString::toDouble(), ossimString::toFloat64(), ossimString::toString(), and ossimString::toUInt32().

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

   //bool         result = true;
   ossimString  s;
   const char*  lookup = 0;

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

   pfx += NOISE;

   if(_incidenceAngleCorrectionName == "Gamma")
   {
        pfx = pfx + "["+ GAMMA +"]";
   }
   if(_incidenceAngleCorrectionName == "Sigma Nought")
   {
        pfx = pfx + "["+ SIGMA_NOUGHT +"]";
   }
   if(_incidenceAngleCorrectionName == "Beta Nought")
   {
        pfx = pfx + "["+ BETA_NOUGHT +"]";
   }
   
   

  std::string s1 = pfx + "["+ GAMMA +"]";
  lookup = kwl.find(s1.c_str(), INCIDENCE_ANGLE_CORRECTION_NAME_KW);
  if (!lookup)
  {
        std::string s1 = pfx + "["+ SIGMA_NOUGHT +"]";
        lookup = kwl.find(s1.c_str(), INCIDENCE_ANGLE_CORRECTION_NAME_KW);
        if (!lookup)
        {
            std::string s1 = pfx + "["+ BETA_NOUGHT +"]";
            lookup = kwl.find(s1.c_str(), INCIDENCE_ANGLE_CORRECTION_NAME_KW);
            if (!lookup)
            {
                    ossimNotify(ossimNotifyLevel_WARN)
                        << MODULE << " Keyword not found: " << INCIDENCE_ANGLE_CORRECTION_NAME_KW << "\n";
                    return false;
            }
        }
  }

  _incidenceAngleCorrectionName = lookup;
  pfx= s1;

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

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

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


  lookup = kwl.find(s1.c_str(), UNITS_KW);
  if (lookup)
  {
    _units = lookup;
  }
  else
  {
    ossimNotify(ossimNotifyLevel_WARN)
         << MODULE << " Keyword not found: " << UNITS_KW << "\n";
    return false;
  }
   
   _noiseLevelValues.clear();
   for (unsigned int i = 0; i < _numberOfNoiseLevelValues; ++i)
   {
        s = pfx + NOISE_LEVEL_VALUES_KW + "[" + ossimString::toString(i) + "]";
        lookup = kwl.find(s.c_str(), "");
        if (lookup)
        {
            s = lookup;
            _noiseLevelValues.push_back( s.toDouble() );
        }      
   }
   
   if( _numberOfNoiseLevelValues != _noiseLevelValues.size() )
   {
        ossimNotify(ossimNotifyLevel_WARN)
                    << MODULE
                    << " Keyword " << NOISE_LEVEL_VALUES_KW 
                    << " is different with the number of noise level values"
                    << std::endl;
        return false;           
   }

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

  lookup = kwl.find(s1.c_str(), OFFSET_KW);
  if (lookup)
  {
    s = lookup;
    _offset = s.toFloat64();
  }
  else
  {
    ossimNotify(ossimNotifyLevel_WARN)
         << MODULE << " Keyword not found: " << OFFSET_KW << "\n";
    return false;
  }
   
  if( _numberOfNoiseLevelValues != _noiseLevelValues.size() )
  {
        ossimNotify(ossimNotifyLevel_WARN)
                    << MODULE
                    << " Keyword " << NOISE_LEVEL_VALUES_KW 
                    << " is different with the number of noise level values"
                    << std::endl;
        return false;           
  }


  return true;
}

operator=()

RadarSat2NoiseLevel & ossimplugins::RadarSat2NoiseLevel::operator=

(

const RadarSat2NoiseLevel &

rhs

)

Affectation operator.

Definition at line 66 of file RadarSat2NoiseLevel.cpp.

References _gain, _incidenceAngleCorrectionName, _noiseLevelValues, _numberOfNoiseLevelValues, _offset, _pixelFirstNoiseValue, _stepSize, and _units.

{
  _incidenceAngleCorrectionName = rhs._incidenceAngleCorrectionName; 
  _pixelFirstNoiseValue = rhs._pixelFirstNoiseValue;     
  _stepSize = rhs._stepSize;
  _numberOfNoiseLevelValues = rhs._numberOfNoiseLevelValues;
  _noiseLevelValues = rhs._noiseLevelValues;
  _units = rhs._units; 
  _offset = rhs._offset;
  _gain = rhs._gain;
  return *this;
}

print()

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

virtual

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

Definition at line 300 of file RadarSat2NoiseLevel.cpp.

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

   //const char* prefix = 0;
   //ossimKeywordlist kwl;
   //ossimString pfx;

   /* TODO Add print method*/
   
   //out << kwl;

   return out;
}

saveState()

bool ossimplugins::RadarSat2NoiseLevel::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 79 of file RadarSat2NoiseLevel.cpp.

References _gain, _incidenceAngleCorrectionName, _noiseLevelValues, _numberOfNoiseLevelValues, _offset, _pixelFirstNoiseValue, _stepSize, _units, ossimKeywordlist::add(), ossimString::chars(), and ossimString::toString().

{
   std::string pfx;
   if (prefix)
   {
      pfx = prefix;
   }
   pfx += NOISE;
   
   if(_incidenceAngleCorrectionName == "Gamma")
   {
        pfx = pfx + "["+ GAMMA +"]";
   }
   if(_incidenceAngleCorrectionName == "Sigma Nought")
   {
        pfx = pfx + "["+ SIGMA_NOUGHT +"]";
   }
   if(_incidenceAngleCorrectionName == "Beta Nought")
   {
        pfx = pfx + "["+ BETA_NOUGHT +"]";
   }

   pfx +=".";
   
   std::string s = pfx + INCIDENCE_ANGLE_CORRECTION_NAME_KW;
   kwl.add(prefix, s.c_str(), _incidenceAngleCorrectionName);
   
   s = pfx + PIXEL_FIRST_NOISE_VALUE_KW;
   kwl.add(prefix, s.c_str(), _pixelFirstNoiseValue);
   
   s = pfx + STEP_SIZE_KW;
   kwl.add(prefix, s.c_str(), _stepSize);

   s = pfx + NUMBER_OF_NOISE_LEVEL_VALUE_KW;
   kwl.add(prefix, s.c_str(), _numberOfNoiseLevelValues);
   
   s = pfx + UNITS_KW;
   kwl.add(prefix, s.c_str(), _units);
   
   for (unsigned int i = 0; i < _noiseLevelValues.size(); ++i)
   {
        s = pfx + NOISE_LEVEL_VALUES_KW + "[" + ossimString::toString(i).chars() + "]";
        kwl.add(prefix, s.c_str(), _noiseLevelValues[i]);
   }

   s = pfx + OFFSET_KW;
   kwl.add(prefix, s.c_str(), _offset);

   s = pfx + GAIN_KW;
   kwl.add(prefix, s.c_str(), _gain);

   return true;
}

set_gain()

void ossimplugins::RadarSat2NoiseLevel::set_gain ( const ossimString &  value )

inline

Definition at line 101 of file RadarSat2NoiseLevel.h.

Referenced by ossimplugins::ossimRadarSat2Model::InitLut().

   {
        _gain = value;
   }  

set_incidenceAngleCorrectionName()

void ossimplugins::RadarSat2NoiseLevel::set_incidenceAngleCorrectionName ( const ossimString &  value )

inline

Definition at line 73 of file RadarSat2NoiseLevel.h.

Referenced by ossimplugins::ossimRadarSat2Model::InitRefNoiseLevel().

   {
        _incidenceAngleCorrectionName = value;
   }  

set_noiseLevelValues()

void ossimplugins::RadarSat2NoiseLevel::set_noiseLevelValues ( const std::vector< ossim_float64 > &  value )

inline

Definition at line 89 of file RadarSat2NoiseLevel.h.

Referenced by ossimplugins::ossimRadarSat2Model::InitRefNoiseLevel().

   {
        _noiseLevelValues = value;
   }  

set_numberOfNoiseLevelValues()

void ossimplugins::RadarSat2NoiseLevel::set_numberOfNoiseLevelValues ( const ossim_uint32 &  value )

inline

Definition at line 85 of file RadarSat2NoiseLevel.h.

Referenced by ossimplugins::ossimRadarSat2Model::InitRefNoiseLevel().

   {
        _numberOfNoiseLevelValues = value;
   }  

set_offset()

void ossimplugins::RadarSat2NoiseLevel::set_offset ( const ossim_float64 &  value )

inline

Definition at line 97 of file RadarSat2NoiseLevel.h.

Referenced by ossimplugins::ossimRadarSat2Model::InitLut().

   {
        _offset = value;
   }  

set_pixelFirstNoiseValue()

void ossimplugins::RadarSat2NoiseLevel::set_pixelFirstNoiseValue ( const ossim_uint32 &  value )

inline

Definition at line 77 of file RadarSat2NoiseLevel.h.

Referenced by ossimplugins::ossimRadarSat2Model::InitRefNoiseLevel().

   {
        _pixelFirstNoiseValue = value;
   }  

set_stepSize()

void ossimplugins::RadarSat2NoiseLevel::set_stepSize ( const ossim_uint32 &  value )

inline

Definition at line 81 of file RadarSat2NoiseLevel.h.

Referenced by ossimplugins::ossimRadarSat2Model::InitRefNoiseLevel().

   {
        _stepSize = value;
   }  

set_units()

void ossimplugins::RadarSat2NoiseLevel::set_units ( const ossimString &  value )

inline

Definition at line 93 of file RadarSat2NoiseLevel.h.

Referenced by ossimplugins::ossimRadarSat2Model::InitRefNoiseLevel().

   {
        _units = value;
   }  

Member Data Documentation

_gain

ossimString ossimplugins::RadarSat2NoiseLevel::_gain

protected

lookup table

Definition at line 154 of file RadarSat2NoiseLevel.h.

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

_incidenceAngleCorrectionName

ossimString ossimplugins::RadarSat2NoiseLevel::_incidenceAngleCorrectionName

protected

Incidence Angle correction Name.

Definition at line 120 of file RadarSat2NoiseLevel.h.

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

_noiseLevelValues

std::vector<ossim_float64> ossimplugins::RadarSat2NoiseLevel::_noiseLevelValues

protected

noise Level Values

Definition at line 139 of file RadarSat2NoiseLevel.h.

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

_numberOfNoiseLevelValues

ossim_uint32 ossimplugins::RadarSat2NoiseLevel::_numberOfNoiseLevelValues

protected

number Of Noise Level Values

Definition at line 134 of file RadarSat2NoiseLevel.h.

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

_offset

ossim_float64 ossimplugins::RadarSat2NoiseLevel::_offset

protected

offset value

Definition at line 149 of file RadarSat2NoiseLevel.h.

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

_pixelFirstNoiseValue

ossim_uint32 ossimplugins::RadarSat2NoiseLevel::_pixelFirstNoiseValue

protected

pixel First Noise Value

Definition at line 125 of file RadarSat2NoiseLevel.h.

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

_stepSize

ossim_uint32 ossimplugins::RadarSat2NoiseLevel::_stepSize

protected

step Size

Definition at line 129 of file RadarSat2NoiseLevel.h.

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

_units

ossimString ossimplugins::RadarSat2NoiseLevel::_units

protected

noise Level units

Definition at line 144 of file RadarSat2NoiseLevel.h.

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

---

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

• RadarSat2NoiseLevel.h
• RadarSat2NoiseLevel.cpp