ITK  4.4.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Attributes | List of all members
itk::watershed::SegmentTreeGenerator< TScalarType > Class Template Reference

#include <itkWatershedSegmentTreeGenerator.h>

+ Inheritance diagram for itk::watershed::SegmentTreeGenerator< TScalarType >:
+ Collaboration diagram for itk::watershed::SegmentTreeGenerator< TScalarType >:

Detailed Description

template<class TScalarType>
class itk::watershed::SegmentTreeGenerator< TScalarType >

This filter is a process object class that implements a step in the N-d watershed segmentation algorithm. It produces an ordered list (SegmentTree) of binary merges between segments at increasing saliency levels. This filter is used in conjunction with WatershedSegmenter and WatershedRelabeler to process an initial segmentation into a final relabeled volume. See itk::WatershedImageFilter for an overview of watershed segmentation.

Inputs
There are two inputs to this filter, the second is optional. (1) A table of segments (SegmentTable) derived from a labeled image. (2) Optionally, a table of predetermined equivalencies among segments (EquivalencyTable), necessary for streaming applications where segments may be joined across streamed chunk boundaries. The flag Merge must be set to true to enable this functionality.
Outputs
The output of this filter is a list of binary merges of segments at increasing saliency. This is the data structure itk::watershed::WatershedSegmentTree referred to as a ``merge tree'' in the itk::WatershedImageFilter documentation.
Parameters
There are two parameters to this filter described below.
FloodLevel is specified as a percentage (0.0 - 1.0) of the maximum possible saliency value in the initial image from which the segment table was derived. A value of 0.0 calculates no merges. A value of 1.0 calculates all of the potential merges that can occur as the FloodLevel is increased to the maximum saliency value. Typically, there is no need to calculate merges past about 40% of the total depth. Because this is the most computationally intensive piece of the watershed segmentation algorithm, it is a good idea to tune this parameter as low as possible on larger volumes.
Merge is a boolean flag indicating whether or not to pre-merge the segments marked as equivalent in the EquivalencyTable. This is only useful for streaming applications and is turned off by default. (TRUE == merge, FALSE == do not merge).
See Also
itk::WatershedImageFilter

Definition at line 78 of file itkWatershedSegmentTreeGenerator.h.

Public Types

typedef DataObject::Pointer DataObjectPointer
 
typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef EquivalencyTable EquivalencyTableType
 
typedef OneWayEquivalencyTable OneWayEquivalencyTableType
 
typedef
OneWayEquivalencyTableType::Pointer 
OneWayEquivalencyTableTypePointer
 
typedef TScalarType ScalarType
 
typedef SegmentTable< ScalarTypeSegmentTableType
 
typedef SegmentTableType::Pointer SegmentTableTypePointer
 
typedef SegmentTree< ScalarTypeSegmentTreeType
 
typedef SegmentTreeType::Pointer SegmentTreeTypePointer
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

void GenerateData ()
 
virtual double GetFloodLevel () const
 
EquivalencyTableTypeGetInputEquivalencyTable ()
 
SegmentTableTypeGetInputSegmentTable ()
 
SegmentTreeTypeGetOutputSegmentTree ()
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
void SetFloodLevel (double)
 
void SetInputEquivalencyTable (EquivalencyTableType *eq)
 
void SetInputSegmentTable (SegmentTableType *st)
 
virtual void SetMerge (bool _arg)
 
virtual bool GetMerge () const
 
virtual void SetHighestCalculatedFloodLevel (double _arg)
 
virtual double GetHighestCalculatedFloodLevel () const
 
virtual void SetConsumeInput (bool _arg)
 
virtual bool GetConsumeInput () const
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData ()
 
NameArray GetInputNames () const
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
virtual const float & GetProgress ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetProgress (float _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float amount)
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArray GetOutputs ()
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () 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 (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static void MergeSegments (SegmentTableTypePointer, OneWayEquivalencyTableTypePointer, const IdentifierType, const IdentifierType)
 
static void PruneMergeSegments (SegmentTableTypePointer, OneWayEquivalencyTableTypePointer, const IdentifierType, const IdentifierType, ScalarType)
 

Protected Member Functions

void CompileMergeList (SegmentTableTypePointer, SegmentTreeTypePointer)
 
void ExtractMergeHierarchy (SegmentTableTypePointer, SegmentTreeTypePointer)
 
void GenerateInputRequestedRegion ()
 
void GenerateOutputRequestedRegion (DataObject *output)
 
void MergeEquivalencies ()
 
void operator= (const Self &)
 
void PrintSelf (std::ostream &os, Indent indent) const
 
 SegmentTreeGenerator ()
 
 SegmentTreeGenerator (const Self &)
 
virtual ~SegmentTreeGenerator ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Types

typedef itksys::hash_map
< IdentifierType, bool,
itksys::hash< IdentifierType > > 
HashMapType
 

Private Attributes

bool m_ConsumeInput
 
double m_FloodLevel
 
double m_HighestCalculatedFloodLevel
 
bool m_Merge
 
OneWayEquivalencyTableType::Pointer m_MergedSegmentsTable
 
typedef SegmentTreeGenerator Self
 
typedef ProcessObject Superclass
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< const SelfConstPointer
 
static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 

Member Typedef Documentation

template<class TScalarType>
typedef SmartPointer< const Self > itk::watershed::SegmentTreeGenerator< TScalarType >::ConstPointer

Standard itk smart pointer declarations

Definition at line 86 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
typedef DataObject::Pointer itk::watershed::SegmentTreeGenerator< TScalarType >::DataObjectPointer

Definition at line 97 of file itkWatershedSegmentTreeGenerator.h.

Standard itk::ProcessObject subclass method.

Definition at line 194 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
typedef EquivalencyTable itk::watershed::SegmentTreeGenerator< TScalarType >::EquivalencyTableType

Definition at line 95 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
typedef itksys::hash_map< IdentifierType, bool, itksys::hash< IdentifierType > > itk::watershed::SegmentTreeGenerator< TScalarType >::HashMapType
private

Definition at line 226 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
typedef OneWayEquivalencyTable itk::watershed::SegmentTreeGenerator< TScalarType >::OneWayEquivalencyTableType

Definition at line 96 of file itkWatershedSegmentTreeGenerator.h.

Definition at line 101 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
typedef SmartPointer< Self > itk::watershed::SegmentTreeGenerator< TScalarType >::Pointer

Standard itk smart pointer declarations

Definition at line 85 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
typedef TScalarType itk::watershed::SegmentTreeGenerator< TScalarType >::ScalarType

Convenient type definitions

Definition at line 88 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
typedef SegmentTable< ScalarType > itk::watershed::SegmentTreeGenerator< TScalarType >::SegmentTableType

Definition at line 93 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
typedef SegmentTableType::Pointer itk::watershed::SegmentTreeGenerator< TScalarType >::SegmentTableTypePointer

Typedefs to avoid internal compiler error bug on Microsoft VC++

Definition at line 100 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
typedef SegmentTree< ScalarType > itk::watershed::SegmentTreeGenerator< TScalarType >::SegmentTreeType

Definition at line 94 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
typedef SegmentTreeType::Pointer itk::watershed::SegmentTreeGenerator< TScalarType >::SegmentTreeTypePointer

Definition at line 102 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
typedef SegmentTreeGenerator itk::watershed::SegmentTreeGenerator< TScalarType >::Self

Standard itk smart pointer declarations

Definition at line 83 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
typedef ProcessObject itk::watershed::SegmentTreeGenerator< TScalarType >::Superclass

Standard itk smart pointer declarations

Definition at line 84 of file itkWatershedSegmentTreeGenerator.h.

Constructor & Destructor Documentation

template<class TScalarType>
itk::watershed::SegmentTreeGenerator< TScalarType >::SegmentTreeGenerator ( )
protected
template<class TScalarType>
virtual itk::watershed::SegmentTreeGenerator< TScalarType >::~SegmentTreeGenerator ( )
inlineprotectedvirtual

Definition at line 200 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
itk::watershed::SegmentTreeGenerator< TScalarType >::SegmentTreeGenerator ( const Self )
inlineprotected

Definition at line 201 of file itkWatershedSegmentTreeGenerator.h.

Member Function Documentation

template<class TScalarType>
void itk::watershed::SegmentTreeGenerator< TScalarType >::CompileMergeList ( SegmentTableTypePointer  ,
SegmentTreeTypePointer   
)
protected

Generates an initial list of all potentential merges in the segment table.

template<class TScalarType>
virtual::itk::LightObject::Pointer itk::watershed::SegmentTreeGenerator< TScalarType >::CreateAnother ( void  ) const
virtual

Standard itk smart pointer declarations

Reimplemented from itk::Object.

template<class TScalarType>
void itk::watershed::SegmentTreeGenerator< TScalarType >::ExtractMergeHierarchy ( SegmentTableTypePointer  ,
SegmentTreeTypePointer   
)
protected

Compiles a list of all the actual segment merges up to the specified flood level, recomputing new potential merges as it goes.

template<class TScalarType>
void itk::watershed::SegmentTreeGenerator< TScalarType >::GenerateData ( )
virtual

Standard non-threaded itk pipeline method

Reimplemented from itk::ProcessObject.

template<class TScalarType>
void itk::watershed::SegmentTreeGenerator< TScalarType >::GenerateInputRequestedRegion ( )
protectedvirtual

What is the input requested region that is required to produce the output requested region? By default, the largest possible region is always required but this is overridden in many subclasses. For instance, for an image processing filter where an output pixel is a simple function of an input pixel, the input requested region will be set to the output requested region. For an image processing filter where an output pixel is a function of the pixels in a neighborhood of an input pixel, then the input requested region will need to be larger than the output requested region (to avoid introducing artificial boundary conditions). This function should never request an input region that is outside the the input largest possible region (i.e. implementations of this method should crop the input requested region at the boundaries of the input largest possible region).

Reimplemented from itk::ProcessObject.

template<class TScalarType>
void itk::watershed::SegmentTreeGenerator< TScalarType >::GenerateOutputRequestedRegion ( DataObject output)
protectedvirtual

Methods required by the itk pipeline

Reimplemented from itk::ProcessObject.

template<class TScalarType>
virtual bool itk::watershed::SegmentTreeGenerator< TScalarType >::GetConsumeInput ( ) const
virtual

Get/Set a flag that prevents the filter from copying its input segment table before executing. This can be enabled to conserve memory, especially in streaming applications where memory is a concern. If enabled, the input to this filter must always be re-executed on updates. Default is false.

template<class TScalarType>
virtual double itk::watershed::SegmentTreeGenerator< TScalarType >::GetFloodLevel ( ) const
virtual
template<class TScalarType>
virtual double itk::watershed::SegmentTreeGenerator< TScalarType >::GetHighestCalculatedFloodLevel ( ) const
virtual

Get/Set HighestCalculatedFloodLevel. HighestCalculatedFloodLevel keeps track of the highest level this filter has computed. It is used to prevent unnecessary re-execution of the filter.

template<class TScalarType>
EquivalencyTableType* itk::watershed::SegmentTreeGenerator< TScalarType >::GetInputEquivalencyTable ( )
inline

Definition at line 129 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
SegmentTableType* itk::watershed::SegmentTreeGenerator< TScalarType >::GetInputSegmentTable ( )
inline

Get/Set the input table of segments to process

Definition at line 105 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
virtual bool itk::watershed::SegmentTreeGenerator< TScalarType >::GetMerge ( ) const
virtual

Get/Set a boolean flag indicating whether or not to pre-merge the segments marked as equivalent in the EquivalencyTable. This is only useful for streaming applications and is turned off by default. (TRUE == merge, FALSE == do not merge).

template<class TScalarType>
virtual const char* itk::watershed::SegmentTreeGenerator< TScalarType >::GetNameOfClass ( ) const
virtual

Standard itk smart pointer declarations

Reimplemented from itk::ProcessObject.

template<class TScalarType>
SegmentTreeType* itk::watershed::SegmentTreeGenerator< TScalarType >::GetOutputSegmentTree ( )
inline

Get/Set the output data

Definition at line 136 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
virtual DataObjectPointer itk::watershed::SegmentTreeGenerator< TScalarType >::MakeOutput ( DataObjectPointerArraySizeType  idx)
virtual

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

template<class TScalarType>
void itk::watershed::SegmentTreeGenerator< TScalarType >::MergeEquivalencies ( )
protected
template<class TScalarType>
static void itk::watershed::SegmentTreeGenerator< TScalarType >::MergeSegments ( SegmentTableTypePointer  ,
OneWayEquivalencyTableTypePointer  ,
const IdentifierType  ,
const IdentifierType   
)
static

Performs a merge of two segments in a SegmentTable according to criteria specific to this algorithm.

template<class TScalarType>
static Pointer itk::watershed::SegmentTreeGenerator< TScalarType >::New ( )
static

Standard itk smart pointer declarations

template<class TScalarType>
void itk::watershed::SegmentTreeGenerator< TScalarType >::operator= ( const Self )
inlineprotected

Definition at line 202 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
void itk::watershed::SegmentTreeGenerator< TScalarType >::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.

Reimplemented from itk::ProcessObject.

template<class TScalarType>
static void itk::watershed::SegmentTreeGenerator< TScalarType >::PruneMergeSegments ( SegmentTableTypePointer  ,
OneWayEquivalencyTableTypePointer  ,
const IdentifierType  ,
const IdentifierType  ,
ScalarType   
)
static

This method should not be used. It will be removed in future versions of this filter.

template<class TScalarType>
virtual void itk::watershed::SegmentTreeGenerator< TScalarType >::SetConsumeInput ( bool  _arg)
virtual

Get/Set a flag that prevents the filter from copying its input segment table before executing. This can be enabled to conserve memory, especially in streaming applications where memory is a concern. If enabled, the input to this filter must always be re-executed on updates. Default is false.

template<class TScalarType>
void itk::watershed::SegmentTreeGenerator< TScalarType >::SetFloodLevel ( double  )

Get/Set FloodLevel. FloodLevel is specified as a percentage (0.0 - 1.0) of the maximum possible saliency value in the initial image from which the segment table was derived. A value of 0.0 calculates no merges. A value of 1.0 calculates all of the potential merges that can occur as the FloodLevel is increased to the maximum saliency value.

template<class TScalarType>
virtual void itk::watershed::SegmentTreeGenerator< TScalarType >::SetHighestCalculatedFloodLevel ( double  _arg)
virtual

Get/Set HighestCalculatedFloodLevel. HighestCalculatedFloodLevel keeps track of the highest level this filter has computed. It is used to prevent unnecessary re-execution of the filter.

template<class TScalarType>
void itk::watershed::SegmentTreeGenerator< TScalarType >::SetInputEquivalencyTable ( EquivalencyTableType eq)
inline

Get/Set input table of equivalencies to pre-merge before running the tree generator algorithm. Only useful for streaming applications

Definition at line 124 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
void itk::watershed::SegmentTreeGenerator< TScalarType >::SetInputSegmentTable ( SegmentTableType st)
inline

Definition at line 110 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
virtual void itk::watershed::SegmentTreeGenerator< TScalarType >::SetMerge ( bool  _arg)
virtual

Get/Set a boolean flag indicating whether or not to pre-merge the segments marked as equivalent in the EquivalencyTable. This is only useful for streaming applications and is turned off by default. (TRUE == merge, FALSE == do not merge).

Member Data Documentation

template<class TScalarType>
bool itk::watershed::SegmentTreeGenerator< TScalarType >::m_ConsumeInput
private

Definition at line 223 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
double itk::watershed::SegmentTreeGenerator< TScalarType >::m_FloodLevel
private

Definition at line 222 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
double itk::watershed::SegmentTreeGenerator< TScalarType >::m_HighestCalculatedFloodLevel
private

This value keeps track of the highest level this filter has been calculated. m_FloodLevel can be manipulated anywhere below this level without re-executing the filter, preventing unnecessary updates.

Definition at line 234 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
bool itk::watershed::SegmentTreeGenerator< TScalarType >::m_Merge
private

Definition at line 221 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>
OneWayEquivalencyTableType::Pointer itk::watershed::SegmentTreeGenerator< TScalarType >::m_MergedSegmentsTable
private

Definition at line 228 of file itkWatershedSegmentTreeGenerator.h.


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