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

#include "itkImageToImageMetric.h"
#include "itkPoint.h"
#include <vector>

namespace itk
{
template< class TFixedImage, class TMovingImage >
class ITK_EXPORT MatchCardinalityImageToImageMetric:
  public ImageToImageMetric< TFixedImage, TMovingImage >
{
public:

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

  itkNewMacro(Self);

  itkTypeMacro(MatchCardinalityImageToImageMetric, ImageToImageMetric);

  typedef typename Superclass::RealType                RealType;
  typedef typename Superclass::TransformType           TransformType;
  typedef typename Superclass::TransformPointer        TransformPointer;
  typedef typename Superclass::TransformParametersType TransformParametersType;
  typedef typename Superclass::TransformJacobianType   TransformJacobianType;
  typedef typename Superclass::GradientPixelType       GradientPixelType;

  typedef typename Superclass::MeasureType             MeasureType;
  typedef typename Superclass::DerivativeType          DerivativeType;
  typedef typename Superclass::FixedImageType          FixedImageType;
  typedef typename Superclass::MovingImageType         MovingImageType;
  typedef typename Superclass::FixedImageConstPointer  FixedImageConstPointer;
  typedef typename Superclass::MovingImageConstPointer MovingImageConstPointer;
  typedef typename Superclass::FixedImageRegionType    FixedImageRegionType;

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

  MeasureType GetValue(const TransformParametersType & parameters) const;

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

  MultiThreader * GetMultiThreader()
  { return m_Threader; }

protected:
  MatchCardinalityImageToImageMetric();
  virtual ~MatchCardinalityImageToImageMetric() {}
  void PrintSelf(std::ostream & os, Indent indent) const;

  MeasureType GetNonconstValue(const TransformParametersType & parameters);

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

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

  static ITK_THREAD_RETURN_TYPE ThreaderCallback(void *arg);

  struct ThreadStruct {
    Pointer Metric;
  };

private:
  MatchCardinalityImageToImageMetric(const Self &); //purposely not implemented
  void operator=(const Self &);                     //purposely not implemented

  bool                         m_MeasureMatches;
  std::vector< MeasureType >   m_ThreadMatches;
  std::vector< SizeValueType > m_ThreadCounts;

  MultiThreader::Pointer m_Threader;
};
} // end namespace itk

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

#endif