SimpleITK  
sitkSaltAndPepperNoiseImageFilter.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 sitkSaltAndPepperNoiseImageFilter_h
19 #define sitkSaltAndPepperNoiseImageFilter_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 
58  public:
60 
63 
67 
70 \
71 
75  SITK_RETURN_SELF_TYPE_HEADER SetProbability ( double Probability ) { this->m_Probability = Probability; return *this; }
76 
80  double GetProbability() const { return this->m_Probability; }\
81 
84  SITK_RETURN_SELF_TYPE_HEADER SetSeed ( uint32_t Seed ) { this->m_Seed = Seed; return *this; }
85 
88  uint32_t GetSeed() const { return this->m_Seed; }
89 
91  std::string GetName() const { return std::string ("SaltAndPepperNoiseImageFilter"); }
92 
94  std::string ToString() const;
95 
96 
98 #ifndef SWIG
99  Image Execute ( Image&& image1 );
100 #endif
101  Image Execute ( const Image& image1 );
102 
103  private:
104 
107  using MemberFunctionType = Image (Self::*)( const Image& image1 );
108  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
110  template <class TImageType> Image ExecuteInternalVectorImage ( const Image& image );
111 
114  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
115 
116 
117  double m_Probability{0.01};
118 
119  uint32_t m_Seed{(uint32_t) itk::simple::sitkWallClock};
120 
121 
122  bool m_InPlace{false};
123  };
124 
134 #ifndef SWIG
135  SITKBasicFilters_EXPORT Image SaltAndPepperNoise ( Image&& image1, double probability = 0.01, uint32_t seed = (uint32_t) itk::simple::sitkWallClock );
136 #endif
137  SITKBasicFilters_EXPORT Image SaltAndPepperNoise ( const Image& image1, double probability = 0.01, uint32_t seed = (uint32_t) itk::simple::sitkWallClock );
138 
140 }
141 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::SaltAndPepperNoise
Image SaltAndPepperNoise(Image &&image1, double probability=0.01, uint32_t seed=(uint32_t) itk::simple::sitkWallClock)
Alter an image with fixed value impulse noise, often called salt and pepper noise.
itk::simple::detail::ExecuteInternalVectorImageAddressor
Definition: sitkDetail.h:66
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
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::SaltAndPepperNoiseImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkSaltAndPepperNoiseImageFilter.h:107
itk::simple::SaltAndPepperNoiseImageFilter::GetSeed
uint32_t GetSeed() const
Definition: sitkSaltAndPepperNoiseImageFilter.h:88
sitkImageFilter.h
itk::simple::SaltAndPepperNoiseImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkSaltAndPepperNoiseImageFilter.h:69
itk::simple::SaltAndPepperNoiseImageFilter::GetName
std::string GetName() const
Definition: sitkSaltAndPepperNoiseImageFilter.h:91
itk::simple::SaltAndPepperNoiseImageFilter
Alter an image with fixed value impulse noise, often called salt and pepper noise.
Definition: sitkSaltAndPepperNoiseImageFilter.h:57
itk::simple::SaltAndPepperNoiseImageFilter::SetSeed
Self & SetSeed(uint32_t Seed)
Definition: sitkSaltAndPepperNoiseImageFilter.h:84
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::sitkWallClock
@ sitkWallClock
Definition: sitkRandomSeed.h:30
itk::simple::SaltAndPepperNoiseImageFilter::SetProbability
Self & SetProbability(double Probability)
Definition: sitkSaltAndPepperNoiseImageFilter.h:75
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple::SaltAndPepperNoiseImageFilter::GetProbability
double GetProbability() const
Definition: sitkSaltAndPepperNoiseImageFilter.h:80
itk::simple::SaltAndPepperNoiseImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkSaltAndPepperNoiseImageFilter.h:114
itk::simple
Definition: sitkAdditionalProcedures.h:28