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

#include <otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const Self > ConstPointer
 
typedef TFunction FunctorType
 
typedef InputImageType::OffsetType InputImageOffsetType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::ConstPointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef InputImageType::SizeType InputImageSizeType
 
typedef Superclass::InputImageType InputImageType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef Superclass::OutputImageType OutputImageType
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::ProcessObject ProcessObjectType
 
typedef UnaryFunctorNeighborhoodWithOffsetImageFilter Self
 
typedef itk::ImageToImageFilter< 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 ()
 
typedef itk::ConstNeighborhoodIterator< TInputImage > NeighborhoodIteratorType
 
typedef NeighborhoodIteratorType::RadiusType RadiusType
 
typedef unsigned char RadiusSizeType
 
std::vector< FunctorType > m_FunctorList
 
InputImageSizeType m_Radius
 
FunctorType m_Functor
 
InputImageOffsetType m_Offset
 
virtual void SetRadius (InputImageSizeType _arg)
 
virtual InputImageSizeType GetRadius ()
 
void SetRadius (unsigned int radius)
 
virtual void SetOffset (InputImageOffsetType off)
 
virtual InputImageOffsetType GetOffset ()
 
FunctorType & GetFunctor ()
 
const FunctorType & GetFunctor () const
 
void SetFunctor (const FunctorType &functor)
 
 UnaryFunctorNeighborhoodWithOffsetImageFilter ()
 
 ~UnaryFunctorNeighborhoodWithOffsetImageFilter () override
 
void BeforeThreadedGenerateData () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
void GenerateInputRequestedRegion (void) override
 
 UnaryFunctorNeighborhoodWithOffsetImageFilter (const Self &)=delete
 
void operator= (const Self &)=delete
 

Detailed Description

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

Implements neighborhood-wise generic operation on image.

This class is parameterized over the input image type and the type of the output image. It is also parameterized by the operation to be applied. A Functor style is used.

Definition at line 43 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 50 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ FunctorType

template<class TInputImage , class TOutputImage , class TFunction >
typedef TFunction otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::FunctorType

Some convenient typedefs.

Definition at line 56 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ InputImageOffsetType

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

Definition at line 65 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ InputImagePixelType

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

Definition at line 63 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ InputImagePointer

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

Definition at line 61 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ InputImageRegionType

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

Definition at line 62 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ InputImageSizeType

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

Definition at line 64 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ InputImageType

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

Definition at line 60 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ NeighborhoodIteratorType

template<class TInputImage , class TOutputImage , class TFunction >
typedef itk::ConstNeighborhoodIterator<TInputImage> otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::NeighborhoodIteratorType

Set/Get the radius of neighborhood.

Definition at line 127 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ OutputImagePixelType

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

Definition at line 69 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ OutputImagePointer

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

Definition at line 67 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ OutputImageRegionType

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

Definition at line 68 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ OutputImageType

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

Definition at line 66 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ Pointer

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

Definition at line 49 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ ProcessObjectType

template<class TInputImage , class TOutputImage , class TFunction >
typedef itk::ProcessObject otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::ProcessObjectType

Definition at line 71 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ RadiusSizeType

template<class TInputImage , class TOutputImage , class TFunction >
typedef unsigned char otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::RadiusSizeType

Set/Get the radius of neighborhood.

Definition at line 129 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ RadiusType

template<class TInputImage , class TOutputImage , class TFunction >
typedef NeighborhoodIteratorType::RadiusType otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::RadiusType

Set/Get the radius of neighborhood.

Definition at line 128 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ Self

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

Standard class typedefs.

Definition at line 47 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ Superclass

template<class TInputImage , class TOutputImage , class TFunction >
typedef itk::ImageToImageFilter<TInputImage, TOutputImage> otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::Superclass

Definition at line 48 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

Constructor & Destructor Documentation

◆ UnaryFunctorNeighborhoodWithOffsetImageFilter() [1/2]

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

Constructor

Definition at line 37 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.hxx.

◆ ~UnaryFunctorNeighborhoodWithOffsetImageFilter()

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

Destructor

Definition at line 140 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ UnaryFunctorNeighborhoodWithOffsetImageFilter() [2/2]

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

Set/Get the radius of neighborhood.

Member Function Documentation

◆ BeforeThreadedGenerateData()

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

Set/Get the radius of neighborhood.

Definition at line 47 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.hxx.

◆ CreateAnother()

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

◆ GenerateInputRequestedRegion()

template<class TInputImage , class TOutputImage , class TFunction >
void otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::GenerateInputRequestedRegion ( void  )
overrideprotected

Pad the input requested region by radius

Definition at line 58 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.hxx.

◆ GetFunctor() [1/2]

template<class TInputImage , class TOutputImage , class TFunction >
FunctorType& otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::GetFunctor ( )
inline

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

Definition at line 98 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ GetFunctor() [2/2]

template<class TInputImage , class TOutputImage , class TFunction >
const FunctorType& otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::GetFunctor ( ) const
inline

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

Definition at line 109 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ GetOffset()

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

Set/Get the radius of neighborhood.

◆ GetRadius()

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

Set/Get the radius of neighborhood.

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

Set/Get the radius of neighborhood.

◆ SetFunctor()

template<class TInputImage , class TOutputImage , class TFunction >
void otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::SetFunctor ( const FunctorType &  functor)
inline

Set the functor object. This replaces the current Functor with a copy of the specified Functor. This allows the user to specify a functor that has ivars set differently than the default functor. This method requires an operator!=() be defined on the functor (or the compiler's default implementation of operator!=() being appropriate).

Definition at line 120 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ SetOffset()

template<class TInputImage , class TOutputImage , class TFunction >
virtual void otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::SetOffset ( InputImageOffsetType  off)
inlinevirtual

Set/Get the offset

Definition at line 85 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ SetRadius() [1/2]

template<class TInputImage , class TOutputImage , class TFunction >
virtual void otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::SetRadius ( InputImageSizeType  _arg)
virtual

Set/Get the radius of neighborhood.

◆ SetRadius() [2/2]

template<class TInputImage , class TOutputImage , class TFunction >
void otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::SetRadius ( unsigned int  radius)
inline

Set unsigned int radius

Definition at line 79 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ ThreadedGenerateData()

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

UnaryFunctorNeighborhoodWithOffsetImageFilter 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 Performs the neighborhood-wise operation

Definition at line 111 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.hxx.

Member Data Documentation

◆ m_Functor

template<class TInputImage , class TOutputImage , class TFunction >
FunctorType otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::m_Functor
private

Set/Get the radius of neighborhood.

Definition at line 170 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ m_FunctorList

template<class TInputImage , class TOutputImage , class TFunction >
std::vector<FunctorType> otb::UnaryFunctorNeighborhoodWithOffsetImageFilter< TInputImage, TOutputImage, TFunction >::m_FunctorList
protected

Set/Get the radius of neighborhood.

Definition at line 162 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ m_Offset

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

Set/Get the radius of neighborhood.

Definition at line 172 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

◆ m_Radius

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

Set/Get the radius of neighborhood.

Definition at line 168 of file otbUnaryFunctorNeighborhoodWithOffsetImageFilter.h.

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