OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::HuPathFunction< TInputPath, TOutput, TPrecision > Class Template Reference

#include <otbHuPathFunction.h>

+ Inheritance diagram for otb::HuPathFunction< TInputPath, TOutput, TPrecision >:
+ Collaboration diagram for otb::HuPathFunction< TInputPath, TOutput, TPrecision >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::PathConstPointer PathConstPointer
 
typedef Superclass::PathType PathType
 
typedef itk::SmartPointer< SelfPointer
 
typedef Superclass::PrecisionType PrecisionType
 
typedef Superclass::RealType RealType
 
typedef HuPathFunction Self
 
typedef RealMomentPathFunction< TInputPath, TOutput, TPrecision > Superclass
 
typedef VertexListType::ConstPointer VertexListPointer
 
typedef itk::VectorContainer< unsigned, VertexTypeVertexListType
 
typedef PathType::ContinuousIndexType VertexType
 
- Public Types inherited from otb::RealMomentPathFunction< TInputPath, double, double >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::PathConstPointer PathConstPointer
 
typedef Superclass::PathType PathType
 
typedef itk::SmartPointer< SelfPointer
 
typedef Superclass::PrecisionType PrecisionType
 
typedef Superclass::OutputType RealType
 
typedef RealMomentPathFunction Self
 
typedef GeometricMomentPathFunction< TInputPath, double, double > Superclass
 
typedef VertexListType::ConstPointer VertexListPointer
 
typedef itk::VectorContainer< unsigned, VertexTypeVertexListType
 
typedef PathType::ContinuousIndexType VertexType
 
- Public Types inherited from otb::GeometricMomentPathFunction< TInputPath, double, double >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::OutputType OutputType
 
typedef Superclass::InputPathConstPointer PathConstPointer
 
typedef Superclass::InputPathType PathType
 
typedef itk::SmartPointer< SelfPointer
 
typedef double PrecisionType
 
typedef GeometricMomentPathFunction Self
 
typedef PathFunction< TInputPath, double > Superclass
 
- Public Types inherited from otb::PathFunction< TInputPath, double >
typedef itk::SmartPointer< const SelfConstPointer
 
typedef InputPathType::ConstPointer InputPathConstPointer
 
typedef Superclass::InputType InputPathType
 
typedef Superclass::OutputType OutputType
 
typedef itk::SmartPointer< SelfPointer
 
typedef PathFunction Self
 
typedef itk::FunctionBase< TInputPath, double > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
RealType Evaluate (const PathType &path) const override
 
virtual RealType Evaluate () const
 
- Public Member Functions inherited from otb::RealMomentPathFunction< TInputPath, double, double >
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from otb::PathFunction< TInputPath, double >
const InputPathTypeGetInputPath () const
 
virtual void SetInputPath (const InputPathType *ptr)
 

Static Public Member Functions

static Pointer New ()
 
short m_MomentNumber
 
virtual void SetMomentNumber (short _arg)
 
virtual const short & GetMomentNumber () const
 
 HuPathFunction ()
 
 ~HuPathFunction () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 HuPathFunction (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from otb::RealMomentPathFunction< TInputPath, double, double >
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 RealMomentPathFunction ()
 
 ~RealMomentPathFunction () override
 
- Protected Member Functions inherited from otb::GeometricMomentPathFunction< TInputPath, double, double >
 GeometricMomentPathFunction ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~GeometricMomentPathFunction () override
 
- Protected Member Functions inherited from otb::PathFunction< TInputPath, double >
 PathFunction ()
 
 ~PathFunction () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Attributes inherited from otb::PathFunction< TInputPath, double >
InputPathConstPointer m_Path
 

Detailed Description

template<class TInputPath, class TOutput = double, class TPrecision = double>
class otb::HuPathFunction< TInputPath, TOutput, TPrecision >

Calculate the Hu's invariant parameter.

Calculate the Hu's invariant defined as:

With :

\[ c_{p, q}=\int \int (x+iy)^{p} \cdot (x-iy)^{q} \cdot f(x, y) \cdot dx \cdot dy \]

And:

This class is templated over the input image type and the path type (e.g. PolyLineParametricPath<2> ).

Definition at line 62 of file otbHuPathFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputPath , class TOutput = double, class TPrecision = double>
typedef itk::SmartPointer<const Self> otb::HuPathFunction< TInputPath, TOutput, TPrecision >::ConstPointer

Definition at line 69 of file otbHuPathFunction.h.

◆ PathConstPointer

template<class TInputPath , class TOutput = double, class TPrecision = double>
typedef Superclass::PathConstPointer otb::HuPathFunction< TInputPath, TOutput, TPrecision >::PathConstPointer

Definition at line 79 of file otbHuPathFunction.h.

◆ PathType

template<class TInputPath , class TOutput = double, class TPrecision = double>
typedef Superclass::PathType otb::HuPathFunction< TInputPath, TOutput, TPrecision >::PathType

InputPathType typedef support.

Definition at line 75 of file otbHuPathFunction.h.

◆ Pointer

template<class TInputPath , class TOutput = double, class TPrecision = double>
typedef itk::SmartPointer<Self> otb::HuPathFunction< TInputPath, TOutput, TPrecision >::Pointer

Definition at line 68 of file otbHuPathFunction.h.

◆ PrecisionType

template<class TInputPath , class TOutput = double, class TPrecision = double>
typedef Superclass::PrecisionType otb::HuPathFunction< TInputPath, TOutput, TPrecision >::PrecisionType

Type for calculation precision

Definition at line 88 of file otbHuPathFunction.h.

◆ RealType

template<class TInputPath , class TOutput = double, class TPrecision = double>
typedef Superclass::RealType otb::HuPathFunction< TInputPath, TOutput, TPrecision >::RealType

OutputType typedef support.

Definition at line 85 of file otbHuPathFunction.h.

◆ Self

template<class TInputPath , class TOutput = double, class TPrecision = double>
typedef HuPathFunction otb::HuPathFunction< TInputPath, TOutput, TPrecision >::Self

Standard class typedefs.

Definition at line 66 of file otbHuPathFunction.h.

◆ Superclass

template<class TInputPath , class TOutput = double, class TPrecision = double>
typedef RealMomentPathFunction<TInputPath, TOutput, TPrecision> otb::HuPathFunction< TInputPath, TOutput, TPrecision >::Superclass

Definition at line 67 of file otbHuPathFunction.h.

◆ VertexListPointer

template<class TInputPath , class TOutput = double, class TPrecision = double>
typedef VertexListType::ConstPointer otb::HuPathFunction< TInputPath, TOutput, TPrecision >::VertexListPointer

Definition at line 82 of file otbHuPathFunction.h.

◆ VertexListType

template<class TInputPath , class TOutput = double, class TPrecision = double>
typedef itk::VectorContainer<unsigned, VertexType> otb::HuPathFunction< TInputPath, TOutput, TPrecision >::VertexListType

Definition at line 81 of file otbHuPathFunction.h.

◆ VertexType

template<class TInputPath , class TOutput = double, class TPrecision = double>
typedef PathType::ContinuousIndexType otb::HuPathFunction< TInputPath, TOutput, TPrecision >::VertexType

Definition at line 80 of file otbHuPathFunction.h.

Constructor & Destructor Documentation

◆ HuPathFunction() [1/2]

template<class TInputPath , class TOutput , class TPrecision >
otb::HuPathFunction< TInputPath, TOutput, TPrecision >::HuPathFunction
protected

Constructor

Definition at line 37 of file otbHuPathFunction.hxx.

◆ ~HuPathFunction()

template<class TInputPath , class TOutput = double, class TPrecision = double>
otb::HuPathFunction< TInputPath, TOutput, TPrecision >::~HuPathFunction ( )
inlineoverrideprotected

Get/Set the radius of the neighborhood over which the statistics are evaluated

Definition at line 102 of file otbHuPathFunction.h.

◆ HuPathFunction() [2/2]

template<class TInputPath , class TOutput = double, class TPrecision = double>
otb::HuPathFunction< TInputPath, TOutput, TPrecision >::HuPathFunction ( const Self )
privatedelete

Get/Set the radius of the neighborhood over which the statistics are evaluated

Member Function Documentation

◆ CreateAnother()

template<class TInputPath , class TOutput = double, class TPrecision = double>
virtual::itk::LightObject::Pointer otb::HuPathFunction< TInputPath, TOutput, TPrecision >::CreateAnother ( void  ) const

◆ Evaluate() [1/2]

template<class TInputPath , class TOutput , class TPrecision >
HuPathFunction< TInputPath, TOutput, TPrecision >::RealType otb::HuPathFunction< TInputPath, TOutput, TPrecision >::Evaluate
virtual

Evaluate the function at non-integer positions

Definition at line 171 of file otbHuPathFunction.hxx.

References otbMsgDevMacro.

◆ Evaluate() [2/2]

template<class TInputPath , class TOutput , class TPrecision >
HuPathFunction< TInputPath, TOutput, TPrecision >::RealType otb::HuPathFunction< TInputPath, TOutput, TPrecision >::Evaluate ( const PathType path) const
override

Evaluate the function at non-integer positions

Definition at line 55 of file otbHuPathFunction.hxx.

◆ GetMomentNumber()

template<class TInputPath , class TOutput = double, class TPrecision = double>
virtual const short& otb::HuPathFunction< TInputPath, TOutput, TPrecision >::GetMomentNumber ( ) const
virtual

Get/Set the radius of the neighborhood over which the statistics are evaluated

◆ GetNameOfClass()

template<class TInputPath , class TOutput = double, class TPrecision = double>
virtual const char* otb::HuPathFunction< TInputPath, TOutput, TPrecision >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ New()

template<class TInputPath , class TOutput = double, class TPrecision = double>
static Pointer otb::HuPathFunction< TInputPath, TOutput, TPrecision >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputPath , class TOutput = double, class TPrecision = double>
void otb::HuPathFunction< TInputPath, TOutput, TPrecision >::operator= ( const Self )
privatedelete

Get/Set the radius of the neighborhood over which the statistics are evaluated

◆ PrintSelf()

template<class TInputPath , class TOutput , class TPrecision >
void otb::HuPathFunction< TInputPath, TOutput, TPrecision >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Get/Set the radius of the neighborhood over which the statistics are evaluated

Definition at line 46 of file otbHuPathFunction.hxx.

◆ SetMomentNumber()

template<class TInputPath , class TOutput = double, class TPrecision = double>
virtual void otb::HuPathFunction< TInputPath, TOutput, TPrecision >::SetMomentNumber ( short  _arg)
virtual

Get/Set the radius of the neighborhood over which the statistics are evaluated

Member Data Documentation

◆ m_MomentNumber

template<class TInputPath , class TOutput = double, class TPrecision = double>
short otb::HuPathFunction< TInputPath, TOutput, TPrecision >::m_MomentNumber
private

Get/Set the radius of the neighborhood over which the statistics are evaluated

Definition at line 111 of file otbHuPathFunction.h.


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