OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
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< SelfPointer
 
typedef PathFunction Self
 
typedef itk::FunctionBase
< TInputPath, TOutput > 
Superclass
 
- Public Types inherited from itk::FunctionBase< TInputPath, TOutput >
typedef SmartPointer< const SelfConstPointer
 
typedef TInputPath InputType
 
typedef TOutput OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

const InputPathTypeGetInputPath () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetInputPath (const InputPathType *ptr)
 
- Public Member Functions inherited from itk::FunctionBase< TInputPath, TOutput >
virtual OutputType Evaluate (const InputType &input) const =0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 PathFunction ()
 
 ~PathFunction () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from itk::FunctionBase< TInputPath, TOutput >
 FunctionBase ()
 
 ~FunctionBase ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

InputPathConstPointer m_Path
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

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 49 of file otbPathFunction.h.

Member Typedef Documentation

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

Definition at line 58 of file otbPathFunction.h.

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

InputPathPointer typedef support

Definition at line 67 of file otbPathFunction.h.

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

InputPathType typedef support.

Definition at line 61 of file otbPathFunction.h.

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

OutputType typedef support.

Definition at line 70 of file otbPathFunction.h.

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

Definition at line 57 of file otbPathFunction.h.

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

Standard class typedefs.

Definition at line 55 of file otbPathFunction.h.

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

Definition at line 56 of file otbPathFunction.h.

Constructor & Destructor Documentation

template<class TInputPath , class TOutput >
otb::PathFunction< TInputPath, TOutput >::PathFunction ( )
protected

Constructor

Definition at line 34 of file otbPathFunction.hxx.

template<class TInputPath , class TOutput >
otb::PathFunction< TInputPath, TOutput >::~PathFunction ( )
inlineoverrideprotected

Definition at line 83 of file otbPathFunction.h.

template<class TInputPath , class TOutput >
otb::PathFunction< TInputPath, TOutput >::PathFunction ( const Self )
privatedelete

Member Function Documentation

template<class TInputPath , class TOutput >
const InputPathType* otb::PathFunction< TInputPath, TOutput >::GetInputPath ( void  ) const
inline

Get the input path.

Definition at line 76 of file otbPathFunction.h.

template<class TInputPath , class TOutput >
virtual const char* otb::PathFunction< TInputPath, TOutput >::GetNameOfClass ( ) const
virtual
template<class TInputPath , class TOutput >
void otb::PathFunction< TInputPath, TOutput >::operator= ( const Self )
privatedelete
template<class TInputPath , class TOutput >
void otb::PathFunction< TInputPath, TOutput >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual
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 58 of file otbPathFunction.hxx.

Member Data Documentation

template<class TInputPath , class TOutput >
InputPathConstPointer otb::PathFunction< TInputPath, TOutput >::m_Path
protected

Definition at line 86 of file otbPathFunction.h.


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