SimpleITK  2.0.0rc2.post17
sitkShotNoiseImageFilter.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 sitkShotNoiseImageFilter_h
19 #define sitkShotNoiseImageFilter_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 sitkImageFilterTemplate.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 
87  public:
89 
91  virtual ~ShotNoiseImageFilter();
92 
96 
99 \
100 
104  SITK_RETURN_SELF_TYPE_HEADER SetScale ( double Scale ) { this->m_Scale = Scale; return *this; }
105 
109  double GetScale() const { return this->m_Scale; }\
110 
113  SITK_RETURN_SELF_TYPE_HEADER SetSeed ( uint32_t Seed ) { this->m_Seed = Seed; return *this; }
114 
117  uint32_t GetSeed() const { return this->m_Seed; }
118 
120  std::string GetName() const { return std::string ("ShotNoiseImageFilter"); }
121 
123  std::string ToString() const;
124 
125 
127 #ifndef SWIG
128  Image Execute ( Image&& image1 );
129 #endif
130  Image Execute ( const Image& image1 );
131 
132  private:
133 
136  using MemberFunctionType = Image (Self::*)( const Image& image1 );
137  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
139  template <class TImageType> Image ExecuteInternalVectorImage ( const Image& image );
140 
143  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
144 
145 
146  double m_Scale{1.0};
147 
149 
150 
151  bool m_InPlace{false};
152  };
153 
163 #ifndef SWIG
164  SITKBasicFilters_EXPORT Image ShotNoise ( Image&& image1, double scale = 1.0, uint32_t seed = (uint32_t) itk::simple::sitkWallClock );
165 #endif
166  SITKBasicFilters_EXPORT Image ShotNoise ( const Image& image1, double scale = 1.0, uint32_t seed = (uint32_t) itk::simple::sitkWallClock );
167 
169  }
170 }
171 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::ShotNoise
Image ShotNoise(Image &&image1, double scale=1.0, uint32_t seed=(uint32_t) itk::simple::sitkWallClock)
Alter an image with shot noise.
sitkBasicFilters.h
itk::simple::detail::ExecuteInternalVectorImageAddressor
Definition: sitkDetail.h:59
itk::simple::ShotNoiseImageFilter::GetSeed
uint32_t GetSeed() const
Definition: sitkShotNoiseImageFilter.h:117
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::ShotNoiseImageFilter::SetSeed
Self & SetSeed(uint32_t Seed)
Definition: sitkShotNoiseImageFilter.h:113
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::ShotNoiseImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkShotNoiseImageFilter.h:98
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ShotNoiseImageFilter::SetScale
Self & SetScale(double Scale)
Definition: sitkShotNoiseImageFilter.h:104
itk::simple::ShotNoiseImageFilter::GetName
std::string GetName() const
Definition: sitkShotNoiseImageFilter.h:120
itk::simple::sitkWallClock
@ sitkWallClock
Definition: sitkRandomSeed.h:31
itk
itk::simple::ShotNoiseImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkShotNoiseImageFilter.h:136
itk::simple::ShotNoiseImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkShotNoiseImageFilter.h:143
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::ShotNoiseImageFilter::GetScale
double GetScale() const
Definition: sitkShotNoiseImageFilter.h:109
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::uint32_t
::uint32_t uint32_t
itk::simple::ShotNoiseImageFilter
Alter an image with shot noise.
Definition: sitkShotNoiseImageFilter.h:86