ITK  5.2.0
Insight Toolkit
itkModulusImageFilter.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 itkModulusImageFilter_h
19 #define itkModulusImageFilter_h
20 
23 
24 
25 namespace itk
26 {
27 
42 template <typename TInputImage1, typename TInputImage2 = TInputImage1, typename TOutputImage = TInputImage1>
43 class ITK_TEMPLATE_EXPORT ModulusImageFilter
44  : public BinaryGeneratorImageFilter<TInputImage1, TInputImage2, TOutputImage>
45 {
46 public:
47  ITK_DISALLOW_COPY_AND_ASSIGN(ModulusImageFilter);
48 
52 
53  using FunctorType = Functor::
54  Modulus<typename TInputImage1::PixelType, typename TInputImage2::PixelType, typename TOutputImage::PixelType>;
55 
58 
59  using OutputPixelType = typename TOutputImage::PixelType;
60  using InputPixelType = typename TInputImage1::PixelType;
61 
63  itkNewMacro(Self);
64 
67 
69  virtual void
71  {
72  this->SetConstant2(_arg);
73  }
74  virtual const InputPixelType &
75  GetDividend() const
76  {
77  return this->GetConstant2();
78  }
80 
81 
82 #ifdef ITK_USE_CONCEPT_CHECKING
83  // Begin concept checking
84  itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<InputPixelType>));
85  // End concept checking
86 #endif
87 
88 protected:
90  ~ModulusImageFilter() override = default;
91 };
92 } // end namespace itk
93 
94 #ifndef ITK_MANUAL_INSTANTIATION
95 # include "itkModulusImageFilter.hxx"
96 #endif
97 
98 #endif
itk::Concept::HasNumericTraits
Definition: itkConceptChecking.h:712
itk::BinaryGeneratorImageFilter
Implements pixel-wise generic operation of two images, or of an image and a constant.
Definition: itkBinaryGeneratorImageFilter.h:56
itk::SmartPointer< Self >
itk::Functor::Modulus
Definition: itkArithmeticOpsFunctors.h:247
itkBinaryGeneratorImageFilter.h
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itkArithmeticOpsFunctors.h
itk::ModulusImageFilter
Computes the modulus (x % dividend) pixel-wise.
Definition: itkModulusImageFilter.h:43
itk::ModulusImageFilter::GetDividend
virtual const InputPixelType & GetDividend() const
Definition: itkModulusImageFilter.h:75
itkConceptMacro
#define itkConceptMacro(name, concept)
Definition: itkConceptChecking.h:64
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ModulusImageFilter::InputPixelType
typename TInputImage1::PixelType InputPixelType
Definition: itkModulusImageFilter.h:60
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::ModulusImageFilter::SetDividend
virtual void SetDividend(InputPixelType _arg)
Definition: itkModulusImageFilter.h:70
itk::ModulusImageFilter::OutputPixelType
typename TOutputImage::PixelType OutputPixelType
Definition: itkModulusImageFilter.h:59