itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage > Class Template Reference

Isolate watershed basins using two seeds. More...

#include <itkIsolatedWatershedImageFilter.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef GradientMagnitudeImageFilter < InputImageType, OutputImageType >	GradientMagnitudeType
typedef InputImageType::IndexType	IndexType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef IsolatedWatershedImageFilter	Self
typedef InputImageType::SizeType	SizeType
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
typedef WatershedImageFilter < InputImageType >	WatershedType
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	SetSeed1 (IndexType _arg)
virtual void	SetSeed2 (IndexType _arg)
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
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	EnlargeOutputRequestedRegion (DataObject *output)
void	GenerateData ()
void	GenerateInputRequestedRegion ()
Protected Attributes
GradientMagnitudeType::Pointer	m_GradientMagnitude
double	m_IsolatedValue
double	m_IsolatedValueTolerance
OutputImagePixelType	m_ReplaceValue1
OutputImagePixelType	m_ReplaceValue2
double	m_Threshold
double	m_UpperValueLimit
WatershedType::Pointer	m_Watershed
Private Member Functions
	IsolatedWatershedImageFilter (const Self &)
void	operator= (const Self &)
IndexType	m_Seed1
IndexType	m_Seed2
virtual double	GetIsolatedValue () const
	IsolatedWatershedImageFilter ()
	~IsolatedWatershedImageFilter ()

---

Detailed Description

template<class TInputImage, class 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 41 of file itkIsolatedWatershedImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

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

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

Definition at line 49 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef GradientMagnitudeImageFilter< InputImageType, OutputImageType > itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GradientMagnitudeType

Definition at line 72 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::IndexType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::IndexType

Definition at line 63 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::ConstPointer itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

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

Definition at line 60 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::PixelType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::InputImagePixelType

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

Definition at line 62 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::Pointer itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::InputImagePointer

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

Definition at line 59 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::RegionType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::InputImageRegionType

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

Definition at line 61 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

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

Definition at line 56 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::PixelType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

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

Definition at line 69 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::Pointer itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 67 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::RegionType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs.

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

Definition at line 68 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 66 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef SmartPointer< Self > itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::Pointer

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

Definition at line 48 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef IsolatedWatershedImageFilter itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

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

Definition at line 46 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::SizeType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::SizeType

Definition at line 64 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef ImageToImageFilter< TInputImage, TOutputImage > itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 47 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef WatershedImageFilter< InputImageType > itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::WatershedType

Definition at line 71 of file itkIsolatedWatershedImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

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

(

)

[protected]

Get value that isolates the two seeds.

template<class TInputImage , class TOutputImage >

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

(

)

[inline, protected]

Get value that isolates the two seeds.

Definition at line 115 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

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

(

const Self &

)

[private]

---

Member Function Documentation

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::CreateAnother

(

void

)

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<class TInputImage , class TOutputImage >

void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion

(

DataObject *

)

[protected, virtual]

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<class TInputImage , class TOutputImage >

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

(

)

[protected, virtual]

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 ThreadedGenerateData(). 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 an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:

ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage >

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

(

)

[protected, virtual]

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

template<class TInputImage , class TOutputImage >

virtual double itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetIsolatedValue

(

)

const [virtual]

Get value that isolates the two seeds.

template<class TInputImage , class TOutputImage >

virtual double itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetIsolatedValueTolerance

(

)

const [virtual]

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

template<class TInputImage , class TOutputImage >

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

(

)

const [virtual]

Run-time type information (and related methods).

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

template<class TInputImage , class 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).

template<class TInputImage , class 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).

template<class TInputImage , class TOutputImage >

virtual double itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetThreshold

(

)

const [virtual]

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

template<class TInputImage , class TOutputImage >

virtual double itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::GetUpperValueLimit

(

)

const [virtual]

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

template<class TInputImage , class TOutputImage >

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

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage >

void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::operator=

(

const Self &

)

[private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

template<class TInputImage , class TOutputImage >

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

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

template<class TInputImage , class 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.

template<class TInputImage , class 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).

template<class TInputImage , class 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).

template<class TInputImage , class 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.

template<class TInputImage , class 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.

template<class TInputImage , class TOutputImage >

virtual void itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::SetThreshold

(

double

_arg

)

[virtual]

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

template<class TInputImage , class 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.

---

Member Data Documentation

template<class TInputImage , class TOutputImage >

GradientMagnitudeType::Pointer itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::m_GradientMagnitude [protected]

Definition at line 123 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

double itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::m_IsolatedValue [protected]

Definition at line 128 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

double itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::m_IsolatedValueTolerance [protected]

Definition at line 129 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

OutputImagePixelType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::m_ReplaceValue1 [protected]

Definition at line 120 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

OutputImagePixelType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::m_ReplaceValue2 [protected]

Definition at line 121 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

IndexType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::m_Seed1 [protected]

Get value that isolates the two seeds.

Definition at line 116 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

IndexType itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::m_Seed2 [protected]

Get value that isolates the two seeds.

Definition at line 117 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

double itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::m_Threshold [protected]

Definition at line 127 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

double itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::m_UpperValueLimit [protected]

Definition at line 130 of file itkIsolatedWatershedImageFilter.h.

template<class TInputImage , class TOutputImage >

WatershedType::Pointer itk::IsolatedWatershedImageFilter< TInputImage, TOutputImage >::m_Watershed [protected]

Definition at line 125 of file itkIsolatedWatershedImageFilter.h.

---

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

• itkIsolatedWatershedImageFilter.h