otb::PathFunction< TInputPath, TOutput > Class Template Reference

#include <otbPathFunction.h>

Inheritance diagram for otb::PathFunction< TInputPath, TOutput >:

Collaboration diagram for otb::PathFunction< TInputPath, TOutput >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef InputPathType::ConstPointer	InputPathConstPointer
typedef Superclass::InputType	InputPathType
typedef Superclass::OutputType	OutputType
typedef itk::SmartPointer< Self >	Pointer
typedef PathFunction	Self
typedef itk::FunctionBase< TInputPath, TOutput >	Superclass

Public Member Functions
const InputPathType *	GetInputPath () const
virtual const char *	GetNameOfClass () const

Protected Member Functions
	PathFunction ()
	~PathFunction () override

Protected Attributes
InputPathConstPointer	m_Path

Private Member Functions
void	operator= (const Self &)=delete
	PathFunction (const Self &)=delete
virtual void	SetInputPath (const InputPathType *ptr)
void	PrintSelf (std::ostream &os, itk::Indent indent) const override

Detailed Description

template<class TInputPath, class TOutput>
class otb::PathFunction< TInputPath, TOutput >

Evaluates a function of an image over a specific path.

PathFunction is a baseclass for all objects that evaluates a function of an image using a path list. This class is templated over the input image type, the path type and the function output and the coordinate representation type (e.g. float or double).

The input path is set via method SetInputPath().

See also

Path

Definition at line 48 of file otbPathFunction.h.

Member Typedef Documentation

ConstPointer

template<class TInputPath , class TOutput >

typedef itk::SmartPointer<const Self> otb::PathFunction< TInputPath, TOutput >::ConstPointer

Definition at line 55 of file otbPathFunction.h.

InputPathConstPointer

template<class TInputPath , class TOutput >

typedef InputPathType::ConstPointer otb::PathFunction< TInputPath, TOutput >::InputPathConstPointer

InputPathPointer typedef support

Definition at line 64 of file otbPathFunction.h.

InputPathType

template<class TInputPath , class TOutput >

typedef Superclass::InputType otb::PathFunction< TInputPath, TOutput >::InputPathType

InputPathType typedef support.

Definition at line 58 of file otbPathFunction.h.

OutputType

template<class TInputPath , class TOutput >

typedef Superclass::OutputType otb::PathFunction< TInputPath, TOutput >::OutputType

OutputType typedef support.

Definition at line 67 of file otbPathFunction.h.

Pointer

template<class TInputPath , class TOutput >

typedef itk::SmartPointer<Self> otb::PathFunction< TInputPath, TOutput >::Pointer

Definition at line 54 of file otbPathFunction.h.

Self

template<class TInputPath , class TOutput >

typedef PathFunction otb::PathFunction< TInputPath, TOutput >::Self

Standard class typedefs.

Definition at line 52 of file otbPathFunction.h.

Superclass

template<class TInputPath , class TOutput >

typedef itk::FunctionBase<TInputPath, TOutput> otb::PathFunction< TInputPath, TOutput >::Superclass

Definition at line 53 of file otbPathFunction.h.

Constructor & Destructor Documentation

PathFunction() [1/2]

template<class TInputPath , class TOutput >

otb::PathFunction< TInputPath, TOutput >::PathFunction

protected

Constructor

Definition at line 33 of file otbPathFunction.hxx.

~PathFunction()

template<class TInputPath , class TOutput >

otb::PathFunction< TInputPath, TOutput >::~PathFunction ( )

inlineoverrideprotected

Definition at line 80 of file otbPathFunction.h.

PathFunction() [2/2]

template<class TInputPath , class TOutput >

otb::PathFunction< TInputPath, TOutput >::PathFunction ( const Self &  )

privatedelete

Member Function Documentation

GetInputPath()

template<class TInputPath , class TOutput >

const InputPathType* otb::PathFunction< TInputPath, TOutput >::GetInputPath ( ) const

inline

Get the input path.

Definition at line 73 of file otbPathFunction.h.

GetNameOfClass()

template<class TInputPath , class TOutput >

virtual const char* otb::PathFunction< TInputPath, TOutput >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented in otb::RealMomentPathFunction< TInputPath, double, double >, otb::GeometricMomentPathFunction< TInputPath, TOutput, TPrecision >, otb::GeometricMomentPathFunction< TInputPath, double, double >, and otb::GeometricMomentPathFunction< TInputPath, std::complex< double >, double >.

operator=()

template<class TInputPath , class TOutput >

void otb::PathFunction< TInputPath, TOutput >::operator= ( const Self &  )

privatedelete

PrintSelf()

template<class TInputPath , class TOutput >

void otb::PathFunction< TInputPath, TOutput >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotected

Standard "PrintSelf" method

Definition at line 42 of file otbPathFunction.hxx.

SetInputPath()

template<class TInputPath , class TOutput >

void otb::PathFunction< TInputPath, TOutput >::SetInputPath ( const InputPathType *  ptr )

virtual

Set the input path.

Initialize by setting the input image

Definition at line 53 of file otbPathFunction.hxx.

Member Data Documentation

m_Path

template<class TInputPath , class TOutput >

InputPathConstPointer otb::PathFunction< TInputPath, TOutput >::m_Path

protected

Definition at line 85 of file otbPathFunction.h.

---

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

• otbPathFunction.h
• otbPathFunction.hxx