ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel > Class Template Referenceabstract

#include <itkObjectMorphologyImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TKernel>
class itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >

Base class for the morphological operations being applied to isolated objects in an image.

This class provides the infrastructure to support of morphological operations being applied to images in which the foreground and background intensities are fixed. This filter operates significantly faster than itkBinaryMorphologicalImageFilters; however itkBinaryMorphologicalImageFilters preserve background pixels based on values of neighboring background pixels - potentially important during erosion.

The "kernel" specified represents a morphology structuring element. The structuring element is a small Neighborhood with values indicating an element is "on" (value > 0) or "off" (value <=0). Morphological operations are defined by placing the structuring element over a pixel, and calculating a nonlinear function (min, max) over the pixels of the image that are under pixels in the structuring element that are "on". The result of this calculation is the value of the pixel in the output image. Under most circumstances, the "center pixel" of the structuring element – or structuring element pixel over the input pixel under consideration – is prescribed to be "on". This is not a strict requirement but the subclasses of this filter are not guaranteed to produce the correct result if the "center pixel" is not part of the structuring element.

Subclasses of this class can define their own operations by simply providing their own Evaluate() protected member functions - one that operates using a smart neighborhood operator for edge faces and one that operates using a standard neighborhood operator..

See also
ErodeObjectMorphologyImageFilter
DilateObjectMorphologyImageFilter
BinaryErodeImageFilter
BinaryDilateImageFilter
GrayscaleErodeImageFilter
GrayscaleDilateImageFilter
NeighborhoodIterator
Neighborhood

Definition at line 74 of file itkObjectMorphologyImageFilter.h.

+ Inheritance diagram for itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >:
+ Collaboration diagram for itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DefaultBoundaryConditionType = ConstantBoundaryCondition< InputImageType >
 
using ImageBoundaryConditionConstPointerType = const ImageBoundaryCondition< InputImageType > *
 
using ImageBoundaryConditionPointerType = ImageBoundaryCondition< InputImageType > *
 
using IndexType = typename TInputImage::IndexType
 
using InputImageType = TInputImage
 
using InputNeighborhoodIteratorType = ConstNeighborhoodIterator< TInputImage >
 
using KernelIteratorType = typename KernelType::ConstIterator
 
using KernelType = TKernel
 
using OutputImageType = TOutputImage
 
using OutputNeighborhoodIteratorType = NeighborhoodIterator< TOutputImage >
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename KernelType::SizeType
 
using RegionType = typename TInputImage::RegionType
 
using Self = ObjectMorphologyImageFilter
 
using SizeType = typename TInputImage::SizeType
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

void GenerateInputRequestedRegion () override
 
virtual ImageBoundaryConditionPointerType GetBoundaryCondition () const
 
virtual const KernelTypeGetKernel () const
 
const char * GetNameOfClass () const override
 
virtual PixelType GetObjectValue () const
 
virtual bool GetUseBoundaryCondition () const
 
void OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
 
void ResetBoundaryCondition ()
 
virtual void SetKernel (KernelType _arg)
 
virtual void SetObjectValue (PixelType _arg)
 
virtual void SetUseBoundaryCondition (bool _arg)
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
const char * GetNameOfClass () const override
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
const char * GetNameOfClass () const override
 
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
const char * GetNameOfClass () const override
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int KernelDimension = TKernel::NeighborhoodDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

void BeforeThreadedGenerateData () override
 
void DynamicThreadedGenerateData (const OutputImageRegionType &) override
 
virtual void Evaluate (OutputNeighborhoodIteratorType &nit, const KernelType &kernel)=0
 
bool IsObjectPixelOnBoundary (const InputNeighborhoodIteratorType &iNIter)
 
 ObjectMorphologyImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ObjectMorphologyImageFilter () override=default
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
void GenerateInputRequestedRegion () override
 
 ImageToImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void VerifyInputInformation () const override
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

ImageBoundaryConditionPointerType m_BoundaryCondition {}
 
DefaultBoundaryConditionType m_DefaultBoundaryCondition {}
 
KernelType m_Kernel {}
 
PixelType m_ObjectValue {}
 
bool m_UseBoundaryCondition {}
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading { true }
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ConstPointer = SmartPointer<const Self>

Definition at line 84 of file itkObjectMorphologyImageFilter.h.

◆ DefaultBoundaryConditionType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::DefaultBoundaryConditionType = ConstantBoundaryCondition<InputImageType>

Definition at line 101 of file itkObjectMorphologyImageFilter.h.

◆ ImageBoundaryConditionConstPointerType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ImageBoundaryConditionConstPointerType = const ImageBoundaryCondition<InputImageType> *

Definition at line 100 of file itkObjectMorphologyImageFilter.h.

◆ ImageBoundaryConditionPointerType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ImageBoundaryConditionPointerType = ImageBoundaryCondition<InputImageType> *

Definition at line 99 of file itkObjectMorphologyImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::IndexType = typename TInputImage::IndexType

Definition at line 94 of file itkObjectMorphologyImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::InputImageType = TInputImage

Image related type alias.

Definition at line 90 of file itkObjectMorphologyImageFilter.h.

◆ InputNeighborhoodIteratorType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::InputNeighborhoodIteratorType = ConstNeighborhoodIterator<TInputImage>

Neighborhood iterator type.

Definition at line 109 of file itkObjectMorphologyImageFilter.h.

◆ KernelIteratorType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelIteratorType = typename KernelType::ConstIterator

Kernel (structuring element) iterator.

Definition at line 116 of file itkObjectMorphologyImageFilter.h.

◆ KernelType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelType = TKernel

Kernel type alias.

Definition at line 113 of file itkObjectMorphologyImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageType = TOutputImage

Definition at line 91 of file itkObjectMorphologyImageFilter.h.

◆ OutputNeighborhoodIteratorType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OutputNeighborhoodIteratorType = NeighborhoodIterator<TOutputImage>

Definition at line 110 of file itkObjectMorphologyImageFilter.h.

◆ PixelType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::PixelType = typename TInputImage::PixelType

Definition at line 95 of file itkObjectMorphologyImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Pointer = SmartPointer<Self>

Definition at line 83 of file itkObjectMorphologyImageFilter.h.

◆ RadiusType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::RadiusType = typename KernelType::SizeType

n-dimensional Kernel radius.

Definition at line 119 of file itkObjectMorphologyImageFilter.h.

◆ RegionType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::RegionType = typename TInputImage::RegionType

Definition at line 92 of file itkObjectMorphologyImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Self = ObjectMorphologyImageFilter

Standard Self type alias

Definition at line 81 of file itkObjectMorphologyImageFilter.h.

◆ SizeType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SizeType = typename TInputImage::SizeType

Definition at line 93 of file itkObjectMorphologyImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 82 of file itkObjectMorphologyImageFilter.h.

Constructor & Destructor Documentation

◆ ObjectMorphologyImageFilter()

template<typename TInputImage , typename TOutputImage , typename TKernel >
itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ObjectMorphologyImageFilter ( )
protected

◆ ~ObjectMorphologyImageFilter()

template<typename TInputImage , typename TOutputImage , typename TKernel >
itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::~ObjectMorphologyImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::BeforeThreadedGenerateData ( )
overrideprotectedvirtual

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::DynamicThreadedGenerateData ( const OutputImageRegionType )
overrideprotectedvirtual

Multi-thread version GenerateData.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ Evaluate()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Evaluate ( OutputNeighborhoodIteratorType nit,
const KernelType kernel 
)
protectedpure virtual

Evaluate image neighborhood with kernel to find the new value for the center pixel value.

Implemented in itk::DilateObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, and itk::ErodeObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage , typename TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GenerateInputRequestedRegion ( )
overridevirtual

ObjectMorphologyImageFilters need to make sure they request enough of an input image to account for the structuring element size. The input requested region is expanded by the radius of the structuring element. If the request extends past the LargestPossibleRegion for the input, the request is cropped by the LargestPossibleRegion.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ GetBoundaryCondition()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual ImageBoundaryConditionPointerType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetBoundaryCondition ( ) const
virtual

Get the current boundary condition.

◆ GetKernel()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual const KernelType & itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetKernel ( ) const
virtual

Get the kernel (structuring element).

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TKernel >
const char * itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetNameOfClass ( ) const
overridevirtual

◆ GetObjectValue()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual PixelType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetObjectValue ( ) const
virtual

Get the pixel value being used to identify the object of interest

◆ GetUseBoundaryCondition()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual bool itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetUseBoundaryCondition ( ) const
virtual

Enable/disable the use of boundary condition. Defaults to false. if false, a neighborhood operator extends outside an image, it does not consider that outside extent when determining if a pixel is on an object's boundary.

◆ IsObjectPixelOnBoundary()

template<typename TInputImage , typename TOutputImage , typename TKernel >
bool itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::IsObjectPixelOnBoundary ( const InputNeighborhoodIteratorType iNIter)
protected

Evaluate a pixel (assumed to have a value of ObjectValue) to determine if one of its neighboring pixels (8-neigh in 2d, etc) is a non-ObjectValue pixel.

◆ OverrideBoundaryCondition()

template<typename TInputImage , typename TOutputImage , typename TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::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. NOTE: Don't forget to set UseBoundaryCondition to true!

Definition at line 148 of file itkObjectMorphologyImageFilter.h.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage , typename TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

◆ ResetBoundaryCondition()

template<typename TInputImage , typename TOutputImage , typename TKernel >
void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ResetBoundaryCondition ( )
inline

Rest the boundary condition to the default

Definition at line 155 of file itkObjectMorphologyImageFilter.h.

◆ SetKernel()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetKernel ( KernelType  _arg)
virtual

Set kernel (structuring element).

◆ SetObjectValue()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetObjectValue ( PixelType  _arg)
virtual

Set the pixel value being used to identify the object of interest

◆ SetUseBoundaryCondition()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual void itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetUseBoundaryCondition ( bool  _arg)
virtual

Enable/disable the use of boundary condition. Defaults to false. if false, a neighborhood operator extends outside an image, it does not consider that outside extent when determining if a pixel is on an object's boundary.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage , typename TKernel >
constexpr unsigned int itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

Image related type alias.

Definition at line 104 of file itkObjectMorphologyImageFilter.h.

◆ KernelDimension

template<typename TInputImage , typename TOutputImage , typename TKernel >
constexpr unsigned int itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelDimension = TKernel::NeighborhoodDimension
staticconstexpr

Definition at line 106 of file itkObjectMorphologyImageFilter.h.

◆ m_BoundaryCondition

template<typename TInputImage , typename TOutputImage , typename TKernel >
ImageBoundaryConditionPointerType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_BoundaryCondition {}
protected

Pointer to a persistent boundary condition object used for the image iterator.

Definition at line 211 of file itkObjectMorphologyImageFilter.h.

◆ m_DefaultBoundaryCondition

template<typename TInputImage , typename TOutputImage , typename TKernel >
DefaultBoundaryConditionType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_DefaultBoundaryCondition {}
protected

Default boundary condition

Definition at line 214 of file itkObjectMorphologyImageFilter.h.

◆ m_Kernel

template<typename TInputImage , typename TOutputImage , typename TKernel >
KernelType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_Kernel {}
protected

kernel or structuring element to use.

Definition at line 220 of file itkObjectMorphologyImageFilter.h.

◆ m_ObjectValue

template<typename TInputImage , typename TOutputImage , typename TKernel >
PixelType itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_ObjectValue {}
protected

Pixel value that indicates the object be operated upon

Definition at line 223 of file itkObjectMorphologyImageFilter.h.

◆ m_UseBoundaryCondition

template<typename TInputImage , typename TOutputImage , typename TKernel >
bool itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_UseBoundaryCondition {}
protected

Defaults to false

Definition at line 217 of file itkObjectMorphologyImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage , typename TKernel >
constexpr unsigned int itk::ObjectMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageDimension = TOutputImage::ImageDimension
staticconstexpr

Definition at line 105 of file itkObjectMorphologyImageFilter.h.


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