MeVisLab Toolbox Reference
mlITKSupport.h
Go to the documentation of this file.
1/*************************************************************************************
2**
3** Copyright 2007, MeVis Medical Solutions AG
4**
5** The user may use this file in accordance with the license agreement provided with
6** the Software or, alternatively, in accordance with the terms contained in a
7** written agreement between the user and MeVis Medical Solutions AG.
8**
9** For further information use the contact form at https://www.mevislab.de/contact
10**
11**************************************************************************************/
12
13#pragma once
14
16// Include dll-specific settings.
17#include "mlInitSystemITKSupport.h"
18
20#include "mlModuleIncludes.h"
21
23#include "mlTools.h"
24
26#include "mlITKSupportMacrosP.h"
27
29#include "mlITKSupportToolFunctions.h"
30
31//---------------------------------------------------------------------------
33//---------------------------------------------------------------------------
34inline void ML_ITK_ML_PRINT_ERROR(const std::string &className,
35 MLErrorCode errCode,
36 std::string reason,
37 const std::string &strParam1="",
38 MLint intParam1=-965386,
39 const std::string &strParam2="",
40 MLint intParam2=-965386,
41 const std::string &strParam3="",
42 MLint intParam3=-965386,
43 const std::string &strParam4="",
44 MLint intParam4=-965386){
45 reason += strParam1;
46 if (intParam1 != -965386){
47 char strBuf[512]="";
48 snprintf(strBuf, 511, "%lld", intParam1);
49 reason += strBuf;
50 }
51 reason += strParam2;
52 if (intParam2 != -965386){
53 char strBuf[512]="";
54 snprintf(strBuf, 511, "%lld", intParam2);
55 reason += strBuf;
56 }
57 reason += strParam3;
58 if (intParam3 != -965386){
59 char strBuf[512]="";
60 snprintf(strBuf, 511, "%lld", intParam3);
61 reason += strBuf;
62 }
63 reason += strParam4;
64 if (intParam4 != -965386){
65 char strBuf[512]="";
66 snprintf(strBuf, 511, "%lld", intParam4);
67 reason += strBuf;
68 }
69
70 ML_PRINT_ERROR(className, errCode, reason);
71}
72
73
74//---------------------------------------------------------------------------
76//---------------------------------------------------------------------------
78#define ML_ITK_WRAPPER_0_2D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
79 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_0, \
80 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_0, \
81 ML_IMPLEMENT_ALL_ITK_2D_CASES, _ML_ITK_DETERMINE_OUT_REGION_0)
82
84#define ML_ITK_WRAPPER_1_2D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
85 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
86 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_1, \
87 ML_IMPLEMENT_ALL_ITK_2D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
88
90#define ML_ITK_WRAPPER_2_2D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
91 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
92 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_2, \
93 ML_IMPLEMENT_ALL_ITK_2D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
94
96#define ML_ITK_WRAPPER_3_2D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
97 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
98 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_3, \
99 ML_IMPLEMENT_ALL_ITK_2D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
101
102
103//---------------------------------------------------------------------------
105//---------------------------------------------------------------------------
107#define ML_ITK_WRAPPER_0_3D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
108 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_0, \
109 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_0, \
110 ML_IMPLEMENT_ALL_ITK_3D_CASES, _ML_ITK_DETERMINE_OUT_REGION_0)
111
113#define ML_ITK_WRAPPER_1_3D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
114 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
115 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_1, \
116 ML_IMPLEMENT_ALL_ITK_3D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
117
119#define ML_ITK_WRAPPER_2_3D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
120 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
121 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_2, \
122 ML_IMPLEMENT_ALL_ITK_3D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
123
125#define ML_ITK_WRAPPER_3_3D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
126 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
127 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_3, \
128 ML_IMPLEMENT_ALL_ITK_3D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
130
131
132//---------------------------------------------------------------------------
134//---------------------------------------------------------------------------
136#define ML_ITK_WRAPPER_0_2D3D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
137 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_0, \
138 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_0, \
139 ML_IMPLEMENT_ALL_ITK_2D3D_CASES, _ML_ITK_DETERMINE_OUT_REGION_0)
140
142#define ML_ITK_WRAPPER_1_2D3D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
143 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
144 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_1, \
145 ML_IMPLEMENT_ALL_ITK_2D3D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
146
148#define ML_ITK_WRAPPER_2_2D3D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
149 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
150 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_2, \
151 ML_IMPLEMENT_ALL_ITK_2D3D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
152
154#define ML_ITK_WRAPPER_3_2D3D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
155 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
156 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_3, \
157 ML_IMPLEMENT_ALL_ITK_2D3D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
159
160//---------------------------------------------------------------------------
162//---------------------------------------------------------------------------
164#define ML_ITK_WRAPPER_0_6D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
165 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_0, \
166 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_0, \
167 ML_IMPLEMENT_ALL_ITK_6D_CASES, _ML_ITK_DETERMINE_OUT_REGION_0)
168
170#define ML_ITK_WRAPPER_1_6D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
171 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
172 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_1, \
173 ML_IMPLEMENT_ALL_ITK_6D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
174
176#define ML_ITK_WRAPPER_2_6D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
177 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
178 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_2, \
179 ML_IMPLEMENT_ALL_ITK_6D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
180
182#define ML_ITK_WRAPPER_3_6D(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
183 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
184 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_3, \
185 ML_IMPLEMENT_ALL_ITK_6D_CASES, _ML_ITK_DETERMINE_OUT_REGION_N)
187
188//---------------------------------------------------------------------------
190// dimension and image dimension must match) in .cpp file.
191//---------------------------------------------------------------------------
193#define ML_ITK_WRAPPER_0_6D_SAME_DIM(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
194 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_0, \
195 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_0, ML_IMPLEMENT_ALL_ITK_6D_SAME_DIM_CASES, \
196 _ML_ITK_DETERMINE_OUT_REGION_0)
197
199#define ML_ITK_WRAPPER_1_6D_SAME_DIM(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
200 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
201 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_1, ML_IMPLEMENT_ALL_ITK_6D_SAME_DIM_CASES, \
202 _ML_ITK_DETERMINE_OUT_REGION_N)
203
205#define ML_ITK_WRAPPER_2_6D_SAME_DIM(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
206 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
207 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_2, ML_IMPLEMENT_ALL_ITK_6D_SAME_DIM_CASES, \
208 _ML_ITK_DETERMINE_OUT_REGION_N)
209
211#define ML_ITK_WRAPPER_3_6D_SAME_DIM(PROJECT_PREFIX, CLASS_NAME, NAMESPACE) \
212 _ML_ITK_WRAPPER(PROJECT_PREFIX, CLASS_NAME, NAMESPACE, _ML_ITK_DETERMINE_IN_REGION_N, \
213 ML_ITK_DEFAULT_WRAPPER_TYPEDEFS_3, ML_IMPLEMENT_ALL_ITK_6D_SAME_DIM_CASES, \
214 _ML_ITK_DETERMINE_OUT_REGION_N)
216
217
218
219//---------------------------------------------------------------------------
222//---------------------------------------------------------------------------
223class TypedObjectHolderBase
224{
225 public:
227 TypedObjectHolderBase(): _m_Filter(nullptr) {}
228
230 virtual ~TypedObjectHolderBase(){}
231
233 inline void* voidFilterPtr(){ return _m_Filter; }
234
235 protected:
239 void * _m_Filter;
240};
241
242//---------------------------------------------------------------------------
244//---------------------------------------------------------------------------
245template <typename FILTER_TYPE>
246class TypedObjectHolderT : public TypedObjectHolderBase
247{
248 public:
250 typedef typename FILTER_TYPE::Pointer ItkObjPtrType;
251
253 TypedObjectHolderT(): TypedObjectHolderBase(), _typedFilterSmartPtr(FILTER_TYPE::New())
254 {
255 // Store the untyped void pointer to the typed itk object in the base class object.
256 TypedObjectHolderBase::_m_Filter = _typedFilterSmartPtr.GetPointer();
257 }
258
260 inline ItkObjPtrType ptr(){ return _typedFilterSmartPtr; }
261
262 protected:
263
265 ItkObjPtrType _typedFilterSmartPtr;
266};
267
268
269
270//---------------------------------------------------------------------------
273//---------------------------------------------------------------------------
274#define IMPLEMENT_ITK_INTERFACE_H(CLASS_NAME) \
275 \
276 protected: \
277 \
278 \
279 \
280 void calculateOutputSubImage(SubImage *outSubImg, int outIndex, SubImage *inSubImgs) override;\
281 \
282 \
283 \
284 TypedObjectHolderBase *_itkObj; \
285 \
286 \
287 MLint _m_Dimension; \
288 \
289 \
290 MLDataType _m_PixelType; \
291 \
292 \
293 \
294 ImageVector _m_Shift[5]; \
295 \
296 \
297 \
298 bool _isValidFilter(){ return _itkObj && _itkObj->voidFilterPtr(); } \
299 \
300 \
301 \
302 void _createITKFilter(MLDataType dataType, MLint dim); \
303 \
304 \
305 void _destroyITKFilter(); \
306 \
307 \
308 SubImageBox _determineInRegion(MLint inIndex, const SubImageBox &outBox, MLint outIndex, MLint numActiveInputs); \
309 \
310 \
311 \
312 SubImageBox _getOutImageRegion(int numImageInputs); \
313 \
314 \
315 MLErrorCode _setFilterParameters(); \
316 \
317 \
318 MLErrorCode _getFilterParameters(); \
319
TypedObjectHolderBase
Base class for all derived classes containing an itk object type pointer and some of its basic inform...
Definition mlITKSupport.h:224
TypedObjectHolderBase::voidFilterPtr
void * voidFilterPtr()
Access method to access the filter as a void pointer.
Definition mlITKSupport.h:233
TypedObjectHolderBase::~TypedObjectHolderBase
virtual ~TypedObjectHolderBase()
Virtual destructor implicitly destroying the typed object in the derived class.
Definition mlITKSupport.h:230
TypedObjectHolderBase::TypedObjectHolderBase
TypedObjectHolderBase()
Constructor for the itk object's base information.
Definition mlITKSupport.h:227
TypedObjectHolderT
Typed version of a mini class containing an itkObject smart pointer.
Definition mlITKSupport.h:247
TypedObjectHolderT::TypedObjectHolderT
TypedObjectHolderT()
Construction and storing of the itk object managed by the smart pointer.
Definition mlITKSupport.h:253
TypedObjectHolderT::_typedFilterSmartPtr
ItkObjPtrType _typedFilterSmartPtr
The typed version of the itk object as smart pointer.
Definition mlITKSupport.h:265
TypedObjectHolderT::ItkObjPtrType
FILTER_TYPE::Pointer ItkObjPtrType
The type of the pointer to the itk object.
Definition mlITKSupport.h:250
TypedObjectHolderT::ptr
ItkObjPtrType ptr()
Returns the smart pointer to the itk object.
Definition mlITKSupport.h:260
MLErrorCode
MLint32 MLErrorCode
Type of an ML Error code.
Definition mlTypeDefs.h:716
ML_PRINT_ERROR
#define ML_PRINT_ERROR(FUNC_NAME, REASON, HANDLING)
Like ML_PRINT_ERROR_DUMP(FUNC_NAME, REASON, HANDLING, RT_OBJ) without a runtime object to be dumped.
Definition mlErrorMacros.h:346
ML_ITK_ML_PRINT_ERROR
void ML_ITK_ML_PRINT_ERROR(const std::string &className, MLErrorCode errCode, std::string reason, const std::string &strParam1="", MLint intParam1=-965386, const std::string &strParam2="", MLint intParam2=-965386, const std::string &strParam3="", MLint intParam3=-965386, const std::string &strParam4="", MLint intParam4=-965386)
Include most ml specific things.
Definition mlITKSupport.h:34
mlrange_cast
Target mlrange_cast(Source arg)
Generic version of checked ML casts.
Definition mlRangeCasts.h:332
MLint
MLint64 MLint
A signed ML integer type with at least 64 bits used for index calculations on very large images even ...
Definition mlTypeDefs.h:490