SimpleITK  
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::simple {
33 
86  public:
88 
90  virtual ~ShotNoiseImageFilter();
91 
95 
98 \
99 
103  SITK_RETURN_SELF_TYPE_HEADER SetScale ( double Scale ) { this->m_Scale = Scale; return *this; }
104 
108  double GetScale() const { return this->m_Scale; }\
109 
112  SITK_RETURN_SELF_TYPE_HEADER SetSeed ( uint32_t Seed ) { this->m_Seed = Seed; return *this; }
113 
116  uint32_t GetSeed() const { return this->m_Seed; }
117 
119  std::string GetName() const { return std::string ("ShotNoiseImageFilter"); }
120 
122  std::string ToString() const;
123 
124 
126 #ifndef SWIG
127  Image Execute ( Image&& image1 );
128 #endif
129  Image Execute ( const Image& image1 );
130 
131  private:
132 
135  using MemberFunctionType = Image (Self::*)( const Image& image1 );
136  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
138  template <class TImageType> Image ExecuteInternalVectorImage ( const Image& image );
139 
142  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
143 
144 
145  double m_Scale{1.0};
146 
147  uint32_t m_Seed{(uint32_t) itk::simple::sitkWallClock};
148 
149 
150  bool m_InPlace{false};
151  };
152 
162 #ifndef SWIG
163  SITKBasicFilters_EXPORT Image ShotNoise ( Image&& image1, double scale = 1.0, uint32_t seed = (uint32_t) itk::simple::sitkWallClock );
164 #endif
165  SITKBasicFilters_EXPORT Image ShotNoise ( const Image& image1, double scale = 1.0, uint32_t seed = (uint32_t) itk::simple::sitkWallClock );
166 
168 }
169 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
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:62
itk::simple::ShotNoiseImageFilter::GetSeed
uint32_t GetSeed() const
Definition: sitkShotNoiseImageFilter.h:116
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::ShotNoiseImageFilter::SetSeed
Self & SetSeed(uint32_t Seed)
Definition: sitkShotNoiseImageFilter.h:112
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
sitkImageFilter.h
itk::simple::ShotNoiseImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkShotNoiseImageFilter.h:97
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ShotNoiseImageFilter::SetScale
Self & SetScale(double Scale)
Definition: sitkShotNoiseImageFilter.h:103
itk::simple::ShotNoiseImageFilter::GetName
std::string GetName() const
Definition: sitkShotNoiseImageFilter.h:119
itk::simple::sitkWallClock
@ sitkWallClock
Definition: sitkRandomSeed.h:29
itk::simple::ShotNoiseImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkShotNoiseImageFilter.h:135
itk::simple::ShotNoiseImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkShotNoiseImageFilter.h:142
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:34
itk::simple::ShotNoiseImageFilter::GetScale
double GetScale() const
Definition: sitkShotNoiseImageFilter.h:108
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::ShotNoiseImageFilter
Alter an image with shot noise.
Definition: sitkShotNoiseImageFilter.h:85