otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput > Class Template Reference

#include <otbTerraSarBrightnessFunctor.h>

Public Member Functions
double	GetCalibrationFactor ()
bool	GetDefaultValue ()
bool	GetResultsInDecibels ()
std::complex< TOutput >	operator() (const std::complex< TInput > &inPix)
TOutput	operator() (const TInput &inPix)
void	SetCalibrationFactor (double val)
void	SetDefaultValue (double db)
void	SetResultsInDecibels (bool db)
	TerraSarBrightnessFunctor ()
virtual	~TerraSarBrightnessFunctor ()

Private Attributes
double	m_CalibrationFactor
double	m_DefaultValue
bool	m_ResultsInDecibels

Detailed Description

template<class TInput, class TOutput>
class otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >

Compute beta naught coefficient.

This functor is intended to be used by the TerrasarBrightnessImageFilter.

For more information on Terrasar calibration, please refer to the documentation of this filter.

See also

TerraSarBrightnessImageFilter

Definition at line 52 of file otbTerraSarBrightnessFunctor.h.

Constructor & Destructor Documentation

TerraSarBrightnessFunctor()

template<class TInput , class TOutput >

otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::TerraSarBrightnessFunctor

Definition at line 34 of file otbTerraSarBrightnessFunctor.hxx.

~TerraSarBrightnessFunctor()

template<class TInput , class TOutput >

virtual otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::~TerraSarBrightnessFunctor ( )

inlinevirtual

Definition at line 56 of file otbTerraSarBrightnessFunctor.h.

Member Function Documentation

GetCalibrationFactor()

template<class TInput , class TOutput >

double otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::GetCalibrationFactor ( )

inline

Definition at line 66 of file otbTerraSarBrightnessFunctor.h.

References otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::m_CalibrationFactor.

GetDefaultValue()

template<class TInput , class TOutput >

bool otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::GetDefaultValue ( )

inline

Set Default value for null or negative pixel beta

Definition at line 90 of file otbTerraSarBrightnessFunctor.h.

References otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::m_DefaultValue.

GetResultsInDecibels()

template<class TInput , class TOutput >

bool otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::GetResultsInDecibels ( )

inline

Get the value of the flag

Definition at line 78 of file otbTerraSarBrightnessFunctor.h.

References otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::m_ResultsInDecibels.

operator()() [1/2]

template<class TInput , class TOutput >

std::complex< TOutput > otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::operator() ( const std::complex< TInput > &  inPix )

inline

We assume that the input pixel is a complex -> complex image

Definition at line 65 of file otbTerraSarBrightnessFunctor.hxx.

operator()() [2/2]

template<class TInput , class TOutput >

TOutput otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::operator() ( const TInput &  inPix )

inline

We assume that the input pixel is a scalar -> modulus image

Definition at line 42 of file otbTerraSarBrightnessFunctor.hxx.

SetCalibrationFactor()

template<class TInput , class TOutput >

void otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::SetCalibrationFactor ( double  val )

inline

Accessors

Definition at line 61 of file otbTerraSarBrightnessFunctor.h.

References otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::m_CalibrationFactor.

SetDefaultValue()

template<class TInput , class TOutput >

void otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::SetDefaultValue ( double  db )

inline

Set Default value for null or negative pixel beta

Definition at line 84 of file otbTerraSarBrightnessFunctor.h.

References otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::m_DefaultValue.

SetResultsInDecibels()

template<class TInput , class TOutput >

void otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::SetResultsInDecibels ( bool  db )

inline

Set results in decibels

Definition at line 72 of file otbTerraSarBrightnessFunctor.h.

References otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::m_ResultsInDecibels.

Member Data Documentation

m_CalibrationFactor

template<class TInput , class TOutput >

double otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::m_CalibrationFactor

private

Calibration Factor

Definition at line 103 of file otbTerraSarBrightnessFunctor.h.

Referenced by otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::GetCalibrationFactor(), and otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::SetCalibrationFactor().

m_DefaultValue

template<class TInput , class TOutput >

double otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::m_DefaultValue

private

Default value for null or negative pixel beta

Definition at line 109 of file otbTerraSarBrightnessFunctor.h.

Referenced by otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::GetDefaultValue(), and otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::SetDefaultValue().

m_ResultsInDecibels

template<class TInput , class TOutput >

bool otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::m_ResultsInDecibels

private

Shall we compute results in decibels ?

Definition at line 106 of file otbTerraSarBrightnessFunctor.h.

Referenced by otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::GetResultsInDecibels(), and otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::SetResultsInDecibels().

---

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

• otbTerraSarBrightnessFunctor.h
• otbTerraSarBrightnessFunctor.hxx