itkConstantPadImageFilter.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 itkConstantPadImageFilter_h
#define itkConstantPadImageFilter_h
 
#include "itkPadImageFilter.h"
 
#include "itkMath.h"
#include "itkConstantBoundaryCondition.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT ConstantPadImageFilter : public PadImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ConstantPadImageFilter);
 
  using Self = ConstantPadImageFilter;
  using Superclass = PadImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(ConstantPadImageFilter);
 
  using typename Superclass::OutputImageRegionType;
  using typename Superclass::InputImageRegionType;
 
  using typename Superclass::OutputImagePixelType;
  using typename Superclass::InputImagePixelType;
 
  using typename Superclass::OutputImageIndexType;
  using typename Superclass::InputImageIndexType;
  using typename Superclass::OutputImageSizeType;
  using typename Superclass::InputImageSizeType;
 
  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
 
  void
  SetConstant(OutputImagePixelType constant)
  {
    if (Math::NotExactlyEquals(constant, m_InternalBoundaryCondition.GetConstant()))
    {
      m_InternalBoundaryCondition.SetConstant(constant);
      this->Modified();
    }
  }
  OutputImagePixelType
  GetConstant() const
  {
    return m_InternalBoundaryCondition.GetConstant();
  }
#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro(OutputEqualityComparableCheck, (Concept::EqualityComparable<OutputImagePixelType>));
  itkConceptMacro(InputConvertibleToOutputCheck, (Concept::Convertible<InputImagePixelType, OutputImagePixelType>));
  itkConceptMacro(SameDimensionCheck, (Concept::SameDimension<ImageDimension, OutputImageDimension>));
  itkConceptMacro(OutputOStreamWritableCheck, (Concept::OStreamWritable<OutputImagePixelType>));
  // End concept checking
#endif
 
protected:
  ConstantPadImageFilter();
  ~ConstantPadImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  ConstantBoundaryCondition<TInputImage, TOutputImage> m_InternalBoundaryCondition{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkConstantPadImageFilter.hxx"
#endif
 
#endif