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

#include <sitkScalarImageKmeansImageFilter.h>

Inheritance diagram for itk::simple::ScalarImageKmeansImageFilter:

Collaboration diagram for itk::simple::ScalarImageKmeansImageFilter:

Detailed Description

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::simple::ScalarImageKmeans for the procedural interface; itk::ScalarImageKmeansImageFilter for the Doxygen on the original ITK class.

Definition at line 54 of file sitkScalarImageKmeansImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList

using	Self = ScalarImageKmeansImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
Image	Execute (const Image &image1)

std::vector< double >	GetClassWithInitialMean () const

std::vector< double >	GetFinalMeans () const

std::string	GetName () const

bool	GetUseNonContiguousLabels () const

	ScalarImageKmeansImageFilter ()

Self &	SetClassWithInitialMean (std::vector< double > ClassWithInitialMean)

Self &	SetUseNonContiguousLabels (bool UseNonContiguousLabels)

std::string	ToString () const

Self &	UseNonContiguousLabelsOff ()

Self &	UseNonContiguousLabelsOn ()

virtual	~ScalarImageKmeansImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event.

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event.

virtual float	GetProgress () const
	An Active Measurement of the progress of execution.

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event.

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands.

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

virtual void	SetNumberOfWorkUnits (unsigned int n)

virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType = Image (Self::*)( const Image& image1 )

Private Member Functions
template<class TImageType>
Image	ExecuteInternal (const Image &image1)

Private Attributes
std::vector< double >	m_ClassWithInitialMean {std::vector<double>()}

std::vector< double >	m_FinalMeans {std::vector<double>()}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

bool	m_UseNonContiguousLabels {false}

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces.

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces.

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces.

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces.

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects.

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects.

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects.

Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) noexcept

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType>
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType>
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TPixelType, unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType>
static Image	CastITKToImage (TImageType *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T>
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::ScalarImageKmeansImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 114 of file sitkScalarImageKmeansImageFilter.h.

◆ PixelIDTypeList

using itk::simple::ScalarImageKmeansImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 66 of file sitkScalarImageKmeansImageFilter.h.

◆ Self

using itk::simple::ScalarImageKmeansImageFilter::Self = ScalarImageKmeansImageFilter

Definition at line 56 of file sitkScalarImageKmeansImageFilter.h.

Constructor & Destructor Documentation

◆ ~ScalarImageKmeansImageFilter()

virtual itk::simple::ScalarImageKmeansImageFilter::~ScalarImageKmeansImageFilter ( )

virtual

Destructor

◆ ScalarImageKmeansImageFilter()

itk::simple::ScalarImageKmeansImageFilter::ScalarImageKmeansImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::ScalarImageKmeansImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType>

Image itk::simple::ScalarImageKmeansImageFilter::ExecuteInternal ( const Image & image1 )

private

Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.

◆ GetClassWithInitialMean()

std::vector< double > itk::simple::ScalarImageKmeansImageFilter::GetClassWithInitialMean ( ) const

inline

Definition at line 75 of file sitkScalarImageKmeansImageFilter.h.

References m_ClassWithInitialMean.

◆ GetFinalMeans()

std::vector< double > itk::simple::ScalarImageKmeansImageFilter::GetFinalMeans ( ) const

inline

Return the array of Means found after the classification.

This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.

Definition at line 96 of file sitkScalarImageKmeansImageFilter.h.

References m_FinalMeans.

◆ GetName()

std::string itk::simple::ScalarImageKmeansImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 100 of file sitkScalarImageKmeansImageFilter.h.

◆ GetUseNonContiguousLabels()

bool itk::simple::ScalarImageKmeansImageFilter::GetUseNonContiguousLabels ( ) const

inline

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.

Definition at line 89 of file sitkScalarImageKmeansImageFilter.h.

References m_UseNonContiguousLabels.

◆ SetClassWithInitialMean()

Self & itk::simple::ScalarImageKmeansImageFilter::SetClassWithInitialMean ( std::vector< double > ClassWithInitialMean )

inline

Definition at line 71 of file sitkScalarImageKmeansImageFilter.h.

References m_ClassWithInitialMean.

◆ SetUseNonContiguousLabels()

Self & itk::simple::ScalarImageKmeansImageFilter::SetUseNonContiguousLabels ( bool UseNonContiguousLabels )

inline

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.

Definition at line 80 of file sitkScalarImageKmeansImageFilter.h.

References m_UseNonContiguousLabels.

Referenced by UseNonContiguousLabelsOff(), and UseNonContiguousLabelsOn().