itk::ThreadedImageRegionPartitioner< VDimension > Class Template Reference

#include <itkThreadedImageRegionPartitioner.h>

Inheritance diagram for itk::ThreadedImageRegionPartitioner< VDimension >:

Collaboration diagram for itk::ThreadedImageRegionPartitioner< VDimension >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	DomainType = typename Superclass::DomainType
using	ImageRegionType = typename Self::DomainType
using	IndexType = typename Self::DomainType::IndexType
using	Pointer = SmartPointer< Self >
using	Self = ThreadedImageRegionPartitioner
using	SizeType = typename Self::DomainType::SizeType
using	Superclass = ThreadedDomainPartitioner< ImageRegion< VDimension > >
Public Types inherited from itk::ThreadedDomainPartitioner< ImageRegion< VDimension > >
using	ConstPointer = SmartPointer< const Self >
using	DomainType = ImageRegion< VDimension >
using	Pointer = SmartPointer< Self >
using	Self = ThreadedDomainPartitioner
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
virtual const char *	GetNameOfClass () const
ThreadIdType	PartitionDomain (const ThreadIdType threadId, const ThreadIdType requestedTotal, const DomainType &completeRegion, DomainType &subRegion) const override
Public Member Functions inherited from itk::ThreadedDomainPartitioner< ImageRegion< VDimension > >
virtual ThreadIdType	PartitionDomain (const ThreadIdType threadId, const ThreadIdType requestedTotal, const DomainType &completeDomain, DomainType &subDomain) const=0
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
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)
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::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 = VDimension

Protected Types
using	ImageRegionSplitterType = ImageRegionSplitterSlowDimension

Protected Member Functions
	ThreadedImageRegionPartitioner ()
	~ThreadedImageRegionPartitioner () override=default
Protected Member Functions inherited from itk::ThreadedDomainPartitioner< ImageRegion< VDimension > >
	ThreadedDomainPartitioner ()=default
	~ThreadedDomainPartitioner () override=default
Protected Member Functions inherited from itk::Object
	Object ()
	~Object () override
void	PrintSelf (std::ostream &os, Indent indent) const override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
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
ImageRegionSplitterType::Pointer	m_ImageRegionSplitter

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

template<unsigned int VDimension>
class itk::ThreadedImageRegionPartitioner< VDimension >

Class for partitioning of an ImageRegion.

Template Parameters

VDimension

The dimensionality of the image.

The DomainType is defined to be an itk::ImageRegion.

Partitioning will occur within the outermost, non-singleton-length dimension of the image region.

This class is typically used as a template argument to a DomainThreader.

See also

ThreadedDomainPartitioner

DomainThreader

Definition at line 45 of file itkThreadedImageRegionPartitioner.h.

Member Typedef Documentation

ConstPointer

template<unsigned int VDimension>

using itk::ThreadedImageRegionPartitioner< VDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 54 of file itkThreadedImageRegionPartitioner.h.

DomainType

template<unsigned int VDimension>

using itk::ThreadedImageRegionPartitioner< VDimension >::DomainType = typename Superclass::DomainType

Type of the object being threaded over

Definition at line 63 of file itkThreadedImageRegionPartitioner.h.

ImageRegionSplitterType

template<unsigned int VDimension>

using itk::ThreadedImageRegionPartitioner< VDimension >::ImageRegionSplitterType = ImageRegionSplitterSlowDimension

protected

Definition at line 93 of file itkThreadedImageRegionPartitioner.h.

ImageRegionType

template<unsigned int VDimension>

using itk::ThreadedImageRegionPartitioner< VDimension >::ImageRegionType = typename Self::DomainType

Definition at line 67 of file itkThreadedImageRegionPartitioner.h.

IndexType

template<unsigned int VDimension>

using itk::ThreadedImageRegionPartitioner< VDimension >::IndexType = typename Self::DomainType::IndexType

Definition at line 69 of file itkThreadedImageRegionPartitioner.h.

Pointer

template<unsigned int VDimension>

using itk::ThreadedImageRegionPartitioner< VDimension >::Pointer = SmartPointer<Self>

Definition at line 53 of file itkThreadedImageRegionPartitioner.h.

Self

template<unsigned int VDimension>

using itk::ThreadedImageRegionPartitioner< VDimension >::Self = ThreadedImageRegionPartitioner

Standard class type aliases.

Definition at line 51 of file itkThreadedImageRegionPartitioner.h.

SizeType

template<unsigned int VDimension>

using itk::ThreadedImageRegionPartitioner< VDimension >::SizeType = typename Self::DomainType::SizeType

Definition at line 68 of file itkThreadedImageRegionPartitioner.h.

Superclass

template<unsigned int VDimension>

using itk::ThreadedImageRegionPartitioner< VDimension >::Superclass = ThreadedDomainPartitioner<ImageRegion<VDimension> >

Definition at line 52 of file itkThreadedImageRegionPartitioner.h.

Constructor & Destructor Documentation

ThreadedImageRegionPartitioner()

template<unsigned int VDimension>

itk::ThreadedImageRegionPartitioner< VDimension >::ThreadedImageRegionPartitioner ( )

protected

~ThreadedImageRegionPartitioner()

template<unsigned int VDimension>

itk::ThreadedImageRegionPartitioner< VDimension >::~ThreadedImageRegionPartitioner ( )

overrideprotecteddefault

Member Function Documentation

CreateAnother()

template<unsigned int VDimension>

virtual::itk::LightObject::Pointer itk::ThreadedImageRegionPartitioner< VDimension >::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::Object.

GetNameOfClass()

template<unsigned int VDimension>

virtual const char* itk::ThreadedImageRegionPartitioner< VDimension >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ThreadedDomainPartitioner< ImageRegion< VDimension > >.

New()

template<unsigned int VDimension>

static Pointer itk::ThreadedImageRegionPartitioner< VDimension >::New ( )

static

Method for creation through the object factory.

PartitionDomain()

template<unsigned int VDimension>

ThreadIdType itk::ThreadedImageRegionPartitioner< VDimension >::PartitionDomain ( const ThreadIdType  threadId, const ThreadIdType  requestedTotal, const DomainType &  completeRegion, DomainType &  subRegion  ) const

override

Split the ImageRegion completeRegion into up to requestedTotal non-overlapping subregions, setting subregion number threadId as subRegion and returning the total number of subregions actually available.

This method should be called repeatedly for each value of threadId from 0 up to the return value (which is always less than or equal to requestedTotal).

It is an error for completeRegion to be zero-length. If threadId is greater than the return value, the contents of subRegion are undefined.

Member Data Documentation

ImageDimension

template<unsigned int VDimension>

constexpr unsigned int itk::ThreadedImageRegionPartitioner< VDimension >::ImageDimension = VDimension

staticconstexpr

Deprecated type alias.

Definition at line 66 of file itkThreadedImageRegionPartitioner.h.

m_ImageRegionSplitter

template<unsigned int VDimension>

ImageRegionSplitterType::Pointer itk::ThreadedImageRegionPartitioner< VDimension >::m_ImageRegionSplitter

private

Definition at line 96 of file itkThreadedImageRegionPartitioner.h.

---

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

• itkThreadedImageRegionPartitioner.h