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

#include <otbFunctionWithNeighborhoodToImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef FunctionType::Pointer FunctionPointerType
 
typedef FunctionType::InputType FunctionPositionType
 
typedef TFunction FunctionType
 
typedef FunctionType::OutputType FunctionValueType
 
typedef InputImageType::ConstPointer InputImageConstPointer
 
typedef InputImageType::OffsetType InputImageOffsetType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::SizeType InputImageSizeType
 
typedef TInputImage InputImageType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef FunctionWithNeighborhoodToImageFilter 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
 
FunctionPointerType m_Function
 
std::vector< FunctionPointerType > m_FunctionList
 
InputImageSizeType m_Radius
 
InputImageOffsetType m_Offset
 
void SetFunction (FunctionPointerType function)
 
FunctionPointerType GetFunction ()
 
virtual InputImageSizeType GetRadius ()
 
void SetRadius (InputImageSizeType &rad)
 
virtual InputImageOffsetType GetOffset ()
 
void SetOffset (InputImageOffsetType &offset)
 
 FunctionWithNeighborhoodToImageFilter ()
 
 ~FunctionWithNeighborhoodToImageFilter () override
 
void BeforeThreadedGenerateData () override
 
void GenerateInputRequestedRegion () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 FunctionWithNeighborhoodToImageFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

template<class TInputImage, class TOutputImage, class TFunction>
class otb::FunctionWithNeighborhoodToImageFilter< 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 51 of file otbFunctionWithNeighborhoodToImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 58 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ FunctionPointerType

template<class TInputImage , class TOutputImage , class TFunction >
typedef FunctionType::Pointer otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::FunctionPointerType

Definition at line 83 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ FunctionPositionType

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

Definition at line 85 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ FunctionType

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

Type of function.

Definition at line 82 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ FunctionValueType

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

Definition at line 84 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ InputImageConstPointer

template<class TInputImage , class TOutputImage , class TFunction >
typedef InputImageType::ConstPointer otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::InputImageConstPointer

Definition at line 70 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ InputImageOffsetType

template<class TInputImage , class TOutputImage , class TFunction >
typedef InputImageType::OffsetType otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::InputImageOffsetType

Definition at line 75 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ InputImagePixelType

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

Definition at line 73 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ InputImagePointer

template<class TInputImage , class TOutputImage , class TFunction >
typedef InputImageType::Pointer otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::InputImagePointer

Definition at line 71 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ InputImageRegionType

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

Definition at line 72 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ InputImageSizeType

template<class TInputImage , class TOutputImage , class TFunction >
typedef InputImageType::SizeType otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::InputImageSizeType

Definition at line 74 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ InputImageType

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

Some typedefs. Image size typedef.

Definition at line 64 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ OutputImagePixelType

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

Definition at line 79 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ OutputImagePointer

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

Definition at line 77 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ OutputImageRegionType

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

Definition at line 78 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ OutputImageType

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

Definition at line 76 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ Pointer

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

Definition at line 57 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ Self

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

Standard class typedefs.

Definition at line 55 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ Superclass

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

Definition at line 56 of file otbFunctionWithNeighborhoodToImageFilter.h.

Constructor & Destructor Documentation

◆ FunctionWithNeighborhoodToImageFilter() [1/2]

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

Constructor

Definition at line 35 of file otbFunctionWithNeighborhoodToImageFilter.hxx.

◆ ~FunctionWithNeighborhoodToImageFilter()

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

Image dimensions

Definition at line 127 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ FunctionWithNeighborhoodToImageFilter() [2/2]

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

Image dimensions

Member Function Documentation

◆ BeforeThreadedGenerateData()

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

Image dimensions

Definition at line 47 of file otbFunctionWithNeighborhoodToImageFilter.hxx.

◆ CreateAnother()

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

◆ GenerateInputRequestedRegion()

template<class TInputImage , class TOutputImage , class TFunction >
void otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::GenerateInputRequestedRegion
overrideprotected

Image dimensions

Definition at line 66 of file otbFunctionWithNeighborhoodToImageFilter.hxx.

◆ GetFunction()

template<class TInputImage , class TOutputImage , class TFunction >
FunctionPointerType otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::GetFunction ( )
inline

Image dimensions

Definition at line 95 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ GetOffset()

template<class TInputImage , class TOutputImage , class TFunction >
virtual InputImageOffsetType otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::GetOffset ( )
virtual

Image dimensions

◆ GetRadius()

template<class TInputImage , class TOutputImage , class TFunction >
virtual InputImageSizeType otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::GetRadius ( )
virtual

Accessors

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

Image dimensions

◆ SetFunction()

template<class TInputImage , class TOutputImage , class TFunction >
void otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::SetFunction ( FunctionPointerType  function)
inline

Set the internal spatial function.

Definition at line 90 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ SetOffset()

template<class TInputImage , class TOutputImage , class TFunction >
void otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::SetOffset ( InputImageOffsetType &  offset)
inline

Image dimensions

Definition at line 117 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ SetRadius()

template<class TInputImage , class TOutputImage , class TFunction >
void otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::SetRadius ( InputImageSizeType &  rad)
inline

Image dimensions

Definition at line 110 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ ThreadedGenerateData()

template<class TInputImage , class TOutputImage , class TFunction >
void otb::FunctionWithNeighborhoodToImageFilter< 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 118 of file otbFunctionWithNeighborhoodToImageFilter.hxx.

Member Data Documentation

◆ InputImageDimension

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

Image dimensions

Definition at line 103 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ m_Function

template<class TInputImage , class TOutputImage , class TFunction >
FunctionPointerType otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::m_Function
private

Image dimensions

Definition at line 152 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ m_FunctionList

template<class TInputImage , class TOutputImage , class TFunction >
std::vector<FunctionPointerType> otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::m_FunctionList
private

Image dimensions

Definition at line 153 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ m_Offset

template<class TInputImage , class TOutputImage , class TFunction >
InputImageOffsetType otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::m_Offset
private

Image dimensions

Definition at line 155 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ m_Radius

template<class TInputImage , class TOutputImage , class TFunction >
InputImageSizeType otb::FunctionWithNeighborhoodToImageFilter< TInputImage, TOutputImage, TFunction >::m_Radius
private

Image dimensions

Definition at line 154 of file otbFunctionWithNeighborhoodToImageFilter.h.

◆ OutputImageDimension

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

Image dimensions

Definition at line 104 of file otbFunctionWithNeighborhoodToImageFilter.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