SimpleITK  2.0.0
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 {
33  namespace simple {
34 
47  public:
49 
51  virtual ~GaborImageSource();
52 
56 
59 
60 
61 
62 \
63 
66  SITK_RETURN_SELF_TYPE_HEADER SetOutputPixelType ( PixelIDValueEnum OutputPixelType ) { this->m_OutputPixelType = OutputPixelType; return *this; }
67 
70  PixelIDValueEnum GetOutputPixelType() const { return this->m_OutputPixelType; }\
71 
74  SITK_RETURN_SELF_TYPE_HEADER SetSize ( std::vector<unsigned int> Size ) { this->m_Size = std::move(Size); return *this; }
75 
78  std::vector<unsigned int> GetSize() const { return this->m_Size; }\
79 
83  SITK_RETURN_SELF_TYPE_HEADER SetSigma ( std::vector<double> Sigma ) { this->m_Sigma = std::move(Sigma); return *this; }
84 
86  SITK_RETURN_SELF_TYPE_HEADER SetSigma( double value ) { this->m_Sigma = std::vector<double>(3, value); return *this; }
87 
91  std::vector<double> GetSigma() const { return this->m_Sigma; }\
92 
96  SITK_RETURN_SELF_TYPE_HEADER SetMean ( std::vector<double> Mean ) { this->m_Mean = std::move(Mean); return *this; }
97 
99  SITK_RETURN_SELF_TYPE_HEADER SetMean( double value ) { this->m_Mean = std::vector<double>(3, value); return *this; }
100 
104  std::vector<double> GetMean() const { return this->m_Mean; }\
105 
109  SITK_RETURN_SELF_TYPE_HEADER SetFrequency ( double Frequency ) { this->m_Frequency = Frequency; return *this; }
110 
114  double GetFrequency() const { return this->m_Frequency; }\
115 
118  SITK_RETURN_SELF_TYPE_HEADER SetOrigin ( std::vector<double> Origin ) { this->m_Origin = std::move(Origin); return *this; }
119 
122  std::vector<double> GetOrigin() const { return this->m_Origin; }\
123 
126  SITK_RETURN_SELF_TYPE_HEADER SetSpacing ( std::vector<double> Spacing ) { this->m_Spacing = std::move(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 
141  std::string GetName() const { return std::string ("GaborImageSource"); }
142 
144  std::string ToString() const;
145 
146 
149  Image Execute ( );
150 
151 
152  private:
153 
156  using MemberFunctionType = Image (Self::*)( );
157  template <class TImageType> Image ExecuteInternal ( );
158 
159 
161 
162  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
163 
164 
166 
167  std::vector<unsigned int> m_Size{std::vector<unsigned int>(3, 64)};
168 
169  std::vector<double> m_Sigma{std::vector<double>(3, 16.0)};
170 
171  std::vector<double> m_Mean{std::vector<double>(3, 32.0)};
172 
173  double m_Frequency{0.4};
174 
175  std::vector<double> m_Origin{std::vector<double>(3, 0.0)};
176 
177  std::vector<double> m_Spacing{std::vector<double>(3, 1.0)};
178 
179  /* 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. */
180  std::vector<double> m_Direction{std::vector<double>()};
181 
182 
183 
184 
185 
186  };
187 
188 
189 
198 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>() );
199  }
200 }
201 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::GaborImageSource::SetSize
Self & SetSize(std::vector< unsigned int > Size)
Definition: sitkGaborImageSource.h:74
itk::simple::GaborImageSource::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkGaborImageSource.h:162
itk::Size
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::GaborImageSource::GetFrequency
double GetFrequency() const
Definition: sitkGaborImageSource.h:114
itk::simple::GaborImageSource::GetOutputPixelType
PixelIDValueEnum GetOutputPixelType() const
Definition: sitkGaborImageSource.h:70
itk::simple::GaborImageSource::GetSize
std::vector< unsigned int > GetSize() const
Definition: sitkGaborImageSource.h:78
itk::simple::GaborImageSource::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkGaborImageSource.h:58
itk::simple::GaborImageSource::MemberFunctionType
Image(Self::*)() MemberFunctionType
Definition: sitkGaborImageSource.h:156
itk::simple::GaborImageSource::SetMean
Self & SetMean(double value)
Definition: sitkGaborImageSource.h:99
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::GaborImageSource::SetSigma
Self & SetSigma(double value)
Definition: sitkGaborImageSource.h:86
itk::simple::GaborImageSource::GetSpacing
std::vector< double > GetSpacing() const
Definition: sitkGaborImageSource.h:130
itk::simple::GaborImageSource::GetName
std::string GetName() const
Definition: sitkGaborImageSource.h:141
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:83
itk::simple::GaborImageSource::SetOrigin
Self & SetOrigin(std::vector< double > Origin)
Definition: sitkGaborImageSource.h:118
itk::simple::sitkFloat32
@ sitkFloat32
32 bit float
Definition: sitkPixelIDValues.h:100
itk::simple::GaborImageSource::GetMean
std::vector< double > GetMean() const
Definition: sitkGaborImageSource.h:104
itk::simple::GaborImageSource
Generate an n-dimensional image of a Gabor filter.
Definition: sitkGaborImageSource.h:46
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::GaborImageSource::SetMean
Self & SetMean(std::vector< double > Mean)
Definition: sitkGaborImageSource.h:96
itk::simple::GaborImageSource::GetDirection
std::vector< double > GetDirection() const
Definition: sitkGaborImageSource.h:138
itk::simple::GaborImageSource::SetDirection
Self & SetDirection(std::vector< double > Direction)
Definition: sitkGaborImageSource.h:134
itk
itk::simple::GaborImageSource::SetOutputPixelType
Self & SetOutputPixelType(PixelIDValueEnum OutputPixelType)
Definition: sitkGaborImageSource.h:66
itk::simple::GaborImageSource::GetSigma
std::vector< double > GetSigma() const
Definition: sitkGaborImageSource.h:91
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::GaborImageSource::SetSpacing
Self & SetSpacing(std::vector< double > Spacing)
Definition: sitkGaborImageSource.h:126
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::GaborImageSource::GetOrigin
std::vector< double > GetOrigin() const
Definition: sitkGaborImageSource.h:122
itk::simple::GaborImageSource::SetFrequency
Self & SetFrequency(double Frequency)
Definition: sitkGaborImageSource.h:109
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.