itkConstantBoundaryCondition.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 itkConstantBoundaryCondition_h
#define itkConstantBoundaryCondition_h
 
#include "itkNumericTraits.h"
#include "itkImageBoundaryCondition.h"
 
namespace itk
{
// Forward reference for VariableLengthVector
template <typename TValue>
class VariableLengthVector;

template <typename TInputImage, typename TOutputImage = TInputImage>
class ITK_TEMPLATE_EXPORT ConstantBoundaryCondition : public ImageBoundaryCondition<TInputImage, TOutputImage>
{
public:
  using Self = ConstantBoundaryCondition;
  using Superclass = ImageBoundaryCondition<TInputImage, TOutputImage>;

  itkOverrideGetNameOfClassMacro(ConstantBoundaryCondition);

  using typename Superclass::PixelType;
  using typename Superclass::PixelPointerType;
  using typename Superclass::OutputPixelType;
  using typename Superclass::RegionType;
  using typename Superclass::IndexType;
  using typename Superclass::SizeType;
  using typename Superclass::OffsetType;
  using typename Superclass::NeighborhoodType;
 
  using typename Superclass::NeighborhoodAccessorFunctorType;

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  ConstantBoundaryCondition() = default;

  void
  Print(std::ostream & os, Indent i = 0) const override;

  template <typename TPixel>
  void
  Initialize(const VariableLengthVector<TPixel> *);

  OutputPixelType
  operator()(const OffsetType &, const OffsetType &, const NeighborhoodType *) const override;

  OutputPixelType
  operator()(const OffsetType &,
             const OffsetType &,
             const NeighborhoodType *,
             const NeighborhoodAccessorFunctorType &) const override;

  void
  SetConstant(const OutputPixelType & c);

  const OutputPixelType &
  GetConstant() const;

  bool
  RequiresCompleteNeighborhood() override
  {
    return false;
  }

  RegionType
  GetInputRequestedRegion(const RegionType & inputLargestPossibleRegion,
                          const RegionType & outputRequestedRegion) const override;

  OutputPixelType
  GetPixel(const IndexType & index, const TInputImage * image) const override;
 
private:
  OutputPixelType m_Constant{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkConstantBoundaryCondition.hxx"
#endif
 
#endif