SimpleITK  2.0.0rc2.post23
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 
32 namespace itk {
33  namespace simple {
34 
50  public:
52 
54  virtual ~GridImageSource();
55 
59 
62 
63 
64 
65 \
66 
69  SITK_RETURN_SELF_TYPE_HEADER SetOutputPixelType ( PixelIDValueEnum OutputPixelType ) { this->m_OutputPixelType = OutputPixelType; return *this; }
70 
73  PixelIDValueEnum GetOutputPixelType() const { return this->m_OutputPixelType; }\
74 
77  SITK_RETURN_SELF_TYPE_HEADER SetSize ( std::vector<unsigned int> Size ) { this->m_Size = std::move(Size); return *this; }
78 
81  std::vector<unsigned int> GetSize() const { return this->m_Size; }\
82 
86  SITK_RETURN_SELF_TYPE_HEADER SetSigma ( std::vector<double> Sigma ) { this->m_Sigma = std::move(Sigma); return *this; }
87 
89  SITK_RETURN_SELF_TYPE_HEADER SetSigma( double value ) { this->m_Sigma = std::vector<double>(3, value); return *this; }
90 
94  std::vector<double> GetSigma() const { return this->m_Sigma; }\
95 
99  SITK_RETURN_SELF_TYPE_HEADER SetGridSpacing ( std::vector<double> GridSpacing ) { this->m_GridSpacing = std::move(GridSpacing); return *this; }
100 
104  std::vector<double> GetGridSpacing() const { return this->m_GridSpacing; }\
105 
109  SITK_RETURN_SELF_TYPE_HEADER SetGridOffset ( std::vector<double> GridOffset ) { this->m_GridOffset = std::move(GridOffset); return *this; }
110 
114  std::vector<double> GetGridOffset() const { return this->m_GridOffset; }\
115 
119  SITK_RETURN_SELF_TYPE_HEADER SetScale ( double Scale ) { this->m_Scale = Scale; return *this; }
120 
124  double GetScale() const { return this->m_Scale; }\
125 
128  SITK_RETURN_SELF_TYPE_HEADER SetOrigin ( std::vector<double> Origin ) { this->m_Origin = std::move(Origin); return *this; }
129 
132  std::vector<double> GetOrigin() const { return this->m_Origin; }\
133 
136  SITK_RETURN_SELF_TYPE_HEADER SetSpacing ( std::vector<double> Spacing ) { this->m_Spacing = std::move(Spacing); return *this; }
137 
140  std::vector<double> GetSpacing() const { return this->m_Spacing; }\
141 
144  SITK_RETURN_SELF_TYPE_HEADER SetDirection ( std::vector<double> Direction ) { this->m_Direction = Direction; return *this; }
145 
148  std::vector<double> GetDirection() const { return this->m_Direction; }
149 
151  std::string GetName() const { return std::string ("GridImageSource"); }
152 
154  std::string ToString() const;
155 
156 
159  Image Execute ( );
160 
161 
162  private:
163 
166  using MemberFunctionType = Image (Self::*)( );
167  template <class TImageType> Image ExecuteInternal ( );
168 
169 
171 
172  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
173 
174 
176 
177  std::vector<unsigned int> m_Size{std::vector<unsigned int>(3, 64)};
178 
179  std::vector<double> m_Sigma{std::vector<double>(3, 0.5)};
180 
181  std::vector<double> m_GridSpacing{std::vector<double>(3, 4.0)};
182 
183  std::vector<double> m_GridOffset{std::vector<double>(3, 0.0)};
184 
185  double m_Scale{255.0};
186 
187  std::vector<double> m_Origin{std::vector<double>(3, 0.0)};
188 
189  std::vector<double> m_Spacing{std::vector<double>(3, 1.0)};
190 
191  /* 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. */
192  std::vector<double> m_Direction{std::vector<double>()};
193 
194 
195 
196 
197 
198  };
199 
200 
201 
210 SITKBasicFilters_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>() );
211  }
212 }
213 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::GridImageSource::GetOrigin
std::vector< double > GetOrigin() const
Definition: sitkGridImageSource.h:132
sitkBasicFilters.h
itk::simple::GridImageSource::GetGridOffset
std::vector< double > GetGridOffset() const
Definition: sitkGridImageSource.h:114
itk::simple::GridImageSource::GetSize
std::vector< unsigned int > GetSize() const
Definition: sitkGridImageSource.h:81
itk::simple::GridImageSource::SetOutputPixelType
Self & SetOutputPixelType(PixelIDValueEnum OutputPixelType)
Definition: sitkGridImageSource.h:69
itk::Size
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::GridImageSource::SetSigma
Self & SetSigma(std::vector< double > Sigma)
Definition: sitkGridImageSource.h:86
itk::simple::GridImageSource::SetGridSpacing
Self & SetGridSpacing(std::vector< double > GridSpacing)
Definition: sitkGridImageSource.h:99
itk::simple::GridImageSource::SetSpacing
Self & SetSpacing(std::vector< double > Spacing)
Definition: sitkGridImageSource.h:136
itk::simple::PixelIDValueEnum
PixelIDValueEnum
Enumerated values of pixelIDs.
Definition: sitkPixelIDValues.h:90
itk::simple::BasicPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > >::Type BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:53
sitkImageFilter.h
itk::simple::GridSource
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 >())
Generate an n-dimensional image of a grid.
itk::simple::GridImageSource::GetName
std::string GetName() const
Definition: sitkGridImageSource.h:151
itk::simple::GridImageSource::GetScale
double GetScale() const
Definition: sitkGridImageSource.h:124
itk::simple::GridImageSource::SetDirection
Self & SetDirection(std::vector< double > Direction)
Definition: sitkGridImageSource.h:144
itk::simple::sitkFloat32
@ sitkFloat32
32 bit float
Definition: sitkPixelIDValues.h:100
itk::simple::GridImageSource::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkGridImageSource.h:61
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk
itk::simple::GridImageSource::SetSigma
Self & SetSigma(double value)
Definition: sitkGridImageSource.h:89
itk::simple::GridImageSource::MemberFunctionType
Image(Self::*)() MemberFunctionType
Definition: sitkGridImageSource.h:166
itk::simple::GridImageSource::SetSize
Self & SetSize(std::vector< unsigned int > Size)
Definition: sitkGridImageSource.h:77
itk::simple::GridImageSource::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkGridImageSource.h:172
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::GridImageSource
Generate an n-dimensional image of a grid.
Definition: sitkGridImageSource.h:49
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::GridImageSource::SetScale
Self & SetScale(double Scale)
Definition: sitkGridImageSource.h:119
itk::simple::GridImageSource::SetOrigin
Self & SetOrigin(std::vector< double > Origin)
Definition: sitkGridImageSource.h:128
itk::simple::GridImageSource::GetDirection
std::vector< double > GetDirection() const
Definition: sitkGridImageSource.h:148
itk::simple::GridImageSource::SetGridOffset
Self & SetGridOffset(std::vector< double > GridOffset)
Definition: sitkGridImageSource.h:109
itk::simple::GridImageSource::GetGridSpacing
std::vector< double > GetGridSpacing() const
Definition: sitkGridImageSource.h:104
itk::simple::GridImageSource::GetSpacing
std::vector< double > GetSpacing() const
Definition: sitkGridImageSource.h:140
itk::simple::GridImageSource::GetOutputPixelType
PixelIDValueEnum GetOutputPixelType() const
Definition: sitkGridImageSource.h:73
itk::simple::GridImageSource::GetSigma
std::vector< double > GetSigma() const
Definition: sitkGridImageSource.h:94