itkImageKernelOperator.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkImageKernelOperator_h
#define itkImageKernelOperator_h
 
#include "itkNeighborhoodOperator.h"
 
#include "itkImage.h"
 
namespace itk
{
template <typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
class ITK_TEMPLATE_EXPORT ImageKernelOperator : public NeighborhoodOperator<TPixel, VDimension, TAllocator>
{
public:

  using Self = ImageKernelOperator;
  using Superclass = NeighborhoodOperator<TPixel, VDimension, TAllocator>;
 
  using ImageType = Image<TPixel, VDimension>;

  itkOverrideGetNameOfClassMacro(ImageKernelOperator);

  void
  SetImageKernel(const ImageType * kernel);

  const ImageType *
  GetImageKernel() const;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
  }
 
protected:
  using typename Superclass::CoefficientVector;

  CoefficientVector
  GenerateCoefficients() override;

  void
  Fill(const CoefficientVector & coeff) override;
 
private:
  typename ImageType::ConstPointer m_ImageKernel{};
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageKernelOperator.hxx"
#endif
 
#endif