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.

Reimplemented in itk::ImageToMeshFilter< TInputImage, TOutputMesh >, itk::PathToImageFilter< TInputPath, TOutputImage >, itk::PointSetToImageFilter< TInputPointSet, TOutputImage >, itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >, itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >, itk::TriangleMeshToBinaryImageFilter< TInputMesh, TOutputImage >, itk::ImageToImageFilter< TInputImage, TOutputImage >, itk::MeshToMeshFilter< TInputMesh, TOutputMesh >, itk::PathToPathFilter< TInputPath, TOutputPath >, itk::ImageFileWriter< TInputImage >, itk::ImageSeriesWriter< TInputImage, TOutputImage >, itk::ImageToPathFilter< TInputImage, TOutputPath >, itk::ImageToImageFilter< Superclass::ImageType, Superclass::ImageType >, itk::ImageToImageFilter< TSpeedImage, TLevelSet >, itk::ImageT


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

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

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