#include <itkMorphologicalWatershedFromMarkersImageFilter.h>

Detailed Description

template<typename TInputImage, typename TLabelImage>
class itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >

Morphological watershed transform from markers.

The watershed transform is a tool for image segmentation that is fast and flexible and potentially fairly parameter free. It was originally derived from a geophysical model of rain falling on a terrain and a variety of more formal definitions have been devised to allow development of practical algorithms. If an image is considered as a terrain and divided into catchment basins then the hope is that each catchment basin would contain an object of interest.

The output is a label image. A label image, sometimes referred to as a categorical image, has unique values for each region. For example, if a watershed produces 2 regions, all pixels belonging to one region would have value A, and all belonging to the other might have value B. Unassigned pixels, such as watershed lines, might have the background value (0 by convention).

The simplest way of using the watershed is to preprocess the image we want to segment so that the boundaries of our objects are bright (e.g apply an edge detector) and compute the watershed transform of the edge image. Watershed lines will correspond to the boundaries and our problem will be solved. This is rarely useful in practice because there are always more regional minima than there are objects, either due to noise or natural variations in the object surfaces. Therefore, while many watershed lines do lie on significant boundaries, there are many that don't. Various methods can be used to reduce the number of minima in the image, like thresholding the smallest values, filtering the minima and/or smoothing the image.

This filter use another approach to avoid the problem of over segmentation: it let the user provide a marker image which mark the minima in the input image and give them a label. The minima are imposed in the input image by the markers. The labels of the output image are the label of the marker image.

The morphological watershed transform algorithm is described in [116].

This code was contributed in the Insight Journal paper: "The watershed transform in ITK - discussion and new developments" by Beare R., Lehmann G. https://doi.org/10.54294/lf8u75

Author: Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.; Richard Beare. Department of Medicine, Monash University, Melbourne, Australia.

See also: WatershedImageFilter, MorphologicalWatershedImageFilter

Definition at line 80 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

Inheritance diagram for itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >:

Collaboration diagram for itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	IndexType = typename LabelImageType::IndexType

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	LabelImageConstPointer = typename LabelImageType::ConstPointer

using	LabelImagePixelType = typename LabelImageType::PixelType

using	LabelImagePointer = typename LabelImageType::Pointer

using	LabelImageRegionType = typename LabelImageType::RegionType

using	LabelImageType = TLabelImage

using	Pointer = SmartPointer<Self>

using	Self = MorphologicalWatershedFromMarkersImageFilter

using	Superclass = ImageToImageFilter<TInputImage, TLabelImage>

Public Types inherited from itk::ImageToImageFilter< TInputImage, TLabelImage >
using	ConstPointer

using	InputImageConstPointer

using	InputImagePixelType

using	InputImagePointer

using	InputImageRegionType

using	InputImageType

typedef typename OutputImageType::PixelType	OutputImagePixelType

using	OutputImagePixelType

typedef typename OutputImageType::RegionType	OutputImageRegionType

using	OutputImageRegionType

using	Pointer

using	Self

using	Superclass

Public Types inherited from itk::ImageSource< TLabelImage >
using	ConstPointer

using	DataObjectIdentifierType

using	DataObjectPointer

using	DataObjectPointerArraySizeType

using	OutputImagePixelType

using	OutputImagePointer

using	OutputImageRegionType

using	OutputImageType

using	Pointer

using	Self

using	Superclass

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
virtual::itk::LightObject::Pointer	CreateAnother () const

const LabelImageType *	GetMarkerImage () const

virtual const char *	GetNameOfClass () const

void	SetInput1 (const TInputImage *input)

void	SetInput2 (const TLabelImage *input)

void	SetMarkerImage (const TLabelImage *input)


virtual void	SetFullyConnected (bool _arg)

virtual const bool &	GetFullyConnected () const

virtual void	FullyConnectedOn ()

virtual void	FullyConnectedOff ()


virtual void	SetMarkWatershedLine (bool _arg)

virtual const bool &	GetMarkWatershedLine () const

virtual void	MarkWatershedLineOn ()

virtual void	MarkWatershedLineOff ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TLabelImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopBackInput () override

void	PopFrontInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TLabelImage >
OutputImageType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)

virtual void	GraftOutput (DataObject *graft)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

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 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	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () 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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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 void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TLabelImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (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 ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = TInputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TLabelImage >
static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

static constexpr unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< TLabelImage >
static constexpr unsigned int	OutputImageDimension

Protected Member Functions
void	EnlargeOutputRequestedRegion (DataObject *output) override

void	GenerateData () override

void	GenerateInputRequestedRegion () override

	MorphologicalWatershedFromMarkersImageFilter ()

void	PrintSelf (std::ostream &os, Indent indent) const override

	~MorphologicalWatershedFromMarkersImageFilter () override=default

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TLabelImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

	ImageToImageFilter ()

	ImageToImageFilter ()

void	VerifyInputInformation () const override

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

	~ImageToImageFilter () override=default

Protected Member Functions inherited from itk::ImageSource< TLabelImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

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	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () 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

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	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Attributes
bool	m_FullyConnected { false }

bool	m_MarkWatershedLine { true }

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TLabelImage >
using	InputToOutputRegionCopierType

using	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< TLabelImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

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)

Protected Attributes inherited from itk::ImageSource< TLabelImage >
bool	m_DynamicMultiThreading

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::ConstPointer = SmartPointer<const Self>

Definition at line 90 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ IndexType

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::IndexType = typename LabelImageType::IndexType

Definition at line 104 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 96 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 98 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ InputImagePointer

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 95 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 97 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ InputImageType

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 93 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ LabelImageConstPointer

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::LabelImageConstPointer = typename LabelImageType::ConstPointer

Definition at line 100 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ LabelImagePixelType

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::LabelImagePixelType = typename LabelImageType::PixelType

Definition at line 102 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ LabelImagePointer

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::LabelImagePointer = typename LabelImageType::Pointer

Definition at line 99 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ LabelImageRegionType

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::LabelImageRegionType = typename LabelImageType::RegionType

Definition at line 101 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ LabelImageType

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::LabelImageType = TLabelImage

Definition at line 94 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ Pointer

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::Pointer = SmartPointer<Self>

Definition at line 89 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ Self

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::Self = MorphologicalWatershedFromMarkersImageFilter

Standard class type aliases.

Definition at line 87 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ Superclass

template<typename TInputImage, typename TLabelImage>

using itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::Superclass = ImageToImageFilter<TInputImage, TLabelImage>

Definition at line 88 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

Constructor & Destructor Documentation

◆ MorphologicalWatershedFromMarkersImageFilter()

template<typename TInputImage, typename TLabelImage>

itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::MorphologicalWatershedFromMarkersImageFilter ( )

protected

Referenced by GetNameOfClass().

◆ ~MorphologicalWatershedFromMarkersImageFilter()

template<typename TInputImage, typename TLabelImage>

itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::~MorphologicalWatershedFromMarkersImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage, typename TLabelImage>

virtual::itk::LightObject::Pointer itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage, typename TLabelImage>

void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::EnlargeOutputRequestedRegion ( DataObject * output )

overrideprotectedvirtual

This filter will enlarge the output requested region to produce all of the output.

See also: ProcessObject::EnlargeOutputRequestedRegion()

Reimplemented from itk::ProcessObject.

◆ FullyConnectedOff()

template<typename TInputImage, typename TLabelImage>

virtual void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::FullyConnectedOff ( )

virtual

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

◆ FullyConnectedOn()

template<typename TInputImage, typename TLabelImage>

virtual void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::FullyConnectedOn ( )

virtual

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

◆ GenerateData()

template<typename TInputImage, typename TLabelImage>

void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::GenerateData ( )

overrideprotectedvirtual

The filter is single threaded.

Reimplemented from itk::ImageSource< TLabelImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage, typename TLabelImage>

void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

MorphologicalWatershedFromMarkersImageFilter needs to request the entire input images.

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

◆ GetFullyConnected()

template<typename TInputImage, typename TLabelImage>

virtual const bool & itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::GetFullyConnected ( ) const

virtual

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

◆ GetMarkerImage()

template<typename TInputImage, typename TLabelImage>

const LabelImageType * itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::GetMarkerImage ( ) const

inline

Get the marker image

Definition at line 125 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

References itk::ProcessObject::GetInput(), and itk::itkDynamicCastInDebugMode().

◆ GetMarkWatershedLine()

template<typename TInputImage, typename TLabelImage>

virtual const bool & itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::GetMarkWatershedLine ( ) const

virtual

Set/Get whether the watershed pixel must be marked or not. Default is true. Set it to false do not only avoid writing watershed pixels, it also decrease algorithm complexity.

◆ GetNameOfClass()

template<typename TInputImage, typename TLabelImage>

virtual const char * itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::GetNameOfClass ( ) const

virtual

See also: LightObject::GetNameOfClass()

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

References MorphologicalWatershedFromMarkersImageFilter().

◆ MarkWatershedLineOff()

template<typename TInputImage, typename TLabelImage>

virtual void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::MarkWatershedLineOff ( )

virtual

Set/Get whether the watershed pixel must be marked or not. Default is true. Set it to false do not only avoid writing watershed pixels, it also decrease algorithm complexity.

◆ MarkWatershedLineOn()

template<typename TInputImage, typename TLabelImage>

virtual void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::MarkWatershedLineOn ( )

virtual

Set/Get whether the watershed pixel must be marked or not. Default is true. Set it to false do not only avoid writing watershed pixels, it also decrease algorithm complexity.

◆ New()

template<typename TInputImage, typename TLabelImage>

static Pointer itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::New ( )

static

Standard New method.

◆ PrintSelf()

template<typename TInputImage, typename TLabelImage>

void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::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, TLabelImage >.

◆ SetFullyConnected()

template<typename TInputImage, typename TLabelImage>

virtual void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::SetFullyConnected ( bool _arg )

virtual

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

◆ SetInput1()

template<typename TInputImage, typename TLabelImage>

void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::SetInput1 ( const TInputImage * input )

inline

Set the input image

Definition at line 132 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

References itk::ImageToImageFilter< TInputImage, TLabelImage >::SetInput().

◆ SetInput2()

template<typename TInputImage, typename TLabelImage>

void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::SetInput2 ( const TLabelImage * input )

inline

Set the marker image

Definition at line 139 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

References SetMarkerImage().

◆ SetMarkerImage()

template<typename TInputImage, typename TLabelImage>

void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::SetMarkerImage ( const TLabelImage * input )

inline

Set the marker image

Definition at line 117 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

References itk::ProcessObject::SetNthInput().

Referenced by SetInput2().

◆ SetMarkWatershedLine()

template<typename TInputImage, typename TLabelImage>

virtual void itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::SetMarkWatershedLine ( bool _arg )

virtual

Set/Get whether the watershed pixel must be marked or not. Default is true. Set it to false do not only avoid writing watershed pixels, it also decrease algorithm complexity.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TLabelImage>

unsigned int itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::ImageDimension = TInputImage::ImageDimension

staticconstexpr

ImageDimension constants

Definition at line 107 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ m_FullyConnected

template<typename TInputImage, typename TLabelImage>

bool itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::m_FullyConnected { false }

private

Definition at line 188 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

◆ m_MarkWatershedLine

template<typename TInputImage, typename TLabelImage>

bool itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::m_MarkWatershedLine { true }

private

Definition at line 190 of file itkMorphologicalWatershedFromMarkersImageFilter.h.

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

itkMorphologicalWatershedFromMarkersImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ InputImageConstPointer

◆ InputImagePixelType

◆ InputImagePointer

◆ InputImageRegionType

◆ InputImageType

◆ LabelImageConstPointer

◆ LabelImagePixelType

◆ LabelImagePointer

◆ LabelImageRegionType

◆ LabelImageType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ MorphologicalWatershedFromMarkersImageFilter()

◆ ~MorphologicalWatershedFromMarkersImageFilter()

Member Function Documentation

◆ CreateAnother()

◆ EnlargeOutputRequestedRegion()

◆ FullyConnectedOff()

◆ FullyConnectedOn()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GetFullyConnected()

◆ GetMarkerImage()

◆ GetMarkWatershedLine()

◆ GetNameOfClass()

◆ MarkWatershedLineOff()

◆ MarkWatershedLineOn()

◆ New()

◆ PrintSelf()

◆ SetFullyConnected()

◆ SetInput1()

◆ SetInput2()

◆ SetMarkerImage()

◆ SetMarkWatershedLine()

Member Data Documentation

◆ ImageDimension

◆ m_FullyConnected

◆ m_MarkWatershedLine