itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage > Class Template Reference

A connected components filter that labels the objects in an arbitrary image. Two pixels are similar if they are within threshold of each other. Uses ConnectedComponentFunctorImageFilter. More...

#include <itkScalarConnectedComponentImageFilter.h>

Inheritance diagram for itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >:

[legend]

Collaboration diagram for itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >:

[legend]

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef Functor::SimilarPixelsFunctor < TInputImage::ValueType >	FunctorType
typedef TInputImage::IndexType	IndexType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef Superclass::InputImagePointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef TInputImage::PixelType	InputPixelType
typedef unsigned long int	LabelType
typedef std::list< IndexType >	ListType
typedef MaskImageType::Pointer	MaskImagePointer
typedef TMaskImage	MaskImageType
typedef TInputImage::OffsetType	OffsetType
typedef TOutputImage::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef TOutputImage::IndexType	OutputIndexType
typedef TOutputImage::OffsetType	OutputOffsetType
typedef TOutputImage::SizeType	OutputSizeType
typedef SmartPointer< Self >	Pointer
typedef TOutputImage::RegionType	RegionType
typedef ScalarConnectedComponentImageFilter	Self
typedef TInputImage::SizeType	SizeType
typedef ConnectedComponentFunctorImageFilter < TInputImage, TOutputImage, Functor::SimilarPixelsFunctor < typename TInputImage::ValueType > , TMaskImage >	Superclass
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 const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual InputPixelType	GetDistanceThreshold ()
DataObjectPointerArray &	GetInputs ()
const TMaskImage *	GetMaskImage () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
virtual const LabelType &	GetObjectCount ()
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
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
virtual void	SetDistanceThreshold (const InputPixelType &thresh)
void	SetMaskImage (TMaskImage *mask)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
	typedef (Concept::IsInteger< OutputImagePixelType >) OutputImagePixelTypeIsInteger
	typedef (Concept::SameDimension< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)>) SameDimension
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)


OutputImageType *	GetOutput (unsigned int idx)
OutputImageType *	GetOutput (void)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()
Protected Types
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)>	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)>	OutputToInputRegionCopierType
Protected Member Functions
virtual void	AllocateOutputs ()
virtual void	CacheInputReleaseDataFlags ()
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
void	EnlargeOutputRequestedRegion (DataObject *)
void	GenerateData ()
void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
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 ()
	ScalarConnectedComponentImageFilter ()
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual int	SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId) ITK_NO_RETURN
virtual	~ScalarConnectedComponentImageFilter ()
Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes
bool	m_FullyConnected
FunctorType	m_Functor
TimeStamp	m_OutputInformationMTime
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating

typedef TInputImage::InternalPixelType	InputInternalPixelType
typedef TMaskImage::PixelType	MaskPixelType
typedef TOutputImage::InternalPixelType	OutputInternalPixelType
typedef TOutputImage::PixelType	OutputPixelType
const FunctorType &	GetFunctor () const
FunctorType &	GetFunctor ()
void	SetFunctor (const FunctorType &functor)
static const unsigned int	ImageDimension
static const unsigned int	InputImageDimension

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

virtual void	FullyConnectedOff ()
virtual void	FullyConnectedOn ()
virtual OutputImagePixelType	GetBackgroundValue () const
virtual const bool &	GetFullyConnected ()
virtual void	SetBackgroundValue (OutputImagePixelType _arg)
virtual void	SetFullyConnected (bool _arg)
void	AfterThreadedGenerateData ()
void	BeforeThreadedGenerateData ()
void	ThreadedGenerateData (const RegionType &outputRegionForThread, int threadId)
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

const InputImageType *	GetInput (unsigned int idx)
const InputImageType *	GetInput (void)
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TInputImage *image)
virtual void	SetInput (const InputImageType *image)
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)

DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual const int &	GetNumberOfThreads ()
DataObjectPointerArray &	GetOutputs ()
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual bool	GetReleaseDataFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
virtual void	SetNumberOfThreads (int _arg)
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual void	SetReleaseDataFlag (bool flag)
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
const DataObject *	GetInput (unsigned int idx) const
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
const DataObject *	GetOutput (unsigned int idx) const
virtual void	RemoveInput (DataObject *input)
virtual void	RemoveOutput (DataObject *output)
virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	SetNthOutput (unsigned int num, DataObject *output)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
typedef int	InternalReferenceCountType

Detailed Description

template<class TInputImage, class TOutputImage, class TMaskImage = TInputImage>
class itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >

A connected components filter that labels the objects in an arbitrary image. Two pixels are similar if they are within threshold of each other. Uses ConnectedComponentFunctorImageFilter.

Definition at line 101 of file itkScalarConnectedComponentImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

typedef SmartPointer<const Self> itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::ConstPointer

Reimplemented from itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, Functor::SimilarPixelsFunctor< TInputImage::ValueType >, TMaskImage >.

Definition at line 114 of file itkScalarConnectedComponentImageFilter.h.

template<class TOutputImage>

typedef DataObject::Pointer itk::ImageSource< TOutputImage >::DataObjectPointer [inherited]

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Reimplemented in itk::BayesianClassifierImageFilter< TInputVectorImage, TLabelsType, TPosteriorsPrecisionType, TPriorsPrecisionType >, itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::SignedDanielssonDistanceMapImageFilter< TInputImage, TOutputImage >, itk::StatisticsImageFilter< TInputImage >, itk::StreamingImageFilter< TInputImage, TOutputImage >, itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >, and itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >.

Definition at line 62 of file itkImageSource.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.

typedef Functor::SimilarPixelsFunctor< TInputImage::ValueType > itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::FunctorType [inherited]

Image typedef support

Definition at line 87 of file itkConnectedComponentFunctorImageFilter.h.

typedef TInputImage ::IndexType itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::IndexType [inherited]

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 92 of file itkConnectedComponentFunctorImageFilter.h.

typedef InputImageType::ConstPointer itk::ImageToImageFilter< TInputImage , TOutputImage >::InputImageConstPointer [inherited]

Definition at line 84 of file itkImageToImageFilter.h.

typedef InputImageType::PixelType itk::ImageToImageFilter< TInputImage , TOutputImage >::InputImagePixelType [inherited]

Definition at line 86 of file itkImageToImageFilter.h.

typedef Superclass::InputImagePointer itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::InputImagePointer [inherited]

Types from the Superclass

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 67 of file itkConnectedComponentFunctorImageFilter.h.

typedef InputImageType::RegionType itk::ImageToImageFilter< TInputImage , TOutputImage >::InputImageRegionType [inherited]

Definition at line 85 of file itkImageToImageFilter.h.

typedef TInputImage itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::InputImageType [inherited]

Image typedef support

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 88 of file itkConnectedComponentFunctorImageFilter.h.

typedef TInputImage ::InternalPixelType itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::InputInternalPixelType [inherited]

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 76 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

typedef TInputImage::PixelType itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::InputPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Reimplemented from itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, Functor::SimilarPixelsFunctor< TInputImage::ValueType >, TMaskImage >.

Definition at line 120 of file itkScalarConnectedComponentImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)> itk::ImageToImageFilter< TInputImage , TOutputImage >::InputToOutputRegionCopierType [protected, inherited]

Typedef for the region copier function object that converts an input region to an output region.

Definition at line 164 of file itkImageToImageFilter.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

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

Definition at line 139 of file itkLightObject.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

typedef unsigned long int itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::LabelType [inherited]

Type used as identifier of the different component labels.

Definition at line 128 of file itkConnectedComponentImageFilter.h.

typedef std::list<IndexType> itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::ListType [inherited]

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 95 of file itkConnectedComponentFunctorImageFilter.h.

typedef MaskImageType::Pointer itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::MaskImagePointer [inherited]

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 97 of file itkConnectedComponentFunctorImageFilter.h.

typedef TMaskImage itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::MaskImageType [inherited]

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 89 of file itkConnectedComponentFunctorImageFilter.h.

typedef TMaskImage ::PixelType itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::MaskPixelType [inherited]

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 77 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

typedef TInputImage::OffsetType itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OffsetType [inherited]

Definition at line 92 of file itkConnectedComponentImageFilter.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

typedef TOutputImage::PixelType itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputImagePixelType [inherited]

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 99 of file itkConnectedComponentImageFilter.h.

template<class TOutputImage>

typedef OutputImageType::Pointer itk::ImageSource< TOutputImage >::OutputImagePointer [inherited]

Definition at line 69 of file itkImageSource.h.

typedef Superclass::OutputImageRegionType itk::ImageToImageFilter< TInputImage , TOutputImage >::OutputImageRegionType [inherited]

Superclass typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 75 of file itkImageToImageFilter.h.

typedef TOutputImage itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::OutputImageType [inherited]

Some convenient typedefs.

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 90 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

typedef TOutputImage::IndexType itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputIndexType [inherited]

Definition at line 96 of file itkConnectedComponentImageFilter.h.

typedef TOutputImage ::InternalPixelType itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::OutputInternalPixelType [inherited]

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 74 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

typedef TOutputImage::OffsetType itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputOffsetType [inherited]

Definition at line 98 of file itkConnectedComponentImageFilter.h.

typedef TOutputImage ::PixelType itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::OutputPixelType [inherited]

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 73 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

typedef TOutputImage::SizeType itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputSizeType [inherited]

Definition at line 97 of file itkConnectedComponentImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> itk::ImageToImageFilter< TInputImage , TOutputImage >::OutputToInputRegionCopierType [protected, inherited]

Typedef for the region copier function object that converts an output region to an input region.

Definition at line 169 of file itkImageToImageFilter.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

typedef SmartPointer<Self> itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::Pointer

Smart pointer typedef support

Reimplemented from itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, Functor::SimilarPixelsFunctor< TInputImage::ValueType >, TMaskImage >.

Definition at line 113 of file itkScalarConnectedComponentImageFilter.h.

typedef TOutputImage ::RegionType itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::RegionType [inherited]

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 94 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

typedef ScalarConnectedComponentImageFilter itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::Self

Standard class typedefs.

Reimplemented from itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, Functor::SimilarPixelsFunctor< TInputImage::ValueType >, TMaskImage >.

Definition at line 108 of file itkScalarConnectedComponentImageFilter.h.

typedef TInputImage ::SizeType itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::SizeType [inherited]

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 93 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

typedef ConnectedComponentFunctorImageFilter< TInputImage,TOutputImage, Functor::SimilarPixelsFunctor<typename TInputImage::ValueType>, TMaskImage> itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::Superclass

Reimplemented from itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, Functor::SimilarPixelsFunctor< TInputImage::ValueType >, TMaskImage >.

Definition at line 112 of file itkScalarConnectedComponentImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::ScalarConnectedComponentImageFilter ( ) [inline, protected]

Definition at line 145 of file itkScalarConnectedComponentImageFilter.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

virtual itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::~ScalarConnectedComponentImageFilter ( ) [inline, protected, virtual]

Definition at line 146 of file itkScalarConnectedComponentImageFilter.h.

Member Function Documentation

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]

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

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

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

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]

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

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::AfterThreadedGenerateData ( ) [protected, virtual, inherited]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::AllocateOutputs ( ) [protected, virtual, inherited]

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Some filters may want to override this default behavior. For example, a filter may have multiple outputs with varying resolution. Or a filter may want to process data in place by grafting its input to its output.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::BeforeThreadedGenerateData ( ) [protected, virtual, inherited]

Standard pipeline methods.

Reimplemented from itk::ImageSource< TOutputImage >.

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

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::CallCopyInputRegionToOutputRegion	(	OutputImageRegionType &	destRegion,
		const InputImageRegionType &	srcRegion
	)			`[protected, virtual, inherited]`

This function calls the actual region copier to do the mapping from input image space to output image space. It uses a Function object used for dispatching to various routines to copy an input region (start index and size) to an output region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::UnaryFunctorImageFilter can support output images of a higher dimension that the input.

This function object is used by the default implementation of GenerateOutputInformation(). It can also be used in routines like ThreadedGenerateData() where a filter may need to map an input region to an output region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the first portion of the input region is copied to the output region. If the input region is a lower dimension than the output, the input region information is copied into the first portion of the output region and the rest of the output region is set to zero.

If a filter needs a different default behavior, it can override this method.

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::CallCopyOutputRegionToInputRegion	(	InputImageRegionType &	destRegion,
		const OutputImageRegionType &	srcRegion
	)			`[protected, virtual, inherited]`

This function calls the actual region copier to do the mapping from output image space to input image space. It uses a Function object used for dispatching to various routines to copy an output region (start index and size) to an input region. For most filters, this is a trivial copy because most filters require the input dimension to match the output dimension. However, some filters like itk::ExtractImageFilter can support output images of a lower dimension that the input.

This function object can be used by GenerateOutputInformation() to copy the input LargestPossibleRegion to the output LargestPossibleRegion and can also be used in GenerateData or ThreadedGenerateData() where a filter may need to map an output region to an input region.

The default copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the input and output images are the same dimension, the input is a higher dimension that the output, or the input is of a lower dimension than the output. The use of an overloaded function is required for proper compilation of the various cases.

For the latter two cases, trivial implementations are used. If the input image is a higher dimension than the output, the output region information is copied into the first portion of the input region and the rest of the input region is set to zero. If the input region is a lower dimension than the output, the first portion of the output region is copied to the input region.

If a filter needs a different default behavior, it can override this method. The ExtractImageFilter overrides this function object so that if the input image is a higher dimension than the output image, the filter can control "where" in the input image the output subimage is extracted (as opposed to mapping to first few dimensions of the input).

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.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::EnlargeOutputRequestedRegion ( DataObject * ) [protected, virtual, inherited]

ConnectedComponentImageFilter will produce all of the output. Therefore it must provide an implementation of EnlargeOutputRequestedRegion().

See also:: ProcessObject::EnlargeOutputRequestedRegion()

Reimplemented from itk::ProcessObject.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

virtual void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::FullyConnectedOff ( ) [virtual, inherited]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

virtual void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::FullyConnectedOn ( ) [virtual, inherited]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

void itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::GenerateData ( void ) [protected, virtual, inherited]

Standard pipeline method.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GenerateInputRequestedRegion ( ) [protected, virtual, inherited]

ConnectedComponentImageFilter needs the entire input. Therefore it must provide an implementation GenerateInputRequestedRegion().

See also:: ProcessObject::GenerateInputRequestedRegion().

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

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.

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

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

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

Reimplemented in itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, itk::watershed::Relabeler< TScalarType, TImageDimension >, itk::watershed::Segmenter< TInputImage >, itk::watershed::SegmentTreeGenerator< TScalarType >, itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, itk::watershed::Segmenter< InputImageType >, and itk::watershed::SegmentTreeGenerator< ScalarType >.

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.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

virtual OutputImagePixelType itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GetBackgroundValue ( ) const [virtual, inherited]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

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.

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

Get the value of the debug flag.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

virtual InputPixelType itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GetDistanceThreshold ( ) [inline, virtual]

Definition at line 127 of file itkScalarConnectedComponentImageFilter.h.

References itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GetDistanceThreshold().

Referenced by itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GetDistanceThreshold().

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

virtual const bool& itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GetFullyConnected ( ) [virtual, inherited]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

const FunctorType& itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::GetFunctor ( ) const [inline, inherited]

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 120 of file itkConnectedComponentFunctorImageFilter.h.

FunctorType& itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::GetFunctor ( ) [inline, inherited]

Get the functor object. The functor is returned by reference. (Functors do not have to derive from itk::LightObject, so they do not necessarily have a reference count. So we cannot return a SmartPointer.)

Definition at line 119 of file itkConnectedComponentFunctorImageFilter.h.

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

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

const DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) const [protected, 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.

Reimplemented in itk::MeshToMeshFilter< TInputMesh, TOutputMesh >, and itk::MeshToMeshFilter< TInput, TOutput >.

const InputImageType* itk::ImageToImageFilter< TInputImage , TOutputImage >::GetInput ( unsigned int idx ) [inherited]

Push/Pop the 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.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

Reimplemented from itk::ProcessObject.

const InputImageType* itk::ImageToImageFilter< TInputImage , TOutputImage >::GetInput ( void ) [inherited]

Push/Pop the 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.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

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 TInputImage , class TOutputImage , class TMaskImage = TInputImage>

const TMaskImage* itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GetMaskImage ( ) const [inline, inherited]

Definition at line 149 of file itkConnectedComponentImageFilter.h.

References itk::ProcessObject::GetInput().

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 TInputImage , class TOutputImage , class TMaskImage = TInputImage>

virtual const char* itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, Functor::SimilarPixelsFunctor< TInputImage::ValueType >, TMaskImage >.

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]

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

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( ) [protected, virtual, 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.

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( ) [protected, virtual, 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.

virtual const int& itk::ProcessObject::GetNumberOfThreads ( ) [virtual, 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.

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

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, TRealType >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

virtual const LabelType& itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::GetObjectCount ( ) [virtual, inherited]

const DataObject* itk::ProcessObject::GetOutput ( unsigned int idx ) const [protected, 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.

template<class TOutputImage>

OutputImageType* itk::ImageSource< TOutputImage >::GetOutput ( unsigned int idx ) [inherited]

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

   anotherFilter->SetInput( someFilter->GetOutput() );
   anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

   image = someFilter->GetOutput();
   image->Update();

   someFilter->Update();
   image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

Reimplemented from itk::ProcessObject.

template<class TOutputImage>

OutputImageType* itk::ImageSource< TOutputImage >::GetOutput ( void ) [inherited]

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

   anotherFilter->SetInput( someFilter->GetOutput() );
   anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

   image = someFilter->GetOutput();
   image->Update();

   someFilter->Update();
   image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

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.

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.

Referenced by itk::XMLFilterWatcher::ShowProgress().

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

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( ) [virtual, 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.

virtual bool itk::ProcessObject::GetReleaseDataFlag ( ) const [virtual, 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.

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

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

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

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

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	output
	)			`[virtual, inherited]`

Graft the specified data object onto this ProcessObject's idx'th output. This is similar to the GraftOutput method except it allows you to specify which output is affected. The specified index must be a valid output number (less than ProcessObject::GetNumberOfOutputs()). See the GraftOutput for general usage information.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::GraftOutput ( DataObject * output ) [virtual, inherited]

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

    // setup the mini-pipeline to process the input to this filter
    firstFilterInMiniPipeline->SetInput( this->GetInput() );

    // setup the mini-pipeline to calculate the correct regions
    // and write to the appropriate bulk data block
    lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );

    // execute the mini-pipeline
    lastFilterInMiniPipeline->Update();

    // graft the mini-pipeline output back onto this filter's output.
    // this is needed to get the appropriate regions passed back.
    this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

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

virtual DataObjectPointer itk::ImageSource< TOutputImage >::MakeOutput ( unsigned int idx ) [virtual, inherited]

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 SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

Reimplemented in itk::BayesianClassifierImageFilter< TInputVectorImage, TLabelsType, TPosteriorsPrecisionType, TPriorsPrecisionType >, itk::EigenAnalysis2DImageFilter< TInputImage, TEigenValueImage, TEigenVectorImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::SignedDanielssonDistanceMapImageFilter< TInputImage, TOutputImage >, itk::StatisticsImageFilter< TInputImage >, itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, THistogram >, itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >, and itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, MaskedRankHistogram< TInputImage::PixelType > >.

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, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

static Pointer itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, Functor::SimilarPixelsFunctor< TInputImage::ValueType >, TMaskImage >.

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::PopBackInput ( ) [virtual, inherited]

Push/Pop the 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.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

Reimplemented from itk::ProcessObject.

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::PopFrontInput ( ) [virtual, inherited]

Push/Pop the 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.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

Reimplemented from itk::ProcessObject.

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< ProcessObject >::Print().

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

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

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

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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, TOutputImage >.

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

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

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::StreamingImageFilter< TInputImage, TOutputImage >, and itk::VTKImageImport< TOutputImage >.

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

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

void itk::ImageToImageFilter< TInputImage , TOutputImage >::PushBackInput ( const DataObject * input ) [inline, protected, virtual, inherited]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::ProcessObject.

Definition at line 251 of file itkImageToImageFilter.h.

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::PushBackInput ( const InputImageType * image ) [virtual, inherited]

Push/Pop the 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.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

void itk::ImageToImageFilter< TInputImage , TOutputImage >::PushFrontInput ( const DataObject * input ) [inline, protected, virtual, inherited]

Push/Pop the 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.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

Reimplemented from itk::ProcessObject.

Definition at line 253 of file itkImageToImageFilter.h.

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::PushFrontInput ( const InputImageType * image ) [virtual, inherited]

Push/Pop the 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.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

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]

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

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( ) [virtual, 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.

void itk::ProcessObject::ReleaseDataFlagOff ( ) [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 257 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( ) [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 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]

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

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]

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

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 TInputImage , class TOutputImage , class TMaskImage = TInputImage>

virtual void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::SetBackgroundValue ( OutputImagePixelType _arg ) [virtual, inherited]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

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

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

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

virtual void itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::SetDistanceThreshold ( const InputPixelType & thresh ) [inline, virtual]

Definition at line 124 of file itkScalarConnectedComponentImageFilter.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

virtual void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::SetFullyConnected ( bool _arg ) [virtual, inherited]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

void itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::SetFunctor ( const FunctorType & functor ) [inline, inherited]

Set the functor object. This replaces the current Functor with a copy of the specified Functor. This allows the user to specify a functor that has ivars set differently than the default functor. This method requires an operator!=() be defined on the functor (or the compiler's default implementation of operator!=() being appropriate).

Definition at line 129 of file itkConnectedComponentFunctorImageFilter.h.

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

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::SetInput	(	unsigned	int,
		const TInputImage *	image
	)			`[virtual, inherited]`

Push/Pop the 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.

The routines are useful for applications that need to process "rolling" sets of images. For instance, if an application has 10 images and they need to run a filter on images 1, 2, 3, 4, then run the filter on images 2, 3, 4, 5, then run the filter on images 3, 4, 5, 6, the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list. Again, this only makes sense for filters that single type of input.

Other uses are also possible. For a single input filter, pushing and popping inputs allow the application to temporarily replace an input to a filter.

virtual void itk::ImageToImageFilter< TInputImage , TOutputImage >::SetInput ( const InputImageType * image ) [virtual, inherited]

Set/Get the image input of this process object.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::SetMaskImage ( TMaskImage * mask ) [inline, inherited]

Definition at line 144 of file itkConnectedComponentImageFilter.h.

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.

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

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, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetFeatureImage(), itk::WatershedImageFilter< TInputImage >::SetInput(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetInputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetInputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputSegmentTable(), itk::watershed::Relabeler< ScalarType, 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< InputImageType >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), and itk::watershed::Segmenter< InputImageType >::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]

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

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg ) [protected, virtual, 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.

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.

template<class TOutputImage>

virtual int itk::ImageSource< TOutputImage >::SplitRequestedRegion	(	int	i,
		int	num,
		OutputImageRegionType &	splitRegion
	)			`[protected, virtual, inherited]`

Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". This method is called "num" times. The regions must not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedRegion, i.e. return value is less than or equal to "num".

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

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		int	threadId
	)			`[protected, virtual, inherited]`

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See also:: GenerateData(), SplitRequestedRegion()

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

void itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::ThreadedGenerateData	(	const RegionType &	outputRegionForThread,
		int	threadId
	)			`[protected, inherited]`

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

template<class TOutputImage>

static ITK_THREAD_RETURN_TYPE itk::ImageSource< TOutputImage >::ThreaderCallback ( void * arg ) [static, protected, inherited]

Static function used as a "callback" by the MultiThreader. The threading library will call this routine for each thread, which will delegate the control to ThreadedGenerateData().

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::typedef ( Concept::IsInteger< OutputImagePixelType > ) [inherited]

This class requires OutputImagePixelTypeIsInteger in the form of (Concept::IsInteger<OutputImagePixelType>)

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::typedef ( Concept::SameDimension< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> ) [inherited]

This class requires SameDimension in the form of (Concept::SameDimension<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)>)

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 >, itk::VTKImageImport< TOutputImage >, and itk::watershed::Segmenter< InputImageType >.

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.

Member Data Documentation

const unsigned int itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::ImageDimension [static, inherited]

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 79 of file itkConnectedComponentFunctorImageFilter.h.

const unsigned int itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::InputImageDimension [static, inherited]

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Reimplemented from itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >.

Definition at line 81 of file itkConnectedComponentFunctorImageFilter.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

bool itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::m_FullyConnected [protected, inherited]

Definition at line 190 of file itkConnectedComponentImageFilter.h.

FunctorType itk::ConnectedComponentFunctorImageFilter< TInputImage , TOutputImage , Functor::SimilarPixelsFunctor< TInputImage::ValueType > , TMaskImage >::m_Functor [protected, inherited]

Definition at line 163 of file itkConnectedComponentFunctorImageFilter.h.

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

Time when GenerateOutputInformation was last called.

Definition at line 431 of file itkProcessObject.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

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

These ivars are made protected so filters like itkStreamingImageFilter can access them directly. This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Definition at line 428 of file itkProcessObject.h.

template<class TInputImage , class TOutputImage , class TMaskImage = TInputImage>

const unsigned int itk::ConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputImageDimension = TOutputImage::ImageDimension [static, inherited]

Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 80 of file itkConnectedComponentImageFilter.h.

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

itkScalarConnectedComponentImageFilter.h

itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage > Class Template Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

template<class TInputImage, class TOutputImage, class TMaskImage = TInputImage> class itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TInputImage, class TOutputImage, class TMaskImage = TInputImage>
class itk::ScalarConnectedComponentImageFilter< TInputImage, TOutputImage, TMaskImage >