MeVisLab Toolbox Reference
itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss > Class Template Reference

Template class to create an itk structured element from an ML kernel. More...

#include <mlITKKernelSupport.h>

Inheritance diagram for itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >:

Public Types

typedef MLITKStructuringElementBase Self
 Standard self typedef. More...
 
typedef Neighborhood< TPixel, VDimension, TAllocator > Superclass
 Standard super class typedef. More...
 
typedef TAllocator AllocatorType
 External support for allocator type. More...
 
typedef TPixel PixelType
 External support for pixel type. More...
 
typedef AllocatorType::iterator Iterator
 Iterator typedef support. More...
 
typedef AllocatorType::const_iterator ConstIterator
 
typedef Superclass::SizeType SizeType
 Size and value typedef support. More...
 
typedef Superclass::SizeValueType SizeValueType
 
typedef Superclass::OffsetType OffsetType
 Offset and value typedef support. More...
 
typedef OffsetType::OffsetValueType OffsetValueType
 
typedef Superclass::RadiusType RadiusType
 Radius typedef support. More...
 
typedef SliceIterator< TPixel, SelfSliceIteratorType
 External slice iterator type typedef support. More...
 

Public Member Functions

 itkStaticConstMacro (NeighborhoodDimension, unsigned int, VDimension)
 External support for dimensionality. More...
 
 MLITKStructuringElementBase ()
 Default constructor. More...
 
 MLITKStructuringElementBase (const ml::Kernel &kernel)
 Convenience constructor directly from the ML kernel. More...
 
virtual ~MLITKStructuringElementBase ()
 Default destructor. Only superclass stuff is done. More...
 
 MLITKStructuringElementBase (const Self &other)
 Copy constructor. Only superclass stuff is done. More...
 
Selfoperator= (const Self &other)
 Assignment operator. Only superclass stuff is done. More...
 
virtual void setKernelFromString (const std::string &kernelStr)
 Convenience constructor from a string description of an ML kernel. More...
 
virtual void CreateStructuringElement (const ml::Kernel &kernel)
 Create the structuring element. More...
 

Detailed Description

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
class itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >

Template class to create an itk structured element from an ML kernel.

It will be passed to morphological itk operators.

Definition at line 35 of file mlITKKernelSupport.h.

Member Typedef Documentation

◆ AllocatorType

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
typedef TAllocator itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::AllocatorType

External support for allocator type.

Definition at line 45 of file mlITKKernelSupport.h.

◆ ConstIterator

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
typedef AllocatorType::const_iterator itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::ConstIterator

Definition at line 58 of file mlITKKernelSupport.h.

◆ Iterator

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
typedef AllocatorType::iterator itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::Iterator

Iterator typedef support.

Note the naming is intentional, i.e., ::iterator and ::const_iterator, because the allocator may be a vnl object or other type, which uses this form.

Definition at line 57 of file mlITKKernelSupport.h.

◆ OffsetType

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
typedef Superclass::OffsetType itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::OffsetType

Offset and value typedef support.

Definition at line 69 of file mlITKKernelSupport.h.

◆ OffsetValueType

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
typedef OffsetType::OffsetValueType itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::OffsetValueType

Definition at line 70 of file mlITKKernelSupport.h.

◆ PixelType

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
typedef TPixel itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::PixelType

External support for pixel type.

Definition at line 51 of file mlITKKernelSupport.h.

◆ RadiusType

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
typedef Superclass::RadiusType itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::RadiusType

Radius typedef support.

Definition at line 74 of file mlITKKernelSupport.h.

◆ Self

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
typedef MLITKStructuringElementBase itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::Self

Standard self typedef.

Definition at line 39 of file mlITKKernelSupport.h.

◆ SizeType

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
typedef Superclass::SizeType itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::SizeType

Size and value typedef support.

Definition at line 63 of file mlITKKernelSupport.h.

◆ SizeValueType

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
typedef Superclass::SizeValueType itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::SizeValueType

Definition at line 64 of file mlITKKernelSupport.h.

◆ SliceIteratorType

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
typedef SliceIterator<TPixel, Self> itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::SliceIteratorType

External slice iterator type typedef support.

Definition at line 77 of file mlITKKernelSupport.h.

◆ Superclass

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
typedef Neighborhood<TPixel, VDimension, TAllocator> itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::Superclass

Standard super class typedef.

Definition at line 42 of file mlITKKernelSupport.h.

Constructor & Destructor Documentation

◆ MLITKStructuringElementBase() [1/3]

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::MLITKStructuringElementBase ( )
inline

Default constructor.

Definition at line 80 of file mlITKKernelSupport.h.

◆ MLITKStructuringElementBase() [2/3]

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::MLITKStructuringElementBase ( const ml::Kernel kernel)
inline

Convenience constructor directly from the ML kernel.

Definition at line 83 of file mlITKKernelSupport.h.

References itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::CreateStructuringElement().

◆ ~MLITKStructuringElementBase()

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
virtual itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::~MLITKStructuringElementBase ( )
inlinevirtual

Default destructor. Only superclass stuff is done.

Definition at line 90 of file mlITKKernelSupport.h.

◆ MLITKStructuringElementBase() [3/3]

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::MLITKStructuringElementBase ( const Self other)
inline

Copy constructor. Only superclass stuff is done.

Definition at line 93 of file mlITKKernelSupport.h.

Member Function Documentation

◆ CreateStructuringElement()

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
virtual void itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::CreateStructuringElement ( const ml::Kernel kernel)
inlinevirtual

◆ itkStaticConstMacro()

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::itkStaticConstMacro ( NeighborhoodDimension  ,
unsigned int  ,
VDimension   
)

External support for dimensionality.

◆ operator=()

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
Self& itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::operator= ( const Self other)
inline

Assignment operator. Only superclass stuff is done.

Definition at line 99 of file mlITKKernelSupport.h.

Referenced by itk::MLITKStructuringElement< TPixel, VDimension, TAllocator >::operator=().

◆ setKernelFromString()

template<class TPixel , unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>, class SuperClss = Neighborhood<TPixel, VDimension, TAllocator >>
virtual void itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::setKernelFromString ( const std::string &  kernelStr)
inlinevirtual

Convenience constructor from a string description of an ML kernel.

Definition at line 106 of file mlITKKernelSupport.h.

References itk::MLITKStructuringElementBase< TPixel, VDimension, TAllocator, SuperClss >::CreateStructuringElement(), and ml::TKernel< KDATATYPE >::setKernel().


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