OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction > Class Template Reference
Data Processing Objects » Filters » Image FiltersGroup Core » | Module OTBCommon

#include <otbFunctionToImageFilter.h>

+ Inheritance diagram for otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >:
+ Collaboration diagram for otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >:

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef FunctionType::Pointer FunctionPointer
 
typedef FunctionType::InputType FunctionPositionType
 
typedef TFunction FunctionType
 
typedef FunctionType::OutputType FunctionValueType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::ConstPointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef FunctionToImageFilter Self
 
typedef itk::InPlaceImageFilter< TInputImage, TOutputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
FunctionPointer m_PixelFunction
 
void SetFunction (FunctionType *PixelFunction)
 
FunctionType * GetFunction ()
 
FunctionType const * GetFunction () const
 
 FunctionToImageFilter ()
 
 ~FunctionToImageFilter () override
 
void BeforeThreadedGenerateData () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 FunctionToImageFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

template<class TInputImage, class TOutputImage, class TFunction>
class otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >

Evaluates a ImageFunction onto a source image.

The class walks an input image and evaluates the function at every pixel location. The output of the spatial function and the pixel type of the output image must be compatible.

Like its parent ImageToImageFilter, this class functions in the filtering pipeline and produces a unique output image.

The function has to inherit from itkImageFunction

See also
SpatialFunctionImageEvaluatorFilter
SpatialFunctionImageFilter
ImageFunction

Definition at line 55 of file otbFunctionToImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage , class TFunction >
typedef itk::SmartPointer<const Self> otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::ConstPointer

Definition at line 62 of file otbFunctionToImageFilter.h.

◆ FunctionPointer

template<class TInputImage , class TOutputImage , class TFunction >
typedef FunctionType::Pointer otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::FunctionPointer

Definition at line 84 of file otbFunctionToImageFilter.h.

◆ FunctionPositionType

template<class TInputImage , class TOutputImage , class TFunction >
typedef FunctionType::InputType otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::FunctionPositionType

Definition at line 86 of file otbFunctionToImageFilter.h.

◆ FunctionType

template<class TInputImage , class TOutputImage , class TFunction >
typedef TFunction otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::FunctionType

Type of function.

Definition at line 83 of file otbFunctionToImageFilter.h.

◆ FunctionValueType

template<class TInputImage , class TOutputImage , class TFunction >
typedef FunctionType::OutputType otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::FunctionValueType

Definition at line 85 of file otbFunctionToImageFilter.h.

◆ InputImagePixelType

template<class TInputImage , class TOutputImage , class TFunction >
typedef InputImageType::PixelType otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePixelType

Definition at line 76 of file otbFunctionToImageFilter.h.

◆ InputImagePointer

template<class TInputImage , class TOutputImage , class TFunction >
typedef InputImageType::ConstPointer otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePointer

Definition at line 74 of file otbFunctionToImageFilter.h.

◆ InputImageRegionType

template<class TInputImage , class TOutputImage , class TFunction >
typedef InputImageType::RegionType otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::InputImageRegionType

Definition at line 75 of file otbFunctionToImageFilter.h.

◆ InputImageType

template<class TInputImage , class TOutputImage , class TFunction >
typedef TInputImage otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::InputImageType

Some typedefs. Image size typedef.

Definition at line 68 of file otbFunctionToImageFilter.h.

◆ OutputImagePixelType

template<class TInputImage , class TOutputImage , class TFunction >
typedef OutputImageType::PixelType otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::OutputImagePixelType

Definition at line 80 of file otbFunctionToImageFilter.h.

◆ OutputImagePointer

template<class TInputImage , class TOutputImage , class TFunction >
typedef OutputImageType::Pointer otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::OutputImagePointer

Definition at line 78 of file otbFunctionToImageFilter.h.

◆ OutputImageRegionType

template<class TInputImage , class TOutputImage , class TFunction >
typedef OutputImageType::RegionType otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageRegionType

Definition at line 79 of file otbFunctionToImageFilter.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage , class TFunction >
typedef TOutputImage otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageType

Definition at line 77 of file otbFunctionToImageFilter.h.

◆ Pointer

template<class TInputImage , class TOutputImage , class TFunction >
typedef itk::SmartPointer<Self> otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::Pointer

Definition at line 61 of file otbFunctionToImageFilter.h.

◆ Self

template<class TInputImage , class TOutputImage , class TFunction >
typedef FunctionToImageFilter otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::Self

Standard class typedefs.

Definition at line 59 of file otbFunctionToImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage , class TFunction >
typedef itk::InPlaceImageFilter<TInputImage, TOutputImage> otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::Superclass

Definition at line 60 of file otbFunctionToImageFilter.h.

Constructor & Destructor Documentation

◆ FunctionToImageFilter() [1/2]

template<class TInputImage , class TOutputImage , class TFunction >
otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::FunctionToImageFilter
protected

Constructor

Definition at line 36 of file otbFunctionToImageFilter.hxx.

◆ ~FunctionToImageFilter()

template<class TInputImage , class TOutputImage , class TFunction >
otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::~FunctionToImageFilter ( )
inlineoverrideprotected

Image dimensions

Definition at line 112 of file otbFunctionToImageFilter.h.

◆ FunctionToImageFilter() [2/2]

template<class TInputImage , class TOutputImage , class TFunction >
otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::FunctionToImageFilter ( const Self &  )
privatedelete

Image dimensions

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TFunction >
void otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::BeforeThreadedGenerateData
overrideprotected

Validate the presence of all three inputs. If one or more inputs are missing, throw an exception.

Connect one of the operands for pixel-wise addition BeforeThreadedGenerateData function. Validate inputs

Definition at line 59 of file otbFunctionToImageFilter.hxx.

◆ CreateAnother()

template<class TInputImage , class TOutputImage , class TFunction >
virtual::itk::LightObject::Pointer otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::CreateAnother ( void  ) const

◆ GetFunction() [1/2]

template<class TInputImage , class TOutputImage , class TFunction >
FunctionType* otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::GetFunction ( )
inline

Image dimensions

Definition at line 94 of file otbFunctionToImageFilter.h.

◆ GetFunction() [2/2]

template<class TInputImage , class TOutputImage , class TFunction >
FunctionType const* otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::GetFunction ( ) const
inline

Image dimensions

Definition at line 98 of file otbFunctionToImageFilter.h.

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage , class TFunction >
virtual const char* otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

◆ New()

template<class TInputImage , class TOutputImage , class TFunction >
static Pointer otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::New ( )
static

Method for creation through the object factory.

◆ operator=()

template<class TInputImage , class TOutputImage , class TFunction >
void otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::operator= ( const Self &  )
privatedelete

Image dimensions

◆ SetFunction()

template<class TInputImage , class TOutputImage , class TFunction >
void otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::SetFunction ( FunctionType *  PixelFunction)
inline

Set the internal spatial function.

Definition at line 89 of file otbFunctionToImageFilter.h.

◆ ThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TFunction >
void otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
itk::ThreadIdType  threadId 
)
overrideprotected

SpatialFunctionImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

ThreadedGenerateData function. Performs the pixel-wise addition

Definition at line 75 of file otbFunctionToImageFilter.hxx.

Member Data Documentation

◆ InputImageDimension

template<class TInputImage , class TOutputImage , class TFunction >
const unsigned int otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::InputImageDimension = TInputImage::ImageDimension
static

Image dimensions

Definition at line 106 of file otbFunctionToImageFilter.h.

◆ m_PixelFunction

template<class TInputImage , class TOutputImage , class TFunction >
FunctionPointer otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::m_PixelFunction
private

The function that will be evaluated over the image

Definition at line 137 of file otbFunctionToImageFilter.h.

◆ OutputImageDimension

template<class TInputImage , class TOutputImage , class TFunction >
const unsigned int otb::FunctionToImageFilter< TInputImage, TOutputImage, TFunction >::OutputImageDimension = TOutputImage::ImageDimension
static

Image dimensions

Definition at line 107 of file otbFunctionToImageFilter.h.

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:24:58 for OTB with   doxygen 1.8.17