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
|
/*=========================================================================
*
* Copyright UMC Utrecht and contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef elxMacro_h
#define elxMacro_h
// Avoid creation of multiple instances of `itk::ImageIOFactoryRegisterManager`, `itk::MeshIOFactoryRegisterManager`,
// and `itk::TransformIOFactoryRegisterManager`.
#undef ITK_IO_FACTORY_REGISTER_MANAGER
/** This include is only used to get rid of a MSVS compiler warning
* when using std::copy. The warning is like:
* 'conversion' conversion from 'type1' to 'type2', possible loss of data
* To solve it ITK recommends to include itkMacro.h before <algorithm> or
* any other stl header. In elastix we try to make sure that elxIncludes.h
* is included before anything else, which includes elxMacro.h, which now
* includes itkWin32Header.h.
*/
#include "itkWin32Header.h"
#include "itkMacro.h"
/**
* Macro for installing support new components
* (like a new metric, interpolator, or transform).
* Must be invoked in the .cxx file of the component,
* after declaration of the class.
*
* Example of usage:
*
* \code
* // elxMyMetric.h //
* #include "elxMetricBase.h"
* #include "itkMattesMutualInformationImageToImageMetric.h"
*
* namespace elastix {
*
* template <typename TElastix>
* class ITK_TEMPLATE_EXPORT MyMetric : public MetricBase<TElastix>,
* public itk::MattesMutualInformationImageToImageMetric
* < MetricBase<TElastix>::FixedImageType
* MetricBase<TElastix>::MovingImageType >
* {
* using Self = MyMetric;
* itkNewMacro( Self ); //needed for the elxInstallMacro
* elxClassNameMacro("MattesMutualInformation"); //also needed
* .......
* };
*
* } // end namespace elastix
* \endcode
*
* \code
* // elxMyMetric.hxx //
* // Definitions of the methods of the MyMetric class template
* \endcode
*
* \code
* // elxMyMetric.cxx //
* #include elxMyMetric.h
* elxInstallMacro(MyMetric);
*
* // CMakeLists.txt //
* ADD_ELXCOMPONENT( MyMetric
* elxMyMetric.h
* elxMyMetric.hxx
* elxMyMetric.cxx
* [<any other source files needed>] )
* \endcode
*
* The class to be installed should inherit from the appropriate base class.
* (elx::MetricBase, elx::TransformBase etc,) and from a specific itk object.
*
* IMPORTANT: only one template argument <class TElastix> is allowed. Not more,
* not less.
*
* Details: a function "int _classname##InstallComponent( _cdb )" is defined.
* In this function a ComponentInstaller template is instantiated.
* It contains the ElastixTypedef<VIndex>, and recursive function DO(cdb).
* DO installs the component for all defined ElastixTypedefs (so for all
* supported image types).
*
*/
#define elxInstallMacro(_classname) \
extern "C" ELX_PLUGIN_EXPORT int _classname##InstallComponent(::elastix::ComponentDatabase * _cdb) \
{ \
return ::elastix::ComponentInstaller<::elastix::_classname>::DO(_cdb); \
} // ignore semicolon
/**
* elxClassNameMacro(_name)
*
* Example of usage:
*
* class MyMetric
* {
* public:
* elxClassNameMacro("MyFirstMetric");
* }
*
* This macro defines two functions.
*
* static const char * elxGetClassNameStatic(){return _name;}
* const char * elxGetClassName() const override { return _name; }
*
* Use this macro in every component that will be installed in the
* ComponentDatabase, using "elxInstallMacro".
*/
#define elxClassNameMacro(_name) \
static const char * elxGetClassNameStatic() { return _name; } \
const char * elxGetClassName() const override { return _name; }
/** Declares a pair of pure virtual member functions (overloaded for const
* and non-const) to get a reference to itself, of the specified type.
*/
#define elxDeclarePureVirtualGetSelfMacro(type) \
virtual const type & GetSelf() const override = 0; \
virtual type & GetSelf() override = 0
/** Defines a pair of overrides of GetSelf() (overloaded for const and
* non-const), which return a reference to itself. Declares a deleted static
* member function overload, just to allow macro calls to end with a semicolon.
*/
#define elxOverrideGetSelfMacro \
auto GetSelf() const -> decltype(*this) override { return *this; } \
auto GetSelf() -> decltype(*this) override { return *this; } \
static void GetSelf(const void *) = delete
/**
* elxout
*
* This macro replaces 'elxout' by 'xl::xout["standard"]'.
* This simplifies writing messages to screen and logfile.
*
* NB: for error and warning messages, for writing to the
* transformparameterfile etc. do not use elxout, but
* xl::xout["{error, warning, etc}"].
*
*/
#define elxout ::xl::xout["standard"]
/********************************************************************************
* *
* Dll export *
* *
********************************************************************************/
#if (defined(_WIN32) || defined(WIN32))
# define ELASTIXLIB_API
#else
# if (__GNUC__ >= 4 || defined(__clang__))
# define ELASTIXLIB_API __attribute__((visibility("default")))
# else
# define ELASTIXLIB_API
# endif
#endif
#if defined(_WIN32) && !defined(__CYGWIN__)
# define ELX_PLUGIN_EXPORT __declspec(dllexport)
#else
# define ELX_PLUGIN_EXPORT __attribute__((visibility("default")))
#endif
#endif // end #ifndef elxMacro_h
|
