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
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* 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
*
* https://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 itkGaussianImageSource_h
#define itkGaussianImageSource_h
#include "itkParametricImageSource.h"
#include "itkFixedArray.h"
#include "itkSize.h"
namespace itk
{
/**
* \class GaussianImageSource
* \brief Generate an n-dimensional image of a Gaussian.
*
* GaussianImageSource generates an image of a Gaussian.
* m_Normalized determines whether or not the Gaussian is normalized
* (whether or not the sum over infinite space is 1.0)
* When creating an image, it is preferable to _not_ normalize the Gaussian
* m_Scale scales the output of the Gaussian to span a range
* larger than 0->1, and is typically set to the maximum value
* of the output data type (for instance, 255 for uchars)
*
* The output image may be of any dimension.
*
* \ingroup DataSources
* \ingroup ITKImageSources
*/
template <typename TOutputImage>
class ITK_TEMPLATE_EXPORT GaussianImageSource : public ParametricImageSource<TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(GaussianImageSource);
/** Standard class type aliases. */
using Self = GaussianImageSource;
using Superclass = ParametricImageSource<TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Typedef for the output image type. */
using OutputImageType = TOutputImage;
/** Typedef for the output image PixelType. */
using OutputImagePixelType = typename TOutputImage::PixelType;
/** Typedef to describe the output image region type. */
using OutputImageRegionType = typename TOutputImage::RegionType;
/** Spacing type alias support Spacing holds the size of a pixel. The
* spacing is the geometric distance between image samples. */
using SpacingType = typename TOutputImage::SpacingType;
/** Origin type alias support The origin is the geometric coordinates
* of the index (0,0). */
using PointType = typename TOutputImage::PointType;
/** Direction type alias support The direction is the direction
* cosines of the image. */
using DirectionType = typename TOutputImage::DirectionType;
/** Dimensionality of the output image */
static constexpr unsigned int NDimensions = TOutputImage::ImageDimension;
/** Type used to store Gaussian parameters. */
using ArrayType = FixedArray<double, Self::NDimensions>;
/** Size type matches that used for images */
using SizeType = typename TOutputImage::SizeType;
using SizeValueType = typename TOutputImage::SizeValueType;
/** Types for parameters. */
using typename Superclass::ParametersValueType;
using typename Superclass::ParametersType;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(GaussianImageSource);
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Gets and sets for Gaussian parameters */
/** Set/Get the scale factor to multiply the true value of the Gaussian. */
itkSetMacro(Scale, double);
itkGetConstReferenceMacro(Scale, double);
/** Set/Get whether or not to normalize the Gaussian. Default is false. */
itkSetMacro(Normalized, bool);
itkGetConstReferenceMacro(Normalized, bool);
itkBooleanMacro(Normalized);
/** Set/Get the standard deviation in each direction. */
itkSetMacro(Sigma, ArrayType);
itkGetConstReferenceMacro(Sigma, ArrayType);
/** Set/Get the mean in each direction. */
itkSetMacro(Mean, ArrayType);
itkGetConstReferenceMacro(Mean, ArrayType);
/** Set/Get the parameters for this source. When this source is
* templated over an N-dimensional output image type, the first N
* values in the parameter array are the Sigma parameters in each
* dimension, the next N values are the Mean parameters in each
* dimension, and the last value is the Scale. */
void
SetParameters(const ParametersType & parameters) override;
ParametersType
GetParameters() const override;
/** Get the number of parameters for this image source. When this
* source is templated over an N-dimensional output image type, the
* number of parameters is 2*N+1. */
unsigned int
GetNumberOfParameters() const override;
protected:
GaussianImageSource();
~GaussianImageSource() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
void
GenerateData() override;
private:
ArrayType m_Sigma{};
ArrayType m_Mean{};
double m_Scale{ 255.0 };
bool m_Normalized{ false };
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkGaussianImageSource.hxx"
#endif
#endif
|
