#include <itkImageRegionSplitterDirection.h>

Detailed Description

Splits an Image region along the slowest axis not in the specified direction. This splitter can be used with image algorithms which operate in a specific direction, where the image should not be split along that dimension.

Definition at line 34 of file itkImageRegionSplitterDirection.h.

Inheritance diagram for itk::ImageRegionSplitterDirection:

Collaboration diagram for itk::ImageRegionSplitterDirection:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = ImageRegionSplitterDirection

using	Superclass = ImageRegionSplitterBase

Public Types inherited from itk::ImageRegionSplitterBase
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = ImageRegionSplitterBase

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
const char *	GetNameOfClass () const override


virtual unsigned int	GetDirection () const

virtual void	SetDirection (unsigned int _arg)

Public Member Functions inherited from itk::ImageRegionSplitterBase
const char *	GetNameOfClass () const override

unsigned int	GetSplit (unsigned int i, unsigned int numberOfPieces, ImageIORegion &region) const

template<unsigned int VImageDimension>
unsigned int	GetSplit (unsigned int i, unsigned int numberOfPieces, ImageRegion< VImageDimension > &region) const

template<unsigned int VImageDimension>
unsigned int	GetNumberOfSplits (const ImageRegion< VImageDimension > &region, unsigned int requestedNumber) const

unsigned int	GetNumberOfSplits (const ImageIORegion &region, unsigned int requestedNumber) 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::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 ()

Protected Member Functions
unsigned int	GetNumberOfSplitsInternal (unsigned int dim, const IndexValueType regionIndex[], const SizeValueType regionSize[], unsigned int requestedNumber) const override

unsigned int	GetSplitInternal (unsigned int dim, unsigned int i, unsigned int numberOfPieces, IndexValueType regionIndex[], SizeValueType regionSize[]) const override

	ImageRegionSplitterDirection ()

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

Protected Member Functions inherited from itk::ImageRegionSplitterBase
virtual unsigned int	GetNumberOfSplitsInternal (unsigned int dim, const IndexValueType regionIndex[], const SizeValueType regionSize[], unsigned int requestedNumber) const =0

virtual unsigned int	GetSplitInternal (unsigned int dim, unsigned int i, unsigned int numberOfPieces, IndexValueType regionIndex[], SizeValueType regionSize[]) const =0

	ImageRegionSplitterBase ()

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

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 Attributes
unsigned int	m_Direction {}

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

Member Typedef Documentation

◆ ConstPointer

using itk::ImageRegionSplitterDirection::ConstPointer = SmartPointer<const Self>

Definition at line 43 of file itkImageRegionSplitterDirection.h.

◆ Pointer

using itk::ImageRegionSplitterDirection::Pointer = SmartPointer<Self>

Definition at line 42 of file itkImageRegionSplitterDirection.h.

◆ Self

using itk::ImageRegionSplitterDirection::Self = ImageRegionSplitterDirection

Standard class type aliases.

Definition at line 40 of file itkImageRegionSplitterDirection.h.

◆ Superclass

using itk::ImageRegionSplitterDirection::Superclass = ImageRegionSplitterBase

Definition at line 41 of file itkImageRegionSplitterDirection.h.

Constructor & Destructor Documentation

◆ ImageRegionSplitterDirection()

itk::ImageRegionSplitterDirection::ImageRegionSplitterDirection ( )

protected

Member Function Documentation

◆ GetDirection()

virtual unsigned int itk::ImageRegionSplitterDirection::GetDirection ( ) const

virtual

Get the direction in which not to split the image.*

Defaults to 0.

◆ GetNameOfClass()

const char * itk::ImageRegionSplitterDirection::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageRegionSplitterBase.

◆ GetNumberOfSplitsInternal()

unsigned int itk::ImageRegionSplitterDirection::GetNumberOfSplitsInternal	(	unsigned int	dim,
		const IndexValueType	regionIndex[],
		const SizeValueType	regionSize[],
		unsigned int	requestedNumber
	)		const

overrideprotectedvirtual

Templateless method to compute the number of possible splits for any number of dimensions.

Implements itk::ImageRegionSplitterBase.

◆ GetSplitInternal()

unsigned int itk::ImageRegionSplitterDirection::GetSplitInternal	(	unsigned int	dim,
		unsigned int	i,
		unsigned int	numberOfPieces,
		IndexValueType	regionIndex[],
		SizeValueType	regionSize[]
	)		const

overrideprotectedvirtual

Templateless method to compute an actual split for any number of dimensions. dim is the size of the regionIndex and regionSize arrays.

Implements itk::ImageRegionSplitterBase.

◆ New()

static Pointer itk::ImageRegionSplitterDirection::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

void itk::ImageRegionSplitterDirection::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::ImageRegionSplitterBase.

◆ SetDirection()

virtual void itk::ImageRegionSplitterDirection::SetDirection ( unsigned int _arg )

virtual

Get the direction in which not to split the image.*

Defaults to 0.

Member Data Documentation

◆ m_Direction

unsigned int itk::ImageRegionSplitterDirection::m_Direction {}

private

Definition at line 81 of file itkImageRegionSplitterDirection.h.

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

itkImageRegionSplitterDirection.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ImageRegionSplitterDirection()

Member Function Documentation

◆ GetDirection()

◆ GetNameOfClass()

◆ GetNumberOfSplitsInternal()

◆ GetSplitInternal()

◆ New()

◆ PrintSelf()

◆ SetDirection()

Member Data Documentation

◆ m_Direction