#include <itkIsolatedWatershedImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >

Isolate watershed basins using two seeds.

IsolatedWatershedImageFilter labels pixels with ReplaceValue1 that are in the same watershed basin as Seed1 AND NOT the same as Seed2. The filter adjusts the waterlevel until the two seeds are not in different basins. The user supplies a Watershed threshold. The algorithm uses a binary search to adjust the upper waterlevel, starting at UpperValueLimit. UpperValueLimit defaults to the 1.0.

Definition at line 42 of file itkIsolatedWatershedImageFilter.h.

Inheritance diagram for itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	GradientMagnitudeType = GradientMagnitudeImageFilter< InputImageType, RealImageType >

using	IndexType = typename InputImageType::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	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	RealImageType = Image< RealPixelType, TInputImage::ImageDimension >

using	RealPixelType = typename NumericTraits< InputImagePixelType >::RealType

using	Self = IsolatedWatershedImageFilter

using	SizeType = typename InputImageType::SizeType

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

using	WatershedType = WatershedImageFilter< RealImageType >

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
virtual double	GetIsolatedValue () const

const char *	GetNameOfClass () const override

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


virtual void	SetSeed1 (IndexType _arg)

virtual IndexType	GetSeed1 () const


virtual void	SetSeed2 (IndexType _arg)

virtual IndexType	GetSeed2 () const


virtual void	SetThreshold (double _arg)

virtual double	GetThreshold () const


virtual void	SetIsolatedValueTolerance (double _arg)

virtual double	GetIsolatedValueTolerance () const


virtual void	SetUpperValueLimit (double _arg)

virtual double	GetUpperValueLimit () const


virtual void	SetReplaceValue1 (OutputImagePixelType _arg)

virtual OutputImagePixelType	GetReplaceValue1 () const

virtual void	SetReplaceValue2 (OutputImagePixelType _arg)

virtual OutputImagePixelType	GetReplaceValue2 () const

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

const InputImageType *	GetInput (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

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () 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 ()

MultiThreaderType *	GetMultiThreader () 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 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

const char *	GetNameOfClass () const override

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

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 Member Functions
void	EnlargeOutputRequestedRegion (DataObject *output) override

void	GenerateData () override

void	GenerateInputRequestedRegion () override

	IsolatedWatershedImageFilter ()

void	VerifyInputInformation () const override

	~IsolatedWatershedImageFilter () 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 ImageRegionSplitterBase *	GetImageRegionSplitter () 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 void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

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)

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

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

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	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
GradientMagnitudeType::Pointer	m_GradientMagnitude {}

double	m_IsolatedValue {}

double	m_IsolatedValueTolerance {}

OutputImagePixelType	m_ReplaceValue1 {}

OutputImagePixelType	m_ReplaceValue2 {}

IndexType	m_Seed1 {}

IndexType	m_Seed2 {}

double	m_Threshold {}

double	m_UpperValueLimit {}

WatershedType::Pointer	m_Watershed {}

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

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 51 of file itkIsolatedWatershedImageFilter.h.

◆ GradientMagnitudeType

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GradientMagnitudeType = GradientMagnitudeImageFilter<InputImageType, RealImageType>

Definition at line 76 of file itkIsolatedWatershedImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::IndexType = typename InputImageType::IndexType

Definition at line 64 of file itkIsolatedWatershedImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 61 of file itkIsolatedWatershedImageFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 63 of file itkIsolatedWatershedImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer

Definition at line 60 of file itkIsolatedWatershedImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 62 of file itkIsolatedWatershedImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Definition at line 59 of file itkIsolatedWatershedImageFilter.h.

◆ OutputImagePixelType

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::OutputImagePixelType = typename OutputImageType::PixelType

Definition at line 70 of file itkIsolatedWatershedImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 68 of file itkIsolatedWatershedImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 69 of file itkIsolatedWatershedImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 67 of file itkIsolatedWatershedImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 50 of file itkIsolatedWatershedImageFilter.h.

◆ RealImageType

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::RealImageType = Image<RealPixelType, TInputImage::ImageDimension>

Definition at line 73 of file itkIsolatedWatershedImageFilter.h.

◆ RealPixelType

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::RealPixelType = typename NumericTraits<InputImagePixelType>::RealType

Definition at line 72 of file itkIsolatedWatershedImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::Self = IsolatedWatershedImageFilter

Standard class type aliases.

Definition at line 48 of file itkIsolatedWatershedImageFilter.h.

◆ SizeType

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::SizeType = typename InputImageType::SizeType

Definition at line 65 of file itkIsolatedWatershedImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 49 of file itkIsolatedWatershedImageFilter.h.

◆ WatershedType

template<typename TInputImage , typename TOutputImage >

using itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::WatershedType = WatershedImageFilter<RealImageType>

Definition at line 75 of file itkIsolatedWatershedImageFilter.h.

Constructor & Destructor Documentation

◆ IsolatedWatershedImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::IsolatedWatershedImageFilter ( )

protected

◆ ~IsolatedWatershedImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::~IsolatedWatershedImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage >

void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject * )

overrideprotectedvirtual

Give the process object a chance to indicate 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.

◆ GenerateData()

template<typename TInputImage , typename TOutputImage >

void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also: ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage >

void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

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

◆ GetIsolatedValue()

template<typename TInputImage , typename TOutputImage >

virtual double itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetIsolatedValue ( ) const

virtual

Get value that isolates the two seeds.

◆ GetIsolatedValueTolerance()

template<typename TInputImage , typename TOutputImage >

virtual double itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetIsolatedValueTolerance ( ) const

virtual

Set/Get the precision required for the intensity threshold value. The default is .001.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

const char * itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ GetReplaceValue1()

template<typename TInputImage , typename TOutputImage >

virtual OutputImagePixelType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetReplaceValue1 ( ) const

virtual

Set/Get value to replace Seed1(Seed2) pixels, pixels that are within the basin that contains Seed1(Seed2) this value. The default is 1(0).

◆ GetReplaceValue2()

template<typename TInputImage , typename TOutputImage >

virtual OutputImagePixelType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetReplaceValue2 ( ) const

virtual

Set/Get value to replace Seed1(Seed2) pixels, pixels that are within the basin that contains Seed1(Seed2) this value. The default is 1(0).

◆ GetSeed1()

template<typename TInputImage , typename TOutputImage >

virtual IndexType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetSeed1 ( ) const

virtual

Set seed point 1. This seed will be isolated from Seed2 (if possible). All pixels connected to this seed will be replaced with ReplaceValue1.

◆ GetSeed2()

template<typename TInputImage , typename TOutputImage >

virtual IndexType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetSeed2 ( ) const

virtual

Set seed point 2. This seed will be isolated from Seed1 (if possible). All pixels connected to this seed will be replaced with ReplaceValue2.

◆ GetThreshold()

template<typename TInputImage , typename TOutputImage >

virtual double itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetThreshold ( ) const

virtual

Set/Get the Watershed threshold. The default is 0.

◆ GetUpperValueLimit()

template<typename TInputImage , typename TOutputImage >

virtual double itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetUpperValueLimit ( ) const

virtual

Set/Get the limit on the upper waterlevel value. The default is 1.0.

◆ New()

template<typename TInputImage , typename TOutputImage >

static Pointer itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >

void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overridevirtual

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 >.

◆ SetIsolatedValueTolerance()

template<typename TInputImage , typename TOutputImage >

virtual void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::SetIsolatedValueTolerance ( double _arg )

virtual

Set/Get the precision required for the intensity threshold value. The default is .001.

◆ SetReplaceValue1()

template<typename TInputImage , typename TOutputImage >

virtual void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::SetReplaceValue1 ( OutputImagePixelType _arg )

virtual

Set/Get value to replace Seed1(Seed2) pixels, pixels that are within the basin that contains Seed1(Seed2) this value. The default is 1(0).

◆ SetReplaceValue2()

template<typename TInputImage , typename TOutputImage >

virtual void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::SetReplaceValue2 ( OutputImagePixelType _arg )

virtual

Set/Get value to replace Seed1(Seed2) pixels, pixels that are within the basin that contains Seed1(Seed2) this value. The default is 1(0).

◆ SetSeed1()

template<typename TInputImage , typename TOutputImage >

virtual void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::SetSeed1 ( IndexType _arg )

virtual

Set seed point 1. This seed will be isolated from Seed2 (if possible). All pixels connected to this seed will be replaced with ReplaceValue1.

◆ SetSeed2()

template<typename TInputImage , typename TOutputImage >

virtual void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::SetSeed2 ( IndexType _arg )

virtual

Set seed point 2. This seed will be isolated from Seed1 (if possible). All pixels connected to this seed will be replaced with ReplaceValue2.

◆ SetThreshold()

template<typename TInputImage , typename TOutputImage >

virtual void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::SetThreshold ( double _arg )

virtual

Set/Get the Watershed threshold. The default is 0.

◆ SetUpperValueLimit()

template<typename TInputImage , typename TOutputImage >

virtual void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::SetUpperValueLimit ( double _arg )

virtual

Set/Get the limit on the upper waterlevel value. The default is 1.0.

◆ VerifyInputInformation()

template<typename TInputImage , typename TOutputImage >

void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::VerifyInputInformation ( ) const

overrideprotectedvirtual

Verifies that the input images occupy the same physical space and the each index is at the same physical location.

The default implementation of the PropagateRequestedRegion() methods copies the index and size from the output to the input. This makes an implicit assumption that the images occupy the same physical location at each voxel. This method enforces that they are the same.

This implementation verifies that all input images of InputImageDimensions have the same origin, spacing and direction.

Filters which do not expect all input images to be at the same physical location should over-ride this method. Also filters whose inputs are different dimensions may need to override this method.