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
|
/*=========================================================================
*
* 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 elxImageSamplerBase_h
#define elxImageSamplerBase_h
/** Needed for the macros */
#include "elxMacro.h"
#include "elxBaseComponentSE.h"
#include "itkImageSamplerBase.h"
namespace elastix
{
// using namespace itk; not here because itk::ImageSamplerBase exists also.
/**
* \class ImageSamplerBase
* \brief This class is the elastix base class for all ImageSamplers.
*
* This class contains all the common functionality for ImageSamplers.
*
* The parameter used in this class is:
* \parameter UseMultiThreadingForSamplers: Flag that can set to "true" or "false".
* If "true" the sampler may use multi-threading (at least if multi-threading is implemented for the selected
* sampler). If "false", it will run single-threaded. This flag will not affect the output of the samplers.\n
* example: <tt>(UseMultiThreadingForSamplers "false")</tt> \n
* Default is "true".
*
* \ingroup ImageSamplers
* \ingroup ComponentBaseClasses
*/
template <class TElastix>
class ITK_TEMPLATE_EXPORT ImageSamplerBase : public BaseComponentSE<TElastix>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(ImageSamplerBase);
/** Standard ITK-stuff. */
using Self = ImageSamplerBase;
using Superclass = BaseComponentSE<TElastix>;
/** Run-time type information (and related methods). */
itkTypeMacro(ImageSamplerBase, BaseComponentSE);
/** Typedefs inherited from Elastix. */
using typename Superclass::ElastixType;
using typename Superclass::RegistrationType;
/** Other typedef's. */
using InputImageType = typename ElastixType::FixedImageType;
/** ITKBaseType. */
using ITKBaseType = itk::ImageSamplerBase<InputImageType>;
/** Retrieves this object as ITKBaseType. */
ITKBaseType *
GetAsITKBaseType()
{
return &(this->GetSelf());
}
/** Retrieves this object as ITKBaseType, to use in const functions. */
const ITKBaseType *
GetAsITKBaseType() const
{
return &(this->GetSelf());
}
/** Retrieves parameters from the configuration, before doing registration. */
void
BeforeRegistrationBase() override;
/** Execute stuff before each resolution:
* \li Give a warning when NewSamplesEveryIteration is specified,
* but the sampler is ignoring it.
*/
void
BeforeEachResolutionBase() override;
protected:
/** The constructor. */
ImageSamplerBase() = default;
/** The destructor. */
~ImageSamplerBase() override = default;
private:
elxDeclarePureVirtualGetSelfMacro(ITKBaseType);
};
} // end namespace elastix
#ifndef ITK_MANUAL_INSTANTIATION
# include "elxImageSamplerBase.hxx"
#endif
#endif // end #ifndef elxImageSamplerBase_h
|
