SimpleITK  
sitkGridImageSource.h
Go to the documentation of this file.
1/*=========================================================================
2*
3* Copyright NumFOCUS
4*
5* Licensed under the Apache License, Version 2.0 (the "License");
6* you may not use this file except in compliance with the License.
7* You may obtain a copy of the License at
8*
9* http://www.apache.org/licenses/LICENSE-2.0.txt
10*
11* Unless required by applicable law or agreed to in writing, software
12* distributed under the License is distributed on an "AS IS" BASIS,
13* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14* See the License for the specific language governing permissions and
15* limitations under the License.
16*
17*=========================================================================*/
18#ifndef sitkGridImageSource_h
19#define sitkGridImageSource_h
20
21/*
22 * WARNING: DO NOT EDIT THIS FILE!
23 * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
24 * Please look at sitkImageSourceTemplate.h.in to make changes.
25 */
26
27#include <memory>
28
29#include "sitkBasicFilters.h"
30#include "sitkImageFilter.h"
31
32namespace itk::simple {
33
58 public:
60
63
67
70
71
72
73\
74
77 SITK_RETURN_SELF_TYPE_HEADER SetOutputPixelType ( PixelIDValueEnum OutputPixelType ) { this->m_OutputPixelType = OutputPixelType; return *this; }
78
82
85 SITK_RETURN_SELF_TYPE_HEADER SetSize ( std::vector<unsigned int> Size ) { this->m_Size = std::move(Size); return *this; }
86
89 std::vector<unsigned int> GetSize() const { return this->m_Size; }\
90
94 SITK_RETURN_SELF_TYPE_HEADER SetSigma ( std::vector<double> Sigma ) { this->m_Sigma = std::move(Sigma); return *this; }
95
97 SITK_RETURN_SELF_TYPE_HEADER SetSigma( double value ) { this->m_Sigma = std::vector<double>(3, value); return *this; }
98
102 std::vector<double> GetSigma() const { return this->m_Sigma; }\
103
107 SITK_RETURN_SELF_TYPE_HEADER SetGridSpacing ( std::vector<double> GridSpacing ) { this->m_GridSpacing = std::move(GridSpacing); return *this; }
108
112 std::vector<double> GetGridSpacing() const { return this->m_GridSpacing; }\
113
117 SITK_RETURN_SELF_TYPE_HEADER SetGridOffset ( std::vector<double> GridOffset ) { this->m_GridOffset = std::move(GridOffset); return *this; }
118
122 std::vector<double> GetGridOffset() const { return this->m_GridOffset; }\
123
127 SITK_RETURN_SELF_TYPE_HEADER SetScale ( double Scale ) { this->m_Scale = Scale; return *this; }
128
132 double GetScale() const { return this->m_Scale; }\
133
136 SITK_RETURN_SELF_TYPE_HEADER SetOrigin ( std::vector<double> Origin ) { this->m_Origin = std::move(Origin); return *this; }
137
140 std::vector<double> GetOrigin() const { return this->m_Origin; }\
141
144 SITK_RETURN_SELF_TYPE_HEADER SetSpacing ( std::vector<double> Spacing ) { this->m_Spacing = std::move(Spacing); return *this; }
145
148 std::vector<double> GetSpacing() const { return this->m_Spacing; }\
149
152 SITK_RETURN_SELF_TYPE_HEADER SetDirection ( std::vector<double> Direction ) { this->m_Direction = Direction; return *this; }
153
156 std::vector<double> GetDirection() const { return this->m_Direction; }\
157
161 SITK_RETURN_SELF_TYPE_HEADER SetWhichDimensions ( std::vector<bool> WhichDimensions ) { this->m_WhichDimensions = std::move(WhichDimensions); return *this; }
162
166 std::vector<bool> GetWhichDimensions() const { return this->m_WhichDimensions; }
167
169 std::string GetName() const { return std::string ("GridImageSource"); }
170
172 std::string ToString() const;
173
174
176
178
179
180 private:
181
183
185 template <class TImageType> Image ExecuteInternal ( );
186
187
189
190 std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
191
192
193 PixelIDValueEnum m_OutputPixelType{itk::simple::sitkFloat32};
194
195 std::vector<unsigned int> m_Size{std::vector<unsigned int>(3, 64)};
196
197 std::vector<double> m_Sigma{std::vector<double>(3, 0.5)};
198
199 std::vector<double> m_GridSpacing{std::vector<double>(3, 4.0)};
200
201 std::vector<double> m_GridOffset{std::vector<double>(3, 0.0)};
202
203 double m_Scale{255.0};
204
205 std::vector<double> m_Origin{std::vector<double>(3, 0.0)};
206
207 std::vector<double> m_Spacing{std::vector<double>(3, 1.0)};
208
209 /* Passing a zero sized array, defaults to identiy matrix. The size of the array must exactly match the direction matrix for the dimension of the image. */
210 std::vector<double> m_Direction{std::vector<double>()};
211
212 std::vector<bool> m_WhichDimensions{std::vector<bool>(3, true)};
213
214
215
216
217
218 };
219
220
221
230SITKBasicFilters_EXPORT Image GridSource ( PixelIDValueEnum outputPixelType = itk::simple::sitkFloat32, std::vector<unsigned int> size = std::vector<unsigned int>(3, 64), std::vector<double> sigma = std::vector<double>(3, 0.5), std::vector<double> gridSpacing = std::vector<double>(3, 4.0), std::vector<double> gridOffset = std::vector<double>(3, 0.0), double scale = 255.0, std::vector<double> origin = std::vector<double>(3, 0.0), std::vector<double> spacing = std::vector<double>(3, 1.0), std::vector<double> direction = std::vector<double>(), std::vector<bool> whichDimensions = std::vector<bool>(3, true) );
231}
232#endif
std::string ToString() const
std::vector< bool > m_WhichDimensions
std::vector< double > GetDirection() const
Self & SetSpacing(std::vector< double > Spacing)
std::vector< double > m_GridOffset
Self & SetSigma(std::vector< double > Sigma)
std::vector< unsigned int > GetSize() const
Self & SetOutputPixelType(PixelIDValueEnum OutputPixelType)
Self & SetDirection(std::vector< double > Direction)
std::vector< double > m_Direction
std::vector< unsigned int > m_Size
Self & SetSize(std::vector< unsigned int > Size)
Self & SetOrigin(std::vector< double > Origin)
Self & SetGridOffset(std::vector< double > GridOffset)
std::vector< double > GetOrigin() const
std::vector< double > GetGridOffset() const
std::vector< bool > GetWhichDimensions() const
BasicPixelIDTypeList PixelIDTypeList
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
std::vector< double > GetGridSpacing() const
Self & SetWhichDimensions(std::vector< bool > WhichDimensions)
Self & SetGridSpacing(std::vector< double > GridSpacing)
std::vector< double > GetSigma() const
std::vector< double > m_GridSpacing
std::vector< double > GetSpacing() const
PixelIDValueEnum GetOutputPixelType() const
The Image class for SimpleITK.
Definition sitkImage.h:77
Image GridSource(PixelIDValueEnum outputPixelType=itk::simple::sitkFloat32, std::vector< unsigned int > size=std::vector< unsigned int >(3, 64), std::vector< double > sigma=std::vector< double >(3, 0.5), std::vector< double > gridSpacing=std::vector< double >(3, 4.0), std::vector< double > gridOffset=std::vector< double >(3, 0.0), double scale=255.0, std::vector< double > origin=std::vector< double >(3, 0.0), std::vector< double > spacing=std::vector< double >(3, 1.0), std::vector< double > direction=std::vector< double >(), std::vector< bool > whichDimensions=std::vector< bool >(3, true))
Generate an n-dimensional image of a grid.
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > > BasicPixelIDTypeList
PixelIDValueEnum
Enumerated values of pixelIDs.
#define SITKBasicFilters_EXPORT