Detailed Description

template<typename TInputImage>
class itk::watershed::Segmenter< TInputImage >

This filter implements the first step in the N-d watershed segmentation algorithm. It produces a segmented, labeled image from a scalar-valued image input. This filter is used in conjunction with WatershedSegmentTreeGenerator and WatershedRelabeler to produce a final segmented image volume. See itk::WatershedImageFilter for an overview of the entire algorithm and notes on the terminology used in describing it.

: The filter is designed to operate in streaming or non-streaming mode. For more information, see the itk::WatershedImageFilter documentation.

Input: There is one input to this algorithm, a real-valued (scalar) itk::Image of arbitrary dimension. The input is assumed to represents a height function, such as a gradient magnitude edge image. The filter can process an image of any dimension. Note that the terms "pixel'' and ``voxel" are interchangeable in this and other watershed component class documentation.

Outputs: There are three potential outputs of this algorithm described below.

: The first output is a labeled image of IdentifierType integers. This is an initial segmentation and labeling that is fed into successive components of the watershed algorithm.

: The second output is a table of segment information, itk::watershed::SegmentTable. This table is a record of each segment numbered in the initial segmentation (output number one) with relevant information needed in successive stages of the algorithm.

: The third output is a data structure containing boundary pixel information, itk::watershed::Boundary. This data is only generated if the flag DoBoundaryAnalysis is set to true and is only useful in streaming applications.

Parameters: Threshold is specified as a percentage (0.0 - 1.0) of the maximum height of the image. This filter thresholds the input image to remove all values below , where are the maximum, minimum values in the image and is the threshold parameter value. Values in the image less than are raised to .

: Thresholding minimum values in the image decreases the number of local minima in the image and produces an initial segmentation with fewer segments. The assumption is that the "shallow" regions that this thresholding eliminates are generally not of interest.

See Also: WatershedImageFilter

Definition at line 88 of file itkWatershedSegmenter.h.

Classes
struct	connectivity_t

struct	flat_region_t

Public Types
using	BoundaryFlatHashValueType = typename BoundaryType::FlatHashValueType

using	BoundaryIndexType = typename BoundaryType::IndexType

using	BoundaryType = Boundary< InputPixelType, Self::ImageDimension >

using	BoundaryTypePointer = typename BoundaryType::Pointer

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType

using	ImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	InputImageTypePointer = typename InputImageType::Pointer

using	InputPixelType = typename InputImageType::PixelType

using	OutputImageType = Image< IdentifierType, Self::ImageDimension >

using	OutputImageTypePointer = typename OutputImageType::Pointer

using	SegmentTableType = SegmentTable< InputPixelType >

using	SegmentTableTypePointer = typename SegmentTableType::Pointer

using	Self = Segmenter

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	GenerateData () override

BoundaryType *	GetBoundary ()

InputImageType *	GetInputImage ()

ImageRegionType	GetLargestPossibleRegion () const

OutputImageType *	GetOutputImage ()

SegmentTableType *	GetSegmentTable ()

DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx) override

void	SetBoundary (BoundaryType *b)

void	SetInputImage (InputImageType *img)

void	SetOutputImage (OutputImageType *img)

void	SetSegmentTable (SegmentTableType *s)


void	SetLargestPossibleRegion (ImageRegionType reg)


virtual void	SetCurrentLabel (IdentifierType _arg)

virtual IdentifierType	GetCurrentLabel () const


virtual void	SetThreshold (double _arg)

virtual double	GetThreshold () const


virtual void	SetDoBoundaryAnalysis (bool _arg)

virtual bool	GetDoBoundaryAnalysis () const


virtual bool	GetSortEdgeLists () const

virtual void	SetSortEdgeLists (bool _arg)

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

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

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 const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

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)

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

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 *)

unsigned long	AddObserver (const EventObject &event, Command *) const

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)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

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
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

Static Public Member Functions
static void	RelabelImage (OutputImageTypePointer, ImageRegionType, EquivalencyTable::Pointer)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

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 constexpr short	NULL_FLOW = -1

static constexpr IdentifierType	NULL_LABEL = 0

Protected Types
using	edge_table_hash_t = itksys::hash_map< IdentifierType, edge_table_t, itksys::hash< IdentifierType > >

using	edge_table_t = itksys::hash_map< IdentifierType, InputPixelType, itksys::hash< IdentifierType > >

using	flat_region_table_t = itksys::hash_map< IdentifierType, flat_region_t, itksys::hash< IdentifierType > >

Protected Member Functions
void	AnalyzeBoundaryFlow (InputImageTypePointer, flat_region_table_t &, InputPixelType)

void	BuildRetainingWall (InputImageTypePointer, ImageRegionType, InputPixelType)

void	CollectBoundaryInformation (flat_region_table_t &)

void	DescendFlatRegions (flat_region_table_t &, ImageRegionType)

virtual void	GenerateConnectivity ()

void	GenerateInputRequestedRegion () override

void	GenerateOutputRequestedRegion (DataObject *output) override

void	GradientDescent (InputImageTypePointer, ImageRegionType)

void	InitializeBoundary ()

void	LabelMinima (InputImageTypePointer, ImageRegionType, flat_region_table_t &, InputPixelType)

void	operator= (const Self &)

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

	Segmenter ()

	Segmenter (const Self &)

void	UpdateOutputInformation () override

void	UpdateSegmentTable (InputImageTypePointer, ImageRegionType)

	~Segmenter () override

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

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

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

	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 num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () ITKv5_CONST

virtual void	VerifyPreconditions () ITKv5_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 idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

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

Static Protected Member Functions
static void	MergeFlatRegions (flat_region_table_t &, EquivalencyTable::Pointer)

static void	MinMax (InputImageTypePointer img, ImageRegionType region, InputPixelType &min, InputPixelType &max)

static void	SetInputImageValues (InputImageTypePointer img, const ImageRegionType region, InputPixelType value)

static void	SetOutputImageValues (OutputImageTypePointer img, const ImageRegionType region, IdentifierType value)

static void	Threshold (InputImageTypePointer destination, InputImageTypePointer source, const ImageRegionType source_region, const ImageRegionType destination_region, InputPixelType threshold)

Protected Attributes
connectivity_t	m_Connectivity

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

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

Private Attributes
IdentifierType	m_CurrentLabel

bool	m_DoBoundaryAnalysis

ImageRegionType	m_LargestPossibleRegion

double	m_MaximumFloodLevel

bool	m_SortEdgeLists

double	m_Threshold

using	Superclass = ProcessObject

using	Pointer = SmartPointer< Self >

using	ConstPointer = SmartPointer< const Self >

static Pointer	New ()

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const