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

#include <itkScalarImageKmeansImageFilter.h>

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

ITK Sphinx Examples:

• <a href=
• <a href=
• <a href=

Definition at line 65 of file itkScalarImageKmeansImageFilter.h.

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

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

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

Public Member Functions
void	AddClassWithInitialMean (RealPixelType mean)
virtual const ParametersType &	GetFinalMeans () const
virtual const ImageRegionType &	GetImageRegion () const
const char *	GetNameOfClass () const override
void	SetImageRegion (const ImageRegionType &region)
virtual void	SetUseNonContiguousLabels (bool _arg)
virtual const bool &	GetUseNonContiguousLabels () const
virtual void	UseNonContiguousLabelsOn ()
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< unsigned char, TInputImage::ImageDimension > >
const InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
const char *	GetNameOfClass () const override
void	PopBackInput () override
void	PopFrontInput () override
virtual void	PushBackInput (const InputImageType *input)
virtual void	PushFrontInput (const InputImageType *input)
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetInput (const InputImageType *input)
virtual void	SetInput (unsigned int, const TInputImage *image)
virtual void	SetCoordinateTolerance (double _arg)
virtual double	GetCoordinateTolerance () const
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance () const
Public Member Functions inherited from itk::ImageSource< Image< unsigned char, TInputImage::ImageDimension > >
const char *	GetNameOfClass () const override
OutputImageType *	GetOutput (unsigned int idx)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
virtual void	GraftOutput (DataObject *graft)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)
ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData () const
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
NameArray	GetInputNames () const
DataObjectPointerArray	GetInputs ()
MultiThreaderType *	GetMultiThreader () const
const char *	GetNameOfClass () const override
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
DataObjectPointerArray	GetOutputs ()
virtual float	GetProgress () const
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
void	IncrementProgress (float increment)
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetMultiThreader (MultiThreaderType *threader)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float progress)
virtual void	SetReleaseDataFlag (bool val)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag () const
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfWorkUnits () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
LightObject::Pointer	CreateAnother () const override
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
const char *	GetNameOfClass () const override
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag) const
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexcept override
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
Pointer	Clone () const
virtual Pointer	CreateAnother () const
virtual void	Delete ()
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< unsigned char, TInputImage::ImageDimension > >
static double	GetGlobalDefaultCoordinateTolerance ()
static double	GetGlobalDefaultDirectionTolerance ()
static void	SetGlobalDefaultCoordinateTolerance (double)
static void	SetGlobalDefaultDirectionTolerance (double)
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

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

Protected Member Functions
void	GenerateData () override
void	PrintSelf (std::ostream &os, Indent indent) const override
	ScalarImageKmeansImageFilter ()
void	VerifyPreconditions () const override
	~ScalarImageKmeansImageFilter () override=default
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, Image< unsigned char, TInputImage::ImageDimension > >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
void	GenerateInputRequestedRegion () override
	ImageToImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const override
void	VerifyInputInformation () const override
	~ImageToImageFilter () override=default
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< Image< unsigned char, TInputImage::ImageDimension > >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
void	GenerateData () override
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
	~ImageSource () override=default
virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
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	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
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
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
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 idx, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)
virtual void	SetPrimaryInput (DataObject *object)
virtual void	SetPrimaryOutput (DataObject *object)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyInputInformation () const
virtual void	VerifyPreconditions () const
	~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 () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName () const
DataObject *	GetOutput (DataObjectPointerArraySizeType i)
const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual bool	GetThreaderUpdateProgress () const
virtual void	ThreaderUpdateProgressOn ()
virtual void	SetThreaderUpdateProgress (bool arg)
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
	~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	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Types
using	MeansContainer = std::vector< RealPixelType >

Private Attributes
ParametersType	m_FinalMeans {}
ImageRegionType	m_ImageRegion {}
bool	m_ImageRegionDefined { false }
MeansContainer	m_InitialMeans {}
bool	m_UseNonContiguousLabels { false }

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, Image< unsigned char, TInputImage::ImageDimension > >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
Static Protected Member Functions inherited from itk::ImageSource< Image< unsigned char, TInputImage::ImageDimension > >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)
Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
static constexpr float	progressFixedToFloat (uint32_t fixed)
static uint32_t	progressFloatToFixed (float f)
Protected Attributes inherited from itk::ImageSource< Image< unsigned char, TInputImage::ImageDimension > >
bool	m_DynamicMultiThreading
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}
bool	m_Updating {}
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

AdaptorType

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

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

Create a List from the scalar image.

Definition at line 97 of file itkScalarImageKmeansImageFilter.h.

ClassifierType

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

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

Definition at line 103 of file itkScalarImageKmeansImageFilter.h.

ClassLabelVectorType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::ClassLabelVectorType = typename ClassifierType::ClassLabelVectorType

Definition at line 106 of file itkScalarImageKmeansImageFilter.h.

ConstPointer

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

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

Definition at line 81 of file itkScalarImageKmeansImageFilter.h.

DecisionRuleType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::DecisionRuleType = itk::Statistics::MinimumDecisionRule

Definition at line 104 of file itkScalarImageKmeansImageFilter.h.

EstimatorType

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

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

Definition at line 116 of file itkScalarImageKmeansImageFilter.h.

ImageRegionType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::ImageRegionType = typename InputImageType::RegionType

Definition at line 120 of file itkScalarImageKmeansImageFilter.h.

InputImageType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Convenient type alias for simplifying declarations.

Definition at line 74 of file itkScalarImageKmeansImageFilter.h.

InputPixelType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::InputPixelType = typename InputImageType::PixelType

Image type alias support

Definition at line 90 of file itkScalarImageKmeansImageFilter.h.

MeansContainer

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

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

private

Definition at line 174 of file itkScalarImageKmeansImageFilter.h.

MeasurementVectorType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::MeasurementVectorType = typename AdaptorType::MeasurementVectorType

Define the Measurement vector type from the AdaptorType.

Definition at line 100 of file itkScalarImageKmeansImageFilter.h.

MembershipFunctionOriginType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::MembershipFunctionOriginType = typename MembershipFunctionType::CentroidType

Definition at line 109 of file itkScalarImageKmeansImageFilter.h.

MembershipFunctionPointer

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::MembershipFunctionPointer = typename MembershipFunctionType::Pointer

Definition at line 111 of file itkScalarImageKmeansImageFilter.h.

MembershipFunctionType

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

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

Definition at line 102 of file itkScalarImageKmeansImageFilter.h.

MembershipFunctionVectorType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::MembershipFunctionVectorType = typename ClassifierType::MembershipFunctionVectorType

Definition at line 108 of file itkScalarImageKmeansImageFilter.h.

OutputImageType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 75 of file itkScalarImageKmeansImageFilter.h.

OutputPixelType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 91 of file itkScalarImageKmeansImageFilter.h.

ParametersType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::ParametersType = typename EstimatorType::ParametersType

Definition at line 118 of file itkScalarImageKmeansImageFilter.h.

Pointer

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 80 of file itkScalarImageKmeansImageFilter.h.

RealPixelType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::RealPixelType = typename NumericTraits<InputPixelType>::RealType

Type used for representing the Mean values.

Definition at line 94 of file itkScalarImageKmeansImageFilter.h.

RegionOfInterestFilterType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::RegionOfInterestFilterType = RegionOfInterestImageFilter<InputImageType, InputImageType>

Definition at line 122 of file itkScalarImageKmeansImageFilter.h.

Self

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::Self = ScalarImageKmeansImageFilter

Standard class type aliases.

Definition at line 78 of file itkScalarImageKmeansImageFilter.h.

Superclass

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

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

Definition at line 79 of file itkScalarImageKmeansImageFilter.h.

TreeGeneratorType

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

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

Create the K-d tree structure.

Definition at line 114 of file itkScalarImageKmeansImageFilter.h.

TreeType

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

using itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::TreeType = typename TreeGeneratorType::KdTreeType

Definition at line 115 of file itkScalarImageKmeansImageFilter.h.

Constructor & Destructor Documentation

ScalarImageKmeansImageFilter()

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

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

protected

~ScalarImageKmeansImageFilter()

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

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

overrideprotecteddefault

Member Function Documentation

AddClassWithInitialMean()

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.

GenerateData()

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

GetFinalMeans()

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.

GetImageRegion()

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

GetNameOfClass()

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

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

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

GetUseNonContiguousLabels()

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.

New()

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.

PrintSelf()

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

SetImageRegion()

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

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

(

const ImageRegionType &

region

)

Set Region method to constrain classification to a certain region

SetUseNonContiguousLabels()

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.

UseNonContiguousLabelsOn()

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.

VerifyPreconditions()

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

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

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 m_NumberOfRequiredInputs are set and not null.

Reimplemented from itk::ProcessObject.

Member Data Documentation

ImageDimension

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

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

staticconstexpr

Extract dimension from input and output image.

Definition at line 71 of file itkScalarImageKmeansImageFilter.h.

m_FinalMeans

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

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

private

Definition at line 178 of file itkScalarImageKmeansImageFilter.h.

m_ImageRegion

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

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

private

Definition at line 182 of file itkScalarImageKmeansImageFilter.h.

m_ImageRegionDefined

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

bool itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::m_ImageRegionDefined { false }

private

Definition at line 184 of file itkScalarImageKmeansImageFilter.h.

m_InitialMeans

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

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

private

Definition at line 176 of file itkScalarImageKmeansImageFilter.h.

m_UseNonContiguousLabels

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

bool itk::ScalarImageKmeansImageFilter< TInputImage, TOutputImage >::m_UseNonContiguousLabels { false }

private

Definition at line 180 of file itkScalarImageKmeansImageFilter.h.

---

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

• itkScalarImageKmeansImageFilter.h