itkImageBoundaryCondition.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 itkImageBoundaryCondition_h
#define itkImageBoundaryCondition_h
 
#include "itkIndex.h"
#include "itkNeighborhood.h"
#include "itkImageRegion.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT ImageBoundaryCondition
{
public:
  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;

  using Self = ImageBoundaryCondition;

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using PixelType = typename TInputImage::PixelType;
  using PixelPointerType = typename TInputImage::InternalPixelType *;
  using OutputPixelType = typename TOutputImage::PixelType;
  using IndexType = Index<ImageDimension>;
  using SizeType = Size<ImageDimension>;
  using OffsetType = Offset<ImageDimension>;
  using RegionType = ImageRegion<ImageDimension>;

  using NeighborhoodType = Neighborhood<PixelPointerType, ImageDimension>;

  using NeighborhoodAccessorFunctorType = typename TInputImage::NeighborhoodAccessorFunctorType;

  ImageBoundaryCondition() = default;

  itkVirtualGetNameOfClassMacro(ImageBoundaryCondition);

  virtual void
  Print(std::ostream & os, Indent i = 0) const
  {
    os << i << this->GetNameOfClass() << " (" << this << ')' << std::endl;
  }

  virtual OutputPixelType
  operator()(const OffsetType &       point_index,
             const OffsetType &       boundary_offset,
             const NeighborhoodType * data) const = 0;

  virtual OutputPixelType
  operator()(const OffsetType &                      point_index,
             const OffsetType &                      boundary_offset,
             const NeighborhoodType *                data,
             const NeighborhoodAccessorFunctorType & neighborhoodAccessorFunctor) const = 0;
 
  virtual ~ImageBoundaryCondition() = default;

  virtual bool
  RequiresCompleteNeighborhood()
  {
    return true;
  }

  virtual RegionType
  GetInputRequestedRegion(const RegionType &                  inputLargestPossibleRegion,
                          [[maybe_unused]] const RegionType & itkNotUsed(outputRequestedRegion)) const
  {
    return inputLargestPossibleRegion;
  }

  virtual OutputPixelType
  GetPixel(const IndexType & index, const TInputImage * image) const = 0;
};
} // end namespace itk
 
#endif