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

#include <otbCompacityPathFunction.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef TOutput OutputType
 
typedef Superclass::InputPathConstPointer PathConstPointer
 
typedef Superclass::InputPathType PathType
 
typedef itk::SmartPointer< SelfPointer
 
typedef double RealType
 
typedef CompacityPathFunction Self
 
typedef PathFunction< TInputPath, TOutput > Superclass
 
typedef VertexListType::ConstPointer VertexListPointer
 
typedef itk::VectorContainer< unsigned, VertexTypeVertexListType
 
typedef PathType::ContinuousIndexType VertexType
 
- 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
 
- Public Member Functions inherited from otb::PathFunction< TInputPath, double >
const InputPathTypeGetInputPath () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetInputPath (const InputPathType *ptr)
 

Static Public Member Functions

static Pointer New ()
 
OutputType Evaluate (const PathType &path) const override
 
virtual OutputType Evaluate () const
 
 CompacityPathFunction ()
 
 ~CompacityPathFunction () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 CompacityPathFunction (const Self &)=delete
 
void operator= (const Self &)=delete
 

Additional Inherited Members

- 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 otb::CompacityPathFunction< TInputPath, TOutput >

Calculate the compacity of a path. The formula of the compacity is :

\[ compacity = 4 \pi Surface / Perimeter^{2} \]

The path must contain at least 3 points. The result value is comprise between 0.0 and 1.0

Definition at line 45 of file otbCompacityPathFunction.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 52 of file otbCompacityPathFunction.h.

◆ OutputType

template<class TInputPath , class TOutput = double>
typedef TOutput otb::CompacityPathFunction< TInputPath, TOutput >::OutputType

Definition at line 66 of file otbCompacityPathFunction.h.

◆ PathConstPointer

template<class TInputPath , class TOutput = double>
typedef Superclass::InputPathConstPointer otb::CompacityPathFunction< TInputPath, TOutput >::PathConstPointer

Definition at line 62 of file otbCompacityPathFunction.h.

◆ PathType

template<class TInputPath , class TOutput = double>
typedef Superclass::InputPathType otb::CompacityPathFunction< TInputPath, TOutput >::PathType

InputPathType typedef support.

Definition at line 58 of file otbCompacityPathFunction.h.

◆ Pointer

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

Definition at line 51 of file otbCompacityPathFunction.h.

◆ RealType

template<class TInputPath , class TOutput = double>
typedef double otb::CompacityPathFunction< TInputPath, TOutput >::RealType

Definition at line 68 of file otbCompacityPathFunction.h.

◆ Self

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

Standard class typedefs.

Definition at line 49 of file otbCompacityPathFunction.h.

◆ Superclass

template<class TInputPath , class TOutput = double>
typedef PathFunction<TInputPath, TOutput> otb::CompacityPathFunction< TInputPath, TOutput >::Superclass

Definition at line 50 of file otbCompacityPathFunction.h.

◆ VertexListPointer

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

Definition at line 65 of file otbCompacityPathFunction.h.

◆ VertexListType

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

Definition at line 64 of file otbCompacityPathFunction.h.

◆ VertexType

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

Definition at line 63 of file otbCompacityPathFunction.h.

Constructor & Destructor Documentation

◆ CompacityPathFunction() [1/2]

template<class TInputPath , class TOutput = double>
otb::CompacityPathFunction< TInputPath, TOutput >::CompacityPathFunction ( )
inlineprotected

Evaluate the function at non-integer positions

Definition at line 76 of file otbCompacityPathFunction.h.

◆ ~CompacityPathFunction()

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

Evaluate the function at non-integer positions

Definition at line 77 of file otbCompacityPathFunction.h.

◆ CompacityPathFunction() [2/2]

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

Evaluate the function at non-integer positions

Member Function Documentation

◆ CreateAnother()

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

◆ Evaluate() [1/2]

template<class TInputPath , class TOutput >
CompacityPathFunction< TInputPath, TOutput >::OutputType otb::CompacityPathFunction< TInputPath, TOutput >::Evaluate
virtual

Evaluate the function at non-integer positions

Definition at line 97 of file otbCompacityPathFunction.hxx.

References otbMsgDevMacro.

◆ Evaluate() [2/2]

template<class TInputPath , class TOutput >
CompacityPathFunction< TInputPath, TOutput >::OutputType otb::CompacityPathFunction< TInputPath, TOutput >::Evaluate ( const PathType path) const
override

Evaluate the function at non-integer positions

Definition at line 39 of file otbCompacityPathFunction.hxx.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

Evaluate the function at non-integer positions

◆ PrintSelf()

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

Evaluate the function at non-integer positions

Definition at line 33 of file otbCompacityPathFunction.hxx.


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