Given a label map and an optional intensity image, compute geometric features. More...

#include <itkLabelGeometryImageFilter.h>

Inheritance diagram for itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >:

Collaboration diagram for itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >:

Classes
class	LabelGeometry
	Geometry stored per label. More...
Public Types
typedef itk::FixedArray < RealType, itkGetStaticConstMacro(ImageDimension)>	AxesLengthType
typedef std::vector < LabelPointType >	BoundingBoxVerticesType
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef itk::FixedArray < typename LabelIndexType::IndexValueType, itkGetStaticConstMacro(ImageDimension) >	IndexArrayType
typedef TIntensityImage::IndexType	IndexType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef TIntensityImage::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TLabelImage	InputImageType
typedef TIntensityImage	IntensityImageType
typedef TLabelImage::Pointer	LabelImagePointer
typedef TLabelImage	LabelImageType
typedef TLabelImage::IndexType	LabelIndexType
typedef std::vector < LabelIndexType >	LabelIndicesType
typedef TLabelImage::PixelType	LabelPixelType
typedef TLabelImage::PointType	LabelPointType
typedef TLabelImage::RegionType	LabelRegionType
typedef TLabelImage::SizeType	LabelSizeType
typedef std::vector < LabelPixelType >	LabelsType
typedef itk::hash_map < LabelPixelType, LabelGeometry > ::const_iterator	MapConstIterator
typedef itk::hash_map < LabelPixelType, LabelGeometry >::iterator	MapIterator
typedef itk::hash_map < LabelPixelType, LabelGeometry >	MapType
typedef vnl_matrix< double >	MatrixType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TIntensityImage	OutputImageType
typedef TIntensityImage::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef SimpleDataObjectDecorator < RealType >	RealObjectType
typedef NumericTraits < PixelType >::RealType	RealType
typedef TIntensityImage::RegionType	RegionType
typedef LabelGeometryImageFilter	Self
typedef TIntensityImage::SizeType	SizeType
typedef ImageToImageFilter < TLabelImage, TIntensityImage >	Superclass
typedef std::vector< double >	VectorType


typedef itk::FixedArray < typename LabelIndexType::IndexValueType, itkGetStaticConstMacro(ImageDimension)*2 >	BoundingBoxType
typedef itk::FixedArray< float, itkGetStaticConstMacro(ImageDimension)*2 >	BoundingBoxFloatType
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	CalculateOrientedBoundingBoxOff ()
virtual void	CalculateOrientedBoundingBoxOn ()
virtual void	CalculateOrientedIntensityRegionsOff ()
virtual void	CalculateOrientedIntensityRegionsOn ()
virtual void	CalculateOrientedLabelRegionsOff ()
virtual void	CalculateOrientedLabelRegionsOn ()
virtual void	CalculatePixelIndicesOff ()
virtual void	CalculatePixelIndicesOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
AxesLengthType	GetAxesLength (LabelPixelType label) const
BoundingBoxType	GetBoundingBox (LabelPixelType label) const
LabelSizeType	GetBoundingBoxSize (LabelPixelType label) const
RealType	GetBoundingBoxVolume (LabelPixelType label) const
virtual bool	GetCalculateOrientedBoundingBox ()
virtual bool	GetCalculateOrientedIntensityRegions ()
virtual bool	GetCalculateOrientedLabelRegions ()
virtual bool	GetCalculatePixelIndices ()
LabelPointType	GetCentroid (LabelPixelType label) const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
RealType	GetEccentricity (LabelPixelType label) const
VectorType	GetEigenvalues (LabelPixelType label) const
MatrixType	GetEigenvectors (LabelPixelType label) const
RealType	GetElongation (LabelPixelType label) const
DataObjectPointerArray &	GetInputs ()
RealType	GetIntegratedIntensity (LabelPixelType label) const
const TIntensityImage *	GetIntensityInput () const
std::vector< LabelPixelType >	GetLabels () const
RealType	GetMajorAxisLength (LabelPixelType label) const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
RealType	GetMinorAxisLength (LabelPixelType label) const
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
RealType	GetOrientation (LabelPixelType label) const
LabelPointType	GetOrientedBoundingBoxOrigin (LabelPixelType label) const
LabelPointType	GetOrientedBoundingBoxSize (LabelPixelType label) const
BoundingBoxVerticesType	GetOrientedBoundingBoxVertices (LabelPixelType label) const
RealType	GetOrientedBoundingBoxVolume (LabelPixelType label) const
TIntensityImage *	GetOrientedIntensityImage (LabelPixelType label) const
TLabelImage *	GetOrientedLabelImage (LabelPixelType label) const
LabelIndicesType	GetPixelIndices (LabelPixelType label) const
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
RegionType	GetRegion (LabelPixelType label) const
MatrixType	GetRotationMatrix (LabelPixelType label) const
unsigned long	GetVolume (LabelPixelType label) const
LabelPointType	GetWeightedCentroid (LabelPixelType label) const
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
bool	HasLabel (LabelPixelType label) const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetCalculateOrientedBoundingBox (const bool value)
void	SetCalculateOrientedIntensityRegions (const bool value)
void	SetCalculateOrientedLabelRegions (const bool value)
void	SetCalculatePixelIndices (const bool value)
void	SetDebug (bool debugFlag) const
void	SetIntensityInput (const TIntensityImage *input)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)


unsigned long	GetNumberOfObjects () const
unsigned long	GetNumberOfLabels () const


virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TLabelImage *image)
const InputImageType *	GetInput (void)
const InputImageType *	GetInput (unsigned int idx)


virtual void	PushBackInput (const InputImageType *image)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const InputImageType *image)
virtual void	PopFrontInput ()


OutputImageType *	GetOutput (void)
OutputImageType *	GetOutput (unsigned int idx)


DataObjectPointerArray &	GetOutputs ()
DataObjectPointerArraySizeType	GetNumberOfOutputs () const


virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()


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


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


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()


static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
Static Public Attributes
static const unsigned int	ImageDimension = TLabelImage::ImageDimension


static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Protected Types
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)>	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)>	OutputToInputRegionCopierType


typedef int	InternalReferenceCountType
Protected Member Functions
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual void	CacheInputReleaseDataFlags ()
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
	LabelGeometryImageFilter ()
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 ()
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
	~LabelGeometryImageFilter ()


const DataObject *	GetInput (unsigned int idx) const


void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)


const DataObject *	GetOutput (unsigned int idx) const


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


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


virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes
TimeStamp	m_OutputInformationMTime
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating

Detailed Description

template<class TLabelImage, class TIntensityImage = TLabelImage>
class itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >

Given a label map and an optional intensity image, compute geometric features.

This filter enables the measurement of geometric features of all objects in a labeled ND volume. This labeled volume can represent, for instance, a medical image segmented into different anatomical structures or a microscope image segmented into individual cells. This filter is closely related to the itkLabelStatisticsImageFilter, which measures statistics of image regions defined by a labeled mask such as min, max, and mean intensity, intensity standard deviation, and bounding boxes. This filter, however, measures the geometry of the labeled regions themselves.

It calculates features similar to the regionprops command of Matlab. The set of measurements that it enables include: volume, centroid, eigenvalues, eigenvectors, axes lenghts, eccentricity, elongation, orientation, bounding box, oriented bounding box, and rotation matrix. These features are based solely on the labeled mask itself. It also calculates integrated intensity and weighted centroid, which are measured on an intensity image under the labeled mask. These features represent the set of currently calculated features, but the framework of the filter is designed so that it can be easily expanded to measure a wide variety of other features.

Authors:: Dirk Padfield and James Miller.

This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on the National Centers for Biomedical Computing can be obtained from http://nihroadmap.nih.gov/bioinformatics.

This filter was contributed in the Insight Journal paper: "A Label Geometry Image Filter for Multiple Object Measurement" by Padfield D., Miller J http://www.insight-journal.org/browse/publication/301 http://hdl.handle.net/1926/1493

Definition at line 74 of file itkLabelGeometryImageFilter.h.

Member Typedef Documentation

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef itk::FixedArray<RealType,itkGetStaticConstMacro(ImageDimension)> itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::AxesLengthType

Axes Length-related typedefs

Definition at line 129 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef itk::FixedArray< float,itkGetStaticConstMacro(ImageDimension)*2> itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::BoundingBoxFloatType

Bounding Box-related typedefs

Definition at line 122 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef itk::FixedArray<typename LabelIndexType::IndexValueType,itkGetStaticConstMacro(ImageDimension)*2> itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::BoundingBoxType

Bounding Box-related typedefs

Definition at line 121 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef std::vector< LabelPointType > itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::BoundingBoxVerticesType

Definition at line 126 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef SmartPointer<const Self> itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TLabelImage, TIntensityImage >.

Definition at line 82 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef DataObject::Pointer itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::DataObjectPointer

Smart Pointer type to a DataObject.

Reimplemented from itk::ImageSource< TIntensityImage >.

Definition at line 115 of file itkLabelGeometryImageFilter.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray [inherited]

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

typedef DataObjectPointerArray::size_type itk::ProcessObject::DataObjectPointerArraySizeType [inherited]

Size type of an std::vector

Definition at line 112 of file itkProcessObject.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef itk::FixedArray< typename LabelIndexType::IndexValueType, itkGetStaticConstMacro(ImageDimension) > itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::IndexArrayType

Index array typedefs

Definition at line 132 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef TIntensityImage::IndexType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::IndexType

Definition at line 95 of file itkLabelGeometryImageFilter.h.

typedef InputImageType::ConstPointer itk::ImageToImageFilter< TLabelImage , TIntensityImage >::InputImageConstPointer [inherited]

Definition at line 84 of file itkImageToImageFilter.h.

typedef InputImageType::PixelType itk::ImageToImageFilter< TLabelImage , TIntensityImage >::InputImagePixelType [inherited]

Definition at line 86 of file itkImageToImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef TIntensityImage::Pointer itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::InputImagePointer

Reimplemented from itk::ImageToImageFilter< TLabelImage, TIntensityImage >.

Definition at line 92 of file itkLabelGeometryImageFilter.h.

typedef InputImageType::RegionType itk::ImageToImageFilter< TLabelImage , TIntensityImage >::InputImageRegionType [inherited]

Definition at line 85 of file itkImageToImageFilter.h.

typedef TLabelImage itk::ImageToImageFilter< TLabelImage , TIntensityImage >::InputImageType [inherited]

Some convenient typedefs.

Definition at line 82 of file itkImageToImageFilter.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)> itk::ImageToImageFilter< TLabelImage , TIntensityImage >::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.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef TIntensityImage itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::IntensityImageType

Image related typedefs.

Definition at line 88 of file itkLabelGeometryImageFilter.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 TLabelImage , class TIntensityImage = TLabelImage>

typedef TLabelImage::Pointer itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::LabelImagePointer

Definition at line 100 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef TLabelImage itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::LabelImageType

Label image related typedefs.

Definition at line 99 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef TLabelImage::IndexType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::LabelIndexType

Definition at line 103 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef std::vector< LabelIndexType > itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::LabelIndicesType

vector of indices

Definition at line 138 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef TLabelImage::PixelType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::LabelPixelType

Definition at line 104 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef TLabelImage::PointType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::LabelPointType

Definition at line 105 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef TLabelImage::RegionType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::LabelRegionType

Definition at line 101 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef TLabelImage::SizeType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::LabelSizeType

Definition at line 102 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef std::vector< LabelPixelType > itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::LabelsType

vector of labels

Definition at line 135 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef itk::hash_map<LabelPixelType, LabelGeometry>::const_iterator itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::MapConstIterator

Definition at line 242 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef itk::hash_map<LabelPixelType, LabelGeometry>::iterator itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::MapIterator

Definition at line 241 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef itk::hash_map<LabelPixelType, LabelGeometry> itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::MapType

Type of the map used to store data per label

Definition at line 240 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef vnl_matrix<double> itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::MatrixType

Matrix type

Definition at line 144 of file itkLabelGeometryImageFilter.h.

typedef Superclass::OutputImagePixelType itk::ImageToImageFilter< TLabelImage , TIntensityImage >::OutputImagePixelType [inherited]

Reimplemented from itk::ImageSource< TIntensityImage >.

Definition at line 79 of file itkImageToImageFilter.h.

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

Definition at line 69 of file itkImageSource.h.

typedef Superclass::OutputImageRegionType itk::ImageToImageFilter< TLabelImage , TIntensityImage >::OutputImageRegionType [inherited]

Superclass typedefs.

Reimplemented from itk::ImageSource< TIntensityImage >.

Definition at line 75 of file itkImageToImageFilter.h.

typedef TIntensityImage itk::ImageSource< TIntensityImage >::OutputImageType [inherited]

Some convenient typedefs.

Definition at line 65 of file itkImageSource.h.

typedef ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)> itk::ImageToImageFilter< TLabelImage , TIntensityImage >::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 TLabelImage , class TIntensityImage = TLabelImage>

typedef TIntensityImage::PixelType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::PixelType

Definition at line 96 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef SmartPointer<Self> itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::Pointer

Reimplemented from itk::ImageToImageFilter< TLabelImage, TIntensityImage >.

Definition at line 81 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef SimpleDataObjectDecorator<RealType> itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::RealObjectType

Type of DataObjects used for scalar outputs

Definition at line 118 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef NumericTraits<PixelType>::RealType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::RealType

Type to use for computations.

Definition at line 112 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef TIntensityImage::RegionType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::RegionType

Definition at line 93 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef LabelGeometryImageFilter itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::Self

Standard Self typedef

Reimplemented from itk::ImageToImageFilter< TLabelImage, TIntensityImage >.

Definition at line 79 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef TIntensityImage::SizeType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::SizeType

Definition at line 94 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef ImageToImageFilter<TLabelImage,TIntensityImage> itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::Superclass

Reimplemented from itk::ImageToImageFilter< TLabelImage, TIntensityImage >.

Definition at line 80 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

typedef std::vector< double > itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::VectorType

Vector type

Definition at line 141 of file itkLabelGeometryImageFilter.h.

Constructor & Destructor Documentation

template<class TLabelImage , class TIntensityImage = TLabelImage>

itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::LabelGeometryImageFilter ( ) [protected]

template<class TLabelImage , class TIntensityImage = TLabelImage>

itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::~LabelGeometryImageFilter ( ) [inline, protected]

Definition at line 463 of file itkLabelGeometryImageFilter.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]

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

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

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[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]

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

virtual void itk::ImageSource< TIntensityImage >::AfterThreadedGenerateData ( void ) [inline, protected, virtual, inherited]

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 265 of file itkImageSource.h.

virtual void itk::ImageSource< TIntensityImage >::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.

virtual void itk::ImageSource< TIntensityImage >::BeforeThreadedGenerateData ( void ) [inline, protected, virtual, inherited]

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 253 of file itkImageSource.h.

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

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

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

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

template<class TLabelImage , class TIntensityImage = TLabelImage>

virtual void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::CalculateOrientedBoundingBoxOff ( ) [virtual]

template<class TLabelImage , class TIntensityImage = TLabelImage>

virtual void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::CalculateOrientedBoundingBoxOn ( ) [virtual]

template<class TLabelImage , class TIntensityImage = TLabelImage>

virtual void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::CalculateOrientedIntensityRegionsOff ( ) [virtual]

template<class TLabelImage , class TIntensityImage = TLabelImage>

virtual void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::CalculateOrientedIntensityRegionsOn ( ) [virtual]

template<class TLabelImage , class TIntensityImage = TLabelImage>

virtual void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::CalculateOrientedLabelRegionsOff ( ) [virtual]

template<class TLabelImage , class TIntensityImage = TLabelImage>

virtual void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::CalculateOrientedLabelRegionsOn ( ) [virtual]

template<class TLabelImage , class TIntensityImage = TLabelImage>

virtual void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::CalculatePixelIndicesOff ( ) [virtual]

template<class TLabelImage , class TIntensityImage = TLabelImage>

virtual void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::CalculatePixelIndicesOn ( ) [virtual]

virtual void itk::ImageToImageFilter< TLabelImage , TIntensityImage >::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< TLabelImage , TIntensityImage >::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.

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

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

Definition at line 225 of file itkProcessObject.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GenerateData ( void ) [protected, virtual]

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:: ThreadedGenerateData()

Reimplemented from itk::ImageSource< TIntensityImage >.

virtual void itk::ImageToImageFilter< TLabelImage , TIntensityImage >::GenerateInputRequestedRegion ( void ) [protected, virtual, inherited]

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 hierachy. 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::ProcessObject.

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

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

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 TLabelImage , class TIntensityImage = TLabelImage>

AxesLengthType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetAxesLength ( LabelPixelType label ) const

Return the axes length for a label.

template<class TLabelImage , class TIntensityImage = TLabelImage>

BoundingBoxType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetBoundingBox ( LabelPixelType label ) const

Return the computed bounding box for a label. This is organized in min/max pairs as [min(X), max(X), min(Y), max(Y), min(Z), max(Z),...]

template<class TLabelImage , class TIntensityImage = TLabelImage>

LabelSizeType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetBoundingBoxSize ( LabelPixelType label ) const

Return the size of the bounding box.

template<class TLabelImage , class TIntensityImage = TLabelImage>

RealType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetBoundingBoxVolume ( LabelPixelType label ) const

Return the volume of the bounding box.

template<class TLabelImage , class TIntensityImage = TLabelImage>

virtual bool itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetCalculateOrientedBoundingBox ( ) [virtual]

template<class TLabelImage , class TIntensityImage = TLabelImage>

virtual bool itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetCalculateOrientedIntensityRegions ( ) [virtual]

template<class TLabelImage , class TIntensityImage = TLabelImage>

virtual bool itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetCalculateOrientedLabelRegions ( ) [virtual]

template<class TLabelImage , class TIntensityImage = TLabelImage>

virtual bool itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetCalculatePixelIndices ( ) [virtual]

template<class TLabelImage , class TIntensityImage = TLabelImage>

LabelPointType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetCentroid ( LabelPixelType label ) const

Return the unweighted centroid for a label.

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 TLabelImage , class TIntensityImage = TLabelImage>

RealType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetEccentricity ( LabelPixelType label ) const

Return the eccentricity for a label.

template<class TLabelImage , class TIntensityImage = TLabelImage>

VectorType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetEigenvalues ( LabelPixelType label ) const

Return the eigenvalues as a vector.

template<class TLabelImage , class TIntensityImage = TLabelImage>

MatrixType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetEigenvectors ( LabelPixelType label ) const

Return the eigenvectors as a matrix.

template<class TLabelImage , class TIntensityImage = TLabelImage>

RealType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetElongation ( LabelPixelType label ) const

Return the elongation for a label. This is defined as the length of the major axis divided by the length of the minor axis.

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

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

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

Set/Get the image input of this process object.

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

Set/Get the image input of this process object.

Reimplemented from itk::ProcessObject.

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

Method used internally for getting an input.

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

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 TLabelImage , class TIntensityImage = TLabelImage>

RealType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetIntegratedIntensity ( LabelPixelType label ) const

Return the number of pixels for all labels. Return the computed integrated pixel intensity for a label.

template<class TLabelImage , class TIntensityImage = TLabelImage>

const TIntensityImage* itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetIntensityInput ( ) const [inline]

Get the label image

Definition at line 335 of file itkLabelGeometryImageFilter.h.

References itk::ProcessObject::GetInput().

template<class TLabelImage , class TIntensityImage = TLabelImage>

std::vector< LabelPixelType > itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetLabels ( ) const [inline]

Get the labels that are in the image.

Definition at line 359 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

RealType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetMajorAxisLength ( LabelPixelType label ) const

Return the major axis length for a label. This is a convenience class that returns the longest length from GetAxesLength.

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

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

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

Returns:: A constant reference to this objects MetaDataDictionary.

template<class TLabelImage , class TIntensityImage = TLabelImage>

RealType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetMinorAxisLength ( LabelPixelType label ) const

Return the minor axis length for a label. This is a convenience class that returns the shortest length from GetAxesLength.

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 TLabelImage , class TIntensityImage = TLabelImage>

virtual const char* itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetNameOfClass ( ) const [virtual]

Runtime information support.

Reimplemented from itk::ImageToImageFilter< TLabelImage, TIntensityImage >.

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.

template<class TLabelImage , class TIntensityImage = TLabelImage>

unsigned long itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetNumberOfLabels ( ) const [inline]

Get the number of labels used

Definition at line 352 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

unsigned long itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetNumberOfObjects ( ) const [inline]

Get the number of labels used

Definition at line 348 of file itkLabelGeometryImageFilter.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]

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

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

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

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

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

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 TLabelImage , class TIntensityImage = TLabelImage>

RealType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetOrientation ( LabelPixelType label ) const

Return the orientation for a label defined in radians.

template<class TLabelImage , class TIntensityImage = TLabelImage>

LabelPointType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetOrientedBoundingBoxOrigin ( LabelPixelType label ) const

Return the origin of the oriented bounding box.

template<class TLabelImage , class TIntensityImage = TLabelImage>

LabelPointType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetOrientedBoundingBoxSize ( LabelPixelType label ) const

Return the size of the oriented bounding box.

template<class TLabelImage , class TIntensityImage = TLabelImage>

BoundingBoxVerticesType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetOrientedBoundingBoxVertices ( LabelPixelType label ) const

Return the oriented bounding box vertices. The order of the vertices corresponds with binary counting, where min is zero and max is one. For example, in 2D, binary counting will give [0,0],[0,1],[1,0],[1,1], which corresponds to [minX,minY],[minX,maxY],[maxX,minY],[maxX,maxY]. Each vertex is defined as an ND point.

template<class TLabelImage , class TIntensityImage = TLabelImage>

RealType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetOrientedBoundingBoxVolume ( LabelPixelType label ) const

Return the volume of the oriented bounding box.

template<class TLabelImage , class TIntensityImage = TLabelImage>

TIntensityImage* itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetOrientedIntensityImage ( LabelPixelType label ) const

Return the intensity region defined by the oriented bounding box.

template<class TLabelImage , class TIntensityImage = TLabelImage>

TLabelImage* itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetOrientedLabelImage ( LabelPixelType label ) const

Return the label region defined by the oriented bounding box.

OutputImageType* itk::ImageSource< TIntensityImage >::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.

OutputImageType* itk::ImageSource< TIntensityImage >::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.

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

Method used internally for getting an output.

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

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

Definition at line 133 of file itkProcessObject.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

LabelIndicesType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetPixelIndices ( LabelPixelType label ) const

Return the all pixel indices for a label.

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.

template<class TLabelImage , class TIntensityImage = TLabelImage>

RegionType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetRegion ( LabelPixelType label ) const

Return the region defined by the bounding box.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( ) [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 bool itk::ProcessObject::GetReleaseDataFlag ( ) const [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 TLabelImage , class TIntensityImage = TLabelImage>

MatrixType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetRotationMatrix ( LabelPixelType label ) const

Return the rotation matrix defined by the eigenvalues/eigenvectors.

template<class TLabelImage , class TIntensityImage = TLabelImage>

unsigned long itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetVolume ( LabelPixelType label ) const

Return the number of pixels for a label. This is the same as the volume and the zero order moment

template<class TLabelImage , class TIntensityImage = TLabelImage>

LabelPointType itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::GetWeightedCentroid ( LabelPixelType label ) const

Return the weighted centroid for a label.

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

virtual void itk::ImageSource< TIntensityImage >::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.

virtual void itk::ImageSource< TIntensityImage >::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).

template<class TLabelImage , class TIntensityImage = TLabelImage>

bool itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::HasLabel ( LabelPixelType label ) const [inline]

Does the specified label exist? Can only be called after a call to Update().

Definition at line 342 of file itkLabelGeometryImageFilter.h.

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.

virtual DataObjectPointer itk::ImageSource< TIntensityImage >::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.

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 TLabelImage , class TIntensityImage = TLabelImage>

static Pointer itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

virtual void itk::ImageToImageFilter< TLabelImage , TIntensityImage >::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< TLabelImage , TIntensityImage >::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]`

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.

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

template<class TLabelImage , class TIntensityImage = TLabelImage>

void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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

Reimplemented from itk::ImageToImageFilter< TLabelImage, TIntensityImage >.

virtual void itk::LightObject::PrintTrailer	(	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.

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.

virtual void itk::ImageToImageFilter< TLabelImage , TIntensityImage >::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< TLabelImage , TIntensityImage >::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.

void itk::ImageToImageFilter< TLabelImage , TIntensityImage >::PushFrontInput ( 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 253 of file itkImageToImageFilter.h.

virtual void itk::ImageToImageFilter< TLabelImage , TIntensityImage >::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]

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::ReleaseDataBeforeUpdateFlagOn ( ) [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.

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

Definition at line 257 of file itkProcessObject.h.

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

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]

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

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]

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

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 TLabelImage , class TIntensityImage = TLabelImage>

void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::SetCalculateOrientedBoundingBox ( const bool value ) [inline]

Definition at line 273 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::SetCalculateOrientedIntensityRegions ( const bool value ) [inline]

Definition at line 311 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::SetCalculateOrientedLabelRegions ( const bool value ) [inline]

Definition at line 293 of file itkLabelGeometryImageFilter.h.

template<class TLabelImage , class TIntensityImage = TLabelImage>

void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::SetCalculatePixelIndices ( const bool value ) [inline]

Definition at line 247 of file itkLabelGeometryImageFilter.h.

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

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

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< TLabelImage , TIntensityImage >::SetInput ( const InputImageType * image ) [virtual, inherited]

Set/Get the image input of this process object.

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

Set/Get the image input of this process object.

template<class TLabelImage , class TIntensityImage = TLabelImage>

void itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::SetIntensityInput ( const TIntensityImage * input ) [inline]

Set the intensity image

Definition at line 328 of file itkLabelGeometryImageFilter.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]

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

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

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

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

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

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

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

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

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

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

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

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

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

virtual int itk::ImageSource< TIntensityImage >::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".

virtual void itk::ImageSource< TIntensityImage >::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()

static ITK_THREAD_RETURN_TYPE itk::ImageSource< TIntensityImage >::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().

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

template<class TLabelImage , class TIntensityImage = TLabelImage>

const unsigned int itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >::ImageDimension = TLabelImage::ImageDimension [static]

Image related typedefs.

Definition at line 109 of file itkLabelGeometryImageFilter.h.

const unsigned int itk::ImageToImageFilter< TLabelImage , TIntensityImage >::InputImageDimension [static, inherited]

ImageDimension constants

Definition at line 90 of file itkImageToImageFilter.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.

const unsigned int itk::ImageToImageFilter< TLabelImage , TIntensityImage >::OutputImageDimension [static, inherited]

ImageDimension constants

Reimplemented from itk::ImageSource< TIntensityImage >.

Definition at line 92 of file itkImageToImageFilter.h.

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

itkLabelGeometryImageFilter.h

itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage > Class Template Reference

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

template<class TLabelImage, class TIntensityImage = TLabelImage> class itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TLabelImage, class TIntensityImage = TLabelImage>
class itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >