1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile: itkImportImageContainer.h,v $
Language: C++
Date: $Date: 2007-12-10 17:11:27 $
Version: $Revision: 1.20 $
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkImportImageContainer_h
#define __itkImportImageContainer_h
#include "itkObject.h"
#include "itkObjectFactory.h"
#include <utility>
namespace itk
{
/** \class ImportImageContainer
* Defines an itk::Image front-end to a standard C-array. This container
* conforms to the ImageContainerInterface. This is a full-fleged Object,
* so there is modification time, debug, and reference count information.
*
* Template parameters for ImportImageContainer:
*
* TElementIdentifier =
* An INTEGRAL type for use in indexing the imported buffer.
*
* TElement =
* The element type stored in the container.
*
* \ingroup ImageObjects
* \ingroup IOFilters
*/
template <typename TElementIdentifier, typename TElement>
class ImportImageContainer: public Object
{
public:
/** Standard class typedefs. */
typedef ImportImageContainer Self;
typedef Object Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
/** Save the template parameters. */
typedef TElementIdentifier ElementIdentifier;
typedef TElement Element;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Standard part of every itk Object. */
itkTypeMacro(ImportImageContainer, Object);
/** Get the pointer from which the image data is imported. */
TElement *GetImportPointer() {return m_ImportPointer;};
/** Set the pointer from which the image data is imported. "num" is
* the number of pixels in the block of memory. If
* "LetContainerManageMemory" is false, then the application retains
* the responsibility of freeing the memory for this image data. If
* "LetContainerManageMemory" is true, then this class will free the
* memory when this object is destroyed. */
void SetImportPointer(TElement *ptr, TElementIdentifier num,
bool LetContainerManageMemory = false);
/** Index operator. This version can be an lvalue. */
TElement & operator[](const ElementIdentifier id)
{ return m_ImportPointer[id]; };
/** Index operator. This version can only be an rvalue */
const TElement & operator[](const ElementIdentifier id) const
{ return m_ImportPointer[id]; };
/** Return a pointer to the beginning of the buffer. This is used by
* the image iterator class. */
TElement *GetBufferPointer()
{ return m_ImportPointer; };
/** Get the capacity of the container. */
unsigned long Capacity(void) const
{ return (unsigned long) m_Capacity; };
/** Get the number of elements currently stored in the container. */
unsigned long Size(void) const
{ return (unsigned long) m_Size; };
/** Tell the container to allocate enough memory to allow at least
* as many elements as the size given to be stored. If new memory
* needs to be allocated, the contents of the old buffer are copied
* to the new area. The old buffer is deleted if the original pointer
* was passed in using "LetContainerManageMemory"=true. The new buffer's
* memory management will be handled by the container from that point on.
*
* \sa SetImportPointer() */
void Reserve(ElementIdentifier num);
/** Tell the container to try to minimize its memory usage for
* storage of the current number of elements. If new memory is
* allocated, the contents of old buffer are copied to the new area.
* The previous buffer is deleted if the original pointer was in
* using "LetContainerManageMemory"=true. The new buffer's memory
* management will be handled by the container from that point on. */
void Squeeze(void);
/** Tell the container to release any of its allocated memory. */
void Initialize(void);
/** These methods allow to define whether upon destruction of this class
* the memory buffer should be released or not. Setting it to true
* (or ON) makes that this class will take care of memory release.
* Setting it to false (or OFF) will prevent the destructor from
* deleting the memory buffer. This is desirable only when the data
* is intended to be used by external applications.
* Note that the normal logic of this class set the value of the boolean
* flag. This may override your setting if you call this methods prematurely.
* \warning Improper use of these methods will result in memory leaks */
itkSetMacro(ContainerManageMemory,bool);
itkGetMacro(ContainerManageMemory,bool);
itkBooleanMacro(ContainerManageMemory);
protected:
ImportImageContainer();
virtual ~ImportImageContainer();
/** 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. */
void PrintSelf(std::ostream& os, Indent indent) const;
virtual TElement* AllocateElements(ElementIdentifier size) const;
private:
ImportImageContainer(const Self&); //purposely not implemented
void operator=(const Self&); //purposely not implemented
TElement *m_ImportPointer;
TElementIdentifier m_Size;
TElementIdentifier m_Capacity;
bool m_ContainerManageMemory;
};
} // end namespace itk
// Define instantiation macro for this template.
#define ITK_TEMPLATE_ImportImageContainer(_, EXPORT, x, y) namespace itk { \
_(2(class EXPORT ImportImageContainer< ITK_TEMPLATE_2 x >)) \
namespace Templates { typedef ImportImageContainer< ITK_TEMPLATE_2 x > ImportImageContainer##y; } \
}
#if ITK_TEMPLATE_EXPLICIT
# include "Templates/itkImportImageContainer+-.h"
#endif
#if ITK_TEMPLATE_TXX
# include "itkImportImageContainer.txx"
#endif
#endif
|
