itkFastChamferDistanceImageFilter.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 itkFastChamferDistanceImageFilter_h
#define itkFastChamferDistanceImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "itkNarrowBand.h"
 
namespace itk
{
 
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT FastChamferDistanceImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FastChamferDistanceImageFilter);

  using Self = FastChamferDistanceImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(FastChamferDistanceImageFilter);

  using InputImageType = TInputImage;

  using OutputImageType = TOutputImage;

  using RegionType = typename InputImageType::RegionType;

  using PixelType = typename InputImageType::PixelType;

  using IndexType = typename RegionType::IndexType;

  using OffsetType = typename InputImageType::OffsetType;

  using SizeType = typename RegionType::SizeType;

  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
  static constexpr unsigned int OutputImageDimension = OutputImageType::ImageDimension;

  using InputImagePointer = typename InputImageType::ConstPointer;

  using BandNodeType = BandNode<IndexType, PixelType>;
  using NarrowBandType = NarrowBand<BandNodeType>;
  using NarrowBandPointer = typename NarrowBandType::Pointer;
 
  using WeightsType = FixedArray<float, ImageDimension>;

  itkSetMacro(Weights, WeightsType);
  itkGetConstReferenceMacro(Weights, WeightsType);
  itkSetMacro(MaximumDistance, float);
  itkGetConstMacro(MaximumDistance, float);
  void
  SetRegionToProcess(const RegionType & r);
 
  RegionType
  GetRegionToProcess() const;
 
  void
  SetNarrowBand(NarrowBandType * ptr);
 
  NarrowBandPointer
  GetNarrowBand() const;
 
  itkConceptMacro(SameDimensionCheck, (Concept::SameDimension<ImageDimension, OutputImageDimension>));
  itkConceptMacro(SameTypeCheck, (Concept::SameType<PixelType, typename TOutputImage::PixelType>));
  itkConceptMacro(FloatConvertibleToPixelTypeCheck, (Concept::Convertible<float, PixelType>));
  itkConceptMacro(PixelTypeConvertibleToFloatCheck, (Concept::Convertible<PixelType, float>));
  itkConceptMacro(PixelTypeGreaterThanFloatCheck, (Concept::GreaterThanComparable<PixelType, float>));
  itkConceptMacro(PixelTypeLessThanFloatCheck, (Concept::LessThanComparable<PixelType, float>));
  itkConceptMacro(PixelTypeFloatAdditiveOperatorsCheck, (Concept::AdditiveOperators<PixelType, float, float>));
  itkConceptMacro(FloatGreaterThanPixelTypeCheck, (Concept::GreaterThanComparable<float, PixelType>));
  itkConceptMacro(FloatLessThanPixelTypeCheck, (Concept::LessThanComparable<float, PixelType>));
 
protected:
  FastChamferDistanceImageFilter();
  ~FastChamferDistanceImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateDataND();

  void
  GenerateData() override;
 
private:
  float m_MaximumDistance{};

  WeightsType m_Weights{};
 
  NarrowBandPointer m_NarrowBand{};

  RegionType m_RegionToProcess{};
}; // end of FastChamferDistanceImageFilter class
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkFastChamferDistanceImageFilter.hxx"
#endif
 
#endif