itkNeighborhoodOperator.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 itkNeighborhoodOperator_h
#define itkNeighborhoodOperator_h
 
#include "itkNeighborhood.h"
#include "itkNumericTraits.h"
#include <vector>
 
namespace itk
{
template <typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator<TPixel>>
class ITK_TEMPLATE_EXPORT NeighborhoodOperator : public Neighborhood<TPixel, VDimension, TAllocator>
{
public:
  using Self = NeighborhoodOperator;
  using Superclass = Neighborhood<TPixel, VDimension, TAllocator>;
 
  itkOverrideGetNameOfClassMacro(NeighborhoodOperator);

  using typename Superclass::SizeType;

  using PixelType = TPixel;

  using SliceIteratorType = SliceIterator<TPixel, Self>;
 
  using PixelRealType = typename NumericTraits<TPixel>::RealType;

  void
  SetDirection(const unsigned int direction)
  {
    if (direction >= VDimension)
    {
      itkExceptionMacro(<< " Can not set direction " << direction << " greater than dimensionality of neighborhood "
                        << VDimension);
    }
    m_Direction = direction;
  }

  [[nodiscard]] unsigned int
  GetDirection() const
  {
    return m_Direction;
  }

  virtual void
  CreateDirectional();

  virtual void
  CreateToRadius(const SizeType &);

  virtual void
  CreateToRadius(const SizeValueType);

  virtual void
  FlipAxes();
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
 
    os << indent << "Direction: " << m_Direction << std::endl;
  }

  void ScaleCoefficients(PixelRealType);
 
protected:
  using CoefficientVector = typename std::vector<PixelRealType>;

  virtual CoefficientVector
  GenerateCoefficients() = 0;

  virtual void
  Fill(const CoefficientVector &) = 0;

  virtual void
  FillCenteredDirectional(const CoefficientVector &);

  void
  InitializeToZero()
  {
    for (unsigned int i = 0; i < this->Size(); ++i)
    {
      this->operator[](i) = PixelType{};
    }
  }
 
private:
  unsigned int m_Direction{ 0 };
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkNeighborhoodOperator.hxx"
#endif
 
/*
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkNeighborhoodOperator.hxx"
#endif
*/
#endif