ITK  5.3.0
Insight Toolkit
itkShotNoiseImageFilter.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 itkShotNoiseImageFilter_h
19 #define itkShotNoiseImageFilter_h
20 
22 
23 namespace itk
24 {
25 
93 template <class TInputImage, class TOutputImage = TInputImage>
94 class ITK_TEMPLATE_EXPORT ShotNoiseImageFilter : public NoiseBaseImageFilter<TInputImage, TOutputImage>
95 {
96 public:
97  ITK_DISALLOW_COPY_AND_MOVE(ShotNoiseImageFilter);
99 
105 
107  itkNewMacro(Self);
108 
111 
113  using typename Superclass::OutputImageType;
114  using typename Superclass::OutputImagePointer;
115  using typename Superclass::OutputImageRegionType;
116  using typename Superclass::OutputImagePixelType;
117 
119  using InputImageType = TInputImage;
120  using InputImagePointer = typename InputImageType::Pointer;
121  using InputImageConstPointer = typename InputImageType::ConstPointer;
123  using InputImagePixelType = typename InputImageType::PixelType;
124 
129  itkGetConstMacro(Scale, double);
130  itkSetMacro(Scale, double);
132 
133 #ifdef ITK_USE_CONCEPT_CHECKING
134 
135  itkConceptMacro(InputConvertibleToOutputCheck,
137 
139 #endif
140 
141 protected:
143  ~ShotNoiseImageFilter() override = default;
144 
145  void
146  PrintSelf(std::ostream & os, Indent indent) const override;
147 
148  void
149  ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread, ThreadIdType threadId) override;
150 
151 
152 private:
153  double m_Scale{ 1.0 };
154 };
155 } // end namespace itk
156 
157 #ifndef ITK_MANUAL_INSTANTIATION
158 # include "itkShotNoiseImageFilter.hxx"
159 #endif
160 
161 #endif
itk::ShotNoiseImageFilter
Alter an image with shot noise.
Definition: itkShotNoiseImageFilter.h:94
itkNoiseBaseImageFilter.h
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