![]() |
ITK
4.13.0
Insight Segmentation and Registration Toolkit
|
#include <itkImageContainerInterface.h>
Used for reference when writing containers conforming to this interface.
This should only be used for reference when writing containers conforming to this interface. ITK uses generic programming to allow container type substitution, so polymorphism is not needed to use containers through this interface. This means that a container conforming to this interface need not be derived from it, and that their methods should not be virtual. However, the container must derive from Object in order to support the reference counting, modification time, and debug information required by this interface.
Note that many comments refer to a "default element" or "default element value". This value is equal to the default constructor of the Element type. Also note that all non-const methods assume that the container was modified, and update the modification time.
TElementIdentifier | A type that shall be used to index the container. It must have a < operator defined for ordering. |
TElement | The element type stored in the container. |
Definition at line 53 of file itkImageContainerInterface.h.
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
typedef TElement | Element |
typedef TElementIdentifier | ElementIdentifier |
typedef SmartPointer< Self > | Pointer |
typedef ImageContainerInterface | Self |
typedef Object | Superclass |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
![]() | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Public Member Functions | |
virtual TElement * | GetBufferPointer ()=0 |
virtual const char * | GetNameOfClass () const |
virtual TElement & | operator[] (const ElementIdentifier)=0 |
virtual const TElement & | operator[] (const ElementIdentifier) const =0 |
virtual void | Reserve (ElementIdentifier)=0 |
virtual ElementIdentifier | Size (void) const =0 |
virtual void | Squeeze (void)=0 |
![]() | |
unsigned long | AddObserver (const EventObject &event, Command *) |
unsigned long | AddObserver (const EventObject &event, Command *) const |
virtual 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 |
virtual void | Register () const override |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) override |
virtual void | UnRegister () const noexceptoverride |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
![]() | |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
itkCloneMacro (Self) | |
void | Print (std::ostream &os, Indent indent=0) const |
Additional Inherited Members | |
![]() | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
![]() | |
static void | BreakOnError () |
static Pointer | New () |
![]() | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetTimeStamp (const TimeStamp &time) |
virtual | ~Object () override |
![]() | |
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 () |
![]() | |
AtomicInt< int > | m_ReferenceCount |
typedef SmartPointer< const Self > itk::ImageContainerInterface< TElementIdentifier, TElement >::ConstPointer |
Definition at line 60 of file itkImageContainerInterface.h.
typedef TElement itk::ImageContainerInterface< TElementIdentifier, TElement >::Element |
Definition at line 67 of file itkImageContainerInterface.h.
typedef TElementIdentifier itk::ImageContainerInterface< TElementIdentifier, TElement >::ElementIdentifier |
Save the template parameters.
Definition at line 63 of file itkImageContainerInterface.h.
typedef SmartPointer< Self > itk::ImageContainerInterface< TElementIdentifier, TElement >::Pointer |
Definition at line 59 of file itkImageContainerInterface.h.
typedef ImageContainerInterface itk::ImageContainerInterface< TElementIdentifier, TElement >::Self |
Standard class typedefs.
Definition at line 57 of file itkImageContainerInterface.h.
typedef Object itk::ImageContainerInterface< TElementIdentifier, TElement >::Superclass |
Definition at line 58 of file itkImageContainerInterface.h.
|
pure virtual |
Return a pointer to the beginning of the buffer. This is used by the image iterator class.
|
virtual |
Standard part of every itk Object.
Reimplemented from itk::Object.
|
pure virtual |
Index operator. This version can be an lvalue.
|
pure virtual |
Index operator. This version can only be an rvalue
|
pure virtual |
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.
|
pure virtual |
Get the number of elements currently stored in the container.
|
pure virtual |
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.