SimpleITK  1.1.0
sitkGridImageSource.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
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 
49  public:
51 
53  virtual ~GridImageSource();
54 
58 
61 
62 
63 
64 
65 
68  SITK_RETURN_SELF_TYPE_HEADER SetOutputPixelType ( PixelIDValueEnum OutputPixelType ) { this->m_OutputPixelType = OutputPixelType; return *this; }
69 
72  PixelIDValueEnum GetOutputPixelType() const { return this->m_OutputPixelType; }
73 
76  SITK_RETURN_SELF_TYPE_HEADER SetSize ( const std::vector<unsigned int> & Size ) { this->m_Size = Size; return *this; }
77 
80  std::vector<unsigned int> GetSize() const { return this->m_Size; }
81 
85  SITK_RETURN_SELF_TYPE_HEADER SetSigma ( const std::vector<double> & Sigma ) { this->m_Sigma = Sigma; return *this; }
86 
88  SITK_RETURN_SELF_TYPE_HEADER SetSigma( double value ) { this->m_Sigma = std::vector<double>(3, value); return *this; }
89 
90 
94  std::vector<double> GetSigma() const { return this->m_Sigma; }
95 
99  SITK_RETURN_SELF_TYPE_HEADER SetGridSpacing ( const std::vector<double> & GridSpacing ) { this->m_GridSpacing = GridSpacing; return *this; }
100 
104  std::vector<double> GetGridSpacing() const { return this->m_GridSpacing; }
105 
109  SITK_RETURN_SELF_TYPE_HEADER SetGridOffset ( const std::vector<double> & GridOffset ) { this->m_GridOffset = 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 ( const std::vector<double> & Origin ) { this->m_Origin = Origin; return *this; }
129 
132  std::vector<double> GetOrigin() const { return this->m_Origin; }
133 
136  SITK_RETURN_SELF_TYPE_HEADER SetSpacing ( const std::vector<double> & Spacing ) { this->m_Spacing = 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; }
150  std::string GetName() const { return std::string ("GridImageSource"); }
151 
153  std::string ToString() const;
154 
155 
157  Image Execute ( );
158 
159 
161  Image Execute ( PixelIDValueEnum outputPixelType, const std::vector<unsigned int> & size, const std::vector<double> & sigma, const std::vector<double> & gridSpacing, const std::vector<double> & gridOffset, double scale, const std::vector<double> & origin, const std::vector<double> & spacing, std::vector<double> direction );
162 
163 
164  private:
165 
168  typedef Image (Self::*MemberFunctionType)( );
169  template <class TImageType> Image ExecuteInternal ( );
170 
171 
172  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
173 
174  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
175 
176 
178  std::vector<unsigned int> m_Size;
179  std::vector<double> m_Sigma;
180  std::vector<double> m_GridSpacing;
181  std::vector<double> m_GridOffset;
182  double m_Scale;
183  std::vector<double> m_Origin;
184  std::vector<double> m_Spacing;
185  /* 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. */
186  std::vector<double> m_Direction;
187 
188 
189 
190  };
191 
192 
193 
202 SITKBasicFilters_EXPORT Image GridSource ( PixelIDValueEnum outputPixelType = itk::simple::sitkFloat32, const std::vector<unsigned int> & size = std::vector<unsigned int>(3, 64), const std::vector<double> & sigma = std::vector<double>(3, 0.5), const std::vector<double> & gridSpacing = std::vector<double>(3, 4.0), const std::vector<double> & gridOffset = std::vector<double>(3, 0.0), double scale = 255.0, const std::vector<double> & origin = std::vector<double>(3, 0.0), const std::vector<double> & spacing = std::vector<double>(3, 1.0), std::vector<double> direction = std::vector<double>() );
203  }
204 }
205 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
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::GridSource
Image GridSource(PixelIDValueEnum outputPixelType=itk::simple::sitkFloat32, const std::vector< unsigned int > &size=std::vector< unsigned int >(3, 64), const std::vector< double > &sigma=std::vector< double >(3, 0.5), const std::vector< double > &gridSpacing=std::vector< double >(3, 4.0), const std::vector< double > &gridOffset=std::vector< double >(3, 0.0), double scale=255.0, const std::vector< double > &origin=std::vector< double >(3, 0.0), const 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::SetOrigin
Self & SetOrigin(const std::vector< double > &Origin)
Definition: sitkGridImageSource.h:128
itk::simple::GridImageSource::GetSize
std::vector< unsigned int > GetSize() const
Definition: sitkGridImageSource.h:80
itk::simple::GridImageSource::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkGridImageSource.h:174
itk::simple::GridImageSource::SetOutputPixelType
Self & SetOutputPixelType(PixelIDValueEnum OutputPixelType)
Definition: sitkGridImageSource.h:68
itk::simple::GridImageSource::SetGridOffset
Self & SetGridOffset(const std::vector< double > &GridOffset)
Definition: sitkGridImageSource.h:109
itk::Size
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::PixelIDValueEnum
PixelIDValueEnum
Enumerated values of pixelIDs.
Definition: sitkPixelIDValues.h:82
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::GridImageSource::SetSigma
Self & SetSigma(const std::vector< double > &Sigma)
Definition: sitkGridImageSource.h:85
itk::simple::GridImageSource::m_Size
std::vector< unsigned int > m_Size
Definition: sitkGridImageSource.h:178
itk::simple::GridImageSource::GetName
std::string GetName() const
Definition: sitkGridImageSource.h:150
itk::simple::GridImageSource::m_GridSpacing
std::vector< double > m_GridSpacing
Definition: sitkGridImageSource.h:180
itk::simple::GridImageSource::m_Spacing
std::vector< double > m_Spacing
Definition: sitkGridImageSource.h:184
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:92
itk::simple::GridImageSource::SetSize
Self & SetSize(const std::vector< unsigned int > &Size)
Definition: sitkGridImageSource.h:76
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::GridImageSource::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkGridImageSource.h:60
itk::simple::GridImageSource::m_OutputPixelType
PixelIDValueEnum m_OutputPixelType
Definition: sitkGridImageSource.h:177
itk::simple::GridImageSource::Self
GridImageSource Self
Definition: sitkGridImageSource.h:50
itk::simple::GridImageSource::m_Scale
double m_Scale
Definition: sitkGridImageSource.h:182
itk
itk::simple::GridImageSource::SetSigma
Self & SetSigma(double value)
Definition: sitkGridImageSource.h:88
itk::simple::GridImageSource::m_Direction
std::vector< double > m_Direction
Definition: sitkGridImageSource.h:186
itk::simple::GridImageSource::SetGridSpacing
Self & SetGridSpacing(const std::vector< double > &GridSpacing)
Definition: sitkGridImageSource.h:99
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::GridImageSource
Generate an n-dimensional image of a grid.
Definition: sitkGridImageSource.h:48
itk::simple::GridImageSource::SetSpacing
Self & SetSpacing(const std::vector< double > &Spacing)
Definition: sitkGridImageSource.h:136
itk::simple::GridImageSource::m_Origin
std::vector< double > m_Origin
Definition: sitkGridImageSource.h:183
itk::simple::GridImageSource::m_Sigma
std::vector< double > m_Sigma
Definition: sitkGridImageSource.h:179
itk::simple::GridImageSource::m_GridOffset
std::vector< double > m_GridOffset
Definition: sitkGridImageSource.h:181
itk::simple::GridImageSource::SetScale
Self & SetScale(double Scale)
Definition: sitkGridImageSource.h:119
itk::simple::GridImageSource::GetDirection
std::vector< double > GetDirection() const
Definition: sitkGridImageSource.h:148
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:72
itk::simple::GridImageSource::GetSigma
std::vector< double > GetSigma() const
Definition: sitkGridImageSource.h:94