ITK  5.2.0
Insight Toolkit
itkImageKernelOperator.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 itkImageKernelOperator_h
19 #define itkImageKernelOperator_h
20 
22 
23 #include "itkImage.h"
24 
25 namespace itk
26 {
49 template <typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
50 class ITK_TEMPLATE_EXPORT ImageKernelOperator : public NeighborhoodOperator<TPixel, VDimension, TAllocator>
51 {
52 public:
53 
57 
59  using SizeType = typename Superclass::SizeType;
61 
63 
67  void
68  SetImageKernel(const ImageType * kernel);
69 
71  const ImageType *
72  GetImageKernel() const;
73 
75  void
76  PrintSelf(std::ostream & os, Indent i) const override
77  {
78  os << i << "ImageKernelOperator { this=" << this << "} " << std::endl;
79  Superclass::PrintSelf(os, i.GetNextIndent());
80  }
82 
83 protected:
85  CoefficientVector
86  GenerateCoefficients() override;
87 
89  void
90  Fill(const CoefficientVector & coeff) override;
91 
92 private:
94 };
95 } // namespace itk
96 
97 #ifndef ITK_MANUAL_INSTANTIATION
98 # include "itkImageKernelOperator.hxx"
99 #endif
100 
101 #endif
itk::Indent::GetNextIndent
Indent GetNextIndent() const
itk::ImageKernelOperator
A NeighborhoodOperator whose coefficients are from an image.
Definition: itkImageKernelOperator.h:50
itk::ImageKernelOperator::SizeType
typename Superclass::SizeType SizeType
Definition: itkImageKernelOperator.h:59
itk::NeighborhoodOperator
Virtual class that defines a common interface to all neighborhood operator subtypes.
Definition: itkNeighborhoodOperator.h:72
itkNeighborhoodOperator.h
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itkImage.h
itk::SmartPointer< const Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::ImageKernelOperator::CoefficientVector
typename Superclass::CoefficientVector CoefficientVector
Definition: itkImageKernelOperator.h:60
itk::ImageKernelOperator::PrintSelf
void PrintSelf(std::ostream &os, Indent i) const override
Definition: itkImageKernelOperator.h:76
itk::ImageKernelOperator::m_ImageKernel
ImageType::ConstPointer m_ImageKernel
Definition: itkImageKernelOperator.h:93
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Image
Templated n-dimensional image class.
Definition: itkImage.h:86
itk::NeighborhoodOperator::CoefficientVector
std::vector< PixelRealType > CoefficientVector
Definition: itkNeighborhoodOperator.h:148