itkMatchCardinalityImageToImageMetric.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 itkMatchCardinalityImageToImageMetric_h
#define itkMatchCardinalityImageToImageMetric_h

 
#include "itkImageToImageMetric.h"
#include "itkPoint.h"
#include <vector>
 
namespace itk
{
template <typename TFixedImage, typename TMovingImage>
class ITK_TEMPLATE_EXPORT MatchCardinalityImageToImageMetric : public ImageToImageMetric<TFixedImage, TMovingImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MatchCardinalityImageToImageMetric);

  using Self = MatchCardinalityImageToImageMetric;
  using Superclass = ImageToImageMetric<TFixedImage, TMovingImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(MatchCardinalityImageToImageMetric);

  using typename Superclass::RealType;
  using typename Superclass::TransformType;
  using typename Superclass::TransformPointer;
  using typename Superclass::TransformParametersType;
  using typename Superclass::TransformJacobianType;
  using typename Superclass::GradientPixelType;
 
  using typename Superclass::MeasureType;
  using typename Superclass::DerivativeType;
  using typename Superclass::FixedImageType;
  using typename Superclass::MovingImageType;
  using typename Superclass::FixedImageConstPointer;
  using typename Superclass::MovingImageConstPointer;
  using typename Superclass::FixedImageRegionType;

  void
  GetDerivative(const TransformParametersType &, DerivativeType & derivative) const override
  {
    itkWarningMacro("This metric does not provide metric derivatives.");
    derivative.Fill(typename DerivativeType::ValueType{});
  }


  MeasureType
  GetValue(const TransformParametersType & parameters) const override;

  itkSetMacro(MeasureMatches, bool);
  itkBooleanMacro(MeasureMatches);
  itkGetConstMacro(MeasureMatches, bool);

  MultiThreaderBase *
  GetMultiThreader()
  {
    return m_Threader;
  }
 
protected:
  MatchCardinalityImageToImageMetric();
  ~MatchCardinalityImageToImageMetric() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  MeasureType
  GetNonconstValue(const TransformParametersType & parameters);

  virtual void
  ThreadedGetValue(const FixedImageRegionType & regionForThread, ThreadIdType threadId);

  virtual ThreadIdType
  SplitFixedRegion(ThreadIdType i, int num, FixedImageRegionType & splitRegion);

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION
  ThreaderCallback(void * arg);

  struct ThreadStruct
  {
    Pointer Metric;
  };
 
private:
  // default to measure percentage of pixel matches
  bool                       m_MeasureMatches{ true };
  std::vector<MeasureType>   m_ThreadMatches{};
  std::vector<SizeValueType> m_ThreadCounts{};

  MultiThreaderBase::Pointer m_Threader{ MultiThreaderBase::New() };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMatchCardinalityImageToImageMetric.hxx"
#endif
 
#endif