SimpleITK  
sitkSpeckleNoiseImageFilter.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 sitkSpeckleNoiseImageFilter_h
19 #define sitkSpeckleNoiseImageFilter_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 
62  public:
64 
66  virtual ~SpeckleNoiseImageFilter();
67 
71 
74 \
75 
79  SITK_RETURN_SELF_TYPE_HEADER SetStandardDeviation ( double StandardDeviation ) { this->m_StandardDeviation = StandardDeviation; return *this; }
80 
84  double GetStandardDeviation() const { return this->m_StandardDeviation; }\
85 
88  SITK_RETURN_SELF_TYPE_HEADER SetSeed ( uint32_t Seed ) { this->m_Seed = Seed; return *this; }
89 
92  uint32_t GetSeed() const { return this->m_Seed; }
93 
95  std::string GetName() const { return std::string ("SpeckleNoiseImageFilter"); }
96 
98  std::string ToString() const;
99 
100 
102 #ifndef SWIG
103  Image Execute ( Image&& image1 );
104 #endif
105  Image Execute ( const Image& image1 );
106 
107  private:
108 
111  using MemberFunctionType = Image (Self::*)( const Image& image1 );
112  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
114  template <class TImageType> Image ExecuteInternalVectorImage ( const Image& image );
115 
118  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
119 
120 
121  double m_StandardDeviation{1.0};
122 
123  uint32_t m_Seed{(uint32_t) itk::simple::sitkWallClock};
124 
125 
126  bool m_InPlace{false};
127  };
128 
138 #ifndef SWIG
139  SITKBasicFilters_EXPORT Image SpeckleNoise ( Image&& image1, double standardDeviation = 1.0, uint32_t seed = (uint32_t) itk::simple::sitkWallClock );
140 #endif
141  SITKBasicFilters_EXPORT Image SpeckleNoise ( const Image& image1, double standardDeviation = 1.0, uint32_t seed = (uint32_t) itk::simple::sitkWallClock );
142 
144 }
145 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
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::SpeckleNoiseImageFilter::GetName
std::string GetName() const
Definition: sitkSpeckleNoiseImageFilter.h:95
itk::simple::SpeckleNoise
Image SpeckleNoise(Image &&image1, double standardDeviation=1.0, uint32_t seed=(uint32_t) itk::simple::sitkWallClock)
Alter an image with speckle (multiplicative) noise.
itk::simple::SpeckleNoiseImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkSpeckleNoiseImageFilter.h:111
sitkImageFilter.h
itk::simple::SpeckleNoiseImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkSpeckleNoiseImageFilter.h:118
itk::simple::SpeckleNoiseImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkSpeckleNoiseImageFilter.h:73
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::SpeckleNoiseImageFilter::SetStandardDeviation
Self & SetStandardDeviation(double StandardDeviation)
Definition: sitkSpeckleNoiseImageFilter.h:79
itk::simple::sitkWallClock
@ sitkWallClock
Definition: sitkRandomSeed.h:30
itk::simple::SpeckleNoiseImageFilter
Alter an image with speckle (multiplicative) noise.
Definition: sitkSpeckleNoiseImageFilter.h:61
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::SpeckleNoiseImageFilter::GetStandardDeviation
double GetStandardDeviation() const
Definition: sitkSpeckleNoiseImageFilter.h:84
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::SpeckleNoiseImageFilter::SetSeed
Self & SetSeed(uint32_t Seed)
Definition: sitkSpeckleNoiseImageFilter.h:88
itk::simple::SpeckleNoiseImageFilter::GetSeed
uint32_t GetSeed() const
Definition: sitkSpeckleNoiseImageFilter.h:92