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
|
/*=========================================================================
*
* 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 itkGenerateImageSource_h
#define itkGenerateImageSource_h
#include "itkImageSource.h"
namespace itk
{
/**
* \class GenerateImageSource
* \brief a Base class for image sources which need to have image
* size, and other meta-data set.
*
* This class adds the ability for the user to set the Image's size,
* spacing, origin, and direction cosines. It is designed to be a base
* class for other image sources which generate an image, while there
* is no image input to the source.
*
* \ingroup DataSources
* \ingroup ITKImageSources
*/
template <typename TOutputImage>
class ITK_TEMPLATE_EXPORT GenerateImageSource : public ImageSource<TOutputImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(GenerateImageSource);
using Self = GenerateImageSource;
using Superclass = ImageSource<TOutputImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Output image type alias */
using OutputImageType = TOutputImage;
using OutputImagePointer = typename OutputImageType::Pointer;
using PixelType = typename OutputImageType::PixelType;
using RegionType = typename OutputImageType::RegionType;
using SpacingType = typename OutputImageType::SpacingType;
using PointType = typename OutputImageType::PointType;
using DirectionType = typename OutputImageType::DirectionType;
using IndexType = typename OutputImageType::IndexType;
/** Typedef the reference image type to be the ImageBase of the OutputImageType */
using ReferenceImageBaseType = ImageBase<TOutputImage::ImageDimension>;
using SizeType = typename TOutputImage::SizeType;
using SizeValueType = typename TOutputImage::SizeValueType;
/** Dimensionality of the output image */
static constexpr unsigned int NDimensions = TOutputImage::ImageDimension;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(GenerateImageSource);
itkSetMacro(UseReferenceImage, bool);
itkBooleanMacro(UseReferenceImage);
itkGetConstMacro(UseReferenceImage, bool);
/**
* Set/Get the size of the output image
**/
itkSetMacro(Size, SizeType);
itkGetConstReferenceMacro(Size, SizeType);
itkSetVectorMacro(Size, SizeValueType, NDimensions);
/**
* Set/Get the output image spacing. This parameter defaults to all ones.
**/
itkSetMacro(Spacing, SpacingType);
itkGetConstReferenceMacro(Spacing, SpacingType);
itkSetVectorMacro(Spacing, const float, NDimensions);
/**
* Set/Get the output image origin. This parameter defaults to all zeros.
**/
itkSetMacro(Origin, PointType);
itkGetConstReferenceMacro(Origin, PointType);
itkSetVectorMacro(Origin, const float, NDimensions);
/**
* Set/Get the output image direction cosine. This parameter
* defaults to the identity matrix.
**/
itkSetMacro(Direction, DirectionType);
itkGetConstReferenceMacro(Direction, DirectionType);
/**
* Set/Get the output image direction cosine. This parameter
* defaults to the identity matrix.
**/
itkSetMacro(StartIndex, IndexType);
itkGetConstReferenceMacro(StartIndex, IndexType);
/** Helper method to set the output parameters based on an image. */
void
SetOutputParametersFromImage(const ReferenceImageBaseType * image);
/** Set a reference image to use to define the output information.
* By default, output information is specified through the
* SetOutputSpacing, Origin, and Direction methods. Alternatively,
* this method can be used to specify an image from which to
* copy the information. UseReferenceImageOn must be set to utilize the
* reference image. */
itkSetInputMacro(ReferenceImage, ReferenceImageBaseType);
/** Get the reference image that is defining the output information. */
itkGetInputMacro(ReferenceImage, ReferenceImageBaseType);
protected:
GenerateImageSource();
~GenerateImageSource() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
void
GenerateOutputInformation() override;
private:
SizeType m_Size{}; // size of the output image
SpacingType m_Spacing{};
PointType m_Origin{};
DirectionType m_Direction{};
IndexType m_StartIndex{};
bool m_UseReferenceImage{ false };
};
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkGenerateImageSource.hxx"
#endif
#endif // itkGenerateImageSource_h
|
