ITK  5.2.0
Insight Toolkit
itkNormalizeToConstantImageFilter.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 itkNormalizeToConstantImageFilter_h
19 #define itkNormalizeToConstantImageFilter_h
20 
21 #include "itkImageToImageFilter.h"
22 #include "itkConceptChecking.h"
23 
24 namespace itk
25 {
26 
55 template <typename TInputImage, typename TOutputImage>
56 class ITK_TEMPLATE_EXPORT NormalizeToConstantImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
57 {
58 public:
59  ITK_DISALLOW_COPY_AND_ASSIGN(NormalizeToConstantImageFilter);
60 
63 
65 
68 
70  using InputImageType = TInputImage;
71  using OutputImageType = TOutputImage;
72  using InputImagePointer = typename InputImageType::Pointer;
73  using InputImageConstPointer = typename InputImageType::ConstPointer;
74  using InputImagePixelType = typename InputImageType::PixelType;
75  using OutputImagePointer = typename OutputImageType::Pointer;
76  using OutputImageConstPointer = typename OutputImageType::ConstPointer;
77  using OutputImagePixelType = typename OutputImageType::PixelType;
81 
83 
85  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
86  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
87  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;
88 
90  itkNewMacro(Self);
91 
94 
96  itkSetMacro(Constant, RealType);
97  itkGetConstMacro(Constant, RealType);
99 
100 #ifdef ITK_USE_CONCEPT_CHECKING
101  // Begin concept checking
104  // End concept checking
105 #endif
106 
107 protected:
109  ~NormalizeToConstantImageFilter() override = default;
110  void
111  PrintSelf(std::ostream & os, Indent indent) const override;
112 
113  void
114  GenerateInputRequestedRegion() override;
115 
116  void
117  GenerateData() override;
118 
119 private:
121 
122 }; // end of class
123 } // end namespace itk
124 
125 #ifndef ITK_MANUAL_INSTANTIATION
126 # include "itkNormalizeToConstantImageFilter.hxx"
127 #endif
128 
129 #endif
itk::Concept::HasNumericTraits
Definition: itkConceptChecking.h:712
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itk::NormalizeToConstantImageFilter::IndexType
typename InputImageType::IndexType IndexType
Definition: itkNormalizeToConstantImageFilter.h:79
itkConceptChecking.h
itk::NormalizeToConstantImageFilter::OutputImageConstPointer
typename OutputImageType::ConstPointer OutputImageConstPointer
Definition: itkNormalizeToConstantImageFilter.h:76
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::NormalizeToConstantImageFilter::RealType
typename NumericTraits< InputImagePixelType >::RealType RealType
Definition: itkNormalizeToConstantImageFilter.h:82
itk::ImageToImageFilter::InputImagePixelType
typename InputImageType::PixelType InputImagePixelType
Definition: itkImageToImageFilter.h:133
itk::NormalizeToConstantImageFilter::RegionType
typename InputImageType::RegionType RegionType
Definition: itkNormalizeToConstantImageFilter.h:78
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
itk::ImageToImageFilter
Base class for filters that take an image as input and produce an image as output.
Definition: itkImageToImageFilter.h:108
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
itkImageToImageFilter.h
itk::NormalizeToConstantImageFilter::m_Constant
RealType m_Constant
Definition: itkNormalizeToConstantImageFilter.h:120
itk::NumericTraits
Define additional traits for native types such as int or float.
Definition: itkNumericTraits.h:58
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::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::NormalizeToConstantImageFilter::SizeType
typename InputImageType::SizeType SizeType
Definition: itkNormalizeToConstantImageFilter.h:80
itk::ImageSource::OutputImagePixelType
typename OutputImageType::PixelType OutputImagePixelType
Definition: itkImageSource.h:93
itk::Concept::HasPixelTraits
Definition: itkConceptChecking.h:750
itk::ImageToImageFilter::InputImageConstPointer
typename InputImageType::ConstPointer InputImageConstPointer
Definition: itkImageToImageFilter.h:131
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90
itk::NormalizeToConstantImageFilter
Scales image pixel intensities to make the sum of all pixels equal a user-defined constant.
Definition: itkNormalizeToConstantImageFilter.h:56