#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 SmartPointer< const Self >	ConstPointer
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 SmartPointer< Self >	Pointer
typedef SegmentTable < InputPixelType >	SegmentTableType
typedef SegmentTableType::Pointer	SegmentTableTypePointer
typedef Segmenter	Self
typedef ProcessObject	Superclass

Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
void	GenerateData ()
virtual const bool &	GetAbortGenerateData ()
BoundaryType *	GetBoundary (void)
Command *	GetCommand (unsigned long tag)
virtual unsigned long	GetCurrentLabel () const
bool	GetDebug () const
virtual bool	GetDoBoundaryAnalysis () const
InputImageType *	GetInputImage (void)
DataObjectPointerArray &	GetInputs ()
ImageRegionType	GetLargestPossibleRegion () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual const int &	GetNumberOfThreads ()
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
OutputImageType *	GetOutputImage (void)
DataObjectPointerArray &	GetOutputs ()
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual bool	GetReleaseDataFlag () const
SegmentTableType *	GetSegmentTable (void)
virtual bool	GetSortEdgeLists () const
virtual double	GetThreshold () 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
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetBoundary (BoundaryType *b)
virtual void	SetCurrentLabel (unsigned long _arg)
void	SetDebug (bool debugFlag) const
virtual void	SetDoBoundaryAnalysis (bool _arg)
void	SetInputImage (InputImageType *img)
void	SetLargestPossibleRegion (ImageRegionType reg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetNumberOfThreads (int _arg)
void	SetOutputImage (OutputImageType *img)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual void	SetReleaseDataFlag (bool flag)
void	SetSegmentTable (SegmentTableType *s)
virtual void	SetSortEdgeLists (bool _arg)
virtual void	SetThreshold (double _arg)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
void	UpdateProgress (float amount)

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	RelabelImage (OutputImageTypePointer, ImageRegionType, EquivalencyTable::Pointer)
static void	SetGlobalWarningDisplay (bool flag)

Static Public Attributes
static const unsigned int	ImageDimension = TInputImage::ImageDimension
static const short	NULL_FLOW = -1
static const unsigned long	NULL_LABEL = 0

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
	Segmenter ()
	Segmenter (const Self &)
virtual	~Segmenter ()
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
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 ()
void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
void	GenerateOutputRequestedRegion (DataObject *output)
DataObject *	GetInput (unsigned int idx)
const DataObject *	GetInput (unsigned int idx) const
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
DataObject *	GetOutput (unsigned int idx)
const DataObject *	GetOutput (unsigned int idx) const
void	GradientDescent (InputImageTypePointer, ImageRegionType)
void	InitializeBoundary ()
void	LabelMinima (InputImageTypePointer, ImageRegionType, flat_region_table_t &, InputPixelType)
void	operator= (const Self &)
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
virtual void	ReleaseInputs ()
virtual void	RemoveInput (DataObject *input)
virtual void	RemoveOutput (DataObject *output)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	SetNthOutput (unsigned int num, DataObject *output)
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)
void	UpdateOutputInformation ()
void	UpdateSegmentTable (InputImageTypePointer, ImageRegionType)

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

Private Attributes
unsigned long	m_CurrentLabel
bool	m_DoBoundaryAnalysis
ImageRegionType	m_LargestPossibleRegion
double	m_MaximumFloodLevel
bool	m_SortEdgeLists
double	m_Threshold

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'' andvoxel'' 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 125 of file itkWatershedSegmenter.h.

template<class TInputImage>

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

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 262 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 segmentadjacency''.

Definition at line 259 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 245 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

protectedinherited

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

Definition at line 137 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 123 of file itkWatershedSegmenter.h.

template<class TInputImage>

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

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

Definition at line 1352 of file itkWatershedSegmenter.txx.

References itk::SmartPointer< TObjectType >::GetPointer(), and itk::ProcessObject::SetNthOutput().

template<class TInputImage>

itk::watershed::Segmenter< TInputImage >::Segmenter ( const Self & )

inlineprotected

Definition at line 265 of file itkWatershedSegmenter.h.

template<class TInputImage >

itk::watershed::Segmenter< TInputImage >::~Segmenter ( )

protectedvirtual

Definition at line 40 of file itkWatershedSegmenter.txx.

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff ( )

virtualinherited

virtual void itk::ProcessObject::AbortGenerateDataOn ( )

virtualinherited

Turn on and off the AbortGenerateData flag.

void itk::ProcessObject::AddInput ( DataObject * input )

protectedvirtualinherited

Adds an input to the first null position in the input list. Expands the list memory if necessary

Reimplemented in otb::ObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionPrecision, TCoordRep >, otb::DescriptorsListSampleGenerator< TInputImage, TVectorData, TListSample, TLabelListSample, TOutputPrecision, TCoordRep >, otb::PersistentDescriptorsListSampleGenerator< TInputImage, TVectorData, TFunctionType, TListSample, TLabelListSample >, and otb::PersistentObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionType >.

Definition at line 144 of file itkProcessObject.cxx.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

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

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::ProcessObject::AddOutput ( DataObject * output )

protectedvirtualinherited

Adds an output to the first null position in the output list. Expands the list memory if necessary

Definition at line 390 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::AnalyzeBoundaryFlow	(	InputImageTypePointer	thresholdImage,
		flat_region_table_t &	flatRegions,
		InputPixelType	max
	)

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.

Definition at line 427 of file itkWatershedSegmenter.txx.

References itk::watershed::Segmenter< TInputImage >::flat_region_t::bounds_min, itk::watershed::Boundary< TScalarType, TDimension >::face_pixel_t::flow, itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetIndex(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GoToBegin(), itk::watershed::Segmenter< TInputImage >::flat_region_t::is_on_boundary, itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IsAtEnd(), itk::watershed::Boundary< TScalarType, TDimension >::face_pixel_t::label, itk::watershed::Segmenter< TInputImage >::flat_region_t::min_label_ptr, itk::EquivalencyTable::New(), itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >::Size(), and itk::watershed::Segmenter< TInputImage >::flat_region_t::value.

void itk::LightObject::BreakOnError ( )

staticinherited

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

Definition at line 149 of file itkLightObject.cxx.

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::BuildRetainingWall	(	InputImageTypePointer	img,
		ImageRegionType	region,
		InputPixelType	value
	)

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.

Definition at line 1050 of file itkWatershedSegmenter.txx.

References itk::watershed::Segmenter< TInputImage >::SetInputImageValues().

void itk::ProcessObject::CacheInputReleaseDataFlags ( )

protectedvirtualinherited

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

Definition at line 1050 of file itkProcessObject.cxx.

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::CollectBoundaryInformation ( flat_region_table_t & flatRegions )

protected

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

Definition at line 328 of file itkWatershedSegmenter.txx.

References itk::ImageRegionIterator< TImage >::Begin(), itk::watershed::Boundary< TScalarType, TDimension >::flat_region_t::bounds_min, itk::hash_map< Key, T,,, >::end(), itk::hash_map< Key, T,,, >::find(), itk::ImageConstIterator< TImage >::Get(), itk::ImageConstIterator< TImage >::GetIndex(), itk::hash_map< Key, T,,, >::insert(), itk::ImageConstIterator< TImage >::IsAtEnd(), itk::watershed::Boundary< TScalarType, TDimension >::flat_region_t::min_label, itk::watershed::Boundary< TScalarType, TDimension >::flat_region_t::offset_list, itk::watershed::Boundary< TScalarType, TDimension >::flat_region_t::value, and itk::ImageRegionIterator< TImage >::Value().

template<class TInputImage>

virtual::itk::LightObject::Pointer itk::watershed::Segmenter< TInputImage >::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.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

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.

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

Definition at line 88 of file itkLightObject.cxx.

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::DescendFlatRegions	(	flat_region_table_t &	flatRegionTable,
		ImageRegionType	imageRegion
	)

protected

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

Definition at line 899 of file itkWatershedSegmenter.txx.

References itk::hash_map< Key, T,,, >::begin(), itk::hash_map< Key, T,,, >::end(), and itk::EquivalencyTable::New().

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * )

inlinevirtualinherited

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 224 of file itkProcessObject.h.

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::GenerateConnectivity ( )

protectedvirtual

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

Definition at line 625 of file itkWatershedSegmenter.txx.

References itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >::GetStride(), and itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >::Size().

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::GenerateData ( void )

virtual

Standard non-threaded pipeline execution method.

Reimplemented from itk::ProcessObject.

Definition at line 54 of file itkWatershedSegmenter.txx.

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::GenerateInputRequestedRegion ( void )

protectedvirtual

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.

Definition at line 1300 of file itkWatershedSegmenter.txx.

void itk::ProcessObject::GenerateOutputInformation ( void )

protectedvirtualinherited

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.

Default implementation - copy information from first input to all outputs

Examples:: Fusion/BayesianFusionImageFilter.cxx.

Definition at line 1095 of file itkProcessObject.cxx.

Referenced by main().

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::GenerateOutputRequestedRegion ( DataObject * output )

protectedvirtual

Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly.

Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type.

By default we set all the output requested regions to be the same.

Reimplemented from itk::ProcessObject.

Definition at line 1325 of file itkWatershedSegmenter.txx.

References itk::ImageBase< VImageDimension >::SetRequestedRegion().

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( )

virtualinherited

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

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

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

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

template<class TInputImage>

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

virtual

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

template<class TInputImage>

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

virtual

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

DataObject * itk::ProcessObject::GetInput ( unsigned int idx )

protectedinherited

Method used internally for getting an input.

Definition at line 470 of file itkProcessObject.cxx.

References NULL.

const DataObject * itk::ProcessObject::GetInput ( unsigned int idx ) const

protectedinherited

Reimplemented in otb::AngularProjectionSetImageFilter< TInputImage, TOutputImage, TAngleList, TPrecision >, otb::SparseUnmixingImageFilter< TInputImage, TOutputImage, VNbInputImage, TPrecision, TMotherWaveletOperator >, otb::AngularProjectionImageFilter< TInputImage, TOutputImage, TAngleArray, TPrecision >, otb::LabeledSampleLocalizationGenerator< TVectorData >, otb::ConcatenateVectorDataFilter< TVectorData >, itk::MeshToMeshFilter< TInputMesh, TOutputMesh >, and itk::MeshToMeshFilter< TInput, TOutput >.

Definition at line 482 of file itkProcessObject.cxx.

References NULL.

template<class TInputImage>

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

inline

Get/Set the input image.

Definition at line 134 of file itkWatershedSegmenter.h.

DataObjectPointerArray& itk::ProcessObject::GetInputs ( )

inlineinherited

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.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

template<class TInputImage>

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

inline

Definition at line 187 of file itkWatershedSegmenter.h.

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

MultiThreader* itk::ProcessObject::GetMultiThreader ( )

inlineinherited

Return the multithreader used by this class.

Definition at line 280 of file itkProcessObject.h.

template<class TInputImage>

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const

inlineinherited

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.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const

inlineinherited

Reimplemented in otb::ImageSeriesFileReaderBase< TImage, TInternalImage >, otb::ImageSeriesFileReaderBase< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >, otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >, and otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >.

Definition at line 135 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( )

protectedvirtualinherited

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( )

protectedvirtualinherited

virtual const int& itk::ProcessObject::GetNumberOfThreads ( )

virtualinherited

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

ProcessObject::DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const

virtualinherited

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.

Get the number of specified inputs

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

Definition at line 112 of file itkProcessObject.cxx.

DataObject * itk::ProcessObject::GetOutput ( unsigned int idx )

protectedinherited

Method used internally for getting an output.

Definition at line 442 of file itkProcessObject.cxx.

References NULL.

const DataObject * itk::ProcessObject::GetOutput ( unsigned int idx ) const

protectedinherited

Definition at line 454 of file itkProcessObject.cxx.

References NULL.

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 144 of file itkWatershedSegmenter.h.

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( )

inlineinherited

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.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

virtual const float& itk::ProcessObject::GetProgress ( )

virtualinherited

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::WatershedMiniPipelineProgressCommand::Execute(), otb::StreamingImageVirtualWriter< TInputImage >::ObserveSourceFilterProgress(), otb::ImageFileWriter< TInputImage >::ObserveSourceFilterProgress(), itk::LaplacianRecursiveGaussianImageFilter< TInputImage, TOutputImage >::ReportProgress(), and itk::XMLFilterWatcher::ShowProgress().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( )

virtualinherited

bool itk::ProcessObject::GetReleaseDataFlag ( ) const

virtualinherited

Definition at line 512 of file itkProcessObject.cxx.

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

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::GradientDescent	(	InputImageTypePointer	img,
		ImageRegionType	region
	)

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.

Definition at line 830 of file itkWatershedSegmenter.txx.

References itk::ImageRegionIterator< TImage >::Begin(), itk::ImageConstIterator< TImage >::Get(), itk::NeighborhoodIterator< TImage, TBoundaryCondition >::GetCenterPointer(), itk::ImageConstIterator< TImage >::GetIndex(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel(), itk::ImageConstIterator< TImage >::IsAtEnd(), and itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::SetLocation().

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::InitializeBoundary ( )

protected

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

Definition at line 400 of file itkWatershedSegmenter.txx.

References itk::ImageRegionIterator< TImage >::Begin(), itk::watershed::Boundary< TScalarType, TDimension >::face_pixel_t::flow, itk::ImageConstIterator< TImage >::IsAtEnd(), itk::watershed::Boundary< TScalarType, TDimension >::face_pixel_t::label, and itk::ImageRegionIterator< TImage >::Set().

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

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

Definition at line 457 of file itkObject.cxx.

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::LabelMinima	(	InputImageTypePointer	img,
		ImageRegionType	region,
		typename Self::flat_region_table_t &	flatRegions,
		InputPixelType	Max
	)

protected

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

Definition at line 678 of file itkWatershedSegmenter.txx.

References itk::watershed::Segmenter< TInputImage >::flat_region_t::bounds_min, itk::hash_map< Key, T,,, >::end(), itk::hash_map< Key, T,,, >::find(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GoToBegin(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IsAtEnd(), itk::watershed::Segmenter< TInputImage >::flat_region_t::min_label_ptr, itk::EquivalencyTable::New(), itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetPixel(), itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >::Size(), and itk::watershed::Segmenter< TInputImage >::flat_region_t::value.

template<class TInputImage >

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

virtual

Standard itk::ProcessObject subclass method.

Reimplemented from itk::ProcessObject.

Definition at line 1248 of file itkWatershedSegmenter.txx.

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::MergeFlatRegions	(	flat_region_table_t &	regions,
		EquivalencyTable::Pointer	eqTable
	)

staticprotected

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

Definition at line 1129 of file itkWatershedSegmenter.txx.

References itk::hash_map< Key, T,,, >::end(), itk::hash_map< Key, T,,, >::erase(), and itk::hash_map< Key, T,,, >::find().

template<class TInputImage >

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

staticprotected

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

Definition at line 1112 of file itkWatershedSegmenter.txx.

References itk::ImageRegionIterator< TImage >::Begin(), itk::ImageConstIterator< TImage >::Get(), itk::ImageConstIterator< TImage >::IsAtEnd(), and itk::ImageRegionIterator< TImage >::Value().

void itk::Object::Modified ( void ) const

virtualinherited

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

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

template<class TInputImage>

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

static

Method for creation through the object factory.

Reimplemented from itk::Object.

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

template<class TInputImage>

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

inlineprotected

Definition at line 268 of file itkWatershedSegmenter.h.

void itk::ProcessObject::PopBackInput ( )

protectedvirtualinherited

Model a stack on the input list by providing a pop back

Definition at line 245 of file itkProcessObject.cxx.

Referenced by otb::JointMassOfBeliefFilter< TMassFunction >::PopBackInput(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::PopBackInput().

void itk::ProcessObject::PopFrontInput ( )

protectedvirtualinherited

Definition at line 280 of file itkProcessObject.cxx.

Referenced by otb::JointMassOfBeliefFilter< TMassFunction >::PopFrontInput(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::PopFrontInput().

void itk::ProcessObject::PrepareOutputs ( )

virtualinherited

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 >, and otb::GeometriesSource.

Definition at line 864 of file itkProcessObject.cxx.

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

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

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

protectedinherited

Definition at line 478 of file itkObject.cxx.

template<class TInputImage >

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

protectedvirtual

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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::ProcessObject.

Definition at line 1382 of file itkWatershedSegmenter.txx.

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::ProcessObject::PropagateRequestedRegion ( DataObject * output )

virtualinherited

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

 check flag to avoid executing forever if there is a loop

 Give the subclass a chance to indicate that it will provide
 more data then required for the output. This can happen, for
 example, when a source can only produce the whole output.
 Although this is being called for a specific output, the source
 may need to enlarge all outputs.

 Give the subclass a chance to define how to set the requested
 regions for each of its outputs, given this output's requested
 region.  The default implementation is to make all the output
 requested regions the same.  A subclass may need to override this
 method if each output is a different resolution.

 Give the subclass a chance to request a larger requested region on 
 the inputs. This is necessary when, for example, a filter
 requires more data at the "internal" boundaries to 
 produce the boundary values - such as an image filter that
 derives a new pixel value by applying some operation to a 
 neighborhood of surrounding original values.

 Now that we know the input requested region, propagate this
 through all the inputs.

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

Definition at line 766 of file itkProcessObject.cxx.

void itk::ProcessObject::PropagateResetPipeline ( )

protectedvirtualinherited

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

Propagate the ResetPipeline call

Definition at line 631 of file itkProcessObject.cxx.

void itk::ProcessObject::PushBackInput ( const DataObject * input )

protectedvirtualinherited

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.

Model a queue on the input list by providing a push back

Definition at line 234 of file itkProcessObject.cxx.

Referenced by otb::OGRDataSourceToLabelImageFilter< TOutputImage >::AddOGRDataSource(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::AddVectorData(), otb::RasterizeVectorDataFilter< TVectorData, TInputImage, TOutputImage >::AddVectorData(), otb::JointMassOfBeliefFilter< TMassFunction >::PushBackInput(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::PushBackInput().

void itk::ProcessObject::PushFrontInput ( const DataObject * input )

protectedvirtualinherited

Definition at line 259 of file itkProcessObject.cxx.

Referenced by otb::JointMassOfBeliefFilter< TMassFunction >::PushFrontInput(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::PushFrontInput().

void itk::Object::Register ( ) const

virtualinherited

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

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::RelabelImage	(	OutputImageTypePointer	img,
		ImageRegionType	region,
		EquivalencyTable::Pointer	eqTable
	)

static

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

Definition at line 1161 of file itkWatershedSegmenter.txx.

References itk::ImageRegionIterator< TImage >::Begin(), itk::ImageConstIterator< TImage >::Get(), itk::ImageConstIterator< TImage >::IsAtEnd(), and itk::ImageRegionIterator< TImage >::Set().

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOff ( )

virtualinherited

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( )

virtualinherited

void itk::ProcessObject::ReleaseDataFlagOff ( )

inlineinherited

Definition at line 256 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( )

inlineinherited

Definition at line 255 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseInputs ( )

protectedvirtualinherited

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

Definition at line 886 of file itkProcessObject.cxx.

Referenced by itk::InPlaceImageFilter< TInputImage, TOutputImage >::ReleaseInputs(), and itk::InPlaceLabelMapFilter< TInputImage >::ReleaseInputs().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::ProcessObject::RemoveInput ( DataObject * input )

protectedvirtualinherited

Remove an input.

Removes the first occurence of the given OutputObject from the inputs to this ProcessObject. If it's the last object on the list, shortens the list.

Definition at line 173 of file itkProcessObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

void itk::ProcessObject::RemoveOutput ( DataObject * output )

protectedvirtualinherited

Definition at line 294 of file itkProcessObject.cxx.

void itk::ProcessObject::ResetPipeline ( )

virtualinherited

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.

Definition at line 621 of file itkProcessObject.cxx.

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

void itk::ProcessObject::RestoreInputReleaseDataFlags ( )

protectedvirtualinherited

Restore the cached input ReleaseDataFlags.

Definition at line 1075 of file itkProcessObject.cxx.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg )

virtualinherited

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

Definition at line 169 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.

Definition at line 275 of file itkObject.cxx.

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.

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

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

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

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

template<class TInputImage>

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

inline

Definition at line 139 of file itkWatershedSegmenter.h.

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::SetInputImageValues	(	InputImageTypePointer	img,
		const ImageRegionType	region,
		InputPixelType	value
	)

staticprotected

Helper functions for filling in regions with values

Definition at line 1081 of file itkWatershedSegmenter.txx.

References itk::ImageRegionIterator< TImage >::Begin(), itk::ImageConstIterator< TImage >::IsAtEnd(), and itk::ImageRegionIterator< TImage >::Set().

Referenced by itk::watershed::Segmenter< TInputImage >::BuildRetainingWall().

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 181 of file itkWatershedSegmenter.h.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns:: Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

void itk::ProcessObject::SetNthInput	(	unsigned int	idx,
		DataObject *	input
	)

protectedvirtualinherited

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

Set an Input of this filter. This method does Register()/UnRegister() manually to deal with the fact that smart pointers aren't around to do the reference counting.

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Definition at line 210 of file itkProcessObject.cxx.

void itk::ProcessObject::SetNthOutput	(	unsigned int	idx,
		DataObject *	output
	)

protectedvirtualinherited

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

Set an output of this filter. This method specifically does not do a Register()/UnRegister() because of the desire to break the reference counting loop.

Definition at line 333 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

Referenced by itk::AutomaticTopologyMeshSource< TOutputMesh >::AutomaticTopologyMeshSource(), itk::BalloonForceFilter< TInputMesh, TOutputMesh >::BalloonForceFilter(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver(), itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >::CoreAtomImageToDistanceMatrixProcess(), itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >::CoreAtomImageToUnaryCorrespondenceMatrixProcess(), itk::SimplexMeshToTriangleMeshFilter< TInputMesh, TOutputMesh >::CreateTriangles(), itk::DeformableMesh3DFilter< TInputMesh, TOutputMesh >::DeformableMesh3DFilter(), itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::DeformableSimplexMesh3DFilter(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalenceRelabeler(), itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >::ExtensionVelocitiesImageFilter(), itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >::FastMarchingExtensionImageFilter(), otb::FillGapsFilter::FillGapsFilter(), itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::ImageRegistrationMethod(), itk::ImageSource< TOutputImage >::ImageSource(), itk::Statistics::ImageToListGenerator< TImage, TMaskImage >::ImageToListGenerator(), itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter(), itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::ImageToSpatialObjectRegistrationMethod(), itk::SimplexMeshAdaptTopologyFilter< TInputMesh, TOutputMesh >::InsertNewCells(), otb::Statistics::ListSampleToBalancedListSampleFilter< TInputSampleList, TLabelSampleList, TOutputSampleList >::ListSampleToBalancedListSampleFilter(), otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::MeanShiftSmoothingImageFilter(), itk::MedialNodePairCorrespondenceProcess< TSourceImage >::MedialNodePairCorrespondenceProcess(), itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >::MedialNodeTripletCorrespondenceProcess(), itk::MeshSource< TOutputMesh >::MeshSource(), itk::MinimumMaximumImageFilter< TInputImage >::MinimumMaximumImageFilter(), otb::MinMaxAttributesLabelMapFilter< TInputImage >::MinMaxAttributesLabelMapFilter(), itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::MultiResolutionImageRegistrationMethod(), itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >::MultiScaleHessianBasedMeasureImageFilter(), itk::PathSource< TOutputPath >::PathSource(), otb::PersistentCompareImageFilter< TInputImage >::PersistentCompareImageFilter(), otb::PersistentDescriptorsListSampleGenerator< TInputImage, TVectorData, TFunctionType, TListSample, TLabelListSample >::PersistentDescriptorsListSampleGenerator(), otb::PersistentHistogramVectorImageFilter< TInputImage >::PersistentHistogramVectorImageFilter(), otb::PersistentInnerProductVectorImageFilter< TInputImage >::PersistentInnerProductVectorImageFilter(), otb::PersistentMatrixTransposeMatrixImageFilter< TInputImage, TInputImage2 >::PersistentMatrixTransposeMatrixImageFilter(), otb::PersistentMinMaxImageFilter< TInputImage >::PersistentMinMaxImageFilter(), otb::PersistentMinMaxVectorImageFilter< TInputImage >::PersistentMinMaxVectorImageFilter(), otb::PersistentObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionType >::PersistentObjectDetectionClassifier(), otb::PersistentStatisticsImageFilter< TInputImage >::PersistentStatisticsImageFilter(), otb::PersistentStreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::PersistentStreamingStatisticsMapFromLabelImageFilter(), otb::PersistentStreamingStatisticsVectorImageFilter< TInputImage, TPrecision >::PersistentStreamingStatisticsVectorImageFilter(), otb::PersistentVectorImageToMatrixFilter< TInputImage >::PersistentVectorImageToMatrixFilter(), itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >::PointSetToImageRegistrationMethod(), itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >::PointSetToPointSetRegistrationMethod(), otb::ProspectModel::ProspectModel(), itk::RegularSphereMeshSource< TOutputMesh >::RegularSphereMeshSource(), itk::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler(), otb::SailModel::SailModel(), itk::watershed::Segmenter< TInputImage >::Segmenter(), itk::watershed::SegmentTreeGenerator< TScalarType >::SegmentTreeGenerator(), itk::watershed::Segmenter< InputImageType >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::MeshSource< TOutputMesh >::SetOutput(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::Segmenter< InputImageType >::SetOutputImage(), itk::watershed::Segmenter< InputImageType >::SetSegmentTable(), itk::SimplexMeshAdaptTopologyFilter< TInputMesh, TOutputMesh >::SimplexMeshAdaptTopologyFilter(), itk::SphereMeshSource< TOutputMesh >::SphereMeshSource(), itk::StatisticsImageFilter< TInputImage >::StatisticsImageFilter(), itk::TriangleMeshToSimplexMeshFilter< TInputMesh, TOutputMesh >::TriangleMeshToSimplexMeshFilter(), itk::TwoOutputExampleImageFilter< TImage >::TwoOutputExampleImageFilter(), itk::VTKPolyDataReader< TOutputMesh >::VTKPolyDataReader(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num )

protectedinherited

Called to allocate the input array. Copies old inputs.

Called by constructor to set up input array.

Definition at line 96 of file itkProcessObject.cxx.

Referenced by otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num )

protectedinherited

Called to allocate the output array. Copies old outputs.

Called by constructor to set up output array.

Definition at line 424 of file itkProcessObject.cxx.

Referenced by otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::MeanShiftSmoothingImageFilter(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg )

protectedvirtualinherited

Referenced by itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::DeformableSimplexMesh3DFilter(), itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >::ExtensionVelocitiesImageFilter(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::FastMarchingImageFilter(), otb::FillGapsFilter::FillGapsFilter(), otb::ImageToLabelMapWithAttributesFilter< TInputImage, TLabeledImage, TLabel, TLabelObject >::ImageToLabelMapWithAttributesFilter(), itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter(), itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::PasteImageFilter(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg )

protectedvirtualinherited

Referenced by itk::AutomaticTopologyMeshSource< TOutputMesh >::AutomaticTopologyMeshSource(), itk::BalloonForceFilter< TInputMesh, TOutputMesh >::BalloonForceFilter(), itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >::CoreAtomImageToDistanceMatrixProcess(), itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >::CoreAtomImageToUnaryCorrespondenceMatrixProcess(), itk::DeformableMesh3DFilter< TInputMesh, TOutputMesh >::DeformableMesh3DFilter(), itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::DeformableSimplexMesh3DFilter(), itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >::ExtensionVelocitiesImageFilter(), itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >::FastMarchingExtensionImageFilter(), otb::FillGapsFilter::FillGapsFilter(), otb::GeometriesSource::GeometriesSource(), itk::ImageSource< TOutputImage >::ImageSource(), itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter(), itk::MedialNodePairCorrespondenceProcess< TSourceImage >::MedialNodePairCorrespondenceProcess(), itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >::MedialNodeTripletCorrespondenceProcess(), itk::MeshSource< TOutputMesh >::MeshSource(), itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >::MultiScaleHessianBasedMeasureImageFilter(), otb::OSMDataToVectorDataGenerator::OSMDataToVectorDataGenerator(), itk::PathSource< TOutputPath >::PathSource(), itk::RegularSphereMeshSource< TOutputMesh >::RegularSphereMeshSource(), itk::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler(), itk::SimplexMeshAdaptTopologyFilter< TInputMesh, TOutputMesh >::SimplexMeshAdaptTopologyFilter(), itk::SphereMeshSource< TOutputMesh >::SphereMeshSource(), itk::TriangleMeshToSimplexMeshFilter< TInputMesh, TOutputMesh >::TriangleMeshToSimplexMeshFilter(), itk::TwoOutputExampleImageFilter< TImage >::TwoOutputExampleImageFilter(), and itk::VTKPolyDataReader< TOutputMesh >::VTKPolyDataReader().

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg )

virtualinherited

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

Referenced by itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivative(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivativePos(), and itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PrecalculateChange().

template<class TInputImage>

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

inline

Definition at line 149 of file itkWatershedSegmenter.h.

template<class TInputImage >

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

staticprotected

Definition at line 1097 of file itkWatershedSegmenter.txx.

References itk::ImageRegionIterator< TImage >::Begin(), itk::ImageConstIterator< TImage >::IsAtEnd(), and itk::ImageRegionIterator< TImage >::Set().

virtual void itk::ProcessObject::SetProgress ( float _arg )

virtualinherited

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.

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg )

virtualinherited

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::SetReleaseDataFlag ( bool flag )

virtualinherited

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 528 of file itkProcessObject.cxx.

template<class TInputImage>

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

inline

Definition at line 159 of file itkWatershedSegmenter.h.

template<class TInputImage>

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

virtual

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 >

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

staticprotected

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.

Definition at line 1181 of file itkWatershedSegmenter.txx.

References itk::ImageRegionIterator< TImage >::Begin(), itk::ImageConstIterator< TImage >::Get(), itk::ImageConstIterator< TImage >::IsAtEnd(), and itk::ImageRegionIterator< TImage >::Set().

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

void itk::ProcessObject::Update ( void )

virtualinherited

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.

The following methods are used to coordinate the execution of the data processing pipeline.

Definition at line 611 of file itkProcessObject.cxx.

Referenced by otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), itk::AutoCropLabelMapFilter< TInputImage >::GenerateOutputInformation(), itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation(), and itk::VoronoiSegmentationImageFilterBase< TInputImage, TOutputImage, TBinaryPriorImage >::RunSegmentOneStep().

void itk::ProcessObject::UpdateLargestPossibleRegion ( )

virtualinherited

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

Definition at line 1120 of file itkProcessObject.cxx.

void itk::ProcessObject::UpdateOutputData ( DataObject * output )

virtualinherited

Actually generate new output

 prevent chasing our tail

 Prepare all the outputs. This may deallocate previous bulk data.

 Propagate the update call - make sure everything we
 might rely on is up-to-date
 Must call PropagateRequestedRegion before UpdateOutputData if multiple 
 inputs since they may lead back to the same data object.

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

 Tell all Observers that the filter is starting

 GenerateData this object - we have not aborted yet, and our progress
 before we start to execute is 0.0.

 Count the number of required inputs which have been assigned

 If we ended due to aborting, push the progress up to 1.0 (since
 it probably didn't end there)

 Notify end event observers

 Now we have to mark the data as up to date.

 Restore the state of any input ReleaseDataFlags

 Release any inputs if marked for release

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

Definition at line 908 of file itkProcessObject.cxx.

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::UpdateOutputInformation ( void )

protectedvirtual

Update the information decribing the output data. This method transverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

 Watch out for loops in the pipeline

   Since we are in a loop, we will want to update. But if
   we don't modify this filter, then we will not execute
   because our OutputInformationMTime will be more recent than
   the MTime of our output.

 We now wish to set the PipelineMTime of each output DataObject to
 the largest of this ProcessObject's MTime, all input DataObject's
 PipelineMTime, and all input's MTime.  We begin with the MTime of
 this ProcessObject.

 Loop through the inputs

     Propagate the UpdateOutputInformation call

     What is the PipelineMTime of this input? Compare this against
     our current computation to find the largest one.

     Pipeline MTime of the input does not include the MTime of the 
     data object itself. Factor these mtimes into the next PipelineMTime

 Call GenerateOutputInformation for subclass specific information.
 Since UpdateOutputInformation propagates all the way up the pipeline,
 we need to be careful here to call GenerateOutputInformation only if
 necessary. Otherwise, we may cause this source to be modified which
 will cause it to execute again on the next update.

   Keep track of the last time GenerateOutputInformation() was called

Reimplemented from itk::ProcessObject.

Definition at line 1262 of file itkWatershedSegmenter.txx.

References itk::Index< VIndexDimension >::SetIndex().

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.

Update the progress of the process object. If a ProgressMethod exists, execute it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

Definition at line 500 of file itkProcessObject.cxx.

Referenced by itk::WatershedMiniPipelineProgressCommand::Execute(), itk::ProgressReporter::ProgressReporter(), and itk::ProgressReporter::~ProgressReporter().

template<class TInputImage >

void itk::watershed::Segmenter< TInputImage >::UpdateSegmentTable	(	InputImageTypePointer	input,
		ImageRegionType	region
	)

protected

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

Definition at line 927 of file itkWatershedSegmenter.txx.

References itk::hash_map< Key, T,,, >::begin(), itk::watershed::SegmentTable< TScalarType >::segment_t::edge_list, itk::hash_map< Key, T,,, >::end(), itk::hash_map< Key, T,,, >::find(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPixel(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GoToBegin(), itk::hash_map< Key, T,,, >::insert(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::IsAtEnd(), itk::watershed::SegmentTable< TScalarType >::segment_t::min, itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >::Size(), and itk::value_type().

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 356 of file itkWatershedSegmenter.h.

template<class TInputImage>

unsigned long itk::watershed::Segmenter< TInputImage >::m_CurrentLabel

private

Definition at line 371 of file itkWatershedSegmenter.h.

template<class TInputImage>

bool itk::watershed::Segmenter< TInputImage >::m_DoBoundaryAnalysis

private

Definition at line 368 of file itkWatershedSegmenter.h.

template<class TInputImage>

ImageRegionType itk::watershed::Segmenter< TInputImage >::m_LargestPossibleRegion

private

Helper, debug method. This is the actual data set size. The pipeline will alter its LargestPossibleRegion, so we need to preserve it here explicitly for streaming applications

Definition at line 365 of file itkWatershedSegmenter.h.

template<class TInputImage>

double itk::watershed::Segmenter< TInputImage >::m_MaximumFloodLevel

private

Definition at line 370 of file itkWatershedSegmenter.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime

protectedinherited

Time when GenerateOutputInformation was last called.

Definition at line 421 of file itkProcessObject.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

template<class TInputImage>

bool itk::watershed::Segmenter< TInputImage >::m_SortEdgeLists

private

Definition at line 367 of file itkWatershedSegmenter.h.

template<class TInputImage>

double itk::watershed::Segmenter< TInputImage >::m_Threshold

private

Definition at line 369 of file itkWatershedSegmenter.h.

bool itk::ProcessObject::m_Updating

protectedinherited

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.

Reimplemented in otb::ImageViewerBase< TPixel, TLabel >, and otb::HistogramAndTransferFunctionWidget< THistogram, TPixel >.

Definition at line 418 of file itkProcessObject.h.

template<class TInputImage>

const short itk::watershed::Segmenter< TInputImage >::NULL_FLOW = -1

static

A constant used in the labeling algorithm.

Definition at line 131 of file itkWatershedSegmenter.h.

template<class TInputImage>

const unsigned long itk::watershed::Segmenter< TInputImage >::NULL_LABEL = 0

static

A constant used in the labeling algorithm.

Definition at line 128 of file itkWatershedSegmenter.h.

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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