itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage > Class Template Reference

#include <itkScalarImageKmeansImageFilter.h>

Inheritance diagram for itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >:

Detailed Description

template<typename TInputImage, typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>
class itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >

Classifies the intensity values of a scalar image using the K-Means algorithm.

Given an input image with scalar values, it uses the K-Means statistical classifier in order to define labels for every pixel in the image. The filter is templated over the type of the input image. The output image is predefined as having the same dimension of the input image and pixel type unsigned char, under the assumption that the classifier will generate less than 256 classes.

You may want to look also at the RelabelImageFilter that may be used as a postprocessing stage, in particular if you are interested in ordering the labels by their relative size in number of pixels.

See Also

Image

ImageKmeansModelEstimator

KdTreeBasedKmeansEstimator, WeightedCentroidKdTreeGenerator, KdTree

RelabelImageFilter

Wiki Examples:

• All Examples
• Cluster the pixels in a greyscale image

Examples:

Examples/Statistics/ScalarImageKmeansClassifier.cxx, and WikiExamples/Statistics/ScalarImageKmeansImageFilter.cxx.

Definition at line 64 of file itkScalarImageKmeansImageFilter.h.

Public Types
typedef itk::Statistics::ImageToListSampleAdaptor < InputImageType >	AdaptorType
typedef itk::Statistics::SampleClassifierFilter < AdaptorType >	ClassifierType
typedef ClassifierType::ClassLabelVectorType	ClassLabelVectorType
typedef SmartPointer< const Self >	ConstPointer
typedef itk::Statistics::MinimumDecisionRule	DecisionRuleType
typedef itk::Statistics::KdTreeBasedKmeansEstimator < TreeType >	EstimatorType
typedef InputImageType::RegionType	ImageRegionType
typedef TInputImage	InputImageType
typedef InputImageType::PixelType	InputPixelType
typedef AdaptorType::MeasurementVectorType	MeasurementVectorType
typedef MembershipFunctionType::CentroidType	MembershipFunctionOriginType
typedef MembershipFunctionType::Pointer	MembershipFunctionPointer
typedef itk::Statistics::DistanceToCentroidMembershipFunction < MeasurementVectorType >	MembershipFunctionType
typedef ClassifierType::MembershipFunctionVectorType	MembershipFunctionVectorType
typedef TOutputImage	OutputImageType
typedef OutputImageType::PixelType	OutputPixelType
typedef EstimatorType::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef NumericTraits < InputPixelType >::RealType	RealPixelType
typedef RegionOfInterestImageFilter < InputImageType, InputImageType >	RegionOfInterestFilterType
typedef ScalarImageKmeansImageFilter	Self
typedef ImageToImageFilter < InputImageType, OutputImageType >	Superclass
typedef itk::Statistics::WeightedCentroidKdTreeGenerator < AdaptorType >	TreeGeneratorType
typedef TreeGeneratorType::KdTreeType	TreeType
Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef SmartPointer< Self >	Pointer
typedef ImageToImageFilter	Self
typedef ImageSource< TOutputImage >	Superclass
Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ImageSource	Self
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef MultiThreader	MultiThreaderType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
void	AddClassWithInitialMean (RealPixelType mean)
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const ParametersType &	GetFinalMeans () const
virtual const ImageRegionType &	GetImageRegion () const
virtual const char *	GetNameOfClass () const
void	SetImageRegion (const ImageRegionType &region)
virtual void	SetUseNonContiguousLabels (bool _arg)
virtual const bool &	GetUseNonContiguousLabels () const
virtual void	UseNonContiguousLabelsOn ()
virtual void	UseNonContiguousLabelsOff ()
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput () override
virtual void	PopFrontInput () override
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TInputImage *image)
virtual void	SetCoordinateTolerance (double _arg)
virtual double	GetCoordinateTolerance () const
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance () const
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *output)
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
virtual ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderType *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
DataObjectPointerArray	GetOutputs ()
virtual const float &	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float progress)
void	SetProgress (float progress)
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

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

Protected Member Functions
void	GenerateData () override
void	PrintSelf (std::ostream &os, Indent indent) const override
	ScalarImageKmeansImageFilter ()
virtual void	VerifyPreconditions () override
virtual	~ScalarImageKmeansImageFilter () override
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	GenerateInputRequestedRegion () override
	ImageToImageFilter ()
virtual void	VerifyInputInformation () override
	~ImageToImageFilter () override
void	PushBackInput (const DataObject *input) override
void	PushFrontInput (const DataObject *input) override
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource () override
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
void	AddOptionalInputName (const DataObjectIdentifierType &)
void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
	~ProcessObject () override
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName (void) const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName (void) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object () override
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Types
typedef std::vector < RealPixelType >	MeansContainer

Private Attributes
ParametersType	m_FinalMeans
ImageRegionType	m_ImageRegion
bool	m_ImageRegionDefined
MeansContainer	m_InitialMeans
bool	m_UseNonContiguousLabels

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

Member Typedef Documentation

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef itk::Statistics::ImageToListSampleAdaptor< InputImageType > itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::AdaptorType

Create a List from the scalar image.

Definition at line 96 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef itk::Statistics::SampleClassifierFilter< AdaptorType > itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::ClassifierType

Definition at line 102 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef ClassifierType::ClassLabelVectorType itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::ClassLabelVectorType

Definition at line 105 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

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

Definition at line 80 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef itk::Statistics::MinimumDecisionRule itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::DecisionRuleType

Definition at line 103 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef itk::Statistics::KdTreeBasedKmeansEstimator< TreeType > itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::EstimatorType

Definition at line 115 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef InputImageType::RegionType itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::ImageRegionType

Definition at line 119 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef TInputImage itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::InputImageType

Convenient typedefs for simplifying declarations.

Definition at line 73 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef InputImageType::PixelType itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::InputPixelType

Image typedef support.

Definition at line 86 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef std::vector< RealPixelType > itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::MeansContainer

private

Definition at line 171 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef AdaptorType::MeasurementVectorType itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::MeasurementVectorType

Define the Measurement vector type from the AdaptorType.

Definition at line 99 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef MembershipFunctionType::CentroidType itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::MembershipFunctionOriginType

Definition at line 108 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef MembershipFunctionType::Pointer itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::MembershipFunctionPointer

Definition at line 110 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef itk::Statistics::DistanceToCentroidMembershipFunction< MeasurementVectorType > itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::MembershipFunctionType

Definition at line 101 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef ClassifierType::MembershipFunctionVectorType itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::MembershipFunctionVectorType

Definition at line 107 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef TOutputImage itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::OutputImageType

Definition at line 74 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef OutputImageType::PixelType itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::OutputPixelType

Definition at line 90 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef EstimatorType::ParametersType itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::ParametersType

Definition at line 117 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef SmartPointer< Self > itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::Pointer

Definition at line 79 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef NumericTraits< InputPixelType >::RealType itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::RealPixelType

Type used for representing the Mean values.

Definition at line 93 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef RegionOfInterestImageFilter< InputImageType, InputImageType > itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::RegionOfInterestFilterType

Definition at line 123 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef ScalarImageKmeansImageFilter itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 77 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef ImageToImageFilter< InputImageType, OutputImageType > itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 78 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef itk::Statistics::WeightedCentroidKdTreeGenerator< AdaptorType > itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::TreeGeneratorType

Create the K-d tree structure.

Definition at line 113 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

typedef TreeGeneratorType::KdTreeType itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::TreeType

Definition at line 114 of file itkScalarImageKmeansImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::ScalarImageKmeansImageFilter ( )

protected

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

virtual itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::~ScalarImageKmeansImageFilter ( )

inlineoverrideprotectedvirtual

Definition at line 156 of file itkScalarImageKmeansImageFilter.h.

Member Function Documentation

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

void itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::AddClassWithInitialMean

(

RealPixelType

mean

)

Add a new class to the classification by specifying its initial mean.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

virtual::itk::LightObject::Pointer itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::CreateAnother ( ) const

virtual

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

Reimplemented from itk::Object.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

void itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::GenerateData ( )

overrideprotectedvirtual

This method runs the statistical methods that identify the means of the classes and the use the distances to those means in order to label the image pixels.

See Also

ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

virtual const ParametersType& itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::GetFinalMeans ( ) const

virtual

Return the array of Means found after the classification.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

virtual const ImageRegionType& itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::GetImageRegion ( ) const

virtual

Get the region over which the statistics will be computed

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

virtual const char* itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

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

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

virtual const bool& itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::GetUseNonContiguousLabels ( ) const

virtual

Set/Get the UseNonContiguousLabels flag. When this is set to false the labels are numbered contiguously, like in {0,1,3..N}. When the flag is set to true, the labels are selected in order to span the dynamic range of the output image. This last option is useful when the output image is intended only for display. The default value is false.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

static Pointer itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

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

overrideprotectedvirtual

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

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

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

void itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::SetImageRegion

(

const ImageRegionType &

region

)

Set Region method to constrain classfication to a certain region

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

virtual void itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::SetUseNonContiguousLabels ( bool  _arg )

virtual

Set/Get the UseNonContiguousLabels flag. When this is set to false the labels are numbered contiguously, like in {0,1,3..N}. When the flag is set to true, the labels are selected in order to span the dynamic range of the output image. This last option is useful when the output image is intended only for display. The default value is false.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

virtual void itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::UseNonContiguousLabelsOff ( )

virtual

Set/Get the UseNonContiguousLabels flag. When this is set to false the labels are numbered contiguously, like in {0,1,3..N}. When the flag is set to true, the labels are selected in order to span the dynamic range of the output image. This last option is useful when the output image is intended only for display. The default value is false.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

virtual void itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::UseNonContiguousLabelsOn ( )

virtual

Set/Get the UseNonContiguousLabels flag. When this is set to false the labels are numbered contiguously, like in {0,1,3..N}. When the flag is set to true, the labels are selected in order to span the dynamic range of the output image. This last option is useful when the output image is intended only for display. The default value is false.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

virtual void itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::VerifyPreconditions ( )

overrideprotectedvirtual

Verifies that the process object has been configured correctly, that all required inputs are set, and needed parameters are set appropriately. If not valid an exceptions will be thrown.

This method is called before UpdateOutputInformation is propagated to the inputs.

The ProcessObject's implementation verifies that the NumberOfRequiredInputs are set and not null.

Reimplemented from itk::ProcessObject.

Member Data Documentation

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

const unsigned int itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension

static

Extract dimension from input and output image.

Definition at line 70 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

ParametersType itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::m_FinalMeans

private

Definition at line 177 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

ImageRegionType itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::m_ImageRegion

private

Definition at line 181 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

bool itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::m_ImageRegionDefined

private

Definition at line 183 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

MeansContainer itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::m_InitialMeans

private

Definition at line 175 of file itkScalarImageKmeansImageFilter.h.

template<typename TInputImage , typename TOutputImage = Image< unsigned char, TInputImage::ImageDimension >>

bool itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::m_UseNonContiguousLabels

private

Definition at line 179 of file itkScalarImageKmeansImageFilter.h.

---

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

• itkScalarImageKmeansImageFilter.h