otb::SarBrightnessFunction< TInputImage, TCoordRep > Class Template Reference

#include <otbSarBrightnessFunction.h>

Inheritance diagram for otb::SarBrightnessFunction< TInputImage, TCoordRep >:

Collaboration diagram for otb::SarBrightnessFunction< TInputImage, TCoordRep >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Superclass::ContinuousIndexType	ContinuousIndexType
typedef FunctorType::RealType	FunctorRealType
typedef otb::Functor::SarBrightnessFunctor< RealType, RealType >	FunctorType
typedef Superclass::IndexType	IndexType
typedef TInputImage	InputImageType
typedef InputImageType::PixelType	InputPixelType
typedef Superclass::OutputType	OutputType
typedef ParametricFunctionType::ConstPointer	ParametricFunctionConstPointer
typedef ParametricFunctionType::Pointer	ParametricFunctionPointer
typedef otb::SarParametricMapFunction< InputImageType >	ParametricFunctionType
typedef itk::SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef double	RealType
typedef SarBrightnessFunction	Self
typedef itk::ImageFunction< TInputImage, typename itk::NumericTraits< typename TInputImage::PixelType >::AbsType, TCoordRep >	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
OutputType	EvaluateAtIndex (const IndexType &index) const override

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = InputImageType::ImageDimension
FunctorRealType	m_Scale
ParametricFunctionPointer	m_Noise
bool	m_EnableNoise
ParametricFunctionPointer	m_AntennaPatternNewGain
ParametricFunctionPointer	m_AntennaPatternOldGain
ParametricFunctionPointer	m_RangeSpreadLoss
OutputType	Evaluate (const PointType &point) const override
OutputType	EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
void	SetInputImage (const InputImageType *ptr) override
virtual void	SetScale (FunctorRealType _arg)
virtual FunctorRealType	GetScale ()
virtual void	SetNoise (ParametricFunctionType *_arg)
virtual const ParametricFunctionType *	GetNoise () const
	itkGetObjectMacro (Noise, ParametricFunctionType)
virtual void	SetEnableNoise (bool _arg)
virtual bool	GetEnableNoise ()
virtual void	SetAntennaPatternNewGain (ParametricFunctionType *_arg)
virtual const ParametricFunctionType *	GetAntennaPatternNewGain () const
	itkGetObjectMacro (AntennaPatternNewGain, ParametricFunctionType)
virtual void	SetAntennaPatternOldGain (ParametricFunctionType *_arg)
	itkGetObjectMacro (AntennaPatternOldGain, ParametricFunctionType)
virtual const ParametricFunctionType *	GetAntennaPatternOldGain () const
virtual void	SetRangeSpreadLoss (ParametricFunctionType *_arg)
virtual const ParametricFunctionType *	GetRangeSpreadLoss () const
	itkGetObjectMacro (RangeSpreadLoss, ParametricFunctionType)
	SarBrightnessFunction ()
	~SarBrightnessFunction () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	SarBrightnessFunction (const Self &)=delete
void	operator= (const Self &)=delete

Detailed Description

template<class TInputImage, class TCoordRep = float>
class otb::SarBrightnessFunction< TInputImage, TCoordRep >

Calculate the backscatter for the given pixel.

Calculate the brightness value for the given pixel

If called with a ContinuousIndex or Point, the calculation is performed at the nearest neighbor.

This class is templated over the input image type and the coordinate representation type (e.g. float or double ).

Definition at line 49 of file otbSarBrightnessFunction.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TCoordRep = float>

typedef itk::SmartPointer<const Self> otb::SarBrightnessFunction< TInputImage, TCoordRep >::ConstPointer

Definition at line 57 of file otbSarBrightnessFunction.h.

ContinuousIndexType

template<class TInputImage , class TCoordRep = float>

typedef Superclass::ContinuousIndexType otb::SarBrightnessFunction< TInputImage, TCoordRep >::ContinuousIndexType

Definition at line 70 of file otbSarBrightnessFunction.h.

FunctorRealType

template<class TInputImage , class TCoordRep = float>

typedef FunctorType::RealType otb::SarBrightnessFunction< TInputImage, TCoordRep >::FunctorRealType

Definition at line 79 of file otbSarBrightnessFunction.h.

FunctorType

template<class TInputImage , class TCoordRep = float>

typedef otb::Functor::SarBrightnessFunctor<RealType, RealType> otb::SarBrightnessFunction< TInputImage, TCoordRep >::FunctorType

Definition at line 78 of file otbSarBrightnessFunction.h.

IndexType

template<class TInputImage , class TCoordRep = float>

typedef Superclass::IndexType otb::SarBrightnessFunction< TInputImage, TCoordRep >::IndexType

Definition at line 69 of file otbSarBrightnessFunction.h.

InputImageType

template<class TInputImage , class TCoordRep = float>

typedef TInputImage otb::SarBrightnessFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 63 of file otbSarBrightnessFunction.h.

InputPixelType

template<class TInputImage , class TCoordRep = float>

typedef InputImageType::PixelType otb::SarBrightnessFunction< TInputImage, TCoordRep >::InputPixelType

Definition at line 67 of file otbSarBrightnessFunction.h.

OutputType

template<class TInputImage , class TCoordRep = float>

typedef Superclass::OutputType otb::SarBrightnessFunction< TInputImage, TCoordRep >::OutputType

Definition at line 68 of file otbSarBrightnessFunction.h.

ParametricFunctionConstPointer

template<class TInputImage , class TCoordRep = float>

typedef ParametricFunctionType::ConstPointer otb::SarBrightnessFunction< TInputImage, TCoordRep >::ParametricFunctionConstPointer

Definition at line 83 of file otbSarBrightnessFunction.h.

ParametricFunctionPointer

template<class TInputImage , class TCoordRep = float>

typedef ParametricFunctionType::Pointer otb::SarBrightnessFunction< TInputImage, TCoordRep >::ParametricFunctionPointer

Definition at line 82 of file otbSarBrightnessFunction.h.

ParametricFunctionType

template<class TInputImage , class TCoordRep = float>

typedef otb::SarParametricMapFunction<InputImageType> otb::SarBrightnessFunction< TInputImage, TCoordRep >::ParametricFunctionType

Definition at line 81 of file otbSarBrightnessFunction.h.

Pointer

template<class TInputImage , class TCoordRep = float>

typedef itk::SmartPointer<Self> otb::SarBrightnessFunction< TInputImage, TCoordRep >::Pointer

Definition at line 56 of file otbSarBrightnessFunction.h.

PointType

template<class TInputImage , class TCoordRep = float>

typedef Superclass::PointType otb::SarBrightnessFunction< TInputImage, TCoordRep >::PointType

Definition at line 71 of file otbSarBrightnessFunction.h.

RealType

template<class TInputImage , class TCoordRep = float>

typedef double otb::SarBrightnessFunction< TInputImage, TCoordRep >::RealType

Datatype used for the evaluation

Definition at line 77 of file otbSarBrightnessFunction.h.

Self

template<class TInputImage , class TCoordRep = float>

typedef SarBrightnessFunction otb::SarBrightnessFunction< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 54 of file otbSarBrightnessFunction.h.

Superclass

template<class TInputImage , class TCoordRep = float>

typedef itk::ImageFunction<TInputImage, typename itk::NumericTraits<typename TInputImage::PixelType>::AbsType, TCoordRep> otb::SarBrightnessFunction< TInputImage, TCoordRep >::Superclass

Definition at line 55 of file otbSarBrightnessFunction.h.

Constructor & Destructor Documentation

SarBrightnessFunction() [1/2]

template<class TInputImage , class TCoordRep >

otb::SarBrightnessFunction< TInputImage, TCoordRep >::SarBrightnessFunction

protected

Constructor

Definition at line 35 of file otbSarBrightnessFunction.hxx.

References otb::SarBrightnessFunction< TInputImage, TCoordRep >::m_AntennaPatternNewGain, otb::SarBrightnessFunction< TInputImage, TCoordRep >::m_AntennaPatternOldGain, otb::SarBrightnessFunction< TInputImage, TCoordRep >::m_EnableNoise, otb::SarBrightnessFunction< TInputImage, TCoordRep >::m_Noise, otb::SarBrightnessFunction< TInputImage, TCoordRep >::m_RangeSpreadLoss, and otb::SarParametricMapFunction< TInputImage, TCoordRep >::New().

~SarBrightnessFunction()

template<class TInputImage , class TCoordRep = float>

otb::SarBrightnessFunction< TInputImage, TCoordRep >::~SarBrightnessFunction ( )

inlineoverrideprotected

Evaluate the function at non-integer positions

Definition at line 147 of file otbSarBrightnessFunction.h.

SarBrightnessFunction() [2/2]

template<class TInputImage , class TCoordRep = float>

otb::SarBrightnessFunction< TInputImage, TCoordRep >::SarBrightnessFunction ( const Self &  )

privatedelete

Evaluate the function at non-integer positions

Member Function Documentation

CreateAnother()

template<class TInputImage , class TCoordRep = float>

virtual::itk::LightObject::Pointer otb::SarBrightnessFunction< TInputImage, TCoordRep >::CreateAnother

(

void

)

const

Evaluate()

template<class TInputImage , class TCoordRep = float>

OutputType otb::SarBrightnessFunction< TInputImage, TCoordRep >::Evaluate ( const PointType &  point ) const

inlineoverride

Evaluate the function at non-integer positions

Definition at line 89 of file otbSarBrightnessFunction.h.

EvaluateAtContinuousIndex()

template<class TInputImage , class TCoordRep = float>

OutputType otb::SarBrightnessFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  cindex ) const

inlineoverride

Evaluate the function at non-integer positions

Definition at line 95 of file otbSarBrightnessFunction.h.

EvaluateAtIndex()

template<class TInputImage , class TCoordRep >

SarBrightnessFunction< TInputImage, TCoordRep >::OutputType otb::SarBrightnessFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType &  index ) const

override

Evalulate the function at specified index

Definition at line 98 of file otbSarBrightnessFunction.hxx.

References otb::Functor::SarBrightnessFunctor< TInput, TOutput >::SetAntennaPatternNewGain(), otb::Functor::SarBrightnessFunctor< TInput, TOutput >::SetAntennaPatternOldGain(), otb::Functor::SarBrightnessFunctor< TInput, TOutput >::SetNoise(), otb::Functor::SarBrightnessFunctor< TInput, TOutput >::SetRangeSpreadLoss(), and otb::Functor::SarBrightnessFunctor< TInput, TOutput >::SetScale().

GetAntennaPatternNewGain()

template<class TInputImage , class TCoordRep = float>

virtual const ParametricFunctionType* otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetAntennaPatternNewGain ( ) const

virtual

Evaluate the function at non-integer positions

GetAntennaPatternOldGain()

template<class TInputImage , class TCoordRep = float>

virtual const ParametricFunctionType* otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetAntennaPatternOldGain ( ) const

virtual

Evaluate the function at non-integer positions

GetEnableNoise()

template<class TInputImage , class TCoordRep = float>

virtual bool otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetEnableNoise ( )

virtual

Evaluate the function at non-integer positions

GetNameOfClass()

template<class TInputImage , class TCoordRep = float>

virtual const char* otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

GetNoise()

template<class TInputImage , class TCoordRep = float>

virtual const ParametricFunctionType* otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetNoise ( ) const

virtual

Evaluate the function at non-integer positions

GetRangeSpreadLoss()

template<class TInputImage , class TCoordRep = float>

virtual const ParametricFunctionType* otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetRangeSpreadLoss ( ) const

virtual

Evaluate the function at non-integer positions

GetScale()

template<class TInputImage , class TCoordRep = float>

virtual FunctorRealType otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetScale ( )

virtual

Evaluate the function at non-integer positions

itkGetObjectMacro() [1/4]

template<class TInputImage , class TCoordRep = float>

otb::SarBrightnessFunction< TInputImage, TCoordRep >::itkGetObjectMacro	(	AntennaPatternNewGain	,
		ParametricFunctionType
	)

Evaluate the function at non-integer positions

itkGetObjectMacro() [2/4]

template<class TInputImage , class TCoordRep = float>

otb::SarBrightnessFunction< TInputImage, TCoordRep >::itkGetObjectMacro	(	AntennaPatternOldGain	,
		ParametricFunctionType
	)

Evaluate the function at non-integer positions

itkGetObjectMacro() [3/4]

template<class TInputImage , class TCoordRep = float>

otb::SarBrightnessFunction< TInputImage, TCoordRep >::itkGetObjectMacro	(	Noise	,
		ParametricFunctionType
	)

Evaluate the function at non-integer positions

itkGetObjectMacro() [4/4]

template<class TInputImage , class TCoordRep = float>

otb::SarBrightnessFunction< TInputImage, TCoordRep >::itkGetObjectMacro	(	RangeSpreadLoss	,
		ParametricFunctionType
	)

Evaluate the function at non-integer positions

New()

template<class TInputImage , class TCoordRep = float>

static Pointer otb::SarBrightnessFunction< TInputImage, TCoordRep >::New ( )

static

Method for creation through the object factory.

operator=()

template<class TInputImage , class TCoordRep = float>

void otb::SarBrightnessFunction< TInputImage, TCoordRep >::operator= ( const Self &  )

privatedelete

Evaluate the function at non-integer positions

PrintSelf()

template<class TInputImage , class TCoordRep >

void otb::SarBrightnessFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

Evaluate the function at non-integer positions

Definition at line 68 of file otbSarBrightnessFunction.hxx.

SetAntennaPatternNewGain()

template<class TInputImage , class TCoordRep = float>

virtual void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetAntennaPatternNewGain ( ParametricFunctionType *  _arg )

virtual

Get/Set the AntennaPatternNewGain value

SetAntennaPatternOldGain()

template<class TInputImage , class TCoordRep = float>

virtual void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetAntennaPatternOldGain ( ParametricFunctionType *  _arg )

virtual

Get/Set the AntennaPatternOldGain value

SetEnableNoise()

template<class TInputImage , class TCoordRep = float>

virtual void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetEnableNoise ( bool  _arg )

virtual

Get/Set the flag which indicate if we use the Offset value

SetInputImage()

template<class TInputImage , class TCoordRep >

void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetInputImage ( const InputImageType *  ptr )

override

Set the input image.

Warning

this method caches BufferedRegion information. If the BufferedRegion has changed, user must call SetInputImage again to update cached values.

Initialize by setting the input image

Definition at line 54 of file otbSarBrightnessFunction.hxx.

SetNoise()

template<class TInputImage , class TCoordRep = float>

virtual void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetNoise ( ParametricFunctionType *  _arg )

virtual

Get/Set the Offset value

SetRangeSpreadLoss()

template<class TInputImage , class TCoordRep = float>

virtual void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetRangeSpreadLoss ( ParametricFunctionType *  _arg )

virtual

Get/Set the RangeSpreadLoss value

SetScale()

template<class TInputImage , class TCoordRep = float>

virtual void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetScale ( FunctorRealType  _arg )

virtual

Get/Set the Scale value

Member Data Documentation

ImageDimension

template<class TInputImage , class TCoordRep = float>

const unsigned int otb::SarBrightnessFunction< TInputImage, TCoordRep >::ImageDimension = InputImageType::ImageDimension

static

Definition at line 73 of file otbSarBrightnessFunction.h.

m_AntennaPatternNewGain

template<class TInputImage , class TCoordRep = float>

ParametricFunctionPointer otb::SarBrightnessFunction< TInputImage, TCoordRep >::m_AntennaPatternNewGain

private

Evaluate the function at non-integer positions

Definition at line 159 of file otbSarBrightnessFunction.h.

Referenced by otb::SarBrightnessFunction< TInputImage, TCoordRep >::SarBrightnessFunction().

m_AntennaPatternOldGain

template<class TInputImage , class TCoordRep = float>

ParametricFunctionPointer otb::SarBrightnessFunction< TInputImage, TCoordRep >::m_AntennaPatternOldGain

private

Evaluate the function at non-integer positions

Definition at line 160 of file otbSarBrightnessFunction.h.

Referenced by otb::SarBrightnessFunction< TInputImage, TCoordRep >::SarBrightnessFunction().

m_EnableNoise

template<class TInputImage , class TCoordRep = float>

bool otb::SarBrightnessFunction< TInputImage, TCoordRep >::m_EnableNoise

private

Evaluate the function at non-integer positions

Definition at line 158 of file otbSarBrightnessFunction.h.

Referenced by otb::SarBrightnessFunction< TInputImage, TCoordRep >::SarBrightnessFunction().

m_Noise

template<class TInputImage , class TCoordRep = float>

ParametricFunctionPointer otb::SarBrightnessFunction< TInputImage, TCoordRep >::m_Noise

private

Evaluate the function at non-integer positions

Definition at line 157 of file otbSarBrightnessFunction.h.

Referenced by otb::SarBrightnessFunction< TInputImage, TCoordRep >::SarBrightnessFunction().

m_RangeSpreadLoss

template<class TInputImage , class TCoordRep = float>

ParametricFunctionPointer otb::SarBrightnessFunction< TInputImage, TCoordRep >::m_RangeSpreadLoss

private

Evaluate the function at non-integer positions

Definition at line 161 of file otbSarBrightnessFunction.h.

Referenced by otb::SarBrightnessFunction< TInputImage, TCoordRep >::SarBrightnessFunction().

m_Scale

template<class TInputImage , class TCoordRep = float>

FunctorRealType otb::SarBrightnessFunction< TInputImage, TCoordRep >::m_Scale

private

Evaluate the function at non-integer positions

Definition at line 156 of file otbSarBrightnessFunction.h.

---

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

• otbSarBrightnessFunction.h
• otbSarBrightnessFunction.hxx