itkDirectedHausdorffDistanceImageFilter.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 itkDirectedHausdorffDistanceImageFilter_h
#define itkDirectedHausdorffDistanceImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkNumericTraits.h"
#include "itkArray.h"
#include "itkCompensatedSummation.h"

namespace itk
{
template< typename TInputImage1, typename TInputImage2 >
class ITK_TEMPLATE_EXPORT DirectedHausdorffDistanceImageFilter:
  public ImageToImageFilter< TInputImage1, TInputImage1 >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(DirectedHausdorffDistanceImageFilter);

  using Self = DirectedHausdorffDistanceImageFilter;
  using Superclass = ImageToImageFilter< TInputImage1, TInputImage1 >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(DirectedHausdorffDistanceImageFilter, ImageToImageFilter);

  using InputImage1Type = TInputImage1;
  using InputImage2Type = TInputImage2;
  using InputImage1Pointer = typename TInputImage1::Pointer;
  using InputImage2Pointer = typename TInputImage2::Pointer;
  using InputImage1ConstPointer = typename TInputImage1::ConstPointer;
  using InputImage2ConstPointer = typename TInputImage2::ConstPointer;

  using RegionType = typename TInputImage1::RegionType;
  using SizeType = typename TInputImage1::SizeType;
  using IndexType = typename TInputImage1::IndexType;

  using InputImage1PixelType = typename TInputImage1::PixelType;
  using InputImage2PixelType = typename TInputImage2::PixelType;

  static constexpr unsigned int ImageDimension = TInputImage1::ImageDimension;

  using RealType = typename NumericTraits< InputImage1PixelType >::RealType;

  void SetInput1(const InputImage1Type *image);

  void SetInput2(const InputImage2Type *image);

  const InputImage1Type * GetInput1();

  const InputImage2Type * GetInput2();

  itkSetMacro(UseImageSpacing, bool);
  itkGetConstMacro( UseImageSpacing, bool );

  itkGetConstMacro(DirectedHausdorffDistance, RealType);
  itkGetConstMacro(AverageHausdorffDistance, RealType);

#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro( InputHasNumericTraitsCheck,
                   ( Concept::HasNumericTraits< InputImage1PixelType > ) );
  // End concept checking
#endif

protected:
  DirectedHausdorffDistanceImageFilter();
  ~DirectedHausdorffDistanceImageFilter() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

  void AllocateOutputs() override;

  void BeforeThreadedGenerateData() override;

  void AfterThreadedGenerateData() override;

  void  ThreadedGenerateData(const RegionType &
                             outputRegionForThread,
                             ThreadIdType threadId) override;

  void DynamicThreadedGenerateData( const RegionType & ) override
  {
    itkExceptionMacro("This class requires threadId so it must use classic multi-threading model");
  }

  // Override since the filter needs all the data for the algorithm
  void GenerateInputRequestedRegion() override;

  // Override since the filter produces all of its output
  void EnlargeOutputRequestedRegion(DataObject *data) override;

private:
  using DistanceMapType = Image< RealType, Self::ImageDimension >;
  using DistanceMapPointer = typename DistanceMapType::Pointer;


  DistanceMapPointer      m_DistanceMap;

  Array< RealType >       m_MaxDistance;
  Array< IdentifierType > m_PixelCount;

  using CompensatedSummationType = itk::CompensatedSummation< RealType >;
  std::vector< CompensatedSummationType >       m_Sum;

  RealType                m_DirectedHausdorffDistance;
  RealType                m_AverageHausdorffDistance;
  bool                    m_UseImageSpacing;
}; // end of class
} // end namespace itk

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

#endif