itkCannyEdgeDetectionImageFilter.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 itkCannyEdgeDetectionImageFilter_h
#define itkCannyEdgeDetectionImageFilter_h

#include "itkConstNeighborhoodIterator.h"
#include "itkDiscreteGaussianImageFilter.h"
#include "itkMultiplyImageFilter.h"
#include "itkMultiThreader.h"
#include "itkDerivativeOperator.h"
#include "itkSparseFieldLayer.h"
#include "itkObjectStore.h"
#include "itkMath.h"

namespace itk
{
template< typename TValue >
class ITK_TEMPLATE_EXPORT ListNode
{
public:
  TValue m_Value;

  ListNode *Next;
  ListNode *Previous;
};

template< typename TInputImage, typename TOutputImage >
class ITK_TEMPLATE_EXPORT CannyEdgeDetectionImageFilter:
  public ImageToImageFilter< TInputImage, TOutputImage >
{
public:
  typedef CannyEdgeDetectionImageFilter                   Self;
  typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass;

  typedef TInputImage  InputImageType;
  typedef TOutputImage OutputImageType;

  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  typedef typename TInputImage::PixelType     InputImagePixelType;
  typedef typename TOutputImage::PixelType    OutputImagePixelType;
  typedef typename TInputImage::IndexType     IndexType;
  typedef typename TInputImage::SizeValueType SizeValueType;

  typedef ZeroFluxNeumannBoundaryCondition< OutputImageType >
  DefaultBoundaryConditionType;

  typedef ConstNeighborhoodIterator< OutputImageType,
                                     DefaultBoundaryConditionType > NeighborhoodType;

  typedef ListNode< IndexType >            ListNodeType;
  typedef ObjectStore< ListNodeType >      ListNodeStorageType;
  typedef SparseFieldLayer< ListNodeType > ListType;
  typedef typename ListType::Pointer       ListPointerType;

  itkNewMacro(Self);

  typedef typename TOutputImage::RegionType OutputImageRegionType;
  typedef typename TInputImage::RegionType  InputImageRegionType;

  itkTypeMacro(CannyEdgeDetectionImageFilter, ImageToImageFilter);

  itkStaticConstMacro(ImageDimension, unsigned int,
                      TInputImage::ImageDimension);
  itkStaticConstMacro(OutputImageDimension, unsigned int,
                      TOutputImage::ImageDimension);

  typedef FixedArray< double, itkGetStaticConstMacro(ImageDimension) > ArrayType;

  itkSetMacro(Variance, ArrayType);
  itkGetConstMacro(Variance, const ArrayType);
  itkSetMacro(MaximumError, ArrayType);
  itkGetConstMacro(MaximumError, const ArrayType);

  void SetVariance(const typename ArrayType::ValueType v)
  {
    for ( unsigned int i = 0; i < TInputImage::ImageDimension; i++ )
      {
      if ( Math::NotExactlyEquals(m_Variance[i], v) )
        {
        m_Variance.Fill(v);
        this->Modified();
        break;
        }
      }
  }

  void SetMaximumError(const typename ArrayType::ValueType v)
  {
    for ( unsigned int i = 0; i < TInputImage::ImageDimension; i++ )
      {
      if ( Math::NotExactlyEquals(m_MaximumError[i], v) )
        {
        m_MaximumError.Fill(v);
        this->Modified();
        break;
        }
      }
  }

  itkSetMacro(UpperThreshold, OutputImagePixelType);
  itkGetConstMacro(UpperThreshold, OutputImagePixelType);

  itkSetMacro(LowerThreshold, OutputImagePixelType);
  itkGetConstMacro(LowerThreshold, OutputImagePixelType);

  OutputImageType * GetNonMaximumSuppressionImage()
  {
    return this->m_MultiplyImageFilter->GetOutput();
  }

  virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;

#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro( InputHasNumericTraitsCheck,
                   ( Concept::HasNumericTraits< InputImagePixelType > ) );
  itkConceptMacro( OutputHasNumericTraitsCheck,
                   ( Concept::HasNumericTraits< OutputImagePixelType > ) );
  itkConceptMacro( SameDimensionCheck,
                   ( Concept::SameDimension< ImageDimension, OutputImageDimension > ) );
  itkConceptMacro( InputIsFloatingPointCheck,
                   ( Concept::IsFloatingPoint< InputImagePixelType > ) );
  itkConceptMacro( OutputIsFloatingPointCheck,
                   ( Concept::IsFloatingPoint< OutputImagePixelType > ) );
  // End concept checking
#endif

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

  void GenerateData() ITK_OVERRIDE;

  typedef DiscreteGaussianImageFilter< InputImageType, OutputImageType >
  GaussianImageFilterType;
  typedef MultiplyImageFilter< OutputImageType,
                               OutputImageType, OutputImageType >       MultiplyImageFilterType;

private:
  ITK_DISALLOW_COPY_AND_ASSIGN(CannyEdgeDetectionImageFilter);

  virtual ~CannyEdgeDetectionImageFilter(){}

  struct CannyThreadStruct
  {
    CannyEdgeDetectionImageFilter *Filter;
  };

  void AllocateUpdateBuffer();

  void HysteresisThresholding();

  void FollowEdge(IndexType index, const OutputImageType *multiplyImageFilterOutput);

  void Compute2ndDerivative();

  //  virtual
  //  int SplitUpdateContainer(int i, int num, ThreadRegionType& splitRegion);

  void ThreadedCompute2ndDerivative(const OutputImageRegionType &
                                    outputRegionForThread, ThreadIdType threadId);

  static ITK_THREAD_RETURN_TYPE
  Compute2ndDerivativeThreaderCallback(void *arg);

  OutputImagePixelType ComputeCannyEdge(const NeighborhoodType & it,
                                        void *globalData);

  void Compute2ndDerivativePos();

  void ThreadedCompute2ndDerivativePos(const OutputImageRegionType &
                                       outputRegionForThread, ThreadIdType threadId);

  static ITK_THREAD_RETURN_TYPE
  Compute2ndDerivativePosThreaderCallback(void *arg);

  ArrayType m_Variance;

  ArrayType m_MaximumError;

  OutputImagePixelType m_UpperThreshold;  //should be float here?

  OutputImagePixelType m_LowerThreshold; //should be float here?

  typename OutputImageType::Pointer m_UpdateBuffer1;

  typename GaussianImageFilterType::Pointer m_GaussianFilter;

  typename MultiplyImageFilterType::Pointer m_MultiplyImageFilter;

  DerivativeOperator< OutputImagePixelType, itkGetStaticConstMacro(ImageDimension) >
  m_ComputeCannyEdge1stDerivativeOper;
  DerivativeOperator< OutputImagePixelType, itkGetStaticConstMacro(ImageDimension) >
  m_ComputeCannyEdge2ndDerivativeOper;

  std::slice m_ComputeCannyEdgeSlice[ImageDimension];

  SizeValueType m_Stride[ImageDimension];
  SizeValueType m_Center;

  typename ListNodeStorageType::Pointer m_NodeStore;
  ListPointerType                       m_NodeList;

  OutputImageType      *m_OutputImage;
};
} //end of namespace itk

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

#endif