ITK  5.3.0
Insight Toolkit
itkAdditiveGaussianNoiseImageFilter.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 itkAdditiveGaussianNoiseImageFilter_h
19 #define itkAdditiveGaussianNoiseImageFilter_h
20 
22 
23 namespace itk
24 {
25 
53 template <class TInputImage, class TOutputImage = TInputImage>
54 class ITK_TEMPLATE_EXPORT AdditiveGaussianNoiseImageFilter : public NoiseBaseImageFilter<TInputImage, TOutputImage>
55 {
56 public:
57  ITK_DISALLOW_COPY_AND_MOVE(AdditiveGaussianNoiseImageFilter);
58 
64 
66  itkNewMacro(Self);
67 
70 
72  using typename Superclass::OutputImageType;
73  using typename Superclass::OutputImagePointer;
74  using typename Superclass::OutputImageRegionType;
75  using typename Superclass::OutputImagePixelType;
76 
78  using InputImageType = TInputImage;
79  using InputImagePointer = typename InputImageType::Pointer;
80  using InputImageConstPointer = typename InputImageType::ConstPointer;
82  using InputImagePixelType = typename InputImageType::PixelType;
83 
86  itkGetConstMacro(Mean, double);
87  itkSetMacro(Mean, double);
89 
92  itkGetConstMacro(StandardDeviation, double);
93  itkSetMacro(StandardDeviation, double);
95 
96 #ifdef ITK_USE_CONCEPT_CHECKING
97 
98  itkConceptMacro(InputConvertibleToOutputCheck,
100 
102 #endif
103 
104 protected:
106  ~AdditiveGaussianNoiseImageFilter() override = default;
107 
108  void
109  PrintSelf(std::ostream & os, Indent indent) const override;
110 
111  void
112  ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread, ThreadIdType threadId) override;
113 
114 
115 private:
116  double m_Mean{ 0.0 };
117  double m_StandardDeviation{ 1.0 };
118 };
119 } // end namespace itk
120 
121 #ifndef ITK_MANUAL_INSTANTIATION
122 # include "itkAdditiveGaussianNoiseImageFilter.hxx"
123 #endif
124 
125 #endif
itkNoiseBaseImageFilter.h
itk::AdditiveGaussianNoiseImageFilter
Alter an image with additive Gaussian white noise.
Definition: itkAdditiveGaussianNoiseImageFilter.h:54
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::ImageToImageFilter::InputImagePixelType
typename InputImageType::PixelType InputImagePixelType
Definition: itkImageToImageFilter.h:133
itk::ThreadIdType
unsigned int ThreadIdType
Definition: itkIntTypes.h:99
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itk::ImageToImageFilter::InputImagePointer
typename InputImageType::Pointer InputImagePointer
Definition: itkImageToImageFilter.h:130
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itk::ImageSource::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkImageSource.h:92
itkConceptMacro
#define itkConceptMacro(name, concept)
Definition: itkConceptChecking.h:65
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::Concept::Convertible
Definition: itkConceptChecking.h:216
itk::NoiseBaseImageFilter
An Abstract Base class for Noise image filters.
Definition: itkNoiseBaseImageFilter.h:39
itk::ImageToImageFilter::InputImageRegionType
typename InputImageType::RegionType InputImageRegionType
Definition: itkImageToImageFilter.h:132
itk::ImageToImageFilter::InputImageConstPointer
typename InputImageType::ConstPointer InputImageConstPointer
Definition: itkImageToImageFilter.h:131