ITK: itk::watershed::SegmentTreeGenerator< TScalarType

template<class TScalarType>

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

Reimplemented from itk::ProcessObject.

Definition at line 85 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>

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

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Definition at line 96 of file itkWatershedSegmentTreeGenerator.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 TScalarType>

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

Definition at line 94 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>

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

Definition at line 95 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>

typedef OneWayEquivalencyTableType::Pointer itk::watershed::SegmentTreeGenerator< TScalarType >::OneWayEquivalencyTableTypePointer

Definition at line 101 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>

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

Reimplemented from itk::ProcessObject.

Definition at line 84 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>

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

Convenient type definitions

Definition at line 87 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>

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

Definition at line 92 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 99 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>

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

Definition at line 93 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

Reimplemented from itk::ProcessObject.

Definition at line 82 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>

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

Reimplemented from itk::ProcessObject.

Definition at line 83 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>

itk::watershed::SegmentTreeGenerator< TScalarType >::SegmentTreeGenerator ( ) [protected]

template<class TScalarType>

virtual itk::watershed::SegmentTreeGenerator< TScalarType >::~SegmentTreeGenerator ( ) [inline, protected, virtual]

Definition at line 197 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>

itk::watershed::SegmentTreeGenerator< TScalarType >::SegmentTreeGenerator ( const Self & ) [inline, protected]

Definition at line 198 of file itkWatershedSegmentTreeGenerator.h.

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

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

Turn on and off the AbortGenerateData flag.

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

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

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

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

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

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

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

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

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

template<class TScalarType>

void itk::watershed::SegmentTreeGenerator< TScalarType >::CompileMergeList	(	SegmentTableTypePointer	,
		SegmentTreeTypePointer
	)			`[protected]`

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

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

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

Reimplemented from itk::LightObject.

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

Turn debugging output off.

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

Turn debugging output on.

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

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

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

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Definition at line 225 of file itkProcessObject.h.

template<class 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 ( ) [protected, virtual]

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.

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

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

template<class TScalarType>

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

Methods required by the itk pipeline

Reimplemented from itk::ProcessObject.

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

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

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

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

template<class TScalarType>

virtual bool itk::watershed::SegmentTreeGenerator< TScalarType >::GetConsumeInput ( ) [virtual]

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

Get the value of the debug flag.

template<class TScalarType>

virtual double itk::watershed::SegmentTreeGenerator< TScalarType >::GetFloodLevel ( ) [virtual]

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

template<class TScalarType>

virtual double itk::watershed::SegmentTreeGenerator< TScalarType >::GetHighestCalculatedFloodLevel ( ) [virtual]

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

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

Method used internally for getting an input.

Referenced by itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GetEquivalencyTable(), itk::watershed::SegmentTreeGenerator< InputImageType::PixelType >::GetInputEquivalencyTable(), itk::watershed::Segmenter< TInputImage >::GetInputImage(), itk::watershed::Relabeler< InputImageType::PixelType, itkGetStaticConstMacro(ImageDimension)>::GetInputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::GetInputImage(), itk::watershed::SegmentTreeGenerator< InputImageType::PixelType >::GetInputSegmentTable(), itk::watershed::Relabeler< InputImageType::PixelType, itkGetStaticConstMacro(ImageDimension)>::GetInputSegmentTree(), itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetLabelInput(), and itk::MorphologicalWatershedFromMarkersImageFilter< TInputImage, TLabelImage >::GetMarkerImage().

template<class TScalarType>

EquivalencyTableType* itk::watershed::SegmentTreeGenerator< TScalarType >::GetInputEquivalencyTable ( ) [inline]

Definition at line 129 of file itkWatershedSegmentTreeGenerator.h.

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

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

Definition at line 108 of file itkProcessObject.h.

template<class TScalarType>

SegmentTableType* itk::watershed::SegmentTreeGenerator< TScalarType >::GetInputSegmentTable ( ) [inline]

Get/Set the input table of segments to process

Definition at line 106 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>

virtual bool itk::watershed::SegmentTreeGenerator< TScalarType >::GetMerge ( ) [virtual]

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

Returns:: A constant reference to this objects MetaDataDictionary.

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

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

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

Return this objects modified time.

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

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

Return the multithreader used by this class.

Definition at line 284 of file itkProcessObject.h.

template<class TScalarType>

virtual const char* itk::watershed::SegmentTreeGenerator< TScalarType >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

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

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

Definition at line 118 of file itkProcessObject.h.

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

Definition at line 135 of file itkProcessObject.h.

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

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

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

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

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

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

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

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

Method used internally for getting an output.

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

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

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

Definition at line 133 of file itkProcessObject.h.

template<class TScalarType>

SegmentTreeType* itk::watershed::SegmentTreeGenerator< TScalarType >::GetOutputSegmentTree ( ) [inline]

Get/Set the output data

Definition at line 137 of file itkWatershedSegmentTreeGenerator.h.

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

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

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

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

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

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

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

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

Return true if an observer is registered for this event.

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

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

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

Call Execute on all the Commands observing this event id.

template<class TScalarType>

virtual DataObjectPointer itk::watershed::SegmentTreeGenerator< TScalarType >::MakeOutput ( unsigned int idx ) [virtual]

Standard itk::ProcessObject subclass method.

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 unsigned	long,
		const unsigned	long
	)			`[static]`

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

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

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

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

template<class TScalarType>

static Pointer itk::watershed::SegmentTreeGenerator< TScalarType >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TScalarType>

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

Definition at line 199 of file itkWatershedSegmentTreeGenerator.h.

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

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

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

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

Reimplemented in itk::WatershedImageFilter< TInputImage >.

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

Cause the object to print itself out.

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

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

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

template<class TScalarType>

void itk::watershed::SegmentTreeGenerator< TScalarType >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

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

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

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

Reimplemented in itk::VTKImageImport< TOutputImage >.

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

Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

template<class TScalarType>

static void itk::watershed::SegmentTreeGenerator< TScalarType >::PruneMergeSegments	(	SegmentTableTypePointer	,
		OneWayEquivalencyTableTypePointer	,
		const unsigned	long,
		const unsigned	long,
		ScalarType
	)			`[static]`

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

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

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

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

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

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

Reimplemented from itk::LightObject.

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

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

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

Definition at line 257 of file itkProcessObject.h.

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

Definition at line 256 of file itkProcessObject.h.

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

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

See also:: InPlaceImageFilter::ReleaseInputs()

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

Remove all observers .

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

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

Remove the observer with this tag value.

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

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

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

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

Restore the cached input ReleaseDataFlags.

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

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

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

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

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

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.

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

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

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

template<class 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 unneccessary 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 125 of file itkWatershedSegmentTreeGenerator.h.

template<class TScalarType>

void itk::watershed::SegmentTreeGenerator< TScalarType >::SetInputSegmentTable ( SegmentTableType * st ) [inline]

Get/Set the input table of segments to process

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

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

Returns:: Set the MetaDataDictionary

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

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

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

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

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

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

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

Called to allocate the input array. Copies old inputs.

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

Called to allocate the output array. Copies old outputs.

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

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

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

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

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

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

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

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

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

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

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

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

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

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

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

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

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

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

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

Actually generate new output

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

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

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.

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

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.

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

Time when GenerateOutputInformation was last called.

Definition at line 431 of file itkProcessObject.h.

volatile int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 119 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count

Definition at line 122 of file itkLightObject.h.

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

This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Definition at line 428 of file itkProcessObject.h.


typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef SegmentTreeGenerator	Self
typedef ProcessObject	Superclass
static Pointer	New ()
virtual const char *	GetNameOfClass () const
Public Types
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector< DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef EquivalencyTable	EquivalencyTableType
typedef OneWayEquivalencyTable	OneWayEquivalencyTableType
typedef OneWayEquivalencyTableType::Pointer	OneWayEquivalencyTableTypePointer
typedef TScalarType	ScalarType
typedef SegmentTable< ScalarType >	SegmentTableType
typedef SegmentTableType::Pointer	SegmentTableTypePointer
typedef SegmentTree< ScalarType >	SegmentTreeType
typedef SegmentTreeType::Pointer	SegmentTreeTypePointer
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
void	GenerateData ()
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
DataObjectPointerArray &	GetInputs ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
SegmentTreeType *	GetOutputSegmentTree ()
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

virtual bool	GetConsumeInput ()
virtual void	SetConsumeInput (bool _arg)

virtual double	GetFloodLevel ()
void	SetFloodLevel (double)

virtual double	GetHighestCalculatedFloodLevel ()
virtual void	SetHighestCalculatedFloodLevel (double _arg)

EquivalencyTableType *	GetInputEquivalencyTable ()
void	SetInputEquivalencyTable (EquivalencyTableType *eq)

SegmentTableType *	GetInputSegmentTable ()
void	SetInputSegmentTable (SegmentTableType *st)

virtual bool	GetMerge ()
virtual void	SetMerge (bool _arg)

DataObjectPointerArraySizeType	GetNumberOfOutputs () const
DataObjectPointerArray &	GetOutputs ()

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

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

virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
virtual void	SetReleaseDataFlag (bool flag)
Static Public Member Functions
static void	BreakOnError ()
static void	MergeSegments (SegmentTableTypePointer, OneWayEquivalencyTableTypePointer, const unsigned long, const unsigned long)
static void	PruneMergeSegments (SegmentTableTypePointer, OneWayEquivalencyTableTypePointer, const unsigned long, const unsigned long, ScalarType)

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Member Functions
virtual void	CacheInputReleaseDataFlags ()
void	CompileMergeList (SegmentTableTypePointer, SegmentTreeTypePointer)
void	ExtractMergeHierarchy (SegmentTableTypePointer, SegmentTreeTypePointer)
virtual void	GenerateOutputInformation ()
void	MergeEquivalencies ()
void	operator= (const Self &)
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RestoreInputReleaseDataFlags ()
	SegmentTreeGenerator (const Self &)
	SegmentTreeGenerator ()
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual	~SegmentTreeGenerator ()

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

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

void	GenerateInputRequestedRegion ()
void	GenerateOutputRequestedRegion (DataObject *output)

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

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

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

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
TimeStamp	m_OutputInformationMTime
volatile int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating

itk::watershed::SegmentTreeGenerator< TScalarType > Class Template Reference

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::watershed::SegmentTreeGenerator< TScalarType > Class Template Reference

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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