#include <itkWatershedImageFilter.h>

Inheritance diagram for itk::WatershedImageFilter< TInputImage >:

Collaboration diagram for itk::WatershedImageFilter< TInputImage >:

Detailed Description

template<typename TInputImage>
class itk::WatershedImageFilter< TInputImage >

A low-level image analysis algorithm that automatically produces a hierarchy of segmented, labeled images from a scalar-valued image input.

Overview and terminology

: This filter implements a non-streaming version of an image segmentation algorithm commonly known as ``watershed segmentation''. Watershed segmentation gets its name from the manner in which the algorithm segments regions into catchment basins. If a function is a continuous height function defined over an image domain, then a catchment basin is defined as the set of points whose paths of steepest descent terminate at the same local minimum of .

: The choice of height function (input) depends on the application, and the basic watershed algorithm operates independently of that choice. For intensity-based image data, you might typically use some sort of gradient magnitude calculation as input. (see itk::GradientMagnitudeImageFilter)

: The watershed algorithm proceeds in several steps. First, an initial classification of all points into catchment basin regions is done by tracing each point down its path of steepest descent to a local minima. Next, neighboring regions and the boundaries between them are analyzed according to some saliency measure (such as minimum boundary height) to produce a tree of merges among adjacent regions. These merges occur at different maximum saliency values. The collective set of all possible merges up to a specified saliency flood level'' is referred to in this documentation as a merge tree''. Metaphorically, the flood level is a value that reflects the amount of precipitation that is rained into the catchment basins. As the flood level rises, boundaries between adjacent segments erode and those segments merge. The minimum value of the flood level is zero and the maximum value is the difference between the highest and lowest values in the input image.

: Note that once the initial analysis and segmentation is done to produce the merge tree, it is trivial to produce a hierarchy of labeled images in constant time. The complexity of the algorithm is in the computation of the merge tree. Once that tree has been created, the initial segmented image can be relabeled to reflect any maximum saliency value found in the tree by simply identifying a subset of segment merges from the tree.

Implementational details: This filter is a wrapper for several lower level process objects (watershed algorithm components in the namespace ``watershed''). For a more complete picture of the implementation, refer to the documentation of those components. The component classes were designed to operate in either a data-streaming or a non-data-streaming mode. The pipeline constructed in this class' GenerateData() method does not support streaming, but is the common use case for the components.

Description of the input to this filter: The input to this filter is a scalar itk::Image of any dimensionality. This input image is assumed to represent some sort of height function or edge map based on the original image that you want to segment (such as would be produced by itk::GradientMagnitudeImageFilter). This filter does not do any pre-processing on its input other than a thresholding step. The algorithm does not explicitly require that the input be of any particular data type, but floating point or double precision data is recommended.

: The recommended pre-processing for scalar image input to this algorithm is to use one of the itk::AnisotropicDiffusionImageFilter subclasses to smooth the original image and then perform some sort of edge calculation based on gradients or curvature.

Description of the output of this filter: This filter will produce an itk::Image of IdentifierType integer type and of the same dimensionality as the input image. The IdentifierType output image is referred to as the ``labeled image'' in this documentation. Each pixel in the image is assigned an IdentifierType integer label that groups it within a connected region.

Some notes on filter parameters: Two parameters control the output of this filter, Threshold and Level. The units of both parameters are percentage points of the maximum height value in the input.

: Threshold is used to set the absolute minimum height value used during processing. Raising this threshold percentage effectively decreases the number of local minima in the input, resulting in an initial segmentation with fewer regions. The assumption is that the shallow regions that thresholding removes are of of less interest.

: The Level parameter controls the depth of metaphorical flooding of the image. That is, it sets the maximum saliency value of interest in the result. Raising and lowering the Level influences the number of segments in the basic segmentation that are merged to produce the final output. A level of 1.0 is analogous to flooding the image up to a depth that is 100 percent of the maximum value in the image. A level of 0.0 produces the basic segmentation, which will typically be very oversegmented. Level values of interest are typically low (i.e. less than about 0.40 or 40% ), since higher values quickly start to undersegment the image.

: The Level parameter can be used to create a hierarchy of output images in constant time once an initial segmentation is done. A typical scenario might go like this: For the initial execution of the filter, set the Level to the maximum saliency value that you anticipate might be of interest. Once the initial Update() of this process object has finished, the Level can be manipulated anywhere below the initial setting without triggering a full update of the segmentation mini-pipeline. All that is now be required to produce the new output is a simple relabeling of the output image.

: Threshold and Level parameters are controlled through the class' Get/SetThreshold() and Get/SetLevel() methods.

Notes on streaming the watershed segmentation code: Coming soon... 12/06/01

Examples:: Examples/Segmentation/WatershedSegmentation1.cxx, Examples/Segmentation/WatershedSegmentation2.cxx, and WikiExamples/Segmentation/WatershedImageFilter.cxx.

Definition at line 150 of file itkWatershedImageFilter.h.

Public Types
typedef InputImageType::IndexType	IndexType

typedef TInputImage	InputImageType

typedef Image< IdentifierType, itkGetStaticConstMacro(ImageDimension) >	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef InputImageType::RegionType	RegionType

typedef InputImageType::PixelType	ScalarType

typedef WatershedImageFilter	Self

typedef InputImageType::SizeType	SizeType

typedef ImageToImageFilter < InputImageType, OutputImageType >	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< Image < IdentifierType, TInputImage::ImageDimension > >	Superclass

Public Types inherited from itk::ImageSource< Image< IdentifierType, TInputImage::ImageDimension > >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::RegionType	OutputImageRegionType

typedef Image< IdentifierType, TInputImage::ImageDimension >	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

void	EnlargeOutputRequestedRegion (DataObject *data) override

void	GenerateData () override

virtual const char *	GetNameOfClass () const

watershed::SegmentTreeGenerator < ScalarType > ::SegmentTreeType *	GetSegmentTree ()

	typedef (Concept::EqualityComparable< ScalarType >) InputEqualityComparableCheck

	typedef (Concept::AdditiveOperators< ScalarType >) InputAdditiveOperatorsCheck

	typedef (Concept::MultiplyOperator< double, ScalarType, ScalarType >) DoubleInputMultiplyOperatorCheck

	typedef (Concept::LessThanComparable< ScalarType >) InputLessThanComparableCheck


void	SetInput (const InputImageType *input) override

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

void	SetThreshold (double)

virtual double	GetThreshold () const

void	SetLevel (double)

virtual double	GetLevel () const

watershed::Segmenter < InputImageType > ::OutputImageType *	GetBasicSegmentation ()

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

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput () override

virtual void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *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< Image< IdentifierType, TInputImage::ImageDimension > >
OutputImageType *	GetOutput (unsigned int idx)

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

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

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *output)

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

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

MultiThreader *	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 void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

void	SetProgress (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	SetNumberOfThreads (ThreadIdType _arg)

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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

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

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 const unsigned int	ImageDimension = TInputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >
static const unsigned int	InputImageDimension

static const unsigned int	OutputImageDimension

Static Public Attributes inherited from itk::ImageSource< Image< IdentifierType, TInputImage::ImageDimension > >
static const unsigned int	OutputImageDimension

Protected Member Functions
virtual void	PrepareOutputs () override

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

	WatershedImageFilter ()

virtual	~WatershedImageFilter ()

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

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

virtual void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

virtual void	VerifyInputInformation () override

	~ImageToImageFilter ()

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

Protected Member Functions inherited from itk::ImageSource< Image< IdentifierType, TInputImage::ImageDimension > >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

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

virtual	~ImageSource ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

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

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

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

	~ProcessObject ()

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

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) 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)

virtual	~Object ()

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 Member Functions
void	operator= (const Self &) ITK_DELETE_FUNCTION

	WatershedImageFilter (const Self &) ITK_DELETE_FUNCTION

Private Attributes
TimeStamp	m_GenerateDataMTime

bool	m_InputChanged

double	m_Level

bool	m_LevelChanged

unsigned long	m_ObserverTag

watershed::Relabeler < ScalarType, itkGetStaticConstMacro(ImageDimension) > ::Pointer	m_Relabeler

watershed::Segmenter < InputImageType >::Pointer	m_Segmenter

double	m_Threshold

bool	m_ThresholdChanged

watershed::SegmentTreeGenerator < ScalarType >::Pointer	m_TreeGenerator

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

Static Protected Member Functions inherited from itk::ImageSource< Image< IdentifierType, TInputImage::ImageDimension > >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TInputImage >

typedef InputImageType::IndexType itk::WatershedImageFilter< TInputImage >::IndexType

Definition at line 171 of file itkWatershedImageFilter.h.

template<typename TInputImage >

typedef TInputImage itk::WatershedImageFilter< TInputImage >::InputImageType

The type of input image.

Definition at line 159 of file itkWatershedImageFilter.h.

template<typename TInputImage >

typedef Image< IdentifierType, itkGetStaticConstMacro(ImageDimension) > itk::WatershedImageFilter< TInputImage >::OutputImageType

The type of output image.

Definition at line 166 of file itkWatershedImageFilter.h.

template<typename TInputImage >

typedef SmartPointer< Self > itk::WatershedImageFilter< TInputImage >::Pointer

Smart pointer typedef support

Definition at line 180 of file itkWatershedImageFilter.h.

template<typename TInputImage >

typedef InputImageType::RegionType itk::WatershedImageFilter< TInputImage >::RegionType

Other convenient typedefs

Definition at line 169 of file itkWatershedImageFilter.h.

template<typename TInputImage >

typedef InputImageType::PixelType itk::WatershedImageFilter< TInputImage >::ScalarType

Typedef support for the input image scalar value type.

Definition at line 177 of file itkWatershedImageFilter.h.

template<typename TInputImage >

typedef WatershedImageFilter itk::WatershedImageFilter< TInputImage >::Self

Standard "Self" typedef.

Definition at line 156 of file itkWatershedImageFilter.h.

template<typename TInputImage >

typedef InputImageType::SizeType itk::WatershedImageFilter< TInputImage >::SizeType

Definition at line 170 of file itkWatershedImageFilter.h.

template<typename TInputImage >

typedef ImageToImageFilter< InputImageType, OutputImageType > itk::WatershedImageFilter< TInputImage >::Superclass

Standard super class typedef support.

Definition at line 174 of file itkWatershedImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage >

itk::WatershedImageFilter< TInputImage >::WatershedImageFilter ( )

protected

template<typename TInputImage >

virtual itk::WatershedImageFilter< TInputImage >::~WatershedImageFilter ( )

inlineprotectedvirtual

Definition at line 263 of file itkWatershedImageFilter.h.

template<typename TInputImage >

itk::WatershedImageFilter< TInputImage >::WatershedImageFilter ( const Self & )

private

Member Function Documentation

template<typename TInputImage >

virtual::itk::LightObject::Pointer itk::WatershedImageFilter< TInputImage >::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::Object.

template<typename TInputImage >

void itk::WatershedImageFilter< TInputImage >::EnlargeOutputRequestedRegion ( DataObject * )

overridevirtual

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented from itk::ProcessObject.

template<typename TInputImage >

void itk::WatershedImageFilter< TInputImage >::GenerateData ( )

overridevirtual

Standard process object method. This filter is not multithreaded.

Reimplemented from itk::ImageSource< Image< IdentifierType, TInputImage::ImageDimension > >.

template<typename TInputImage >

watershed::Segmenter< InputImageType >::OutputImageType* itk::WatershedImageFilter< TInputImage >::GetBasicSegmentation ( )

inline

Get the basic segmentation from the Segmenter member filter.

Definition at line 231 of file itkWatershedImageFilter.h.

References itk::watershed::Segmenter< TInputImage >::GetOutputImage(), itk::WatershedImageFilter< TInputImage >::m_Segmenter, and itk::ProcessObject::Update().

template<typename TInputImage >

virtual double itk::WatershedImageFilter< TInputImage >::GetLevel ( ) const

virtual

Set/Get the input thresholding parameter. Units are a percentage of the maximum depth in the image.

template<typename TInputImage >

virtual const char* itk::WatershedImageFilter< TInputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

Reimplemented from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >.

template<typename TInputImage >

watershed::SegmentTreeGenerator< ScalarType >::SegmentTreeType* itk::WatershedImageFilter< TInputImage >::GetSegmentTree ( )

inline

Get the segmentation tree from from the TreeGenerator member filter.

Definition at line 240 of file itkWatershedImageFilter.h.

References itk::watershed::SegmentTreeGenerator< TScalar >::GetOutputSegmentTree(), and itk::WatershedImageFilter< TInputImage >::m_TreeGenerator.

template<typename TInputImage >

virtual double itk::WatershedImageFilter< TInputImage >::GetThreshold ( ) const

virtual

Set/Get the input thresholding parameter. Units are a percentage of the maximum depth in the image.

template<typename TInputImage >

static Pointer itk::WatershedImageFilter< TInputImage >::New ( )

static

Method for creation through the object factory.

template<typename TInputImage >

void itk::WatershedImageFilter< TInputImage >::operator= ( const Self & )

private

template<typename TInputImage >

virtual void itk::WatershedImageFilter< TInputImage >::PrepareOutputs ( )

overrideprotectedvirtual

An opportunity to Allocate/Deallocate bulk data.

Reimplemented from itk::ProcessObject.

template<typename TInputImage >

void itk::WatershedImageFilter< TInputImage >::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, Image< IdentifierType, TInputImage::ImageDimension > >.

template<typename TInputImage >

void itk::WatershedImageFilter< TInputImage >::SetInput ( const InputImageType * input )

inlineoverridevirtual

Set/Get the input thresholding parameter. Units are a percentage of the maximum depth in the image.

Reimplemented from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >.

Definition at line 194 of file itkWatershedImageFilter.h.

References itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >::GetInput(), itk::WatershedImageFilter< TInputImage >::m_InputChanged, itk::WatershedImageFilter< TInputImage >::m_Segmenter, itk::watershed::Segmenter< TInputImage >::SetInputImage(), and itk::ProcessObject::SetNthInput().

Referenced by itk::WatershedImageFilter< TInputImage >::SetInput().

template<typename TInputImage >

virtual void itk::WatershedImageFilter< TInputImage >::SetInput	(	unsigned int	i,
		const TInputImage *	image
	)

inlineoverridevirtual

Set/Get the input thresholding parameter. Units are a percentage of the maximum depth in the image.

Reimplemented from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >.

Definition at line 209 of file itkWatershedImageFilter.h.

References itk::WatershedImageFilter< TInputImage >::SetInput().

template<typename TInputImage >

void itk::WatershedImageFilter< TInputImage >::SetLevel ( double )

Set/Get the flood level for generating the merge tree from the initial segmentation

template<typename TInputImage >

void itk::WatershedImageFilter< TInputImage >::SetThreshold ( double )

Set/Get the input thresholding parameter. Units are a percentage of the maximum depth in the image.

template<typename TInputImage >

itk::WatershedImageFilter< TInputImage >::typedef ( Concept::EqualityComparable< ScalarType > )

This class requires InputEqualityComparableCheck in the form of ( Concept::EqualityComparable< ScalarType > )

template<typename TInputImage >

itk::WatershedImageFilter< TInputImage >::typedef ( Concept::AdditiveOperators< ScalarType > )

This class requires InputAdditiveOperatorsCheck in the form of ( Concept::AdditiveOperators< ScalarType > )

template<typename TInputImage >

itk::WatershedImageFilter< TInputImage >::typedef ( Concept::MultiplyOperator< double, ScalarType, ScalarType > )

This class requires DoubleInputMultiplyOperatorCheck in the form of ( Concept::MultiplyOperator< double, ScalarType, ScalarType > )

template<typename TInputImage >

itk::WatershedImageFilter< TInputImage >::typedef ( Concept::LessThanComparable< ScalarType > )

This class requires InputLessThanComparableCheck in the form of ( Concept::LessThanComparable< ScalarType > )

Member Data Documentation

template<typename TInputImage >

const unsigned int itk::WatershedImageFilter< TInputImage >::ImageDimension = TInputImage::ImageDimension

static

Dimension of the input and output images.

Definition at line 163 of file itkWatershedImageFilter.h.

template<typename TInputImage >

TimeStamp itk::WatershedImageFilter< TInputImage >::m_GenerateDataMTime

private

Definition at line 301 of file itkWatershedImageFilter.h.

template<typename TInputImage >

bool itk::WatershedImageFilter< TInputImage >::m_InputChanged

private

Definition at line 299 of file itkWatershedImageFilter.h.

Referenced by itk::WatershedImageFilter< TInputImage >::SetInput().

template<typename TInputImage >

double itk::WatershedImageFilter< TInputImage >::m_Level

private

The percentage of the maximum saliency value among adjacencies in the segments of the initial segmentation to which ``flooding'' of the image should occur. A tree of segment merges is calculated up to this level.

Definition at line 283 of file itkWatershedImageFilter.h.

template<typename TInputImage >

bool itk::WatershedImageFilter< TInputImage >::m_LevelChanged

private

Definition at line 297 of file itkWatershedImageFilter.h.

template<typename TInputImage >

unsigned long itk::WatershedImageFilter< TInputImage >::m_ObserverTag

private

Definition at line 295 of file itkWatershedImageFilter.h.

template<typename TInputImage >

watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension) >::Pointer itk::WatershedImageFilter< TInputImage >::m_Relabeler

private

Definition at line 293 of file itkWatershedImageFilter.h.

template<typename TInputImage >

watershed::Segmenter< InputImageType >::Pointer itk::WatershedImageFilter< TInputImage >::m_Segmenter

private

The component parts of the segmentation algorithm. These objects must save state between calls to GenerateData() so that the computationally expensive execution of segment tree generation is not unnecessarily repeated.

Definition at line 289 of file itkWatershedImageFilter.h.

Referenced by itk::WatershedImageFilter< TInputImage >::GetBasicSegmentation(), and itk::WatershedImageFilter< TInputImage >::SetInput().

template<typename TInputImage >

double itk::WatershedImageFilter< TInputImage >::m_Threshold

private

A Percentage of the maximum depth (max - min pixel value) in the input image. This percentage will be used to threshold the minimum values in the image.

Definition at line 277 of file itkWatershedImageFilter.h.

template<typename TInputImage >

bool itk::WatershedImageFilter< TInputImage >::m_ThresholdChanged

private

Definition at line 298 of file itkWatershedImageFilter.h.

template<typename TInputImage >

watershed::SegmentTreeGenerator< ScalarType >::Pointer itk::WatershedImageFilter< TInputImage >::m_TreeGenerator

private

Definition at line 291 of file itkWatershedImageFilter.h.

Referenced by itk::WatershedImageFilter< TInputImage >::GetSegmentTree().

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

itkWatershedImageFilter.h

Detailed Description

template<typename TInputImage> class itk::WatershedImageFilter< TInputImage >

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename TInputImage>
class itk::WatershedImageFilter< TInputImage >