itk::TobogganImageFilter< TInputImage > Class Template Reference

#include <itkTobogganImageFilter.h>

Inheritance diagram for itk::TobogganImageFilter< TInputImage >:

Collaboration diagram for itk::TobogganImageFilter< TInputImage >:

Detailed Description

template<typename TInputImage>
class itk::TobogganImageFilter< TInputImage >

toboggan image segmentation The Toboggan segmentation takes a gradient magnitude image as input and produces an (over-)segmentation of the image based on connecting each pixel to a local minimum of gradient. It is roughly equivalent to a watershed segmentation of the lowest level.

The output is a 4 connected labeled map of the image.

Definition at line 39 of file itkTobogganImageFilter.h.

Public Types
enum	{ ImageDimension = InputImageType::ImageDimension }
typedef InputImageType::IndexType	IndexType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef TInputImage	InputImageType
typedef ConstNeighborhoodIterator < TInputImage >	NeighborhoodIteratorType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef Image< IdentifierType, itkGetStaticConstMacro(NDimensions) >	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef InputImageType::RegionType	RegionType
typedef InputImageType::PixelType	ScalarType
typedef TobogganImageFilter	Self
typedef InputImageType::SizeType	SizeType
typedef ImageToImageFilter < InputImageType, OutputImageType >	Superclass
Public Types inherited from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef SmartPointer< Self >	Pointer
typedef ImageToImageFilter	Self
typedef ImageSource< Image < IdentifierType, TInputImage::ImageDimension > >	Superclass
Public Types inherited from itk::ImageSource< Image< IdentifierType, TInputImage::ImageDimension > >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef Image< IdentifierType, TInputImage::ImageDimension >	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ImageSource	Self
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef MultiThreader	MultiThreaderType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
void	EnlargeOutputRequestedRegion (DataObject *) override
void	GenerateData () override
void	GenerateInputRequestedRegion () override
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >
const InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput () override
virtual void	PopFrontInput () override
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TInputImage *image)
virtual void	SetCoordinateTolerance (double _arg)
virtual double	GetCoordinateTolerance () const
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance () const
Public Member Functions inherited from itk::ImageSource< Image< IdentifierType, TInputImage::ImageDimension > >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *output)
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
virtual ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderType *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
DataObjectPointerArray	GetOutputs ()
virtual const float &	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float progress)
void	SetProgress (float progress)
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads () const
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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () 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 Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Static Public Attributes
static const unsigned int	NDimensions = TInputImage::ImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::ImageSource< Image< IdentifierType, TInputImage::ImageDimension > >
static const unsigned int	OutputImageDimension

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override
	TobogganImageFilter ()
	~TobogganImageFilter () override
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	ImageToImageFilter ()
virtual void	VerifyInputInformation () override
	~ImageToImageFilter () override
void	PushBackInput (const DataObject *input) override
void	PushFrontInput (const DataObject *input) override
Protected Member Functions inherited from itk::ImageSource< Image< IdentifierType, TInputImage::ImageDimension > >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource () override
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
void	AddOptionalInputName (const DataObjectIdentifierType &)
void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (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)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
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	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~ProcessObject () override
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName (void) const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName (void) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () 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 () override
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 ()

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType
Static Protected Member Functions inherited from itk::ImageSource< Image< IdentifierType, TInputImage::ImageDimension > >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TInputImage >

typedef InputImageType::IndexType itk::TobogganImageFilter< TInputImage >::IndexType

Definition at line 69 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef InputImageType::ConstPointer itk::TobogganImageFilter< TInputImage >::InputImageConstPointer

Definition at line 71 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef InputImageType::PixelType itk::TobogganImageFilter< TInputImage >::InputImagePixelType

Input image pixel type.

Definition at line 61 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef InputImageType::Pointer itk::TobogganImageFilter< TInputImage >::InputImagePointer

Definition at line 70 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef TInputImage itk::TobogganImageFilter< TInputImage >::InputImageType

The type of input image.

Definition at line 49 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef ConstNeighborhoodIterator< TInputImage > itk::TobogganImageFilter< TInputImage >::NeighborhoodIteratorType

Neighborhood iterator type

Definition at line 98 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef OutputImageType::PixelType itk::TobogganImageFilter< TInputImage >::OutputImagePixelType

Output image pixel type.

Definition at line 58 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef OutputImageType::Pointer itk::TobogganImageFilter< TInputImage >::OutputImagePointer

Definition at line 72 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef Image< IdentifierType, itkGetStaticConstMacro(NDimensions) > itk::TobogganImageFilter< TInputImage >::OutputImageType

The type of output image.

Definition at line 55 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef SmartPointer< Self > itk::TobogganImageFilter< TInputImage >::Pointer

Smart pointer typedef support

Definition at line 81 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef InputImageType::RegionType itk::TobogganImageFilter< TInputImage >::RegionType

Other convenient typedefs

Definition at line 67 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef InputImageType::PixelType itk::TobogganImageFilter< TInputImage >::ScalarType

Typedef support for the input image scalar value type.

Definition at line 78 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef TobogganImageFilter itk::TobogganImageFilter< TInputImage >::Self

Standard "Self" typedef.

Definition at line 46 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef InputImageType::SizeType itk::TobogganImageFilter< TInputImage >::SizeType

Definition at line 68 of file itkTobogganImageFilter.h.

template<typename TInputImage >

typedef ImageToImageFilter< InputImageType, OutputImageType > itk::TobogganImageFilter< TInputImage >::Superclass

Standard super class typedef support.

Definition at line 75 of file itkTobogganImageFilter.h.

Member Enumeration Documentation

template<typename TInputImage >

anonymous enum

Dimension of the input and output images.

Enumerator
ImageDimension

Definition at line 64 of file itkTobogganImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage >

itk::TobogganImageFilter< TInputImage >::TobogganImageFilter ( )

protected

template<typename TInputImage >

itk::TobogganImageFilter< TInputImage >::~TobogganImageFilter ( )

inlineoverrideprotected

Definition at line 111 of file itkTobogganImageFilter.h.

Member Function Documentation

template<typename TInputImage >

virtual::itk::LightObject::Pointer itk::TobogganImageFilter< TInputImage >::CreateAnother ( ) const

virtual

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

Reimplemented from itk::Object.

template<typename TInputImage >

void itk::TobogganImageFilter< TInputImage >::EnlargeOutputRequestedRegion ( DataObject *  )

overridevirtual

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.

Reimplemented from itk::ProcessObject.

template<typename TInputImage >

void itk::TobogganImageFilter< TInputImage >::GenerateData ( )

overridevirtual

Standard process object method. This filter is not multithreaded.

Reimplemented from itk::ImageSource< Image< IdentifierType, TInputImage::ImageDimension > >.

template<typename TInputImage >

void itk::TobogganImageFilter< TInputImage >::GenerateInputRequestedRegion ( void  )

overridevirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See Also

ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >.

template<typename TInputImage >

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

virtual

Run-time type information (and related methods)

Reimplemented from itk::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >.

template<typename TInputImage >

static Pointer itk::TobogganImageFilter< TInputImage >::New ( )

static

Method for creation through the object factory.

template<typename TInputImage >

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

overrideprotectedvirtual

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::ImageToImageFilter< TInputImage, Image< IdentifierType, TInputImage::ImageDimension > >.

Member Data Documentation

template<typename TInputImage >

const unsigned int itk::TobogganImageFilter< TInputImage >::NDimensions = TInputImage::ImageDimension

static

Number of dimensions.

Definition at line 52 of file itkTobogganImageFilter.h.

---

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

• itkTobogganImageFilter.h