Orfeo Toolbox  3.16
Public Member Functions | Private Attributes
otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput > Class Template Reference

Compute beta naught coefficient. More...

#include <otbTerraSarBrightnessFunctor.h>

+ Inheritance diagram for otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >:

List of all members.

Public Member Functions

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

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 50 of file otbTerraSarBrightnessFunctor.h.


Constructor & Destructor Documentation

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

Definition at line 32 of file otbTerraSarBrightnessFunctor.txx.

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

Definition at line 54 of file otbTerraSarBrightnessFunctor.h.


Member Function Documentation

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

Definition at line 62 of file otbTerraSarBrightnessFunctor.h.

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 86 of file otbTerraSarBrightnessFunctor.h.

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

Get the value of the flag

Definition at line 74 of file otbTerraSarBrightnessFunctor.h.

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.txx.

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 66 of file otbTerraSarBrightnessFunctor.txx.

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

Accessors

Definition at line 57 of file otbTerraSarBrightnessFunctor.h.

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 80 of file otbTerraSarBrightnessFunctor.h.

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

Set results in decibels

Definition at line 68 of file otbTerraSarBrightnessFunctor.h.


Member Data Documentation

template<class TInput, class TOutput>
double otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::m_CalibrationFactor
private
template<class TInput, class TOutput>
double otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::m_DefaultValue
private
template<class TInput, class TOutput>
bool otb::Functor::TerraSarBrightnessFunctor< TInput, TOutput >::m_ResultsInDecibels
private

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

Generated at Sun Feb 3 2013 04:26:33 for Orfeo Toolbox with doxygen 1.8.1.1