#include <itkSLICImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TDistancePixel = float>
class itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >

Simple Linear Iterative Clustering (SLIC) super-pixel segmentation.

The Simple Linear Iterative Clustering (SLIC) algorithm groups pixels into a set of labeled regions or super-pixels. Super-pixels follow natural image boundaries, are compact, and are nearly uniform regions which can be used as a larger primitive for more efficient computation. The SLIC algorithm can be viewed as a spatially constrained iterative k-means method.

The original algorithm was designed to cluster on the joint domain of the images index space and its CIELAB color space. This implementation works with images of arbitrary dimension as well as scalar, single channel, images and most multi-component image types including ITK's arbitrary length VectorImage.

The distance between a pixel and a cluster is the sum of squares of the difference between their joint range and domains ( index and value ). The computation is done in index space with scales provided by the SpatialProximityWeight parameters.

The output is a label image with each label representing a superpixel cluster. Every pixel in the output is labeled, and the starting label id is zero.

This code was contributed in the Insight Journal paper: "Scalable Simple Linear Iterative Clustering (SSLIC) Using a Generic and Parallel Approach" by Lowekamp B. C., Chen D. T., Yaniv Z., Yoo T. S. https://doi.org/10.54294/8hic7f

Definition at line 61 of file itkSLICImageFilter.h.

Inheritance diagram for itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >:

Collaboration diagram for itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >:

Classes
struct	UpdateCluster

Public Types
using	ClusterComponentType = double

using	ClusterType = vnl_vector_ref< ClusterComponentType >

using	ConstPointer = SmartPointer< const Self >

using	ContinuousIndexType = ContinuousIndex< typename PointType::ValueType, ImageDimension >

using	DistanceImageType = Image< DistanceType, ImageDimension >

using	DistanceType = TDistancePixel

using	IndexType = typename InputImageType::IndexType

using	InputImageType = TInputImage

using	InputPixelType = typename InputImageType::PixelType

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	OutputPixelType = typename OutputImageType::PixelType

using	Pointer = SmartPointer< Self >

using	PointType = typename InputImageType::PointType

using	Self = SLICImageFilter

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

using	SuperGridSizeType = FixedArray< unsigned int, ImageDimension >

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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< TOutputImage >

Public Types inherited from itk::ImageSource< TOutputImage >
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 = TOutputImage

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
virtual void	EnforceConnectivityOn ()

virtual double	GetAverageResidual () const

virtual bool	GetEnforceConnectivity ()

virtual bool	GetInitializationPerturbation ()

virtual unsigned int	GetMaximumNumberOfIterations () const

const char *	GetNameOfClass () const override

virtual double	GetSpatialProximityWeight () const

virtual SuperGridSizeType	GetSuperGridSize () const

virtual void	InitializationPerturbationOn ()

virtual void	SetEnforceConnectivity (bool _arg)

virtual void	SetInitializationPerturbation (bool _arg)

virtual void	SetMaximumNumberOfIterations (unsigned int _arg)

virtual void	SetSpatialProximityWeight (double _arg)

virtual void	SetSuperGridSize (SuperGridSizeType _arg)

void	SetSuperGridSize (unsigned int factor)

void	SetSuperGridSize (unsigned int i, unsigned int factor)

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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< TOutputImage >
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, TOutputImage >
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, TOutputImage >
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions
void	AfterThreadedGenerateData () override

void	BeforeThreadedGenerateData () override

DistanceType	Distance (const ClusterType &cluster, const InputPixelType &_v, const PointType &pt)

DistanceType	Distance (const ClusterType &cluster1, const ClusterType &cluster2)

void	EnlargeOutputRequestedRegion (DataObject *output) override

void	GenerateData () override

void	PrintSelf (std::ostream &os, Indent indent) const override

void	SingleThreadedConnectivity ()

	SLICImageFilter ()

void	ThreadedConnectivity (SizeValueType clusterIndex)

void	ThreadedPerturbClusters (SizeValueType clusterIndex)

void	ThreadedUpdateClusters (const OutputImageRegionType &updateRegionForThread)

void	ThreadedUpdateDistanceAndLabel (const OutputImageRegionType &outputRegionForThread)

	~SLICImageFilter () override=default

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)

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< TOutputImage >
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	MarkerImageType = Image< unsigned char, ImageDimension >

using	UpdateClusterMap = std::map< vcl_size_t, UpdateCluster >

Private Member Functions
void	RelabelConnectedRegion (const IndexType &seed, OutputPixelType requiredLabel, OutputPixelType outputLabel, std::vector< IndexType > &indexStack)

Private Attributes
double	m_AverageResidual {}

std::vector< ClusterComponentType >	m_Clusters {}

DistanceImageType::Pointer	m_DistanceImage {}

FixedArray< double, ImageDimension >	m_DistanceScales {}

bool	m_EnforceConnectivity { true }

bool	m_InitializationPerturbation { true }

MarkerImageType::Pointer	m_MarkerImage {}

unsigned int	m_MaximumNumberOfIterations {}

std::mutex	m_Mutex {}

std::vector< ClusterComponentType >	m_OldClusters {}

double	m_SpatialProximityWeight { 10.0 }

SuperGridSizeType	m_SuperGridSize {}

std::vector< UpdateClusterMap >	m_UpdateClusterPerThread {}

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
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< TOutputImage >
bool	m_DynamicMultiThreading { true }

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

◆ ClusterComponentType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::ClusterComponentType = double

Definition at line 94 of file itkSLICImageFilter.h.

◆ ClusterType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::ClusterType = vnl_vector_ref<ClusterComponentType>

Definition at line 95 of file itkSLICImageFilter.h.

◆ ConstPointer

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

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

Definition at line 70 of file itkSLICImageFilter.h.

◆ ContinuousIndexType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::ContinuousIndexType = ContinuousIndex<typename PointType::ValueType, ImageDimension>

Definition at line 92 of file itkSLICImageFilter.h.

◆ DistanceImageType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::DistanceImageType = Image<DistanceType, ImageDimension>

Definition at line 88 of file itkSLICImageFilter.h.

◆ DistanceType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::DistanceType = TDistancePixel

Definition at line 87 of file itkSLICImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::IndexType = typename InputImageType::IndexType

Definition at line 90 of file itkSLICImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::InputImageType = TInputImage

Image type information.

Definition at line 83 of file itkSLICImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

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

Definition at line 84 of file itkSLICImageFilter.h.

◆ MarkerImageType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::MarkerImageType = Image<unsigned char, ImageDimension>

private

Definition at line 229 of file itkSLICImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 97 of file itkSLICImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::OutputImageType = TOutputImage

Definition at line 85 of file itkSLICImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

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

Definition at line 86 of file itkSLICImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

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

Definition at line 69 of file itkSLICImageFilter.h.

◆ PointType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::PointType = typename InputImageType::PointType

Definition at line 91 of file itkSLICImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::Self = SLICImageFilter

Standard class type aliases.

Definition at line 67 of file itkSLICImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 68 of file itkSLICImageFilter.h.

◆ SuperGridSizeType

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::SuperGridSizeType = FixedArray<unsigned int, ImageDimension>

Definition at line 99 of file itkSLICImageFilter.h.

◆ UpdateClusterMap

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

using itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::UpdateClusterMap = std::map<vcl_size_t, UpdateCluster>

private

Definition at line 227 of file itkSLICImageFilter.h.

Constructor & Destructor Documentation

◆ SLICImageFilter()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::SLICImageFilter ( )

protected

◆ ~SLICImageFilter()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::~SLICImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ AfterThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::AfterThreadedGenerateData ( )

overrideprotectedvirtual

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

Reimplemented from itk::ImageSource< TOutputImage >.

◆ BeforeThreadedGenerateData()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::BeforeThreadedGenerateData ( )

overrideprotectedvirtual

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

Reimplemented from itk::ImageSource< TOutputImage >.

◆ Distance() [1/2]

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

DistanceType itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::Distance	(	const ClusterType &	cluster,
		const InputPixelType &	_v,
		const PointType &	pt
	)

protected

◆ Distance() [2/2]

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

DistanceType itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::Distance	(	const ClusterType &	cluster1,
		const ClusterType &	cluster2
	)

protected

◆ EnforceConnectivityOn()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::EnforceConnectivityOn ( )

virtual

◆ EnlargeOutputRequestedRegion()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::EnlargeOutputRequestedRegion ( DataObject * output )

overrideprotectedvirtual

Generate full output and require full input

Reimplemented from itk::ProcessObject.

◆ GenerateData()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::GenerateData ( )

overrideprotectedvirtual

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

See also: ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetAverageResidual()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual double itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::GetAverageResidual ( ) const

virtual

Get the current average cluster residual.

After each iteration the residual is computed as the distance between the current clusters and the previous. This is averaged so that the value is independent of the number of clusters.

◆ GetEnforceConnectivity()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual bool itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::GetEnforceConnectivity ( )

virtual

◆ GetInitializationPerturbation()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual bool itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::GetInitializationPerturbation ( )

virtual

◆ GetMaximumNumberOfIterations()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual unsigned int itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::GetMaximumNumberOfIterations ( ) const

virtual

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

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

overridevirtual

See also: LightObject::GetNameOfClass()

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

◆ GetSpatialProximityWeight()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual double itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::GetSpatialProximityWeight ( ) const

virtual

◆ GetSuperGridSize()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual SuperGridSizeType itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::GetSuperGridSize ( ) const

virtual

◆ InitializationPerturbationOn()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::InitializationPerturbationOn ( )

virtual

◆ New()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

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

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::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 >.

◆ RelabelConnectedRegion()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::RelabelConnectedRegion	(	const IndexType &	seed,
		OutputPixelType	requiredLabel,
		OutputPixelType	outputLabel,
		std::vector< IndexType > &	indexStack
	)

private

◆ SetEnforceConnectivity()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::SetEnforceConnectivity ( bool _arg )

virtual

Post processing step to enforce superpixel morphology.

Enable an additional computation which ensures all label pixels of the same value are spatially connected. Disconnected labeled components are assigned a new value if of sufficient size, or are relabeled to the previously encountered value if small.

◆ SetInitializationPerturbation()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::SetInitializationPerturbation ( bool _arg )

virtual

Enable perturbation of initial cluster center location.

After grid based initialization, this option enables moving the initial cluster center location to the minimum gradient in a small neighborhood. If the grid size is less than three this is automatically disabled.

◆ SetMaximumNumberOfIterations()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::SetMaximumNumberOfIterations ( unsigned int _arg )

virtual

Number of iterations to run.

Specify the number of iterations to run when optimizing the clusters.

◆ SetSpatialProximityWeight()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::SetSpatialProximityWeight ( double _arg )

virtual

The spatial weight for the distance function.

Increasing this value makes the superpixel shape more regular, but more varied in image values. The range of the pixel values and image dimension can effect the appropriate value.

◆ SetSuperGridSize() [1/3]

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

virtual void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::SetSuperGridSize ( SuperGridSizeType _arg )

virtual

The expected superpixel size and shape.

The requested size of a superpixel used to form a regular grid for initialization and limits the search space for pixels. The size may be set anisotropically to provide a directional bias. This may be set to reflect spacing of this image.

◆ SetSuperGridSize() [2/3]

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::SetSuperGridSize ( unsigned int factor )

◆ SetSuperGridSize() [3/3]

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::SetSuperGridSize	(	unsigned int	i,
		unsigned int	factor
	)

◆ SingleThreadedConnectivity()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::SingleThreadedConnectivity ( )

protected

◆ ThreadedConnectivity()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::ThreadedConnectivity ( SizeValueType clusterIndex )

protected

◆ ThreadedPerturbClusters()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::ThreadedPerturbClusters ( SizeValueType clusterIndex )

protected

◆ ThreadedUpdateClusters()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::ThreadedUpdateClusters ( const OutputImageRegionType & updateRegionForThread )

protected

◆ ThreadedUpdateDistanceAndLabel()

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

void itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::ThreadedUpdateDistanceAndLabel ( const OutputImageRegionType & outputRegionForThread )

protected

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

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

staticconstexpr

ImageDimension constants

Definition at line 79 of file itkSLICImageFilter.h.

◆ m_AverageResidual

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

double itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_AverageResidual {}

private

Definition at line 240 of file itkSLICImageFilter.h.

◆ m_Clusters

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

std::vector<ClusterComponentType> itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_Clusters {}

private

Definition at line 211 of file itkSLICImageFilter.h.

◆ m_DistanceImage

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

DistanceImageType::Pointer itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_DistanceImage {}

private

Definition at line 233 of file itkSLICImageFilter.h.

◆ m_DistanceScales

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

FixedArray<double, ImageDimension> itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_DistanceScales {}

private

Definition at line 210 of file itkSLICImageFilter.h.

◆ m_EnforceConnectivity

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

bool itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_EnforceConnectivity { true }

private

Definition at line 236 of file itkSLICImageFilter.h.

◆ m_InitializationPerturbation

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

bool itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_InitializationPerturbation { true }

private

Definition at line 238 of file itkSLICImageFilter.h.

◆ m_MarkerImage

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

MarkerImageType::Pointer itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_MarkerImage {}

private

Definition at line 234 of file itkSLICImageFilter.h.

◆ m_MaximumNumberOfIterations

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

unsigned int itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_MaximumNumberOfIterations {}

private

Definition at line 207 of file itkSLICImageFilter.h.

◆ m_Mutex

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

std::mutex itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_Mutex {}

private

Definition at line 241 of file itkSLICImageFilter.h.

◆ m_OldClusters

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

std::vector<ClusterComponentType> itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_OldClusters {}

private

Definition at line 212 of file itkSLICImageFilter.h.

◆ m_SpatialProximityWeight

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

double itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_SpatialProximityWeight { 10.0 }

private

Definition at line 208 of file itkSLICImageFilter.h.

◆ m_SuperGridSize

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

SuperGridSizeType itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_SuperGridSize {}

private

Definition at line 206 of file itkSLICImageFilter.h.

◆ m_UpdateClusterPerThread

template<typename TInputImage , typename TOutputImage , typename TDistancePixel = float>

std::vector<UpdateClusterMap> itk::SLICImageFilter< TInputImage, TOutputImage, TDistancePixel >::m_UpdateClusterPerThread {}

private

Definition at line 231 of file itkSLICImageFilter.h.

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

itkSLICImageFilter.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ClusterComponentType

◆ ClusterType

◆ ConstPointer

◆ ContinuousIndexType

◆ DistanceImageType

◆ DistanceType

◆ IndexType

◆ InputImageType

◆ InputPixelType

◆ MarkerImageType

◆ OutputImageRegionType

◆ OutputImageType

◆ OutputPixelType

◆ Pointer

◆ PointType

◆ Self

◆ Superclass

◆ SuperGridSizeType

◆ UpdateClusterMap

Constructor & Destructor Documentation

◆ SLICImageFilter()

◆ ~SLICImageFilter()

Member Function Documentation

◆ AfterThreadedGenerateData()

◆ BeforeThreadedGenerateData()

◆ Distance() [1/2]

◆ Distance() [2/2]

◆ EnforceConnectivityOn()

◆ EnlargeOutputRequestedRegion()

◆ GenerateData()

◆ GetAverageResidual()

◆ GetEnforceConnectivity()

◆ GetInitializationPerturbation()

◆ GetMaximumNumberOfIterations()

◆ GetNameOfClass()

◆ GetSpatialProximityWeight()

◆ GetSuperGridSize()

◆ InitializationPerturbationOn()

◆ New()

◆ PrintSelf()

◆ RelabelConnectedRegion()

◆ SetEnforceConnectivity()

◆ SetInitializationPerturbation()

◆ SetMaximumNumberOfIterations()

◆ SetSpatialProximityWeight()

◆ SetSuperGridSize() [1/3]

◆ SetSuperGridSize() [2/3]

◆ SetSuperGridSize() [3/3]

◆ SingleThreadedConnectivity()

◆ ThreadedConnectivity()

◆ ThreadedPerturbClusters()

◆ ThreadedUpdateClusters()

◆ ThreadedUpdateDistanceAndLabel()

Member Data Documentation

◆ ImageDimension

◆ m_AverageResidual

◆ m_Clusters

◆ m_DistanceImage

◆ m_DistanceScales

◆ m_EnforceConnectivity

◆ m_InitializationPerturbation

◆ m_MarkerImage

◆ m_MaximumNumberOfIterations

◆ m_Mutex

◆ m_OldClusters

◆ m_SpatialProximityWeight

◆ m_SuperGridSize

◆ m_UpdateClusterPerThread