itkHoughTransform2DCirclesImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 = TOutputPixelType  >
class ITK_TEMPLATE_EXPORT HoughTransform2DCirclesImageFilter:
  public ImageToImageFilter< Image< TInputPixelType, 2 >, Image< TOutputPixelType, 2 > >
{
public:

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

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

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

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

  typedef typename InputImageType::IndexType IndexType;

  typedef typename InputImageType::PixelType PixelType;

  typedef typename InputImageType::RegionType OutputImageRegionType;

  typedef EllipseSpatialObject< 2 >    CircleType;
  typedef typename CircleType::Pointer CirclePointer;
  typedef std::list< CirclePointer >   CirclesListType;

  typedef typename CirclesListType::size_type CirclesListSizeType;

  itkTypeMacro(HoughTransform2DCirclesImageFilter, ImageToImageFilter);

  itkNewMacro(Self);

  void GenerateData() ITK_OVERRIDE;

  void SetRadius(double radius);

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

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

  itkSetMacro(Threshold, double);

  itkGetConstMacro(Threshold, double);

  itkGetModifiableObjectMacro(RadiusImage, RadiusImageType);

  itkSetMacro(SigmaGradient, double);

  itkGetConstMacro(SigmaGradient, double);

  CirclesListType & GetCircles();

  itkLegacyMacro(CirclesListType & GetCircles(unsigned int n));

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

  itkSetMacro(DiscRadiusRatio, float);
  itkGetConstMacro(DiscRadiusRatio, float);

  itkSetMacro(Variance, float);
  itkGetConstMacro(Variance, float);

  itkSetMacro(SweepAngle, float);
  itkGetConstMacro(SweepAngle, float);

#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro( IntConvertibleToOutputCheck,
                   ( Concept::Convertible< int, TOutputPixelType > ) );
  itkConceptMacro( InputGreaterThanDoubleCheck,
                   ( Concept::GreaterThanComparable< PixelType, double > ) );
  itkConceptMacro( OutputPlusIntCheck,
                   ( Concept::AdditiveOperators< TOutputPixelType, int > ) );
  itkConceptMacro( OutputDividedByIntCheck,
                   ( Concept::DivisionOperators< TOutputPixelType, int > ) );
  // End concept checking
#endif

protected:

  HoughTransform2DCirclesImageFilter();
  virtual ~HoughTransform2DCirclesImageFilter() ITK_OVERRIDE {}

  void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

  void GenerateInputRequestedRegion() ITK_OVERRIDE;

  void EnlargeOutputRequestedRegion( DataObject *itkNotUsed(output) ) ITK_OVERRIDE;

private:

  ITK_DISALLOW_COPY_AND_ASSIGN(HoughTransform2DCirclesImageFilter);

  float                 m_SweepAngle;
  double                m_MinimumRadius;
  double                m_MaximumRadius;
  double                m_Threshold;
  double                m_SigmaGradient;

  RadiusImagePointer    m_RadiusImage;
  CirclesListType       m_CirclesList;
  CirclesListSizeType   m_NumberOfCircles;
  float                 m_DiscRadiusRatio;
  float                 m_Variance;
  ModifiedTimeType      m_OldModifiedTime;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkHoughTransform2DCirclesImageFilter.hxx"
#endif

#endif