ITK  6.0.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 * https://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
24namespace itk
25{
26
54template <class TInputImage, class TOutputImage = TInputImage>
55class ITK_TEMPLATE_EXPORT SpeckleNoiseImageFilter : public NoiseBaseImageFilter<TInputImage, TOutputImage>
56{
57public:
58 ITK_DISALLOW_COPY_AND_MOVE(SpeckleNoiseImageFilter);
59
65
67 itkNewMacro(Self);
68
70 itkOverrideGetNameOfClassMacro(SpeckleNoiseImageFilter);
71
73 using typename Superclass::OutputImageType;
74 using typename Superclass::OutputImagePointer;
75 using typename Superclass::OutputImageRegionType;
76 using typename Superclass::OutputImagePixelType;
77
79 using InputImageType = TInputImage;
83 using InputImagePixelType = typename InputImageType::PixelType;
84
87 itkGetConstMacro(StandardDeviation, double);
88 itkSetMacro(StandardDeviation, double);
91#ifdef ITK_USE_CONCEPT_CHECKING
93 itkConceptMacro(InputConvertibleToOutputCheck,
95
97#endif
98
99protected:
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
109private:
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
typename OutputImageType::RegionType OutputImageRegionType
Control indentation during Print() invocation.
Definition: itkIndent.h:50
Light weight base class for most itk classes.
An Abstract Base class for Noise image filters.
Alter an image with speckle (multiplicative) noise.
void PrintSelf(std::ostream &os, Indent indent) const override
typename InputImageType::Pointer InputImagePointer
typename InputImageType::PixelType InputImagePixelType
void ThreadedGenerateData(const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override
typename InputImageType::RegionType InputImageRegionType
typename InputImageType::ConstPointer InputImageConstPointer
~SpeckleNoiseImageFilter() override=default
SmartPointer< const Self > ConstPointer
SmartPointer< Self > Pointer
#define itkConceptMacro(name, concept)
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
unsigned int ThreadIdType
Definition: itkIntTypes.h:102