ITK  5.3.0
Insight Toolkit
itkSpeckleNoiseImageFilter.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 
19 #ifndef itkSpeckleNoiseImageFilter_h
20 #define itkSpeckleNoiseImageFilter_h
21 
23 
24 namespace itk
25 {
26 
54 template <class TInputImage, class TOutputImage = TInputImage>
55 class ITK_TEMPLATE_EXPORT SpeckleNoiseImageFilter : public NoiseBaseImageFilter<TInputImage, TOutputImage>
56 {
57 public:
58  ITK_DISALLOW_COPY_AND_MOVE(SpeckleNoiseImageFilter);
59 
65 
67  itkNewMacro(Self);
68 
71 
73  using OutputImageType = typename Superclass::OutputImageType;
74  using OutputImagePointer = typename Superclass::OutputImagePointer;
75  using OutputImageRegionType = typename Superclass::OutputImageRegionType;
76  using OutputImagePixelType = typename Superclass::OutputImagePixelType;
77 
79  using InputImageType = TInputImage;
80  using InputImagePointer = typename InputImageType::Pointer;
81  using InputImageConstPointer = typename InputImageType::ConstPointer;
83  using InputImagePixelType = typename InputImageType::PixelType;
84 
87  itkGetConstMacro(StandardDeviation, double);
88  itkSetMacro(StandardDeviation, double);
90 
91 #ifdef ITK_USE_CONCEPT_CHECKING
92 
93  itkConceptMacro(InputConvertibleToOutputCheck,
95 
97 #endif
98 
99 protected:
101  ~SpeckleNoiseImageFilter() override = default;
102 
103  void
104  PrintSelf(std::ostream & os, Indent indent) const override;
105 
106  void
107  ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread, ThreadIdType threadId) override;
108 
109 private:
110  double m_StandardDeviation{ 1.0 };
111 };
112 } // end namespace itk
113 
114 #ifndef ITK_MANUAL_INSTANTIATION
115 # include "itkSpeckleNoiseImageFilter.hxx"
116 #endif
117 
118 #endif
itkNoiseBaseImageFilter.h
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
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::ImageSource::OutputImagePixelType
typename OutputImageType::PixelType OutputImagePixelType
Definition: itkImageSource.h:93
itk::Concept::Convertible
Definition: itkConceptChecking.h:216
itk::NoiseBaseImageFilter
An Abstract Base class for Noise image filters.
Definition: itkNoiseBaseImageFilter.h:39
itk::SpeckleNoiseImageFilter
Alter an image with speckle (multiplicative) noise.
Definition: itkSpeckleNoiseImageFilter.h:55
itk::ImageToImageFilter::InputImageRegionType
typename InputImageType::RegionType InputImageRegionType
Definition: itkImageToImageFilter.h:132
itk::ImageToImageFilter::InputImageConstPointer
typename InputImageType::ConstPointer InputImageConstPointer
Definition: itkImageToImageFilter.h:131
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90