itkNeighborhoodAlgorithm.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 itkNeighborhoodAlgorithm_h
#define itkNeighborhoodAlgorithm_h
 
#include <list>
#include "itkImage.h"
#include "itkNeighborhoodOperator.h"
#include "itkNeighborhoodIterator.h"
 
namespace itk::NeighborhoodAlgorithm
{
template <typename TImage>
struct ImageBoundaryFacesCalculator
{
  using RadiusType = typename NeighborhoodIterator<TImage>::RadiusType;
  using RegionType = typename TImage::RegionType;
  using IndexType = typename TImage::IndexType;
  using SizeType = typename TImage::SizeType;
  using FaceListType = std::list<RegionType>;
  static constexpr unsigned int ImageDimension = TImage::ImageDimension;

  class Result
  {
  public:
    [[nodiscard]] RegionType
    GetNonBoundaryRegion() const
    {
      return m_NonBoundaryRegion;
    }

    [[nodiscard]] const FaceListType &
    GetBoundaryFaces() const
    {
      return m_BoundaryFaces;
    }

    friend bool
    operator==(const Result & lhs, const Result & rhs)
    {
      return (lhs.m_NonBoundaryRegion == rhs.m_NonBoundaryRegion) && (lhs.m_BoundaryFaces == rhs.m_BoundaryFaces);
    }

    friend bool
    operator!=(const Result & lhs, const Result & rhs)
    {
      return !(lhs == rhs);
    }
 
  private:
    friend struct ImageBoundaryFacesCalculator;
 
    RegionType   m_NonBoundaryRegion;
    FaceListType m_BoundaryFaces;
  };

  static Result
  Compute(const TImage &, RegionType, RadiusType);
 
  FaceListType
  operator()(const TImage *, RegionType, RadiusType);
};

template <typename TImage>
struct CalculateOutputWrapOffsetModifiers
{
  using OffsetType = Offset<TImage::ImageDimension>;
  OffsetType
  operator()(TImage *, TImage *) const;
};
} // namespace itk::NeighborhoodAlgorithm
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkNeighborhoodAlgorithm.hxx"
#endif
 
#endif