SimpleITK  1.1.0
sitkGaussianImageSource.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 sitkGaussianImageSource_h
19 #define sitkGaussianImageSource_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 
45  public:
47 
49  virtual ~GaussianImageSource();
50 
54 
57 
58 
59 
60 
61 
64  SITK_RETURN_SELF_TYPE_HEADER SetOutputPixelType ( PixelIDValueEnum OutputPixelType ) { this->m_OutputPixelType = OutputPixelType; return *this; }
65 
68  PixelIDValueEnum GetOutputPixelType() const { return this->m_OutputPixelType; }
69 
72  SITK_RETURN_SELF_TYPE_HEADER SetSize ( const std::vector<unsigned int> & Size ) { this->m_Size = Size; return *this; }
73 
76  std::vector<unsigned int> GetSize() const { return this->m_Size; }
77 
81  SITK_RETURN_SELF_TYPE_HEADER SetSigma ( const std::vector<double> & Sigma ) { this->m_Sigma = Sigma; return *this; }
82 
84  SITK_RETURN_SELF_TYPE_HEADER SetSigma( double value ) { this->m_Sigma = std::vector<double>(3, value); return *this; }
85 
86 
90  std::vector<double> GetSigma() const { return this->m_Sigma; }
91 
95  SITK_RETURN_SELF_TYPE_HEADER SetMean ( const std::vector<double> & Mean ) { this->m_Mean = Mean; return *this; }
96 
98  SITK_RETURN_SELF_TYPE_HEADER SetMean( double value ) { this->m_Mean = std::vector<double>(3, value); return *this; }
99 
100 
104  std::vector<double> GetMean() const { return this->m_Mean; }
105 
109  SITK_RETURN_SELF_TYPE_HEADER SetScale ( double Scale ) { this->m_Scale = Scale; return *this; }
110 
114  double GetScale() const { return this->m_Scale; }
115 
118  SITK_RETURN_SELF_TYPE_HEADER SetOrigin ( const std::vector<double> & Origin ) { this->m_Origin = Origin; return *this; }
119 
122  std::vector<double> GetOrigin() const { return this->m_Origin; }
123 
126  SITK_RETURN_SELF_TYPE_HEADER SetSpacing ( const std::vector<double> & Spacing ) { this->m_Spacing = Spacing; return *this; }
127 
130  std::vector<double> GetSpacing() const { return this->m_Spacing; }
131 
134  SITK_RETURN_SELF_TYPE_HEADER SetDirection ( std::vector<double> Direction ) { this->m_Direction = Direction; return *this; }
135 
138  std::vector<double> GetDirection() const { return this->m_Direction; }
139 
143  SITK_RETURN_SELF_TYPE_HEADER SetNormalized ( bool Normalized ) { this->m_Normalized = Normalized; return *this; }
144 
146  SITK_RETURN_SELF_TYPE_HEADER NormalizedOn() { return this->SetNormalized(true); }
147  SITK_RETURN_SELF_TYPE_HEADER NormalizedOff() { return this->SetNormalized(false); }
148 
152  bool GetNormalized() const { return this->m_Normalized; }
154  std::string GetName() const { return std::string ("GaussianImageSource"); }
155 
157  std::string ToString() const;
158 
159 
161  Image Execute ( );
162 
163 
165  Image Execute ( PixelIDValueEnum outputPixelType, const std::vector<unsigned int> & size, const std::vector<double> & sigma, const std::vector<double> & mean, double scale, const std::vector<double> & origin, const std::vector<double> & spacing, std::vector<double> direction, bool normalized );
166 
167 
168  private:
169 
172  typedef Image (Self::*MemberFunctionType)( );
173  template <class TImageType> Image ExecuteInternal ( );
174 
175 
176  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
177 
178  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
179 
180 
182  std::vector<unsigned int> m_Size;
183  std::vector<double> m_Sigma;
184  std::vector<double> m_Mean;
185  double m_Scale;
186  std::vector<double> m_Origin;
187  std::vector<double> m_Spacing;
188  /* 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. */
189  std::vector<double> m_Direction;
191 
192 
193 
194  };
195 
196 
197 
206 SITKBasicFilters_EXPORT Image GaussianSource ( 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, 16.0), const std::vector<double> & mean = std::vector<double>(3, 32.0), double scale = 255, 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>(), bool normalized = false );
207  }
208 }
209 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
itk::simple::GaussianImageSource::m_Spacing
std::vector< double > m_Spacing
Definition: sitkGaussianImageSource.h:187
itk::simple::GaussianImageSource::SetScale
Self & SetScale(double Scale)
Definition: sitkGaussianImageSource.h:109
itk::simple::GaussianImageSource::GetNormalized
bool GetNormalized() const
Definition: sitkGaussianImageSource.h:152
sitkBasicFilters.h
itk::Size
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::GaussianImageSource::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkGaussianImageSource.h:56
itk::simple::GaussianImageSource::NormalizedOn
Self & NormalizedOn()
Definition: sitkGaussianImageSource.h:146
itk::simple::GaussianImageSource::SetMean
Self & SetMean(const std::vector< double > &Mean)
Definition: sitkGaussianImageSource.h:95
itk::simple::GaussianImageSource::SetNormalized
Self & SetNormalized(bool Normalized)
Definition: sitkGaussianImageSource.h:143
itk::simple::GaussianImageSource::m_Size
std::vector< unsigned int > m_Size
Definition: sitkGaussianImageSource.h:182
itk::simple::GaussianImageSource
Generate an n-dimensional image of a Gaussian.
Definition: sitkGaussianImageSource.h:44
itk::simple::GaussianImageSource::SetDirection
Self & SetDirection(std::vector< double > Direction)
Definition: sitkGaussianImageSource.h:134
itk::simple::GaussianImageSource::GetOrigin
std::vector< double > GetOrigin() const
Definition: sitkGaussianImageSource.h:122
itk::simple::GaussianImageSource::Self
GaussianImageSource Self
Definition: sitkGaussianImageSource.h:46
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::GaussianImageSource::SetSpacing
Self & SetSpacing(const std::vector< double > &Spacing)
Definition: sitkGaussianImageSource.h:126
itk::simple::GaussianImageSource::GetMean
std::vector< double > GetMean() const
Definition: sitkGaussianImageSource.h:104
itk::simple::GaussianImageSource::SetSize
Self & SetSize(const std::vector< unsigned int > &Size)
Definition: sitkGaussianImageSource.h:72
itk::simple::GaussianImageSource::SetOrigin
Self & SetOrigin(const std::vector< double > &Origin)
Definition: sitkGaussianImageSource.h:118
itk::simple::GaussianImageSource::GetSpacing
std::vector< double > GetSpacing() const
Definition: sitkGaussianImageSource.h:130
itk::simple::GaussianImageSource::GetDirection
std::vector< double > GetDirection() const
Definition: sitkGaussianImageSource.h:138
itk::simple::GaussianImageSource::GetScale
double GetScale() const
Definition: sitkGaussianImageSource.h:114
itk::simple::GaussianImageSource::m_Normalized
bool m_Normalized
Definition: sitkGaussianImageSource.h:190
itk::simple::GaussianImageSource::SetSigma
Self & SetSigma(const std::vector< double > &Sigma)
Definition: sitkGaussianImageSource.h:81
itk::simple::GaussianImageSource::SetOutputPixelType
Self & SetOutputPixelType(PixelIDValueEnum OutputPixelType)
Definition: sitkGaussianImageSource.h:64
itk::simple::sitkFloat32
@ sitkFloat32
32 bit float
Definition: sitkPixelIDValues.h:92
itk::simple::GaussianImageSource::m_Origin
std::vector< double > m_Origin
Definition: sitkGaussianImageSource.h:186
itk::simple::Mean
Image Mean(const Image &image1, const std::vector< unsigned int > &radius=std::vector< unsigned int >(3, 1))
Applies an averaging filter to an image.
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::GaussianImageSource::m_Sigma
std::vector< double > m_Sigma
Definition: sitkGaussianImageSource.h:183
itk::simple::GaussianImageSource::m_OutputPixelType
PixelIDValueEnum m_OutputPixelType
Definition: sitkGaussianImageSource.h:181
itk::simple::GaussianImageSource::GetName
std::string GetName() const
Definition: sitkGaussianImageSource.h:154
itk
itk::simple::GaussianImageSource::m_Direction
std::vector< double > m_Direction
Definition: sitkGaussianImageSource.h:189
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::GaussianImageSource::SetSigma
Self & SetSigma(double value)
Definition: sitkGaussianImageSource.h:84
itk::simple::GaussianSource
Image GaussianSource(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, 16.0), const std::vector< double > &mean=std::vector< double >(3, 32.0), double scale=255, 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 >(), bool normalized=false)
Generate an n-dimensional image of a Gaussian.
itk::simple::GaussianImageSource::NormalizedOff
Self & NormalizedOff()
Definition: sitkGaussianImageSource.h:147
itk::simple::GaussianImageSource::GetSize
std::vector< unsigned int > GetSize() const
Definition: sitkGaussianImageSource.h:76
itk::simple::GaussianImageSource::GetSigma
std::vector< double > GetSigma() const
Definition: sitkGaussianImageSource.h:90
itk::simple::GaussianImageSource::GetOutputPixelType
PixelIDValueEnum GetOutputPixelType() const
Definition: sitkGaussianImageSource.h:68
itk::simple::GaussianImageSource::SetMean
Self & SetMean(double value)
Definition: sitkGaussianImageSource.h:98
itk::simple::GaussianImageSource::m_Scale
double m_Scale
Definition: sitkGaussianImageSource.h:185
itk::simple::GaussianImageSource::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkGaussianImageSource.h:178
itk::simple::GaussianImageSource::m_Mean
std::vector< double > m_Mean
Definition: sitkGaussianImageSource.h:184