ITK  5.2.0
Insight Toolkit
Public Types | Private Types | List of all members
itk::ValarrayImageContainer< TElementIdentifier, TElement > Class Template Reference

#include <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
 

Private Types

using ValarrayType = std::valarray< Element >
 
 ValarrayImageContainer ()
 
 ValarrayImageContainer (unsigned long n)
 
 ValarrayImageContainer (unsigned long n, const Element &x)
 
 ValarrayImageContainer (const Self &r)
 
static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
TElement & operator[] (const ElementIdentifier id)
 
const TElement & operator[] (const ElementIdentifier id) const
 
TElement * GetBufferPointer ()
 
unsigned long Size () const
 
void Reserve (ElementIdentifier num)
 
void Squeeze ()
 
void Initialize ()
 
void Fill (const TElement &value)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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-fleged Object, so there is modification time, debug, and reference count information.

Template Parameters
TElementIdentifierAn INTEGRAL type for use in indexing the valarray. It must have a < operator defined for ordering.
TElementThe element type stored in the container.

Definition at line 48 of file itkValarrayImageContainer.h.

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

◆ CreateAnother()

template<typename TElementIdentifier , typename TElement >
virtual::itk::LightObject::Pointer itk::ValarrayImageContainer< TElementIdentifier, TElement >::CreateAnother ( ) const
virtual

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.

Reimplemented from itk::Object.

◆ 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 150 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 102 of file itkValarrayImageContainer.h.

◆ GetNameOfClass()

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

Standard part of every itk Object.

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 143 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 94 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 97 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 160 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 127 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 117 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 136 of file itkValarrayImageContainer.h.


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