#include <itkValarrayImageContainer.h>

Detailed Description

template<typename TElementIdentifier, typename TElement>
class itk::ValarrayImageContainer< TElementIdentifier, TElement >

Defines a front-end to the std\::<valarray> container that conforms to the ImageContainerInterface.

This is a full-fledged Object, so there is modification time, debug, and reference count information.

Template Parameters

TElementIdentifier	An INTEGRAL type for use in indexing the valarray. It must have a < operator defined for ordering.
TElement	The element type stored in the container.

Definition at line 48 of file itkValarrayImageContainer.h.

Inheritance diagram for itk::ValarrayImageContainer< TElementIdentifier, TElement >:

Collaboration diagram for itk::ValarrayImageContainer< TElementIdentifier, TElement >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Element = TElement

using	ElementIdentifier = TElementIdentifier

using	Pointer = SmartPointer< Self >

using	Self = ValarrayImageContainer

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
void	Fill (const TElement &value)

const char *	GetNameOfClass () const override

void	Initialize ()

TElement &	operator[] (const ElementIdentifier id)

const TElement &	operator[] (const ElementIdentifier id) const

void	Reserve (ElementIdentifier num)

unsigned long	Size () const

void	Squeeze ()


TElement *	GetBufferPointer ()


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

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::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

	ValarrayImageContainer ()

	ValarrayImageContainer (unsigned long n)

	ValarrayImageContainer (unsigned long n, const Element &x)

	ValarrayImageContainer (const Self &r)

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 Types
using	ValarrayType = std::valarray< Element >

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

Member Typedef Documentation

◆ ConstPointer

template<typename TElementIdentifier , typename TElement >

using itk::ValarrayImageContainer< TElementIdentifier, TElement >::ConstPointer = SmartPointer<const Self>

Definition at line 57 of file itkValarrayImageContainer.h.

◆ Element

template<typename TElementIdentifier , typename TElement >

using itk::ValarrayImageContainer< TElementIdentifier, TElement >::Element = TElement

Definition at line 61 of file itkValarrayImageContainer.h.

◆ ElementIdentifier

template<typename TElementIdentifier , typename TElement >

using itk::ValarrayImageContainer< TElementIdentifier, TElement >::ElementIdentifier = TElementIdentifier

Save the template parameters.

Definition at line 60 of file itkValarrayImageContainer.h.

◆ Pointer

template<typename TElementIdentifier , typename TElement >

using itk::ValarrayImageContainer< TElementIdentifier, TElement >::Pointer = SmartPointer<Self>

Definition at line 56 of file itkValarrayImageContainer.h.

◆ Self

template<typename TElementIdentifier , typename TElement >

using itk::ValarrayImageContainer< TElementIdentifier, TElement >::Self = ValarrayImageContainer

Standard class type aliases.

Definition at line 54 of file itkValarrayImageContainer.h.

◆ Superclass

template<typename TElementIdentifier , typename TElement >

using itk::ValarrayImageContainer< TElementIdentifier, TElement >::Superclass = Object

Definition at line 55 of file itkValarrayImageContainer.h.

◆ ValarrayType

template<typename TElementIdentifier , typename TElement >

using itk::ValarrayImageContainer< TElementIdentifier, TElement >::ValarrayType = std::valarray<Element>

private

Quick access to the STL valarray type that was inherited.

Definition at line 65 of file itkValarrayImageContainer.h.

Constructor & Destructor Documentation

◆ ValarrayImageContainer() [1/4]

template<typename TElementIdentifier , typename TElement >

itk::ValarrayImageContainer< TElementIdentifier, TElement >::ValarrayImageContainer ( )

inlineprotected

Provide pass-through constructors corresponding to all the STL valarray constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.

Definition at line 72 of file itkValarrayImageContainer.h.

◆ ValarrayImageContainer() [2/4]

template<typename TElementIdentifier , typename TElement >

itk::ValarrayImageContainer< TElementIdentifier, TElement >::ValarrayImageContainer ( unsigned long n )

inlineprotected

Provide pass-through constructors corresponding to all the STL valarray constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.

Definition at line 75 of file itkValarrayImageContainer.h.

◆ ValarrayImageContainer() [3/4]

template<typename TElementIdentifier , typename TElement >

itk::ValarrayImageContainer< TElementIdentifier, TElement >::ValarrayImageContainer	(	unsigned long	n,
		const Element &	x
	)

inlineprotected

Provide pass-through constructors corresponding to all the STL valarray constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.

Definition at line 78 of file itkValarrayImageContainer.h.

◆ ValarrayImageContainer() [4/4]

template<typename TElementIdentifier , typename TElement >

itk::ValarrayImageContainer< TElementIdentifier, TElement >::ValarrayImageContainer ( const Self & r )

inlineprotected

Provide pass-through constructors corresponding to all the STL valarray constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.

Definition at line 81 of file itkValarrayImageContainer.h.

Member Function Documentation

◆ Fill()

template<typename TElementIdentifier , typename TElement >

void itk::ValarrayImageContainer< TElementIdentifier, TElement >::Fill ( const TElement & value )

inline

Tell the container to release any of its allocated memory.

Definition at line 158 of file itkValarrayImageContainer.h.

◆ GetBufferPointer()

template<typename TElementIdentifier , typename TElement >

TElement* itk::ValarrayImageContainer< TElementIdentifier, TElement >::GetBufferPointer ( )

inline

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

Definition at line 110 of file itkValarrayImageContainer.h.

◆ GetNameOfClass()

template<typename TElementIdentifier , typename TElement >

const char* itk::ValarrayImageContainer< TElementIdentifier, TElement >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ Initialize()

template<typename TElementIdentifier , typename TElement >

void itk::ValarrayImageContainer< TElementIdentifier, TElement >::Initialize ( )

inline

Tell the container to release any of its allocated memory.

Definition at line 151 of file itkValarrayImageContainer.h.

◆ New()

template<typename TElementIdentifier , typename TElement >

static Pointer itk::ValarrayImageContainer< TElementIdentifier, TElement >::New ( )

static

Method for creation through the object factory.

◆ operator[]() [1/2]

template<typename TElementIdentifier , typename TElement >

TElement& itk::ValarrayImageContainer< TElementIdentifier, TElement >::operator[] ( const ElementIdentifier id )

inline

Index operator. This version can be an lvalue.

Definition at line 95 of file itkValarrayImageContainer.h.

◆ operator[]() [2/2]

template<typename TElementIdentifier , typename TElement >

const TElement& itk::ValarrayImageContainer< TElementIdentifier, TElement >::operator[] ( const ElementIdentifier id ) const

inline

Index operator. This version can only be an rvalue

Definition at line 102 of file itkValarrayImageContainer.h.

◆ PrintSelf()

template<typename TElementIdentifier , typename TElement >

void itk::ValarrayImageContainer< TElementIdentifier, TElement >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

inlineoverridevirtual

PrintSelf routine. Normally this is a protected internal method. It is made public here so that Image can call this method. Users should not call this method but should call Print() instead.

Reimplemented from itk::Object.

Definition at line 168 of file itkValarrayImageContainer.h.

References itk::Object::PrintSelf().

◆ Reserve()

template<typename TElementIdentifier , typename TElement >

void itk::ValarrayImageContainer< TElementIdentifier, TElement >::Reserve ( ElementIdentifier num )

inline

Tell the container to allocate enough memory to allow at least as many elements as the size given to be stored. This is NOT guaranteed to actually allocate any memory, but is useful if the implementation of the container allocates contiguous storage.

Definition at line 135 of file itkValarrayImageContainer.h.

◆ Size()

template<typename TElementIdentifier , typename TElement >

unsigned long itk::ValarrayImageContainer< TElementIdentifier, TElement >::Size ( ) const

inline

Get the number of elements currently stored in the container.

Definition at line 125 of file itkValarrayImageContainer.h.

◆ Squeeze()

template<typename TElementIdentifier , typename TElement >

void itk::ValarrayImageContainer< TElementIdentifier, TElement >::Squeeze ( )

inline

Tell the container to try to minimize its memory usage for storage of the current number of elements. This is NOT guaranteed to decrease memory usage.

Definition at line 144 of file itkValarrayImageContainer.h.

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

itkValarrayImageContainer.h

Detailed Description

template<typename TElementIdentifier, typename TElement> class itk::ValarrayImageContainer< TElementIdentifier, TElement >

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Element

◆ ElementIdentifier

◆ Pointer

◆ Self

◆ Superclass

◆ ValarrayType

Constructor & Destructor Documentation

◆ ValarrayImageContainer() [1/4]

◆ ValarrayImageContainer() [2/4]

◆ ValarrayImageContainer() [3/4]

◆ ValarrayImageContainer() [4/4]

Member Function Documentation

◆ Fill()

◆ GetBufferPointer()

◆ GetNameOfClass()

◆ Initialize()

◆ New()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ PrintSelf()

◆ Reserve()

◆ Size()

◆ Squeeze()

template<typename TElementIdentifier, typename TElement>
class itk::ValarrayImageContainer< TElementIdentifier, TElement >