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

#include <itkLabelVotingImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage>
class itk::LabelVotingImageFilter< TInputImage, TOutputImage >

This filter performs pixelwise voting among an arbitrary number of input images, where each of them represents a segmentation of the same scene (i.e., image).

Label voting is a simple method of classifier combination applied to image segmentation. Typically, the accuracy of the combined segmentation exceeds the accuracy of any of the input segmentations. Voting is therefore commonly used as a way of boosting segmentation performance.

The use of label voting for combination of multiple segmentations is described in [100].

INPUTS

All input volumes to this filter must be segmentations of an image, that is, they must have discrete pixel values where each value represents a different segmented object.

Input volumes must all contain the same size RequestedRegions. Not all input images must contain all possible labels, but all label values must have the same meaning in all images.

OUTPUTS

The voting filter produces a single output volume. Each output pixel contains the label that occurred most often among the labels assigned to this pixel in all the input volumes, that is, the label that received the maximum number of "votes" from the input pixels.. If the maximum number of votes is not unique, i.e., if more than one label have a maximum number of votes, an "undecided" label is assigned to that output pixel.

By default, the label used for undecided pixels is the maximum label value used in the input images plus one. Since it is possible for an image with 8 bit pixel values to use all 256 possible label values, it is permissible to combine 8 bit (i.e., byte) images into a 16 bit (i.e., short) output image.

PARAMETERS

The label used for "undecided" labels can be set using SetLabelForUndecidedPixels. This functionality can be unset by calling UnsetLabelForUndecidedPixels.

Author

Torsten Rohlfing, SRI International, Neuroscience Program

Definition at line 73 of file itkLabelVotingImageFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>
using	InputImagePointer = typename InputImageType::ConstPointer
using	InputImageType = TInputImage
using	InputPixelType = typename TInputImage::PixelType
using	LabelCountType = unsigned long
using	OutputImagePointer = typename OutputImageType::Pointer
using	OutputImageRegionType
using	OutputImageType = TOutputImage
using	OutputPixelType = typename TOutputImage::PixelType
using	Pointer = SmartPointer<Self>
using	Self = LabelVotingImageFilter
using	Superclass = ImageToImageFilter<TInputImage, TOutputImage>
Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	ConstPointer
using	InputImageConstPointer
using	InputImagePixelType
using	InputImagePointer
using	InputImageRegionType
using	InputImageType
typedef typename OutputImageType::PixelType	OutputImagePixelType
using	OutputImagePixelType
typedef typename OutputImageType::RegionType	OutputImageRegionType
using	OutputImageRegionType
using	Pointer
using	Self
using	Superclass
Public Types inherited from itk::ImageSource< TInputImage >
using	ConstPointer
using	DataObjectIdentifierType
using	DataObjectPointer
using	DataObjectPointerArraySizeType
using	OutputImagePixelType
using	OutputImagePointer
using	OutputImageRegionType
using	OutputImageType
using	Pointer
using	Self
using	Superclass
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::itk::LightObject::Pointer	CreateAnother () const
OutputPixelType	GetLabelForUndecidedPixels () const
const char *	GetNameOfClass () const override
void	SetLabelForUndecidedPixels (const OutputPixelType l)
void	UnsetLabelForUndecidedPixels ()
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
const InputImageType *	GetInput () const
const InputImageType *	GetInput () const
const InputImageType *	GetInput (unsigned int idx) const
const InputImageType *	GetInput (unsigned int idx) const
void	PopBackInput () override
void	PopBackInput () override
void	PopFrontInput () override
void	PopFrontInput () override
virtual void	PushBackInput (const InputImageType *input)
virtual void	PushBackInput (const InputImageType *input)
virtual void	PushFrontInput (const InputImageType *input)
virtual void	PushFrontInput (const InputImageType *input)
virtual void	SetInput (const InputImageType *input)
virtual void	SetInput (const InputImageType *input)
virtual void	SetInput (unsigned int, const TInputImage *image)
virtual void	SetInput (unsigned int, const TInputImage *image)
virtual void	SetCoordinateTolerance (double _arg)
virtual double	GetCoordinateTolerance () const
virtual void	SetCoordinateTolerance (double _arg)
virtual double	GetCoordinateTolerance () const
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance () const
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance () const
Public Member Functions inherited from itk::ImageSource< TInputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *graft)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
virtual void	GraftOutput (DataObject *graft)
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *output)
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 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	ReleaseDataBeforeUpdateFlagOff ()
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
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 void	Delete ()
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static double	GetGlobalDefaultCoordinateTolerance ()
static double	GetGlobalDefaultCoordinateTolerance ()
static double	GetGlobalDefaultDirectionTolerance ()
static double	GetGlobalDefaultDirectionTolerance ()
static void	SetGlobalDefaultCoordinateTolerance (double)
static void	SetGlobalDefaultCoordinateTolerance (double)
static void	SetGlobalDefaultDirectionTolerance (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 = TOutputImage::ImageDimension
static constexpr unsigned int	InputImageDimension = TInputImage::ImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static constexpr unsigned int	InputImageDimension
static constexpr unsigned int	InputImageDimension
static constexpr unsigned int	OutputImageDimension
static constexpr unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::ImageSource< TInputImage >
static constexpr unsigned int	OutputImageDimension

Protected Member Functions
void	BeforeThreadedGenerateData () override
InputPixelType	ComputeMaximumInputValue ()
void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread) override
	LabelVotingImageFilter ()
void	PrintSelf (std::ostream &, Indent) const override
	~LabelVotingImageFilter () override=default
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
void	GenerateInputRequestedRegion () override
void	GenerateInputRequestedRegion () override
	ImageToImageFilter ()
	ImageToImageFilter ()
void	VerifyInputInformation () const override
void	VerifyInputInformation () const override
	~ImageToImageFilter () override=default
	~ImageToImageFilter () override=default
Protected Member Functions inherited from itk::ImageSource< TInputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
void	ClassicMultiThread (ThreadFunctionType callbackFunction)
void	GenerateData () override
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
	~ImageSource () override=default
virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
virtual bool	GetDynamicMultiThreading () const
virtual void	SetDynamicMultiThreading (bool _arg)
virtual void	DynamicMultiThreadingOn ()
virtual void	DynamicMultiThreadingOff ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
void	AddOptionalInputName (const DataObjectIdentifierType &)
void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
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	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	ThreaderUpdateProgressOff ()
virtual void	SetThreaderUpdateProgress (bool arg)
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
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	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Attributes
bool	m_HasLabelForUndecidedPixels { false }
OutputPixelType	m_LabelForUndecidedPixels {}
vcl_size_t	m_TotalLabelCount { 0 }

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
using	InputToOutputRegionCopierType
using	OutputToInputRegionCopierType
Static Protected Member Functions inherited from itk::ImageSource< TInputImage >
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< TInputImage >
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

ConstPointer

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 82 of file itkLabelVotingImageFilter.h.

InputImagePointer

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::LabelVotingImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::ConstPointer

Definition at line 103 of file itkLabelVotingImageFilter.h.

InputImageType

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Image type alias support

Definition at line 101 of file itkLabelVotingImageFilter.h.

InputPixelType

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 93 of file itkLabelVotingImageFilter.h.

LabelCountType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::LabelVotingImageFilter< TInputImage, TOutputImage >::LabelCountType = unsigned long

Definition at line 106 of file itkLabelVotingImageFilter.h.

OutputImagePointer

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::LabelVotingImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 104 of file itkLabelVotingImageFilter.h.

OutputImageRegionType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ImageSource< TOutputImage >::OutputImageRegionType

Definition at line 125 of file itkImageSource.h.

OutputImageType

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 102 of file itkLabelVotingImageFilter.h.

OutputPixelType

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 92 of file itkLabelVotingImageFilter.h.

Pointer

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 81 of file itkLabelVotingImageFilter.h.

Self

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Standard class type aliases.

Definition at line 79 of file itkLabelVotingImageFilter.h.

Superclass

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::LabelVotingImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 80 of file itkLabelVotingImageFilter.h.

Constructor & Destructor Documentation

LabelVotingImageFilter()

template<typename TInputImage, typename TOutputImage = TInputImage>

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

protected

Referenced by GetNameOfClass().

~LabelVotingImageFilter()

template<typename TInputImage, typename TOutputImage = TInputImage>

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

overrideprotecteddefault

Member Function Documentation

BeforeThreadedGenerateData()

template<typename TInputImage, typename TOutputImage = TInputImage>

void itk::LabelVotingImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )

overrideprotectedvirtual

Determine maximum label value in all input images and initialize global data.

Reimplemented from itk::ImageSource< TInputImage >.

ComputeMaximumInputValue()

template<typename TInputImage, typename TOutputImage = TInputImage>

InputPixelType itk::LabelVotingImageFilter< TInputImage, TOutputImage >::ComputeMaximumInputValue ( )

protected

Determine maximum value among all input images' pixels.

CreateAnother()

template<typename TInputImage, typename TOutputImage = TInputImage>

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

virtual

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

Reimplemented from itk::LightObject.

DynamicThreadedGenerateData()

template<typename TInputImage, typename TOutputImage = TInputImage>

void itk::LabelVotingImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType & outputRegionForThread )

overrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See also

GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TInputImage >.

GetLabelForUndecidedPixels()

template<typename TInputImage, typename TOutputImage = TInputImage>

OutputPixelType itk::LabelVotingImageFilter< TInputImage, TOutputImage >::GetLabelForUndecidedPixels ( ) const

inline

Get label value used for undecided pixels. After updating the filter, this function returns the actual label value used for undecided pixels in the current output. Note that this value is overwritten when SetLabelForUndecidedPixels is called and the new value only becomes effective upon the next filter update.

Definition at line 127 of file itkLabelVotingImageFilter.h.

References m_LabelForUndecidedPixels.

GetNameOfClass()

template<typename TInputImage, typename TOutputImage = TInputImage>

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

overridevirtual

See also

LightObject::GetNameOfClass()

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

References LabelVotingImageFilter().

New()

template<typename TInputImage, typename TOutputImage = TInputImage>

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

static

Method for creation through the object factory.

PrintSelf()

template<typename TInputImage, typename TOutputImage = TInputImage>

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

overrideprotectedvirtual

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

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

SetLabelForUndecidedPixels()

template<typename TInputImage, typename TOutputImage = TInputImage>

void itk::LabelVotingImageFilter< TInputImage, TOutputImage >::SetLabelForUndecidedPixels ( const OutputPixelType l )

inline

Set label value for undecided pixels.

Definition at line 113 of file itkLabelVotingImageFilter.h.

References m_HasLabelForUndecidedPixels, m_LabelForUndecidedPixels, and itk::Object::Modified().

UnsetLabelForUndecidedPixels()

template<typename TInputImage, typename TOutputImage = TInputImage>

void itk::LabelVotingImageFilter< TInputImage, TOutputImage >::UnsetLabelForUndecidedPixels ( )

inline

Unset label value for undecided pixels and turn on automatic selection.

Definition at line 135 of file itkLabelVotingImageFilter.h.

References m_HasLabelForUndecidedPixels, and itk::Object::Modified().

Member Data Documentation

ImageDimension

template<typename TInputImage, typename TOutputImage = TInputImage>

unsigned int itk::LabelVotingImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 98 of file itkLabelVotingImageFilter.h.

InputImageDimension

template<typename TInputImage, typename TOutputImage = TInputImage>

unsigned int itk::LabelVotingImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 97 of file itkLabelVotingImageFilter.h.

m_HasLabelForUndecidedPixels

template<typename TInputImage, typename TOutputImage = TInputImage>

bool itk::LabelVotingImageFilter< TInputImage, TOutputImage >::m_HasLabelForUndecidedPixels { false }

private

Definition at line 175 of file itkLabelVotingImageFilter.h.

Referenced by SetLabelForUndecidedPixels(), and UnsetLabelForUndecidedPixels().

m_LabelForUndecidedPixels

template<typename TInputImage, typename TOutputImage = TInputImage>

OutputPixelType itk::LabelVotingImageFilter< TInputImage, TOutputImage >::m_LabelForUndecidedPixels {}

private

Definition at line 174 of file itkLabelVotingImageFilter.h.

Referenced by GetLabelForUndecidedPixels(), and SetLabelForUndecidedPixels().

m_TotalLabelCount

template<typename TInputImage, typename TOutputImage = TInputImage>

vcl_size_t itk::LabelVotingImageFilter< TInputImage, TOutputImage >::m_TotalLabelCount { 0 }

private

Definition at line 176 of file itkLabelVotingImageFilter.h.

---

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

• itkLabelVotingImageFilter.h