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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/*
-----------------------------------------------------------------------
Copyright: 2010-2014, iMinds-Vision Lab, University of Antwerp
2014, CWI, Amsterdam
Contact: astra@uantwerpen.be
Website: http://sf.net/projects/astra-toolbox
This file is part of the ASTRA Toolbox.
The ASTRA Toolbox is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
The ASTRA Toolbox is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with the ASTRA Toolbox. If not, see <http://www.gnu.org/licenses/>.
-----------------------------------------------------------------------
$Id$
*/
#ifndef _INC_ASTRA_FLOAT32VOLUMEDATA3DMEMORY
#define _INC_ASTRA_FLOAT32VOLUMEDATA3DMEMORY
#include "Float32Data3DMemory.h"
#include "VolumeGeometry3D.h"
#include "Float32VolumeData3D.h"
namespace astra {
/**
* This class represents three-dimensional Volume Data where the entire data block is stored in memory.
*/
class _AstraExport CFloat32VolumeData3DMemory : public CFloat32Data3DMemory, public CFloat32VolumeData3D
{
public:
/** Default constructor. Sets all numeric member variables to 0 and all pointer member variables to NULL.
*
* If an object is constructed using this default constructor, it must always be followed by a call
* to one of the init() methods before the object can be used. Any use before calling init() is not allowed,
* except calling the member function isInitialized().
*
*/
CFloat32VolumeData3DMemory();
/** Constructor. Create an instance of the CFloat32VolumeData3DMemory class without initializing the data.
*
* Memory is allocated for the data block. The allocated memory is not cleared and
* its contents after construction is undefined. Construction may be followed by a
* call to copyData() to fill the memory block.
* The size of the data is determined by the specified volume geometry object.
*
* @param _pGeometry Volume Geometry object. This object will be HARDCOPIED into this class.
*/
CFloat32VolumeData3DMemory(CVolumeGeometry3D* _pGeometry);
/** Constructor. Create an instance of the CFloat32VolumeData3DMemory class with initialization of the data.
*
* Memory is allocated for the data block and the contents of the memory pointed to by
* _pfData is copied into the allocated memory.
* The size of the data is determined by the specified volume geometry object.
*
* @param _pGeometry Volume Geometry object. This object will be HARDCOPIED into this class.
* @param _pfData pointer to a one-dimensional float32 data block
*/
CFloat32VolumeData3DMemory(CVolumeGeometry3D* _pGeometry, const float32* _pfData);
/** Constructor. Create an instance of the CFloat32VolumeData3DMemory class with scalar initialization of the data.
*
* Memory is allocated for the data block and the contents of the memory pointed to by
* _pfData is copied into the allocated memory.
* The size of the data is determined by the specified volume geometry object.
*
* @param _pGeometry Volume Geometry object. This object will be HARDCOPIED into this class.
* @param _fScalar scalar value
*/
CFloat32VolumeData3DMemory(CVolumeGeometry3D* _pGeometry, float32 _fScalar);
/** Constructor. Create an instance of the CFloat32VolumeData3DMemory class with pre-allocated memory.
*
* Creates an instance of the CFloat32VolumeData3DMemory class. Memory
* is pre-allocated and passed via the abstract CFloat32CustomMemory handle
* class. The handle will be deleted when the memory can be freed.
* You should override the destructor to provide custom behaviour on free.
*
* @param _pGeometry Volume Geometry object. This object will be HARDCOPIED into this class.
* @param _pCustomMemory custom memory handle
*
*/
CFloat32VolumeData3DMemory(CVolumeGeometry3D* _pGeometry, CFloat32CustomMemory* _pCustomMemory);
/** Destructor.
*/
virtual ~CFloat32VolumeData3DMemory();
/** Initialization. Initializes of the CFloat32VolumeData3DMemory class without initializing the data.
*
* Memory is allocated for the data block. The allocated memory is not cleared and
* its contents after construction is undefined. Construction may be followed by a
* call to copyData() to fill the memory block.
* The size of the data is determined by the specified volume geometry object.
*
* @param _pGeometry Volume Geometry of the data. This object will be HARDCOPIED into this class.
* @return Initialization of the base class successful.
*/
bool initialize(CVolumeGeometry3D* _pGeometry);
/** Initialization. Initializes an instance of the CFloat32VolumeData3DMemory class with initialization of the data.
*
* Memory is allocated for the data block and the contents of the memory pointed to by
* _pfData is copied into the allocated memory.
* The size of the data is determined by the specified volume geometry object.
*
* @param _pGeometry Volume Geometry of the data. This object will be HARDCOPIED into this class.
* @param _pfData pointer to a one-dimensional float32 data block
*/
bool initialize(CVolumeGeometry3D* _pGeometry, const float32* _pfData);
/** Initialization. Initializes an instance of the CFloat32VolumeData3DMemory class with scalar initialization of the data.
*
* Memory is allocated for the data block and the contents of the memory pointed to by
* _pfData is copied into the allocated memory.
* The size of the data is determined by the specified volume geometry object.
*
* @param _pGeometry Volume Geometry of the data. This object will be HARDCOPIED into this class.
* @param _fScalar scalar value
*/
bool initialize(CVolumeGeometry3D* _pGeometry, float32 _fScalar);
/** Initialization. Initializes an instance of the CFloat32VolumeData3DMemory class with pre-allocated memory.
*
* Memory is pre-allocated and passed via the abstract CFloat32CustomMemory handle
* class. The handle will be deleted when the memory can be freed.
* You should override the destructor to provide custom behaviour on free.
*
* @param _pGeometry Volume Geometry object. This object will be HARDCOPIED into this class.
* @param _pCustomMemory custom memory handle
*
*/
bool initialize(CVolumeGeometry3D* _pGeometry, CFloat32CustomMemory* _pCustomMemory);
/** Which type is this class?
*
* @return DataType: VOLUME
*/
virtual CFloat32Data3D::EDataType getType() const;
/** Get the volume geometry.
*
* @return pointer to volume geometry.
*/
CVolumeGeometry3D* getGeometry();
/**
* Gets a slice, containing all voxels with a given x (= column) index.
*/
CFloat32VolumeData2D * fetchSliceX(int _iColumnIndex) const;
/**
* Gets a slice, containing all voxels with a given y (= row) index.
*/
CFloat32VolumeData2D * fetchSliceY(int _iRowIndex) const;
/**
* Gets a slice, containing all voxels with a given z (= slice) index.
*/
CFloat32VolumeData2D * fetchSliceZ(int _iSliceIndex) const;
/**
* Gets a slice, containing all voxels with a given x (= column) index.
*/
void returnSliceX(int _iColumnIndex, CFloat32VolumeData2D * _pSliceData);
/**
* Gets a slice, containing all voxels with a given y (= row) index.
*/
void returnSliceY(int _iRowIndex, CFloat32VolumeData2D * _pSliceData);
/**
* Copies data from a 2D slice containing all voxels with a given z (= slice) index to the
* 3D memory stored in this class.
*/
void returnSliceZ(int _iSliceIndex, CFloat32VolumeData2D * _pSliceData);
/** This SLOW function returns a volume value stored a specific index in the array.
* Reading values in this way might cause a lot of unnecessary memory operations, don't
* use it in time-critical code.
*
* @param _iIndex Index in the array if the data were stored completely in main memory
* @return The value the location specified by _iIndex
*/
virtual float32 getVoxelValue(int _iIndex);
/** This SLOW function stores a voxel value at a specific index in the array.
* Writing values in this way might cause a lot of unnecessary memory operations, don't
* use it in time-critical code.
*
* @param _iIndex Index in the array if the data were stored completely in main memory
* @param _fValue The value to be stored at the location specified by _iIndex
*/
virtual void setVoxelValue(int _iIndex, float32 _fValue);
/**
* Overloaded Operator: data = data (pointwise)
*
* @param _dataIn r-value
* @return l-value
*/
CFloat32VolumeData3DMemory& operator=(const CFloat32VolumeData3DMemory& _dataIn);
};
//----------------------------------------------------------------------------------------
// Get the projection geometry.
inline CVolumeGeometry3D* CFloat32VolumeData3DMemory::getGeometry()
{
ASTRA_ASSERT(m_bInitialized);
return m_pGeometry;
}
//----------------------------------------------------------------------------------------
// Get type
inline CFloat32Data3D::EDataType CFloat32VolumeData3DMemory::getType() const
{
return VOLUME;
}
} // end namespace astra
#endif // _INC_ASTRA_FLOAT32VOLUMEDATA3DMEMORY
|
