OTB  7.2.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
otb::UnaryFunctorNeighborhoodVectorImageFilter< TInputImage, TOutputImage, TFunction > Class Template Reference

#include <otbUnaryFunctorNeighborhoodVectorImageFilter.h>

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

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef TFunction FunctorType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::ConstPointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef itk::ConstNeighborhoodIterator< TInputImage > NeighborhoodIteratorType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::ProcessObject ProcessObjectType
 
typedef NeighborhoodIteratorType::RadiusType RadiusType
 
typedef UnaryFunctorNeighborhoodVectorImageFilter Self
 
typedef itk::InPlaceImageFilter< TInputImage, TOutputImage > Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
FunctorTypeGetFunctor ()
 
virtual const char * GetNameOfClass () const
 
void SetFunctor (const FunctorType &functor)
 
virtual void SetRadius (RadiusType _arg)
 
virtual RadiusType GetRadius ()
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

void GenerateOutputInformation (void) override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId) override
 
 ~UnaryFunctorNeighborhoodVectorImageFilter () override
 
 UnaryFunctorNeighborhoodVectorImageFilter ()
 

Protected Attributes

RadiusType m_Radius
 

Private Member Functions

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

Private Attributes

FunctorType m_Functor
 

Detailed Description

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

Implements neighborhood-wise generic operation of one vector image.

This class is parameterized over the types of the input image 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 42 of file otbUnaryFunctorNeighborhoodVectorImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

◆ FunctorType

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

Some convenient typedefs.

Definition at line 63 of file otbUnaryFunctorNeighborhoodVectorImageFilter.h.

◆ InputImagePixelType

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

◆ InputImagePointer

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

◆ InputImageRegionType

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

◆ InputImageType

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

◆ NeighborhoodIteratorType

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

◆ OutputImagePixelType

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

◆ OutputImagePointer

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

◆ OutputImageRegionType

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

◆ OutputImageType

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

◆ Pointer

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

◆ ProcessObjectType

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

◆ RadiusType

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

◆ Self

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

Standard class typedefs.

Definition at line 46 of file otbUnaryFunctorNeighborhoodVectorImageFilter.h.

◆ Superclass

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

Constructor & Destructor Documentation

◆ UnaryFunctorNeighborhoodVectorImageFilter() [1/2]

template<class TInputImage , class TOutputImage , class TFunction >
otb::UnaryFunctorNeighborhoodVectorImageFilter< TInputImage, TOutputImage, TFunction >::UnaryFunctorNeighborhoodVectorImageFilter ( )
protected

Constructor

Definition at line 36 of file otbUnaryFunctorNeighborhoodVectorImageFilter.hxx.

◆ ~UnaryFunctorNeighborhoodVectorImageFilter()

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

◆ UnaryFunctorNeighborhoodVectorImageFilter() [2/2]

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

Member Function Documentation

◆ CreateAnother()

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

◆ GenerateOutputInformation()

template<class TInputImage , class TOutputImage , class TFunction >
void otb::UnaryFunctorNeighborhoodVectorImageFilter< TInputImage, TOutputImage, TFunction >::GenerateOutputInformation ( void  )
overrideprotected

Since the number of components per pixel depends on the radius range, one must reimplement this method to set the proper number of component on the filter output.

Generate the output information

Definition at line 49 of file otbUnaryFunctorNeighborhoodVectorImageFilter.hxx.

◆ GetFunctor()

template<class TInputImage, class TOutputImage, class TFunction>
FunctorType& otb::UnaryFunctorNeighborhoodVectorImageFilter< TInputImage, TOutputImage, TFunction >::GetFunctor ( void  )
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 79 of file otbUnaryFunctorNeighborhoodVectorImageFilter.h.

◆ GetNameOfClass()

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

◆ GetRadius()

template<class TInputImage, class TOutputImage, class TFunction>
virtual RadiusType otb::UnaryFunctorNeighborhoodVectorImageFilter< TInputImage, TOutputImage, TFunction >::GetRadius ( )
virtual

Set/Get Radius The main difference from itkUnaryFunctiorNeighborhoodImageFilter and otbBinaryFunctorNeighborhoodVectorImageFilter is that the radius may not be square...

◆ New()

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

Method for creation through the object factory.

◆ operator=()

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

◆ SetFunctor()

template<class TInputImage, class TOutputImage, class TFunction>
void otb::UnaryFunctorNeighborhoodVectorImageFilter< 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 90 of file otbUnaryFunctorNeighborhoodVectorImageFilter.h.

◆ SetRadius()

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

Set/Get Radius The main difference from itkUnaryFunctiorNeighborhoodImageFilter and otbBinaryFunctorNeighborhoodVectorImageFilter is that the radius may not be square...

◆ ThreadedGenerateData()

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

UnaryFunctorNeighborhoodVectorImageFilter 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 60 of file otbUnaryFunctorNeighborhoodVectorImageFilter.hxx.

Member Data Documentation

◆ InputImageDimension

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

Dimension

Definition at line 58 of file otbUnaryFunctorNeighborhoodVectorImageFilter.h.

◆ m_Functor

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

◆ m_Radius

template<class TInputImage, class TOutputImage, class TFunction>
RadiusType otb::UnaryFunctorNeighborhoodVectorImageFilter< TInputImage, TOutputImage, TFunction >::m_Radius
protected

◆ OutputImageDimension

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

Dimension

Definition at line 59 of file otbUnaryFunctorNeighborhoodVectorImageFilter.h.


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