OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
otb::SarParametricMapFunction< TInputImage, TCoordRep > Class Template Reference
Data Processing Objects » Functions » Image FunctionsGroup SAR » | Module OTBSARCalibration

#include <otbSarParametricMapFunction.h>

+ Inheritance diagram for otb::SarParametricMapFunction< TInputImage, TCoordRep >:
+ Collaboration diagram for otb::SarParametricMapFunction< TInputImage, TCoordRep >:

Public Types

typedef std::array< int, 2 > ArrayIndexType
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef Superclass::ContinuousIndexType ContinuousIndexType
 
typedef Superclass::IndexType IndexType
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef itk::VariableSizeMatrix< double > MatrixType
 
typedef Superclass::OutputType OutputType
 
typedef PointSetType::PixelType PixelType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef PointSetType::ConstPointer PointSetConstPointer
 
typedef PointSetType::Pointer PointSetPointer
 
typedef itk::PointSet< OutputType, ImageDimension > PointSetType
 
typedef PointSetType::PointType PointType
 
typedef itk::NumericTraits< InputPixelType >::ScalarRealType RealType
 
typedef SarParametricMapFunction Self
 
typedef itk::ImageFunction< TInputImage, typename itk::NumericTraits< typename TInputImage::PixelType >::ScalarRealType, TCoordRep > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
RealType Evaluate (const PointType &point) const override
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = InputImageType::ImageDimension
 
PointSetPointer m_PointSet
 
MatrixType m_Coeff
 
bool m_IsInitialize
 
double m_ProductWidth
 
double m_ProductHeight
 
RealType EvaluateAtIndex (const IndexType &index) const override
 
RealType EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
 
 itkGetObjectMacro (PointSet, PointSetType)
 
virtual const PointSetType * GetPointSet () const
 
void SetPointSet (PointSetPointer val)
 
virtual void SetCoeff (MatrixType _arg)
 
virtual MatrixType GetCoeff ()
 
virtual MatrixType GetCoeff () const
 
virtual const bool & GetIsInitialize () const
 
void SetPolynomalSize (const IndexType PolynomalSize)
 
void SetPolynomalSize (const ArrayIndexType PolynomalSize)
 
void EvaluateParametricCoefficient ()
 
void SetConstantValue (const RealType &value)
 
 SarParametricMapFunction ()
 
 ~SarParametricMapFunction () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 SarParametricMapFunction (const Self &)=delete
 
void operator= (const Self &)=delete
 
double Horner (PointType point) const
 

Detailed Description

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

Evaluates a parametric bidimensionnal polynomial model from a PointSet.

Note
This is an internal class used by the Sar calibration framework.

Definition at line 43 of file otbSarParametricMapFunction.h.

Member Typedef Documentation

◆ ArrayIndexType

template<class TInputImage , class TCoordRep = float>
typedef std::array<int, 2> otb::SarParametricMapFunction< TInputImage, TCoordRep >::ArrayIndexType

Definition at line 64 of file otbSarParametricMapFunction.h.

◆ ConstPointer

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

Definition at line 51 of file otbSarParametricMapFunction.h.

◆ ContinuousIndexType

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

Definition at line 65 of file otbSarParametricMapFunction.h.

◆ IndexType

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

Definition at line 63 of file otbSarParametricMapFunction.h.

◆ InputImageType

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

InputImageType typedef support.

Definition at line 57 of file otbSarParametricMapFunction.h.

◆ InputPixelType

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

Definition at line 61 of file otbSarParametricMapFunction.h.

◆ MatrixType

template<class TInputImage , class TCoordRep = float>
typedef itk::VariableSizeMatrix<double> otb::SarParametricMapFunction< TInputImage, TCoordRep >::MatrixType

Definition at line 75 of file otbSarParametricMapFunction.h.

◆ OutputType

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

Definition at line 62 of file otbSarParametricMapFunction.h.

◆ PixelType

template<class TInputImage , class TCoordRep = float>
typedef PointSetType::PixelType otb::SarParametricMapFunction< TInputImage, TCoordRep >::PixelType

Definition at line 73 of file otbSarParametricMapFunction.h.

◆ Pointer

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

Definition at line 50 of file otbSarParametricMapFunction.h.

◆ PointSetConstPointer

template<class TInputImage , class TCoordRep = float>
typedef PointSetType::ConstPointer otb::SarParametricMapFunction< TInputImage, TCoordRep >::PointSetConstPointer

Definition at line 71 of file otbSarParametricMapFunction.h.

◆ PointSetPointer

template<class TInputImage , class TCoordRep = float>
typedef PointSetType::Pointer otb::SarParametricMapFunction< TInputImage, TCoordRep >::PointSetPointer

Definition at line 70 of file otbSarParametricMapFunction.h.

◆ PointSetType

template<class TInputImage , class TCoordRep = float>
typedef itk::PointSet<OutputType, ImageDimension> otb::SarParametricMapFunction< TInputImage, TCoordRep >::PointSetType

Definition at line 69 of file otbSarParametricMapFunction.h.

◆ PointType

template<class TInputImage , class TCoordRep = float>
typedef PointSetType::PointType otb::SarParametricMapFunction< TInputImage, TCoordRep >::PointType

Definition at line 72 of file otbSarParametricMapFunction.h.

◆ RealType

template<class TInputImage , class TCoordRep = float>
typedef itk::NumericTraits<InputPixelType>::ScalarRealType otb::SarParametricMapFunction< TInputImage, TCoordRep >::RealType

Datatype used for the evaluation

Definition at line 78 of file otbSarParametricMapFunction.h.

◆ Self

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

Standard class typedefs.

Definition at line 48 of file otbSarParametricMapFunction.h.

◆ Superclass

template<class TInputImage , class TCoordRep = float>
typedef itk::ImageFunction<TInputImage, typename itk::NumericTraits<typename TInputImage::PixelType>::ScalarRealType, TCoordRep> otb::SarParametricMapFunction< TInputImage, TCoordRep >::Superclass

Definition at line 49 of file otbSarParametricMapFunction.h.

Constructor & Destructor Documentation

◆ SarParametricMapFunction() [1/2]

template<class TInputImage , class TCoordRep >
otb::SarParametricMapFunction< TInputImage, TCoordRep >::SarParametricMapFunction
protected

Constructor

Definition at line 40 of file otbSarParametricMapFunction.hxx.

References otb::SarParametricMapFunction< TInputImage, TCoordRep >::m_Coeff.

◆ ~SarParametricMapFunction()

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

the width of the complete product (read from metadata)

Definition at line 133 of file otbSarParametricMapFunction.h.

◆ SarParametricMapFunction() [2/2]

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

the width of the complete product (read from metadata)

Member Function Documentation

◆ CreateAnother()

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

◆ Evaluate()

template<class TInputImage , class TCoordRep >
SarParametricMapFunction< TInputImage, TCoordRep >::RealType otb::SarParametricMapFunction< TInputImage, TCoordRep >::Evaluate ( const PointType &  point) const
override

Evaluate the function at specific positions

Definition at line 189 of file otbSarParametricMapFunction.hxx.

◆ EvaluateAtContinuousIndex()

template<class TInputImage , class TCoordRep = float>
RealType otb::SarParametricMapFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  cindex) const
inlineoverride

the width of the complete product (read from metadata)

Definition at line 93 of file otbSarParametricMapFunction.h.

◆ EvaluateAtIndex()

template<class TInputImage , class TCoordRep = float>
RealType otb::SarParametricMapFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType &  index) const
inlineoverride

Evalulate the function at specified index

Definition at line 84 of file otbSarParametricMapFunction.h.

◆ EvaluateParametricCoefficient()

template<class TInputImage , class TCoordRep >
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::EvaluateParametricCoefficient

Evaluate parametric coefficient from pointset

Definition at line 103 of file otbSarParametricMapFunction.hxx.

References otb::NumberOfColumns, and otb::NumberOfLines.

◆ GetCoeff() [1/2]

template<class TInputImage , class TCoordRep = float>
virtual MatrixType otb::SarParametricMapFunction< TInputImage, TCoordRep >::GetCoeff ( )
virtual

the width of the complete product (read from metadata)

◆ GetCoeff() [2/2]

template<class TInputImage , class TCoordRep = float>
virtual MatrixType otb::SarParametricMapFunction< TInputImage, TCoordRep >::GetCoeff ( ) const
virtual

the width of the complete product (read from metadata)

◆ GetIsInitialize()

template<class TInputImage , class TCoordRep = float>
virtual const bool& otb::SarParametricMapFunction< TInputImage, TCoordRep >::GetIsInitialize ( ) const
virtual

Get/Set the Coeff pointer

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ GetPointSet()

template<class TInputImage , class TCoordRep = float>
virtual const PointSetType* otb::SarParametricMapFunction< TInputImage, TCoordRep >::GetPointSet ( ) const
virtual

the width of the complete product (read from metadata)

◆ Horner()

template<class TInputImage , class TCoordRep >
double otb::SarParametricMapFunction< TInputImage, TCoordRep >::Horner ( PointType  point) const
private

the width of the complete product (read from metadata)

Definition at line 79 of file otbSarParametricMapFunction.hxx.

◆ itkGetObjectMacro()

template<class TInputImage , class TCoordRep = float>
otb::SarParametricMapFunction< TInputImage, TCoordRep >::itkGetObjectMacro ( PointSet  ,
PointSetType   
)

Get/Set the PointSet pointer

◆ New()

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

Method for creation through the object factory.

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

◆ operator=()

template<class TInputImage , class TCoordRep = float>
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::operator= ( const Self &  )
privatedelete

the width of the complete product (read from metadata)

◆ PrintSelf()

template<class TInputImage , class TCoordRep >
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

the width of the complete product (read from metadata)

Definition at line 213 of file otbSarParametricMapFunction.hxx.

◆ SetCoeff()

template<class TInputImage , class TCoordRep = float>
virtual void otb::SarParametricMapFunction< TInputImage, TCoordRep >::SetCoeff ( MatrixType  _arg)
virtual

Get/Set the Coeff pointer

◆ SetConstantValue()

template<class TInputImage , class TCoordRep >
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::SetConstantValue ( const RealType &  value)

Set constante value for evaluation

Definition at line 49 of file otbSarParametricMapFunction.hxx.

◆ SetPointSet()

template<class TInputImage , class TCoordRep = float>
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::SetPointSet ( PointSetPointer  val)
inline

the width of the complete product (read from metadata)

Definition at line 103 of file otbSarParametricMapFunction.h.

◆ SetPolynomalSize() [1/2]

template<class TInputImage , class TCoordRep >
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::SetPolynomalSize ( const ArrayIndexType  PolynomalSize)

the width of the complete product (read from metadata)

Definition at line 73 of file otbSarParametricMapFunction.hxx.

◆ SetPolynomalSize() [2/2]

template<class TInputImage , class TCoordRep >
void otb::SarParametricMapFunction< TInputImage, TCoordRep >::SetPolynomalSize ( const IndexType  PolynomalSize)

Get/Set the PolynomalSize pointer

Definition at line 65 of file otbSarParametricMapFunction.hxx.

Member Data Documentation

◆ ImageDimension

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

Definition at line 67 of file otbSarParametricMapFunction.h.

◆ m_Coeff

template<class TInputImage , class TCoordRep = float>
MatrixType otb::SarParametricMapFunction< TInputImage, TCoordRep >::m_Coeff
private

the width of the complete product (read from metadata)

Definition at line 145 of file otbSarParametricMapFunction.h.

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

◆ m_IsInitialize

template<class TInputImage , class TCoordRep = float>
bool otb::SarParametricMapFunction< TInputImage, TCoordRep >::m_IsInitialize
private

the width of the complete product (read from metadata)

Definition at line 146 of file otbSarParametricMapFunction.h.

◆ m_PointSet

template<class TInputImage , class TCoordRep = float>
PointSetPointer otb::SarParametricMapFunction< TInputImage, TCoordRep >::m_PointSet
private

the width of the complete product (read from metadata)

Definition at line 144 of file otbSarParametricMapFunction.h.

◆ m_ProductHeight

template<class TInputImage , class TCoordRep = float>
double otb::SarParametricMapFunction< TInputImage, TCoordRep >::m_ProductHeight
private

the width of the complete product (read from metadata)

Definition at line 148 of file otbSarParametricMapFunction.h.

◆ m_ProductWidth

template<class TInputImage , class TCoordRep = float>
double otb::SarParametricMapFunction< TInputImage, TCoordRep >::m_ProductWidth
private

the width of the complete product (read from metadata)

Definition at line 147 of file otbSarParametricMapFunction.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:25:26 for OTB with   doxygen 1.8.17