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 itkGridImageSource_h
#define itkGridImageSource_h
#include "itkGenerateImageSource.h"
#include "itkFixedArray.h"
#include "itkKernelFunctionBase.h"
#include "itkVectorContainer.h"
#include "vnl/vnl_vector.h"
namespace itk
{
/**
* \class GridImageSource
* \brief Generate an n-dimensional image of a grid.
*
* GridImageSource generates an image of a grid.
* From the abstract...
* "Certain classes of images find disparate use amongst members of the
* ITK community for such purposes as visualization, simulation,
* testing, etc. Currently there exists two derived classes from the
* ImageSource class used for generating specific images for various
* applications, viz. RandomImageSource and GaussianImageSource. We
* propose to add to this set with the class GridImageSource which,
* obviously enough, produces a grid image. Such images are useful for
* visualizing deformation when used in conjunction with the
* WarpImageFilter, simulating magnetic resonance tagging images, or
* creating optical illusions with which to amaze your friends."
*
* The output image may be of any dimension.
*
* \author Tustison N., Avants B., Gee J. University of Pennsylvania
*
* This implementation was taken from the Insight Journal paper:
* https://www.insight-journal.org/browse/publication/140
*
* \ingroup DataSources
* \ingroup ITKImageSources
*/
template <typename TOutputImage>
class ITK_TEMPLATE_EXPORT GridImageSource : public GenerateImageSource<TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(GridImageSource);
/** Standard class type aliases. */
using Self = GridImageSource;
using Superclass = GenerateImageSource<TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(GridImageSource);
/** Method for creation through the object factory. */
itkNewMacro(Self);
using RealType = double;
/** Dimensionality of the output image */
static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;
/** Typedef for the output image types. */
using ImageType = TOutputImage;
using ImageRegionType = typename TOutputImage::RegionType;
using PixelType = typename TOutputImage::PixelType;
using SpacingType = typename TOutputImage::SpacingType;
using OriginType = typename TOutputImage::PointType;
using DirectionType = typename TOutputImage::DirectionType;
using SizeType = typename TOutputImage::SizeType;
using KernelFunctionType = KernelFunctionBase<double>;
/** Other convenient types. */
using ArrayType = FixedArray<RealType, Self::ImageDimension>;
using BoolArrayType = FixedArray<bool, Self::ImageDimension>;
using PixelArrayType = vnl_vector<RealType>;
using PixelArrayContainerType = VectorContainer<SizeValueType, PixelArrayType>;
/** Set/Get kernel function used to create the grid. */
itkSetObjectMacro(KernelFunction, KernelFunctionType);
itkGetConstReferenceObjectMacro(KernelFunction, KernelFunctionType);
/** Set/Get the standard deviation of the Gaussians or width of the box
* functions.*/
itkSetMacro(Sigma, ArrayType);
itkGetConstReferenceMacro(Sigma, ArrayType);
/** Set/Get the grid spacing of the peaks. */
itkSetMacro(GridSpacing, ArrayType);
itkGetConstReferenceMacro(GridSpacing, ArrayType);
/** Set/Get the grid offset. */
itkSetMacro(GridOffset, ArrayType);
itkGetConstReferenceMacro(GridOffset, ArrayType);
/** Set/Get the dimensions which are gridded. */
itkSetMacro(WhichDimensions, BoolArrayType);
itkGetConstReferenceMacro(WhichDimensions, BoolArrayType);
/** Set/Get the scale factor to multiply the true value of the grid. */
itkSetMacro(Scale, RealType);
itkGetConstReferenceMacro(Scale, RealType);
protected:
GridImageSource();
~GridImageSource() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
void
DynamicThreadedGenerateData(const ImageRegionType & outputRegionForThread) override;
void
BeforeThreadedGenerateData() override;
private:
/** Internal variable to speed up the calculation of pixel values. */
typename PixelArrayContainerType::Pointer m_PixelArrays{};
typename KernelFunctionType::Pointer m_KernelFunction{};
ArrayType m_Sigma{};
ArrayType m_GridSpacing{};
ArrayType m_GridOffset{};
BoolArrayType m_WhichDimensions{};
RealType m_Scale{ 255.0 };
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkGridImageSource.hxx"
#endif
#endif
|
