Medical Imaging Interaction Toolkit  2021.10.00
Medical Imaging Interaction Toolkit
itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType > Class Template Reference

#include <itkNeighborhoodFunctorImageFilter.h>

Inheritance diagram for itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >:
Collaboration diagram for itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >:

Public Types

typedef NeighborhoodFunctorImageFilter Self
 
typedef ImageToImageFilter< TInputImageType, TFeatureImageType > Superclass
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< const SelfConstPointer
 
typedef TInputImageType InputImageType
 
typedef TInputImageType::PixelType InputImagePixelType
 
typedef itk::Image< short, InputImageDimension > MaskImageType
 
typedef MaskImageType::PixelType MaskImagePixelType
 
typedef TFeatureImageType FeatureImageType
 
typedef FeatureImageType::PixelType FeaturePixelType
 
typedef itk::Size< InputImageDimension > SizeType
 
typedef ImageBoundaryCondition< InputImageType > * ImageBoundaryConditionPointerType
 
typedef ZeroFluxNeumannBoundaryCondition< InputImageTypeDefaultBoundaryCondition
 
typedef Superclass::OutputImageRegionType OutputImageRegionType
 
typedef Neighborhood< InputImagePixelType, InputImageDimension > NeighborhoodType
 

Public Member Functions

virtual const char * GetClassName () const
 
 itkStaticConstMacro (ImageDimension, unsigned int, TFeatureImageType::ImageDimension)
 
 itkStaticConstMacro (InputImageDimension, unsigned int, TInputImageType::ImageDimension)
 
void OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
 
ImageBoundaryConditionPointerType GetBoundaryCondition ()
 
void SetNeighborhoodSize (SizeType size)
 
void SetNeighborhoodSize (unsigned int size)
 
SizeType GetNeighborhoodSize ()
 
void SetMask (const typename MaskImageType::Pointer &ptr)
 
const FunctorType & GetFunctorReference () const
 
FunctorType & GetFunctorReference ()
 
void SetFunctor (const FunctorType &func)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 NeighborhoodFunctorImageFilter ()
 
 ~NeighborhoodFunctorImageFilter () override
 
void BeforeThreadedGenerateData () override
 
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override
 
void GenerateInputRequestedRegion () override
 

Detailed Description

template<typename TInputImageType, typename TFeatureImageType, class FunctorType>
class itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >

Definition at line 29 of file itkNeighborhoodFunctorImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef SmartPointer< const Self > itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::ConstPointer

Definition at line 35 of file itkNeighborhoodFunctorImageFilter.h.

◆ DefaultBoundaryCondition

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef ZeroFluxNeumannBoundaryCondition< InputImageType > itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::DefaultBoundaryCondition

Typedef for the default boundary condition

Definition at line 60 of file itkNeighborhoodFunctorImageFilter.h.

◆ FeatureImageType

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef TFeatureImageType itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::FeatureImageType

Definition at line 52 of file itkNeighborhoodFunctorImageFilter.h.

◆ FeaturePixelType

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef FeatureImageType::PixelType itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::FeaturePixelType

Definition at line 53 of file itkNeighborhoodFunctorImageFilter.h.

◆ ImageBoundaryConditionPointerType

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef ImageBoundaryCondition< InputImageType >* itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::ImageBoundaryConditionPointerType

Typedef for generic boundary condition pointer.

Definition at line 57 of file itkNeighborhoodFunctorImageFilter.h.

◆ InputImagePixelType

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef TInputImageType::PixelType itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::InputImagePixelType

Definition at line 49 of file itkNeighborhoodFunctorImageFilter.h.

◆ InputImageType

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef TInputImageType itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::InputImageType

Definition at line 48 of file itkNeighborhoodFunctorImageFilter.h.

◆ MaskImagePixelType

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef MaskImageType::PixelType itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::MaskImagePixelType

Definition at line 51 of file itkNeighborhoodFunctorImageFilter.h.

◆ MaskImageType

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef itk::Image<short, InputImageDimension> itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::MaskImageType

Definition at line 50 of file itkNeighborhoodFunctorImageFilter.h.

◆ NeighborhoodType

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef Neighborhood< InputImagePixelType, InputImageDimension > itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::NeighborhoodType

Definition at line 65 of file itkNeighborhoodFunctorImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef Superclass::OutputImageRegionType itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::OutputImageRegionType

Superclass typedefs.

Definition at line 63 of file itkNeighborhoodFunctorImageFilter.h.

◆ Pointer

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef SmartPointer< Self > itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::Pointer

Definition at line 34 of file itkNeighborhoodFunctorImageFilter.h.

◆ Self

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef NeighborhoodFunctorImageFilter itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::Self

Definition at line 32 of file itkNeighborhoodFunctorImageFilter.h.

◆ SizeType

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef itk::Size<InputImageDimension> itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::SizeType

Definition at line 54 of file itkNeighborhoodFunctorImageFilter.h.

◆ Superclass

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
typedef ImageToImageFilter<TInputImageType, TFeatureImageType> itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::Superclass

Definition at line 33 of file itkNeighborhoodFunctorImageFilter.h.

Constructor & Destructor Documentation

◆ NeighborhoodFunctorImageFilter()

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::NeighborhoodFunctorImageFilter ( )
inlineprotected

◆ ~NeighborhoodFunctorImageFilter()

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
void itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::BeforeThreadedGenerateData ( )
overrideprotected

◆ GenerateInputRequestedRegion()

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
void itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::GenerateInputRequestedRegion ( )
overrideprotected

NeighborhoodFunctorImageFilter needs a larger input requested region than the output requested region. As such, NeighborhoodOperatorImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See also
ProcessObject::GenerateInputRequestedRegion()

Referenced by itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::~NeighborhoodFunctorImageFilter().

◆ GetBoundaryCondition()

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
ImageBoundaryConditionPointerType itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::GetBoundaryCondition ( )
inline

Get the boundary condition specified

Definition at line 76 of file itkNeighborhoodFunctorImageFilter.h.

◆ GetClassName()

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
virtual const char* itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::GetClassName ( ) const
virtual

◆ GetFunctorReference() [1/2]

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
const FunctorType& itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::GetFunctorReference ( ) const
inline

Definition at line 85 of file itkNeighborhoodFunctorImageFilter.h.

◆ GetFunctorReference() [2/2]

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
FunctorType& itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::GetFunctorReference ( )
inline

Definition at line 90 of file itkNeighborhoodFunctorImageFilter.h.

◆ GetNeighborhoodSize()

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
SizeType itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::GetNeighborhoodSize ( )
inline

Definition at line 81 of file itkNeighborhoodFunctorImageFilter.h.

◆ itkStaticConstMacro() [1/2]

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::itkStaticConstMacro ( ImageDimension  ,
unsigned  int,
TFeatureImageType::ImageDimension   
)

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

◆ itkStaticConstMacro() [2/2]

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::itkStaticConstMacro ( InputImageDimension  ,
unsigned  int,
TInputImageType::ImageDimension   
)

◆ New()

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
static Pointer itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::New ( )
static

◆ OverrideBoundaryCondition()

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
void itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::OverrideBoundaryCondition ( const ImageBoundaryConditionPointerType  i)
inline

Allows a user to override the internal boundary condition. Care should be be taken to ensure that the overriding boundary condition is a persistent object during the time it is referenced. The overriding condition can be of a different type than the default type as long as it is a subclass of ImageBoundaryCondition.

Definition at line 72 of file itkNeighborhoodFunctorImageFilter.h.

◆ SetFunctor()

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
void itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::SetFunctor ( const FunctorType &  func)
inline

Definition at line 95 of file itkNeighborhoodFunctorImageFilter.h.

◆ SetMask()

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
void itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::SetMask ( const typename MaskImageType::Pointer &  ptr)
inline

Definition at line 83 of file itkNeighborhoodFunctorImageFilter.h.

◆ SetNeighborhoodSize() [1/2]

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
void itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::SetNeighborhoodSize ( SizeType  size)
inline

Definition at line 79 of file itkNeighborhoodFunctorImageFilter.h.

◆ SetNeighborhoodSize() [2/2]

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
void itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::SetNeighborhoodSize ( unsigned int  size)
inline

Definition at line 80 of file itkNeighborhoodFunctorImageFilter.h.

◆ ThreadedGenerateData()

template<typename TInputImageType , typename TFeatureImageType , class FunctorType >
void itk::NeighborhoodFunctorImageFilter< TInputImageType, TFeatureImageType, FunctorType >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
)
overrideprotected

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