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.jinja to make changes.
25 */
26
27#include <memory>
28
29#include "sitkBasicFilters.h"
30#include "sitkImageFilter.h"
32
33namespace itk::simple {
34
65public:
67
70
74
77
78
79
80
84 void
85 SetStandardDeviation(double StandardDeviation )
86 { this->m_StandardDeviation = StandardDeviation; }
87
90 double
91 GetStandardDeviation() const { return this->m_StandardDeviation; }
92
93
96 void
97 SetSeed(uint32_t Seed )
98 { this->m_Seed = Seed; }
99
101 uint32_t
102 GetSeed() const { return this->m_Seed; }
103
104
106 std::string GetName() const { return std::string("SpeckleNoiseImageFilter"); }
107
109 std::string ToString() const;
110
111
113#ifndef SWIG
114 Image Execute(Image&& image1);
115#endif
116 Image Execute(const Image &image1);
117
118
119private:
121 using MemberFunctionType = Image (Self::*)(const Image &image1);
122 template <class TImageType> Image ExecuteInternal(const Image &image1);
124 template <class TImageType> Image ExecuteInternalVectorImage(const Image& image);
128
129
130 double m_StandardDeviation{ 1.0 };
131
132 uint32_t m_Seed{ (uint32_t) itk::simple::sitkWallClock };
133
134
135
136
137
138
139
140 bool m_InPlace{false};
141
142};
143
144
153#ifndef SWIG
155 Image&& image1, double standardDeviation = 1.0, uint32_t seed = (uint32_t) itk::simple::sitkWallClock
156);
157
158
159#endif
161 const Image &image1, double standardDeviation = 1.0, uint32_t seed = (uint32_t) itk::simple::sitkWallClock
162);
163
165
166}
167#endif
The Image class for SimpleITK.
Definition sitkImage.h:77
Image Execute(const Image &image1)
Image ExecuteInternalVectorImage(const Image &image)
Image ExecuteInternal(const Image &image1)
static const detail::MemberFunctionFactory< MemberFunctionType > & GetMemberFunctionFactory()
Image(Self::*)(const Image &image1) MemberFunctionType
void SetStandardDeviation(double StandardDeviation)
A class used to instantiate and generate function object to templated member functions.
Image SpeckleNoise(Image &&image1, double standardDeviation=1.0, uint32_t seed=(uint32_t) itk::simple::sitkWallClock)
Alter an image with speckle (multiplicative) noise.
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
#define SITKBasicFilters_EXPORT