OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::MetaImageFunction< TOutputPrecision, TCoordRep > Class Template Reference

#include <otbMetaImageFunction.h>

+ Inheritance diagram for otb::MetaImageFunction< TOutputPrecision, TCoordRep >:
+ Collaboration diagram for otb::MetaImageFunction< TOutputPrecision, TCoordRep >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef TCoordRep CoordRepType
 
typedef std::vector< FunctionPointerTypeFunctionContainerType
 
typedef FunctionType::Pointer FunctionPointerType
 
typedef Superclass FunctionType
 
typedef itk::VariableLengthVector< ValueTypeOutputType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::Point< CoordRepType, 2 > PointType
 
typedef MetaImageFunction Self
 
typedef itk::FunctionBase< itk::Point< TCoordRep, 2 >, itk::VariableLengthVector< TOutputPrecision > > Superclass
 
typedef TOutputPrecision ValueType
 

Public Member Functions

void AddFunction (FunctionType *function)
 
void ClearFunctions ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
OutputType Evaluate (const PointType &point) const override
 
virtual const char * GetNameOfClass () const
 
FunctionTypeGetNthFunction (unsigned int index)
 
unsigned int GetNumberOfFunctions () const
 
void RemoveNthFunction (unsigned int index)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 MetaImageFunction ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ~MetaImageFunction () override
 

Private Member Functions

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

Private Attributes

FunctionContainerType m_FunctionContainer
 

Detailed Description

template<class TOutputPrecision = double, class TCoordRep = double>
class otb::MetaImageFunction< TOutputPrecision, TCoordRep >

Concatenate results from multiple ImageFunction.

The MetaImageFunction class allows calling multiple ImageFunction at the same location and to concatenate their result into a single VariableLengthVector.

In the case of ImageFunction which do not produce VariableLengthVector, one can wrap these function using the ImageFunctionAdaptor class, which will translate the image function output to a VariableLengthVector.

Definition at line 48 of file otbMetaImageFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<class TOutputPrecision = double, class TCoordRep = double>
typedef itk::SmartPointer<const Self> otb::MetaImageFunction< TOutputPrecision, TCoordRep >::ConstPointer

Definition at line 55 of file otbMetaImageFunction.h.

◆ CoordRepType

template<class TOutputPrecision = double, class TCoordRep = double>
typedef TCoordRep otb::MetaImageFunction< TOutputPrecision, TCoordRep >::CoordRepType

Definition at line 61 of file otbMetaImageFunction.h.

◆ FunctionContainerType

template<class TOutputPrecision = double, class TCoordRep = double>
typedef std::vector<FunctionPointerType> otb::MetaImageFunction< TOutputPrecision, TCoordRep >::FunctionContainerType

Definition at line 72 of file otbMetaImageFunction.h.

◆ FunctionPointerType

template<class TOutputPrecision = double, class TCoordRep = double>
typedef FunctionType::Pointer otb::MetaImageFunction< TOutputPrecision, TCoordRep >::FunctionPointerType

Definition at line 71 of file otbMetaImageFunction.h.

◆ FunctionType

template<class TOutputPrecision = double, class TCoordRep = double>
typedef Superclass otb::MetaImageFunction< TOutputPrecision, TCoordRep >::FunctionType

Definition at line 70 of file otbMetaImageFunction.h.

◆ OutputType

template<class TOutputPrecision = double, class TCoordRep = double>
typedef itk::VariableLengthVector<ValueType> otb::MetaImageFunction< TOutputPrecision, TCoordRep >::OutputType

Definition at line 67 of file otbMetaImageFunction.h.

◆ Pointer

template<class TOutputPrecision = double, class TCoordRep = double>
typedef itk::SmartPointer<Self> otb::MetaImageFunction< TOutputPrecision, TCoordRep >::Pointer

Definition at line 54 of file otbMetaImageFunction.h.

◆ PointType

template<class TOutputPrecision = double, class TCoordRep = double>
typedef itk::Point<CoordRepType, 2> otb::MetaImageFunction< TOutputPrecision, TCoordRep >::PointType

Definition at line 65 of file otbMetaImageFunction.h.

◆ Self

template<class TOutputPrecision = double, class TCoordRep = double>
typedef MetaImageFunction otb::MetaImageFunction< TOutputPrecision, TCoordRep >::Self

Definition at line 52 of file otbMetaImageFunction.h.

◆ Superclass

template<class TOutputPrecision = double, class TCoordRep = double>
typedef itk::FunctionBase<itk::Point<TCoordRep, 2>, itk::VariableLengthVector<TOutputPrecision> > otb::MetaImageFunction< TOutputPrecision, TCoordRep >::Superclass

Definition at line 53 of file otbMetaImageFunction.h.

◆ ValueType

template<class TOutputPrecision = double, class TCoordRep = double>
typedef TOutputPrecision otb::MetaImageFunction< TOutputPrecision, TCoordRep >::ValueType

Definition at line 66 of file otbMetaImageFunction.h.

Constructor & Destructor Documentation

◆ MetaImageFunction() [1/2]

template<class TOutputPrecision , class TCoordRep >
otb::MetaImageFunction< TOutputPrecision, TCoordRep >::MetaImageFunction
protected

Constructor

Definition at line 32 of file otbMetaImageFunction.hxx.

◆ ~MetaImageFunction()

template<class TOutputPrecision , class TCoordRep >
otb::MetaImageFunction< TOutputPrecision, TCoordRep >::~MetaImageFunction
overrideprotected

Destructor

Definition at line 37 of file otbMetaImageFunction.hxx.

◆ MetaImageFunction() [2/2]

template<class TOutputPrecision = double, class TCoordRep = double>
otb::MetaImageFunction< TOutputPrecision, TCoordRep >::MetaImageFunction ( const Self )
privatedelete

Member Function Documentation

◆ AddFunction()

template<class TOutputPrecision , class TCoordRep >
void otb::MetaImageFunction< TOutputPrecision, TCoordRep >::AddFunction ( FunctionType function)

Add a new function to the functions vector

Definition at line 43 of file otbMetaImageFunction.hxx.

◆ ClearFunctions()

template<class TOutputPrecision , class TCoordRep >
void otb::MetaImageFunction< TOutputPrecision, TCoordRep >::ClearFunctions

Add a new function the functions vector (compatibility via adapters) Clear functions vector

Definition at line 49 of file otbMetaImageFunction.hxx.

◆ CreateAnother()

template<class TOutputPrecision = double, class TCoordRep = double>
virtual::itk::LightObject::Pointer otb::MetaImageFunction< TOutputPrecision, TCoordRep >::CreateAnother ( void  ) const

◆ Evaluate()

template<class TOutputPrecision , class TCoordRep >
MetaImageFunction< TOutputPrecision, TCoordRep >::OutputType otb::MetaImageFunction< TOutputPrecision, TCoordRep >::Evaluate ( const PointType point) const
override

Evaluate the function at the given location

Definition at line 74 of file otbMetaImageFunction.hxx.

◆ GetNameOfClass()

template<class TOutputPrecision = double, class TCoordRep = double>
virtual const char* otb::MetaImageFunction< TOutputPrecision, TCoordRep >::GetNameOfClass ( ) const
virtual

◆ GetNthFunction()

template<class TOutputPrecision , class TCoordRep >
MetaImageFunction< TOutputPrecision, TCoordRep >::FunctionType * otb::MetaImageFunction< TOutputPrecision, TCoordRep >::GetNthFunction ( unsigned int  index)

Retrieve the nth function

Definition at line 61 of file otbMetaImageFunction.hxx.

◆ GetNumberOfFunctions()

template<class TOutputPrecision , class TCoordRep >
unsigned int otb::MetaImageFunction< TOutputPrecision, TCoordRep >::GetNumberOfFunctions

Get the number of function registered

Definition at line 55 of file otbMetaImageFunction.hxx.

◆ New()

template<class TOutputPrecision = double, class TCoordRep = double>
static Pointer otb::MetaImageFunction< TOutputPrecision, TCoordRep >::New ( )
static

◆ operator=()

template<class TOutputPrecision = double, class TCoordRep = double>
void otb::MetaImageFunction< TOutputPrecision, TCoordRep >::operator= ( const Self )
privatedelete

◆ PrintSelf()

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

PrintSelf method

Definition at line 110 of file otbMetaImageFunction.hxx.

◆ RemoveNthFunction()

template<class TOutputPrecision , class TCoordRep >
void otb::MetaImageFunction< TOutputPrecision, TCoordRep >::RemoveNthFunction ( unsigned int  index)

Remove the nth function

Definition at line 67 of file otbMetaImageFunction.hxx.

Member Data Documentation

◆ m_FunctionContainer

template<class TOutputPrecision = double, class TCoordRep = double>
FunctionContainerType otb::MetaImageFunction< TOutputPrecision, TCoordRep >::m_FunctionContainer
private

Definition at line 109 of file otbMetaImageFunction.h.


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