OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
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< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef double RealType
 
typedef SarBrightnessFunction Self
 
typedef itk::ImageFunction
< TInputImage, typename
itk::NumericTraits< typename
TInputImage::PixelType >
::AbsType, TCoordRep > 
Superclass
 
- Public Types inherited from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::AbsType, TCoordRep >
typedef SmartPointer< const SelfConstPointer
 
typedef ContinuousIndex
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
ContinuousIndexType
 
typedef TCoordRep CoordRepType
 
typedef InputImageType::IndexType IndexType
 
typedef
InputImageType::IndexValueType 
IndexValueType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef itk::NumericTraits
< TInputImage::PixelType >
::AbsType 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Point< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
PointType
 
typedef ImageFunction Self
 
typedef FunctionBase< Point
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) >
, itk::NumericTraits
< TInputImage::PixelType >
::AbsType > 
Superclass
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, itk::NumericTraits< TInputImage::PixelType >::AbsType >
typedef SmartPointer< const SelfConstPointer
 
typedef Point< TCoordRep,
TInputImage::ImageDimension > 
InputType
 
typedef itk::NumericTraits
< TInputImage::PixelType >
::AbsType 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
OutputType EvaluateAtIndex (const IndexType &index) const override
 
virtual const char * GetNameOfClass () const
 
OutputType Evaluate (const PointType &point) const override
 
OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const 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)
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::AbsType, TCoordRep >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
virtual itk::NumericTraits
< TInputImage::PixelType >
::AbsType 
Evaluate (const PointType &point) const override=0
 
virtual itk::NumericTraits
< TInputImage::PixelType >
::AbsType 
EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
 
virtual itk::NumericTraits
< TInputImage::PixelType >
::AbsType 
EvaluateAtIndex (const IndexType &index) const =0
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
const InputImageTypeGetInputImage () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const IndexTypeGetStartIndex () const
 
virtual bool IsInsideBuffer (const PointType &point) const
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
- Public Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, itk::NumericTraits< TInputImage::PixelType >::AbsType >
virtual OutputType Evaluate (const InputType &input) const =0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::AbsType, TCoordRep >
static const unsigned int ImageDimension
 

Protected Member Functions

 ~SarBrightnessFunction () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::AbsType, TCoordRep >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFunction ()
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, itk::NumericTraits< TInputImage::PixelType >::AbsType >
 FunctionBase ()
 
 ~FunctionBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

void operator= (const Self &)=delete
 
 SarBrightnessFunction (const Self &)=delete
 

Private Attributes

ParametricFunctionPointer m_AntennaPatternNewGain
 
ParametricFunctionPointer m_AntennaPatternOldGain
 
bool m_EnableNoise
 
ParametricFunctionPointer m_Noise
 
ParametricFunctionPointer m_RangeSpreadLoss
 
FunctorRealType m_Scale
 
void SetInputImage (const InputImageType *ptr) override
 
 SarBrightnessFunction ()
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::AbsType, TCoordRep >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

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

Calculate the backscatter for the given pixel.

Calculate the brigthness 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

template<class TInputImage, class TCoordRep = float>
typedef itk::SmartPointer<const Self> otb::SarBrightnessFunction< TInputImage, TCoordRep >::ConstPointer

Definition at line 59 of file otbSarBrightnessFunction.h.

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

Definition at line 72 of file otbSarBrightnessFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef FunctorType::RealType otb::SarBrightnessFunction< TInputImage, TCoordRep >::FunctorRealType

Definition at line 81 of file otbSarBrightnessFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef otb::Functor::SarBrightnessFunctor<RealType, RealType> otb::SarBrightnessFunction< TInputImage, TCoordRep >::FunctorType

Definition at line 80 of file otbSarBrightnessFunction.h.

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

Definition at line 71 of file otbSarBrightnessFunction.h.

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

InputImageType typedef support.

Definition at line 65 of file otbSarBrightnessFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef InputImageType::PixelType otb::SarBrightnessFunction< TInputImage, TCoordRep >::InputPixelType

Definition at line 69 of file otbSarBrightnessFunction.h.

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

Definition at line 70 of file otbSarBrightnessFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef ParametricFunctionType::ConstPointer otb::SarBrightnessFunction< TInputImage, TCoordRep >::ParametricFunctionConstPointer

Definition at line 85 of file otbSarBrightnessFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef ParametricFunctionType::Pointer otb::SarBrightnessFunction< TInputImage, TCoordRep >::ParametricFunctionPointer

Definition at line 84 of file otbSarBrightnessFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef otb::SarParametricMapFunction<InputImageType> otb::SarBrightnessFunction< TInputImage, TCoordRep >::ParametricFunctionType

Definition at line 83 of file otbSarBrightnessFunction.h.

template<class TInputImage, class TCoordRep = float>
typedef itk::SmartPointer<Self> otb::SarBrightnessFunction< TInputImage, TCoordRep >::Pointer

Definition at line 58 of file otbSarBrightnessFunction.h.

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

Definition at line 73 of file otbSarBrightnessFunction.h.

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

Datatype used for the evaluation

Definition at line 79 of file otbSarBrightnessFunction.h.

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

Standard class typedefs.

Definition at line 55 of file otbSarBrightnessFunction.h.

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 57 of file otbSarBrightnessFunction.h.

Constructor & Destructor Documentation

template<class TInputImage , class TCoordRep >
otb::SarBrightnessFunction< TInputImage, TCoordRep >::SarBrightnessFunction ( )
protected

Constructor

Definition at line 36 of file otbSarBrightnessFunction.hxx.

template<class TInputImage, class TCoordRep = float>
otb::SarBrightnessFunction< TInputImage, TCoordRep >::~SarBrightnessFunction ( )
inlineoverrideprotected

Definition at line 150 of file otbSarBrightnessFunction.h.

template<class TInputImage, class TCoordRep = float>
otb::SarBrightnessFunction< TInputImage, TCoordRep >::SarBrightnessFunction ( const Self )
privatedelete

Member Function Documentation

template<class TInputImage, class TCoordRep = float>
virtual::itk::LightObject::Pointer otb::SarBrightnessFunction< TInputImage, TCoordRep >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

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 91 of file otbSarBrightnessFunction.h.

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 97 of file otbSarBrightnessFunction.h.

template<class TInputImage , class TCoordRep >
SarBrightnessFunction< TInputImage, TCoordRep >::OutputType otb::SarBrightnessFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType index) const
override
template<class TInputImage, class TCoordRep = float>
virtual const ParametricFunctionType* otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetAntennaPatternNewGain ( ) const
virtual

Get/Set the AntennaPatternNewGain value

template<class TInputImage, class TCoordRep = float>
virtual const ParametricFunctionType* otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetAntennaPatternOldGain ( ) const
virtual

Get/Set the AntennaPatternOldGain value

template<class TInputImage, class TCoordRep = float>
virtual bool otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetEnableNoise ( )
virtual

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

template<class TInputImage, class TCoordRep = float>
virtual const char* otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::AbsType, TCoordRep >.

template<class TInputImage, class TCoordRep = float>
virtual const ParametricFunctionType* otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetNoise ( ) const
virtual

Get/Set the Offset value

template<class TInputImage, class TCoordRep = float>
virtual const ParametricFunctionType* otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetRangeSpreadLoss ( ) const
virtual

Get/Set the RangeSpreadLoss value

template<class TInputImage, class TCoordRep = float>
virtual FunctorRealType otb::SarBrightnessFunction< TInputImage, TCoordRep >::GetScale ( )
virtual

Get/Set the Scale value

template<class TInputImage, class TCoordRep = float>
otb::SarBrightnessFunction< TInputImage, TCoordRep >::itkGetObjectMacro ( Noise  ,
ParametricFunctionType   
)

Get/Set the Offset value

template<class TInputImage, class TCoordRep = float>
otb::SarBrightnessFunction< TInputImage, TCoordRep >::itkGetObjectMacro ( AntennaPatternNewGain  ,
ParametricFunctionType   
)

Get/Set the AntennaPatternNewGain value

template<class TInputImage, class TCoordRep = float>
otb::SarBrightnessFunction< TInputImage, TCoordRep >::itkGetObjectMacro ( AntennaPatternOldGain  ,
ParametricFunctionType   
)

Get/Set the AntennaPatternOldGain value

template<class TInputImage, class TCoordRep = float>
otb::SarBrightnessFunction< TInputImage, TCoordRep >::itkGetObjectMacro ( RangeSpreadLoss  ,
ParametricFunctionType   
)

Get/Set the RangeSpreadLoss value

template<class TInputImage, class TCoordRep = float>
static Pointer otb::SarBrightnessFunction< TInputImage, TCoordRep >::New ( )
static

Method for creation through the object factory.

template<class TInputImage, class TCoordRep = float>
void otb::SarBrightnessFunction< TInputImage, TCoordRep >::operator= ( const Self )
privatedelete
template<class TInputImage , class TCoordRep >
void otb::SarBrightnessFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from itk::Object.

Definition at line 75 of file otbSarBrightnessFunction.hxx.

template<class TInputImage, class TCoordRep = float>
virtual void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetAntennaPatternNewGain ( ParametricFunctionType _arg)
virtual

Get/Set the AntennaPatternNewGain value

template<class TInputImage, class TCoordRep = float>
virtual void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetAntennaPatternOldGain ( ParametricFunctionType _arg)
virtual

Get/Set the AntennaPatternOldGain value

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

template<class TInputImage , class TCoordRep >
void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetInputImage ( const InputImageType ptr)
overridevirtual

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

Reimplemented from itk::ImageFunction< TInputImage, itk::NumericTraits< TInputImage::PixelType >::AbsType, TCoordRep >.

Definition at line 58 of file otbSarBrightnessFunction.hxx.

template<class TInputImage, class TCoordRep = float>
virtual void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetNoise ( ParametricFunctionType _arg)
virtual

Get/Set the Offset value

template<class TInputImage, class TCoordRep = float>
virtual void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetRangeSpreadLoss ( ParametricFunctionType _arg)
virtual

Get/Set the RangeSpreadLoss value

template<class TInputImage, class TCoordRep = float>
virtual void otb::SarBrightnessFunction< TInputImage, TCoordRep >::SetScale ( FunctorRealType  _arg)
virtual

Get/Set the Scale value

Member Data Documentation

template<class TInputImage, class TCoordRep = float>
const unsigned int otb::SarBrightnessFunction< TInputImage, TCoordRep >::ImageDimension = InputImageType::ImageDimension
static

Definition at line 75 of file otbSarBrightnessFunction.h.

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

Definition at line 160 of file otbSarBrightnessFunction.h.

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

Definition at line 161 of file otbSarBrightnessFunction.h.

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

Definition at line 159 of file otbSarBrightnessFunction.h.

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

Definition at line 158 of file otbSarBrightnessFunction.h.

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

Definition at line 162 of file otbSarBrightnessFunction.h.

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

Definition at line 157 of file otbSarBrightnessFunction.h.


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