#include <itkWatershedSegmenter.h>

Inheritance diagram for itk::watershed::Segmenter< TInputImage >:

Collaboration diagram for itk::watershed::Segmenter< TInputImage >:

Classes
struct	connectivity_t
struct	flat_region_t
Public Types
typedef BoundaryType::FlatHashValueType	BoundaryFlatHashValueType
typedef BoundaryType::IndexType	BoundaryIndexType
typedef Boundary < InputPixelType, itkGetStaticConstMacro(ImageDimension)>	BoundaryType
typedef BoundaryType::Pointer	BoundaryTypePointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef InputImageType::RegionType	ImageRegionType
typedef TInputImage	InputImageType
typedef InputImageType::Pointer	InputImageTypePointer
typedef InputImageType::PixelType	InputPixelType
typedef Image< unsigned long, itkGetStaticConstMacro(ImageDimension)>	OutputImageType
typedef OutputImageType::Pointer	OutputImageTypePointer
typedef SegmentTable < InputPixelType >	SegmentTableType
typedef SegmentTableType::Pointer	SegmentTableTypePointer
typedef Segmenter	Self
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
void	GenerateData ()
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
DataObjectPointerArray &	GetInputs ()
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
void	UpdateProgress (float amount)


InputImageType *	GetInputImage (void)
void	SetInputImage (InputImageType *img)


OutputImageType *	GetOutputImage (void)
void	SetOutputImage (OutputImageType *img)


SegmentTableType *	GetSegmentTable (void)
void	SetSegmentTable (SegmentTableType *s)


BoundaryType *	GetBoundary (void)
void	SetBoundary (BoundaryType *b)


void	SetLargestPossibleRegion (ImageRegionType reg)
ImageRegionType	GetLargestPossibleRegion () const


virtual void	SetCurrentLabel (unsigned long _arg)
virtual unsigned long	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)


DataObjectPointerArray &	GetOutputs ()
DataObjectPointerArraySizeType	GetNumberOfOutputs () const


virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()


virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()


virtual void	SetNumberOfThreads (int _arg)
virtual const int &	GetNumberOfThreads ()


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()
static void	RelabelImage (OutputImageTypePointer, ImageRegionType, EquivalencyTable::Pointer)


static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
Static Public Attributes
static const unsigned int	ImageDimension = TInputImage::ImageDimension
static short	NULL_FLOW
static unsigned long	NULL_LABEL
Protected Types
typedef itk::hash_map < unsigned long, edge_table_t, itk::hash< unsigned long > >	edge_table_hash_t
typedef itk::hash_map < unsigned long, InputPixelType, itk::hash < unsigned long > >	edge_table_t
typedef itk::hash_map < unsigned long, flat_region_t, itk::hash< unsigned long > >	flat_region_table_t


typedef int	InternalReferenceCountType
Protected Member Functions
void	AnalyzeBoundaryFlow (InputImageTypePointer, flat_region_table_t &, InputPixelType)
void	BuildRetainingWall (InputImageTypePointer, ImageRegionType, InputPixelType)
virtual void	CacheInputReleaseDataFlags ()
void	CollectBoundaryInformation (flat_region_table_t &)
void	DescendFlatRegions (flat_region_table_t &, ImageRegionType)
virtual void	GenerateConnectivity ()
virtual void	GenerateOutputInformation ()
void	GradientDescent (InputImageTypePointer, ImageRegionType)
void	InitializeBoundary ()
void	LabelMinima (InputImageTypePointer, ImageRegionType, flat_region_table_t &, InputPixelType)
void	operator= (const Self &)
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RestoreInputReleaseDataFlags ()
	Segmenter (const Self &)
	Segmenter ()
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
void	UpdateSegmentTable (InputImageTypePointer, ImageRegionType)
virtual	~Segmenter ()


void	GenerateInputRequestedRegion ()
void	GenerateOutputRequestedRegion (DataObject *output)
void	UpdateOutputInformation ()


virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	AddInput (DataObject *input)
virtual void	RemoveInput (DataObject *input)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)
virtual const unsigned int &	GetNumberOfRequiredInputs ()


virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()


DataObject *	GetInput (unsigned int idx)
const DataObject *	GetInput (unsigned int idx) const


virtual void	SetNthOutput (unsigned int num, DataObject *output)
virtual void	AddOutput (DataObject *output)
virtual void	RemoveOutput (DataObject *output)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)
virtual const unsigned int &	GetNumberOfRequiredOutputs ()


DataObject *	GetOutput (unsigned int idx)
const DataObject *	GetOutput (unsigned int idx) const


virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
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, unsigned long value)
static void	Threshold (InputImageTypePointer destination, InputImageTypePointer source, const ImageRegionType source_region, const ImageRegionType destination_region, InputPixelType threshold)
Protected Attributes
connectivity_t	m_Connectivity
TimeStamp	m_OutputInformationMTime
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating

typedef ProcessObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
static Pointer	New ()
virtual const char *	GetNameOfClass () const

Detailed Description

template<class 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 unsigned long 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 90 of file itkWatershedSegmenter.h.

Member Typedef Documentation

template<class TInputImage>

typedef BoundaryType::FlatHashValueType itk::watershed::Segmenter< TInputImage >::BoundaryFlatHashValueType

Definition at line 109 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef BoundaryType::IndexType itk::watershed::Segmenter< TInputImage >::BoundaryIndexType

Definition at line 108 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef Boundary<InputPixelType, itkGetStaticConstMacro(ImageDimension)> itk::watershed::Segmenter< TInputImage >::BoundaryType

Definition at line 107 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef BoundaryType::Pointer itk::watershed::Segmenter< TInputImage >::BoundaryTypePointer

Definition at line 126 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef SmartPointer<const Self> itk::watershed::Segmenter< TInputImage >::ConstPointer

Methods to implement smart pointers and work with the itk object factory

Reimplemented from itk::ProcessObject.

Definition at line 117 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef DataObject::Pointer itk::watershed::Segmenter< TInputImage >::DataObjectPointer

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Definition at line 111 of file itkWatershedSegmenter.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray [inherited]

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

typedef DataObjectPointerArray::size_type itk::ProcessObject::DataObjectPointerArraySizeType [inherited]

Size type of an std::vector

Definition at line 112 of file itkProcessObject.h.

template<class TInputImage>

typedef itk::hash_map<unsigned long, edge_table_t, itk::hash<unsigned long> > itk::watershed::Segmenter< TInputImage >::edge_table_hash_t [protected]

Definition at line 272 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef itk::hash_map<unsigned long, InputPixelType, itk::hash<unsigned long> > itk::watershed::Segmenter< TInputImage >::edge_table_t [protected]

Table for storing tables of edges. This is convenient in generating the segment table, even though the edge tables are stored as ordered lists. An ``edge'' in this context is synonymous with a segment ``adjacency''.

Definition at line 269 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef itk::hash_map<unsigned long, flat_region_t, itk::hash<unsigned long> > itk::watershed::Segmenter< TInputImage >::flat_region_table_t [protected]

Table for storing flat region information.

Definition at line 255 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef InputImageType::RegionType itk::watershed::Segmenter< TInputImage >::ImageRegionType

Definition at line 104 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef TInputImage itk::watershed::Segmenter< TInputImage >::InputImageType

Define image types and dimensionality

Definition at line 98 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef InputImageType::Pointer itk::watershed::Segmenter< TInputImage >::InputImageTypePointer

Typedefs necessary on microsoft VC++ to avoid internal compiler errors

Definition at line 119 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef InputImageType::PixelType itk::watershed::Segmenter< TInputImage >::InputPixelType

Definition at line 105 of file itkWatershedSegmenter.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

template<class TInputImage>

typedef Image<unsigned long, itkGetStaticConstMacro(ImageDimension)> itk::watershed::Segmenter< TInputImage >::OutputImageType

Definition at line 103 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef OutputImageType::Pointer itk::watershed::Segmenter< TInputImage >::OutputImageTypePointer

Definition at line 124 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef SmartPointer<Self> itk::watershed::Segmenter< TInputImage >::Pointer

Methods to implement smart pointers and work with the itk object factory

Reimplemented from itk::ProcessObject.

Definition at line 116 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef SegmentTable<InputPixelType> itk::watershed::Segmenter< TInputImage >::SegmentTableType

Definition at line 110 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef SegmentTableType::Pointer itk::watershed::Segmenter< TInputImage >::SegmentTableTypePointer

Definition at line 125 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef Segmenter itk::watershed::Segmenter< TInputImage >::Self

Standard self typedefs

Reimplemented from itk::ProcessObject.

Definition at line 95 of file itkWatershedSegmenter.h.

template<class TInputImage>

typedef ProcessObject itk::watershed::Segmenter< TInputImage >::Superclass

Methods to implement smart pointers and work with the itk object factory

Reimplemented from itk::ProcessObject.

Definition at line 115 of file itkWatershedSegmenter.h.

Constructor & Destructor Documentation

template<class TInputImage>

itk::watershed::Segmenter< TInputImage >::Segmenter ( ) [protected]

template<class TInputImage>

itk::watershed::Segmenter< TInputImage >::Segmenter ( const Self & ) [inline, protected]

Definition at line 275 of file itkWatershedSegmenter.h.

template<class TInputImage>

virtual itk::watershed::Segmenter< TInputImage >::~Segmenter ( ) [protected, virtual]

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff ( ) [virtual, inherited]

virtual void itk::ProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

virtual void itk::ProcessObject::AddInput ( DataObject * input ) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

virtual void itk::ProcessObject::AddOutput ( DataObject * output ) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::AnalyzeBoundaryFlow	(	InputImageTypePointer	,
		flat_region_table_t &	,
		InputPixelType
	)			`[protected]`

Performs a gradient descent connected component analysis at the boundaries of the images that border other image chunks. Useful only in data streaming applications.

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::BuildRetainingWall	(	InputImageTypePointer	,
		ImageRegionType	,
		InputPixelType
	)			`[protected]`

Fills boundary pixels with a specified value. Used by labeling methods to build a very high ``wall'' around the image so that gradient descent does not need to watch boundaries.

virtual void itk::ProcessObject::CacheInputReleaseDataFlags ( ) [protected, virtual, inherited]

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::CollectBoundaryInformation ( flat_region_table_t & ) [protected]

Traverses each boundary and fills in the data needed for joining streamed chunks of an image volume. Only necessary for streaming applications.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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

Reimplemented from itk::LightObject.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::DescendFlatRegions	(	flat_region_table_t &	,
		ImageRegionType
	)			`[protected]`

Associates each flat region with a local minimum and relabels accordingly.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * ) [inline, virtual, inherited]

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.

Definition at line 225 of file itkProcessObject.h.

template<class TInputImage>

virtual void itk::watershed::Segmenter< TInputImage >::GenerateConnectivity ( ) [protected, virtual]

Constructs the connectivity list and the corresponding set of directional Offset indicies.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::GenerateData ( ) [virtual]

Standard non-threaded pipeline execution method.

Reimplemented from itk::ProcessObject.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::GenerateInputRequestedRegion ( ) [protected, virtual]

This method asks for an image region that is one pixel larger at each boundary than the region being processed. This single pixel expansion represents an overlap with adjacent image chunks

Reimplemented from itk::ProcessObject.

virtual void itk::ProcessObject::GenerateOutputInformation ( ) [protected, virtual, inherited]

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::GenerateOutputRequestedRegion ( DataObject * output ) [protected, virtual]

This method asks for an image region that is one pixel larger at each boundary than the region being processed. This single pixel expansion represents an overlap with adjacent image chunks

Reimplemented from itk::ProcessObject.

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

template<class TInputImage>

BoundaryType* itk::watershed::Segmenter< TInputImage >::GetBoundary ( void ) [inline]

Returns the boundary information data necessary only for data streaming applications.

Definition at line 168 of file itkWatershedSegmenter.h.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

template<class TInputImage>

virtual unsigned long itk::watershed::Segmenter< TInputImage >::GetCurrentLabel ( ) const [virtual]

Gets/Sets the initial label (unsigned long integer value) used by the labeling algorithm. Only necessary for streaming applications.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

template<class TInputImage>

virtual bool itk::watershed::Segmenter< TInputImage >::GetDoBoundaryAnalysis ( ) const [virtual]

Turns on special labeling of the boundaries for streaming applications. The default value is FALSE, meaning that boundary analysis is turned off.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) [protected, inherited]

Method used internally for getting an input.

const DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) const [protected, inherited]

Method used internally for getting an input.

Reimplemented in itk::MeshToMeshFilter< TInputMesh, TOutputMesh >, and itk::MeshToMeshFilter< TInput, TOutput >.

template<class TInputImage>

InputImageType* itk::watershed::Segmenter< TInputImage >::GetInputImage ( void ) [inline]

Get/Set the input image.

Definition at line 135 of file itkWatershedSegmenter.h.

DataObjectPointerArray& itk::ProcessObject::GetInputs ( ) [inline, inherited]

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

Definition at line 108 of file itkProcessObject.h.

template<class TInputImage>

ImageRegionType itk::watershed::Segmenter< TInputImage >::GetLargestPossibleRegion ( ) const [inline]

This method is necessary until the streaming mechanisms of the Itk pipeline are full fleshed out. It is only used for streaming applications. Calling this method gets/sets the image size of the complete volume being streamed. The member variables controlled by this method will not be modified by the Itk pipeline and are necessary for analysis of boundaries.

Definition at line 192 of file itkWatershedSegmenter.h.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

MultiThreader* itk::ProcessObject::GetMultiThreader ( ) [inline, inherited]

Return the multithreader used by this class.

Definition at line 284 of file itkProcessObject.h.

template<class TInputImage>

virtual const char* itk::watershed::Segmenter< TInputImage >::GetNameOfClass ( ) const [virtual]

Methods to implement smart pointers and work with the itk object factory

Reimplemented from itk::ProcessObject.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const [inline, inherited]

Get the size of the input vector. This is merely the size of the input vector, not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null.

Definition at line 118 of file itkProcessObject.h.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const [inline, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 135 of file itkProcessObject.h.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( ) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( ) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

virtual const int& itk::ProcessObject::GetNumberOfThreads ( ) [virtual, inherited]

Get/Set the number of threads to create when executing.

Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SplitRequestedRegion().

virtual DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const [virtual, inherited]

Get the number of valid inputs. This is the number of non-null entries in the input vector in the first NumberOfRequiredInputs slots. This method is used to determine whether the necessary required inputs have been set. Subclasses of ProcessObject may override this implementation if the required inputs are not the first slots in input vector.

Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField, TRealType >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

DataObject* itk::ProcessObject::GetOutput ( unsigned int idx ) [protected, inherited]

Method used internally for getting an output.

Referenced by itk::watershed::Segmenter< InputImageType >::GetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::GetEquivalencyTable(), itk::TwoOutputExampleImageFilter< TImage >::GetInverseOutput(), itk::watershed::Segmenter< InputImageType >::GetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::GetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GetOutputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::GetOutputSegmentTree(), and itk::watershed::Segmenter< InputImageType >::GetSegmentTable().

const DataObject* itk::ProcessObject::GetOutput ( unsigned int idx ) const [protected, inherited]

Method used internally for getting an output.

template<class TInputImage>

OutputImageType* itk::watershed::Segmenter< TInputImage >::GetOutputImage ( void ) [inline]

Get/Set the labeled output image. The output image is always of unsigned long integers.

Definition at line 146 of file itkWatershedSegmenter.h.

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( ) [inline, inherited]

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 133 of file itkProcessObject.h.

virtual const float& itk::ProcessObject::GetProgress ( ) [virtual, inherited]

Get the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution.

Referenced by itk::XMLFilterWatcher::ShowProgress().

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

virtual bool itk::ProcessObject::GetReleaseDataFlag ( ) const [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

template<class TInputImage>

SegmentTableType* itk::watershed::Segmenter< TInputImage >::GetSegmentTable ( void ) [inline]

Get/Set the segment table. The segment table is a table of segmentation information identifying each region produced by the labeling algorithm.

Definition at line 157 of file itkWatershedSegmenter.h.

template<class TInputImage>

virtual bool itk::watershed::Segmenter< TInputImage >::GetSortEdgeLists ( ) const [virtual]

Determines whether the algorithm will sort the adjacencies in its SegmentTable before returning. Default is true. This is an option only useful for streaming applications where the sorting only needs to be done after all iterations have taken place.

template<class TInputImage>

virtual double itk::watershed::Segmenter< TInputImage >::GetThreshold ( ) const [virtual]

Gets/Sets the input threshold. 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 $ L = min + T * (max - min) $ , where $ max, min $ are the maximum, minimum values in the image and $ T $ is the threshold parameter value. Values in the image less than $ L $ are raised to $ L $ . 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.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::GradientDescent	(	InputImageTypePointer	,
		ImageRegionType
	)			`[protected]`

Follows each unlabeled pixel in the image down its path of steepest descent. Each pixel along that path is identified with the local minima already labeled at the end of the path.

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::InitializeBoundary ( ) [protected]

Allocates boundary structure information and sets the boundary data to null values.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::LabelMinima	(	InputImageTypePointer	,
		ImageRegionType	,
		flat_region_table_t &	,
		InputPixelType
	)			`[protected]`

Labels all the local minima in the image. Also identifies and labels connected ``flat'' regions.

template<class TInputImage>

virtual DataObjectPointer itk::watershed::Segmenter< TInputImage >::MakeOutput ( unsigned int idx ) [virtual]

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

template<class TInputImage>

static void itk::watershed::Segmenter< TInputImage >::MergeFlatRegions	(	flat_region_table_t &	,
		EquivalencyTable::Pointer
	)			`[static, protected]`

Helper function. Finds the minimum and maximum values in an image.

template<class TInputImage>

static void itk::watershed::Segmenter< TInputImage >::MinMax	(	InputImageTypePointer	img,
		ImageRegionType	region,
		InputPixelType &	min,
		InputPixelType &	max
	)			`[static, protected]`

Helper function. Finds the minimum and maximum values in an image.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TInputImage>

static Pointer itk::watershed::Segmenter< TInputImage >::New ( ) [static]

Methods to implement smart pointers and work with the itk object factory

Reimplemented from itk::Object.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::operator= ( const Self & ) [inline, protected]

Definition at line 278 of file itkWatershedSegmenter.h.

virtual void itk::ProcessObject::PopBackInput ( ) [protected, virtual, inherited]

Push/Pop an input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

virtual void itk::ProcessObject::PopFrontInput ( ) [protected, virtual, inherited]

Push/Pop an input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

virtual void itk::ProcessObject::PrepareOutputs ( ) [virtual, inherited]

An opportunity to deallocate a ProcessObject's bulk data storage. Some filters may wish to reuse existing bulk data storage to avoid unnecessary deallocation/allocation sequences. The default implementation calls Initialize() on each output. DataObject::Initialize() frees its bulk data by default.

Reimplemented in itk::WatershedImageFilter< TInputImage >.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, 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::ProcessObject.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

virtual void itk::ProcessObject::PropagateRequestedRegion ( DataObject * output ) [virtual, inherited]

Send the requested region information back up the pipeline (to the filters that preceed this one).

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >, and itk::VTKImageImport< TOutputImage >.

virtual void itk::ProcessObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

Called to allocate the input array. Copies old inputs. Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

virtual void itk::ProcessObject::PushBackInput ( const DataObject * input ) [protected, virtual, inherited]

Push/Pop an input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

virtual void itk::ProcessObject::PushFrontInput ( const DataObject * input ) [protected, virtual, inherited]

Push/Pop an input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

template<class TInputImage>

static void itk::watershed::Segmenter< TInputImage >::RelabelImage	(	OutputImageTypePointer	,
		ImageRegionType	,
		EquivalencyTable::Pointer
	)			`[static]`

Helper function. Other classes may have occasion to use this. Relabels an image according to a table of equivalencies.

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOff ( ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

void itk::ProcessObject::ReleaseDataFlagOff ( ) [inline, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

Definition at line 257 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( ) [inline, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

Definition at line 256 of file itkProcessObject.h.

virtual void itk::ProcessObject::ReleaseInputs ( ) [protected, virtual, inherited]

A filter may need to release its input's bulk data after it has finished calculating a new output. The filter may need to release the inputs because the user has turned on the ReleaseDataFlag or it may need to release the inputs because the filter is an "in place" filter and it has overwritten its input with its output data. The implementation here simply checks the ReleaseDataFlag of the inputs. InPlaceImageFilter overrides this method so release the input it has overwritten.

See also:: InPlaceImageFilter::ReleaseInputs()

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

virtual void itk::ProcessObject::RemoveInput ( DataObject * input ) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

virtual void itk::ProcessObject::RemoveOutput ( DataObject * output ) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

virtual void itk::ProcessObject::ResetPipeline ( ) [virtual, inherited]

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

virtual void itk::ProcessObject::RestoreInputReleaseDataFlags ( ) [protected, virtual, inherited]

Restore the cached input ReleaseDataFlags.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::SetBoundary ( BoundaryType * b ) [inline]

Returns the boundary information data necessary only for data streaming applications.

Definition at line 173 of file itkWatershedSegmenter.h.

template<class TInputImage>

virtual void itk::watershed::Segmenter< TInputImage >::SetCurrentLabel ( unsigned long _arg ) [virtual]

Gets/Sets the initial label (unsigned long integer value) used by the labeling algorithm. Only necessary for streaming applications.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<class TInputImage>

virtual void itk::watershed::Segmenter< TInputImage >::SetDoBoundaryAnalysis ( bool _arg ) [virtual]

Turns on special labeling of the boundaries for streaming applications. The default value is FALSE, meaning that boundary analysis is turned off.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::SetInputImage ( InputImageType * img ) [inline]

Get/Set the input image.

Definition at line 140 of file itkWatershedSegmenter.h.

template<class TInputImage>

static void itk::watershed::Segmenter< TInputImage >::SetInputImageValues	(	InputImageTypePointer	img,
		const ImageRegionType	region,
		InputPixelType	value
	)			`[static, protected]`

Helper functions for filling in regions with values

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::SetLargestPossibleRegion ( ImageRegionType reg ) [inline]

This method is necessary until the streaming mechanisms of the Itk pipeline are full fleshed out. It is only used for streaming applications. Calling this method gets/sets the image size of the complete volume being streamed. The member variables controlled by this method will not be modified by the Itk pipeline and are necessary for analysis of boundaries.

Definition at line 186 of file itkWatershedSegmenter.h.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

virtual void itk::ProcessObject::SetNthInput	(	unsigned int	num,
		DataObject *	input
	)			`[protected, virtual, inherited]`

Protected methods for setting inputs. Subclasses make use of them for setting input.

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryA(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryB(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetEquivalencyTable(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetFeatureImage(), itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetFeatureImage(), itk::WatershedImageFilter< TInputImage >::SetInput(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetInputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetInputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputSegmentTable(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputSegmentTree(), itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType >::SetReferenceImage(), and itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage().

virtual void itk::ProcessObject::SetNthOutput	(	unsigned int	num,
		DataObject *	output
	)			`[protected, virtual, inherited]`

Protected methods for setting outputs. Subclasses make use of them for getting output.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalenceRelabeler(), itk::watershed::Segmenter< InputImageType >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), and itk::watershed::Segmenter< InputImageType >::SetSegmentTable().

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num ) [protected, inherited]

Called to allocate the input array. Copies old inputs.

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num ) [protected, inherited]

Called to allocate the output array. Copies old outputs.

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg ) [protected, virtual, inherited]

Protected methods for setting inputs. Subclasses make use of them for setting input.

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg ) [protected, virtual, inherited]

Protected methods for setting outputs. Subclasses make use of them for getting output.

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg ) [virtual, inherited]

Get/Set the number of threads to create when executing.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::SetOutputImage ( OutputImageType * img ) [inline]

Get/Set the labeled output image. The output image is always of unsigned long integers.

Definition at line 151 of file itkWatershedSegmenter.h.

template<class TInputImage>

static void itk::watershed::Segmenter< TInputImage >::SetOutputImageValues	(	OutputImageTypePointer	img,
		const ImageRegionType	region,
		unsigned long	value
	)			`[static, protected]`

virtual void itk::ProcessObject::SetProgress ( float _arg ) [virtual, inherited]

Set the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. The ProgressEvent is NOT invoked.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

virtual void itk::ProcessObject::SetReleaseDataFlag ( bool flag ) [virtual, inherited]

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::SetSegmentTable ( SegmentTableType * s ) [inline]

Get/Set the segment table. The segment table is a table of segmentation information identifying each region produced by the labeling algorithm.

Definition at line 162 of file itkWatershedSegmenter.h.

template<class TInputImage>

virtual void itk::watershed::Segmenter< TInputImage >::SetSortEdgeLists ( bool _arg ) [virtual]

Determines whether the algorithm will sort the adjacencies in its SegmentTable before returning. Default is true. This is an option only useful for streaming applications where the sorting only needs to be done after all iterations have taken place.

template<class TInputImage>

virtual void itk::watershed::Segmenter< TInputImage >::SetThreshold ( double _arg ) [virtual]

Gets/Sets the input threshold. 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 $ L = min + T * (max - min) $ , where $ max, min $ are the maximum, minimum values in the image and $ T $ is the threshold parameter value. Values in the image less than $ L $ are raised to $ L $ . 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.

template<class TInputImage>

static void itk::watershed::Segmenter< TInputImage >::Threshold	(	InputImageTypePointer	destination,
		InputImageTypePointer	source,
		const ImageRegionType	source_region,
		const ImageRegionType	destination_region,
		InputPixelType	threshold
	)			`[static, protected]`

Helper function. Thresholds low values and copies values from one image into another. The source and destination regions must match in size (not enforced). For integral types, the dynamic range of the image is adjusted such that the maximum value in the image is always at least one less than the maximum value allowed for that data type.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::Update ( ) [virtual, inherited]

Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead.

Reimplemented in itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >, itk::MedialNodePairCorrespondenceProcess< TSourceImage >, itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >, itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >, itk::ImageFileWriter< TInputImage >, and itk::ImageSeriesWriter< TInputImage, TOutputImage >.

virtual void itk::ProcessObject::UpdateLargestPossibleRegion ( ) [virtual, inherited]

Like Update(), but sets the output requested region to the largest possible region for the output. This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update().

virtual void itk::ProcessObject::UpdateOutputData ( DataObject * output ) [virtual, inherited]

Actually generate new output

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::UpdateOutputInformation ( ) [protected, virtual]

This method asks for an image region that is one pixel larger at each boundary than the region being processed. This single pixel expansion represents an overlap with adjacent image chunks

Reimplemented from itk::ProcessObject.

void itk::ProcessObject::UpdateProgress ( float amount ) [inherited]

Update the progress of the process object.

Sets the Progress ivar to amount and invokes any observers for the ProgressEvent. The parameter amount should be in [0,1] and is the cumulative (not incremental) progress.

template<class TInputImage>

void itk::watershed::Segmenter< TInputImage >::UpdateSegmentTable	(	InputImageTypePointer	,
		ImageRegionType
	)			`[protected]`

Adds entries to the output segment table for all labeled segments in the image.

Member Data Documentation

template<class TInputImage>

const unsigned int itk::watershed::Segmenter< TInputImage >::ImageDimension = TInputImage::ImageDimension [static]

Definition at line 100 of file itkWatershedSegmenter.h.

template<class TInputImage>

connectivity_t itk::watershed::Segmenter< TInputImage >::m_Connectivity [protected]

This is a debugging method. Will be removed. 11/14/01 jc Holds generalized connectivity information for connected component labeling and gradient descent analysis in pixel neighborhoods.

Definition at line 367 of file itkWatershedSegmenter.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected, inherited]

Time when GenerateOutputInformation was last called.

Definition at line 431 of file itkProcessObject.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

bool itk::ProcessObject::m_Updating [protected, inherited]

These ivars are made protected so filters like itkStreamingImageFilter can access them directly. This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Definition at line 428 of file itkProcessObject.h.

template<class TInputImage>

short itk::watershed::Segmenter< TInputImage >::NULL_FLOW [static]

A constant used in the labeling algorithm.

Definition at line 132 of file itkWatershedSegmenter.h.

template<class TInputImage>

unsigned long itk::watershed::Segmenter< TInputImage >::NULL_LABEL [static]

A constant used in the labeling algorithm.

Definition at line 129 of file itkWatershedSegmenter.h.

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

itkWatershedSegmenter.h

itk::watershed::Segmenter< TInputImage > Class Template Reference [Watershed-based Segmentation Filters]

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::watershed::Segmenter< TInputImage > Class Template Reference
[Watershed-based Segmentation Filters]

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