itkHoughTransform2DCirclesImageFilter.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 itkHoughTransform2DCirclesImageFilter_h
#define itkHoughTransform2DCirclesImageFilter_h
 
 
#include "itkImageToImageFilter.h"
#include "itkEllipseSpatialObject.h"
 
namespace itk
{
 
template <typename TInputPixelType, typename TOutputPixelType, typename TRadiusPixelType>
class ITK_TEMPLATE_EXPORT HoughTransform2DCirclesImageFilter
  : public ImageToImageFilter<Image<TInputPixelType, 2>, Image<TOutputPixelType, 2>>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(HoughTransform2DCirclesImageFilter);

  using Self = HoughTransform2DCirclesImageFilter;
  using Superclass = ImageToImageFilter<Image<TInputPixelType, 2>, Image<TOutputPixelType, 2>>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using InputImageType = Image<TInputPixelType, 2>;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;

  using OutputImageType = Image<TOutputPixelType, 2>;
  using OutputImagePointer = typename OutputImageType::Pointer;

  using RadiusImageType = Image<TRadiusPixelType, 2>;
  using RadiusImagePointer = typename RadiusImageType::Pointer;

  using IndexType = typename InputImageType::IndexType;

  using PixelType = typename InputImageType::PixelType;

  using OutputImageRegionType = typename InputImageType::RegionType;

  using CircleType = EllipseSpatialObject<2>;
  using CirclePointer = typename CircleType::Pointer;
  using CirclesListType = std::list<CirclePointer>;
 
  using CirclesListSizeType = typename CirclesListType::size_type;

  itkOverrideGetNameOfClassMacro(HoughTransform2DCirclesImageFilter);

  itkNewMacro(Self);

  void
  VerifyPreconditions() const override;

  void
  GenerateData() override;

  void
  SetRadius(double radius);

  itkSetMacro(MinimumRadius, double);
  itkGetConstMacro(MinimumRadius, double);

  itkSetMacro(MaximumRadius, double);
  itkGetConstMacro(MaximumRadius, double);

  itkSetMacro(Threshold, double);

  itkGetConstMacro(Threshold, double);

  itkSetMacro(GradientNormThreshold, double);
  itkGetConstMacro(GradientNormThreshold, double);

  itkGetModifiableObjectMacro(RadiusImage, RadiusImageType);

  itkSetMacro(SigmaGradient, double);

  itkGetConstMacro(SigmaGradient, double);

  CirclesListType &
  GetCircles();

  itkSetMacro(NumberOfCircles, CirclesListSizeType);
  itkGetConstMacro(NumberOfCircles, CirclesListSizeType);

  itkSetMacro(DiscRadiusRatio, double);
  itkGetConstMacro(DiscRadiusRatio, double);

  itkSetMacro(Variance, double);
  itkGetConstMacro(Variance, double);

  itkSetMacro(SweepAngle, double);
  itkGetConstMacro(SweepAngle, double);

  itkSetMacro(UseImageSpacing, bool);
  itkGetConstMacro(UseImageSpacing, bool);
 
  itkConceptMacro(IntConvertibleToOutputCheck, (Concept::Convertible<int, TOutputPixelType>));
  itkConceptMacro(InputGreaterThanDoubleCheck, (Concept::GreaterThanComparable<PixelType, double>));
  itkConceptMacro(OutputPlusIntCheck, (Concept::AdditiveOperators<TOutputPixelType, int>));
  itkConceptMacro(OutputDividedByIntCheck, (Concept::DivisionOperators<TOutputPixelType, int>));
 
protected:
  HoughTransform2DCirclesImageFilter();
  ~HoughTransform2DCirclesImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateInputRequestedRegion() override;

  void
  EnlargeOutputRequestedRegion(DataObject * itkNotUsed(output)) override;
 
private:
  double m_SweepAngle{ 0.0 };
  double m_MinimumRadius{ 0.0 };
  double m_MaximumRadius{ 10.0 };
  double m_Threshold{ 0.0 };
  double m_GradientNormThreshold{ 1.0 };
  double m_SigmaGradient{ 1.0 };
 
  RadiusImagePointer  m_RadiusImage{};
  CirclesListType     m_CirclesList{};
  CirclesListSizeType m_NumberOfCircles{ 1 };
  double              m_DiscRadiusRatio{ 1 };
  double              m_Variance{ 10 };
  bool                m_UseImageSpacing{ true };
  ModifiedTimeType    m_OldModifiedTime{ 0 };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkHoughTransform2DCirclesImageFilter.hxx"
#endif
 
#endif