SimpleITK  
sitkGaborImageSource.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 sitkGaborImageSource_h
19 #define sitkGaborImageSource_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::simple {
33 
46  public:
48 
50  virtual ~GaborImageSource();
51 
55 
58 
59 
60 
61 \
62 
65  SITK_RETURN_SELF_TYPE_HEADER SetOutputPixelType ( PixelIDValueEnum OutputPixelType ) { this->m_OutputPixelType = OutputPixelType; return *this; }
66 
69  PixelIDValueEnum GetOutputPixelType() const { return this->m_OutputPixelType; }\
70 
73  SITK_RETURN_SELF_TYPE_HEADER SetSize ( std::vector<unsigned int> Size ) { this->m_Size = std::move(Size); return *this; }
74 
77  std::vector<unsigned int> GetSize() const { return this->m_Size; }\
78 
82  SITK_RETURN_SELF_TYPE_HEADER SetSigma ( std::vector<double> Sigma ) { this->m_Sigma = std::move(Sigma); return *this; }
83 
85  SITK_RETURN_SELF_TYPE_HEADER SetSigma( double value ) { this->m_Sigma = std::vector<double>(3, value); return *this; }
86 
90  std::vector<double> GetSigma() const { return this->m_Sigma; }\
91 
95  SITK_RETURN_SELF_TYPE_HEADER SetMean ( std::vector<double> Mean ) { this->m_Mean = std::move(Mean); return *this; }
96 
98  SITK_RETURN_SELF_TYPE_HEADER SetMean( double value ) { this->m_Mean = std::vector<double>(3, value); return *this; }
99 
103  std::vector<double> GetMean() const { return this->m_Mean; }\
104 
108  SITK_RETURN_SELF_TYPE_HEADER SetFrequency ( double Frequency ) { this->m_Frequency = Frequency; return *this; }
109 
113  double GetFrequency() const { return this->m_Frequency; }\
114 
117  SITK_RETURN_SELF_TYPE_HEADER SetOrigin ( std::vector<double> Origin ) { this->m_Origin = std::move(Origin); return *this; }
118 
121  std::vector<double> GetOrigin() const { return this->m_Origin; }\
122 
125  SITK_RETURN_SELF_TYPE_HEADER SetSpacing ( std::vector<double> Spacing ) { this->m_Spacing = std::move(Spacing); return *this; }
126 
129  std::vector<double> GetSpacing() const { return this->m_Spacing; }\
130 
133  SITK_RETURN_SELF_TYPE_HEADER SetDirection ( std::vector<double> Direction ) { this->m_Direction = Direction; return *this; }
134 
137  std::vector<double> GetDirection() const { return this->m_Direction; }
138 
140  std::string GetName() const { return std::string ("GaborImageSource"); }
141 
143  std::string ToString() const;
144 
145 
148  Image Execute ( );
149 
150 
151  private:
152 
155  using MemberFunctionType = Image (Self::*)( );
156  template <class TImageType> Image ExecuteInternal ( );
157 
158 
160 
161  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
162 
163 
165 
166  std::vector<unsigned int> m_Size{std::vector<unsigned int>(3, 64)};
167 
168  std::vector<double> m_Sigma{std::vector<double>(3, 16.0)};
169 
170  std::vector<double> m_Mean{std::vector<double>(3, 32.0)};
171 
172  double m_Frequency{0.4};
173 
174  std::vector<double> m_Origin{std::vector<double>(3, 0.0)};
175 
176  std::vector<double> m_Spacing{std::vector<double>(3, 1.0)};
177 
178  /* 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. */
179  std::vector<double> m_Direction{std::vector<double>()};
180 
181 
182 
183 
184 
185  };
186 
187 
188 
197 SITKBasicFilters_EXPORT Image GaborSource ( PixelIDValueEnum outputPixelType = itk::simple::sitkFloat32, std::vector<unsigned int> size = std::vector<unsigned int>(3, 64), std::vector<double> sigma = std::vector<double>(3, 16.0), std::vector<double> mean = std::vector<double>(3, 32.0), double frequency = 0.4, 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>() );
198 }
199 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::GaborImageSource::SetSize
Self & SetSize(std::vector< unsigned int > Size)
Definition: sitkGaborImageSource.h:73
itk::simple::GaborImageSource::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkGaborImageSource.h:161
itk::Size
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::GaborImageSource::GetFrequency
double GetFrequency() const
Definition: sitkGaborImageSource.h:113
itk::simple::GaborImageSource::GetOutputPixelType
PixelIDValueEnum GetOutputPixelType() const
Definition: sitkGaborImageSource.h:69
itk::simple::GaborImageSource::GetSize
std::vector< unsigned int > GetSize() const
Definition: sitkGaborImageSource.h:77
itk::simple::BasicPixelIDTypeList
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
Definition: sitkPixelIDTypeLists.h:51
itk::simple::GaborImageSource::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkGaborImageSource.h:57
itk::simple::GaborImageSource::MemberFunctionType
Image(Self::*)() MemberFunctionType
Definition: sitkGaborImageSource.h:155
itk::simple::GaborImageSource::SetMean
Self & SetMean(double value)
Definition: sitkGaborImageSource.h:98
itk::simple::PixelIDValueEnum
PixelIDValueEnum
Enumerated values of pixelIDs.
Definition: sitkPixelIDValues.h:91
sitkImageFilter.h
itk::simple::GaborImageSource::SetSigma
Self & SetSigma(double value)
Definition: sitkGaborImageSource.h:85
itk::simple::GaborImageSource::GetSpacing
std::vector< double > GetSpacing() const
Definition: sitkGaborImageSource.h:129
itk::simple::GaborImageSource::GetName
std::string GetName() const
Definition: sitkGaborImageSource.h:140
itk::simple::Mean
Image Mean(const Image &image1, std::vector< unsigned int > radius=std::vector< unsigned int >(3, 1))
Applies an averaging filter to an image.
itk::simple::GaborImageSource::SetSigma
Self & SetSigma(std::vector< double > Sigma)
Definition: sitkGaborImageSource.h:82
itk::simple::GaborImageSource::SetOrigin
Self & SetOrigin(std::vector< double > Origin)
Definition: sitkGaborImageSource.h:117
itk::simple::sitkFloat32
@ sitkFloat32
32 bit float
Definition: sitkPixelIDValues.h:101
itk::simple::GaborImageSource::GetMean
std::vector< double > GetMean() const
Definition: sitkGaborImageSource.h:103
itk::simple::GaborImageSource
Generate an n-dimensional image of a Gabor filter.
Definition: sitkGaborImageSource.h:45
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::GaborImageSource::SetMean
Self & SetMean(std::vector< double > Mean)
Definition: sitkGaborImageSource.h:95
itk::simple::GaborImageSource::GetDirection
std::vector< double > GetDirection() const
Definition: sitkGaborImageSource.h:137
itk::simple::GaborImageSource::SetDirection
Self & SetDirection(std::vector< double > Direction)
Definition: sitkGaborImageSource.h:133
itk::simple::GaborImageSource::SetOutputPixelType
Self & SetOutputPixelType(PixelIDValueEnum OutputPixelType)
Definition: sitkGaborImageSource.h:65
itk::simple::GaborImageSource::GetSigma
std::vector< double > GetSigma() const
Definition: sitkGaborImageSource.h:90
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:34
itk::simple::GaborImageSource::SetSpacing
Self & SetSpacing(std::vector< double > Spacing)
Definition: sitkGaborImageSource.h:125
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::GaborImageSource::GetOrigin
std::vector< double > GetOrigin() const
Definition: sitkGaborImageSource.h:121
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::GaborImageSource::SetFrequency
Self & SetFrequency(double Frequency)
Definition: sitkGaborImageSource.h:108
itk::simple::GaborSource
Image GaborSource(PixelIDValueEnum outputPixelType=itk::simple::sitkFloat32, std::vector< unsigned int > size=std::vector< unsigned int >(3, 64), std::vector< double > sigma=std::vector< double >(3, 16.0), std::vector< double > mean=std::vector< double >(3, 32.0), double frequency=0.4, 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 Gabor filter.