SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ScalarImageKmeansImageFilter Class Reference

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:

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef ScalarImageKmeansImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image1)
 
Image Execute (const Image &image1, std::vector< double > classWithInitialMean, bool useNonContiguousLabels)
 
std::vector< double > GetClassWithInitialMean () const
 
std::vector< double > GetFinalMeans () const
 
std::string GetName () const
 
bool GetUseNonContiguousLabels () const
 
 ScalarImageKmeansImageFilter ()
 
SelfSetClassWithInitialMean (std::vector< double > ClassWithInitialMean)
 
SelfSetUseNonContiguousLabels (bool UseNonContiguousLabels)
 
std::string ToString () const
 
SelfUseNonContiguousLabelsOff ()
 
SelfUseNonContiguousLabelsOn ()
 
virtual ~ScalarImageKmeansImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 1 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
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
 

Private Types

typedef Image(Self::* MemberFunctionType) (const Image &image1)
 

Private Member Functions

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

Private Attributes

std::vector< double > m_ClassWithInitialMean
 
std::vector< double > m_FinalMeans
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_UseNonContiguousLabels
 

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 void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image CastITKToImage (TImageType *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)
 
static const itk::EventObjectGetITKEventObject (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)
 

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 52 of file sitkScalarImageKmeansImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::ScalarImageKmeansImageFilter::MemberFunctionType) (const Image &image1)
private

Setup for member function dispatching

Definition at line 115 of file sitkScalarImageKmeansImageFilter.h.

Define the pixels types supported by this filter

Definition at line 64 of file sitkScalarImageKmeansImageFilter.h.

Definition at line 54 of file sitkScalarImageKmeansImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::ScalarImageKmeansImageFilter::Execute ( const Image image1,
std::vector< double >  classWithInitialMean,
bool  useNonContiguousLabels 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::ScalarImageKmeansImageFilter::ExecuteInternal ( const Image image1)
private
std::vector<double> itk::simple::ScalarImageKmeansImageFilter::GetClassWithInitialMean ( ) const
inline

Definition at line 74 of file sitkScalarImageKmeansImageFilter.h.

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 95 of file sitkScalarImageKmeansImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 98 of file sitkScalarImageKmeansImageFilter.h.

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 88 of file sitkScalarImageKmeansImageFilter.h.

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

Definition at line 70 of file sitkScalarImageKmeansImageFilter.h.

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 79 of file sitkScalarImageKmeansImageFilter.h.

std::string itk::simple::ScalarImageKmeansImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Self& itk::simple::ScalarImageKmeansImageFilter::UseNonContiguousLabelsOff ( )
inline

Definition at line 83 of file sitkScalarImageKmeansImageFilter.h.

Self& itk::simple::ScalarImageKmeansImageFilter::UseNonContiguousLabelsOn ( )
inline

Set the value of UseNonContiguousLabels to true or false respectfully.

Definition at line 82 of file sitkScalarImageKmeansImageFilter.h.

Friends And Related Function Documentation

Definition at line 119 of file sitkScalarImageKmeansImageFilter.h.

Member Data Documentation

std::vector<double> itk::simple::ScalarImageKmeansImageFilter::m_ClassWithInitialMean
private

Definition at line 124 of file sitkScalarImageKmeansImageFilter.h.

std::vector<double> itk::simple::ScalarImageKmeansImageFilter::m_FinalMeans
private

Definition at line 128 of file sitkScalarImageKmeansImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ScalarImageKmeansImageFilter::m_MemberFactory
private

Definition at line 121 of file sitkScalarImageKmeansImageFilter.h.

bool itk::simple::ScalarImageKmeansImageFilter::m_UseNonContiguousLabels
private

Definition at line 126 of file sitkScalarImageKmeansImageFilter.h.


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