itkHistogramImageToImageMetric.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 itkHistogramImageToImageMetric_h
#define itkHistogramImageToImageMetric_h

#include "itkHistogram.h"
#include "itkImageToImageMetric.h"

namespace itk
{
template< typename TFixedImage, typename TMovingImage >
class HistogramImageToImageMetric:
  public ImageToImageMetric< TFixedImage, TMovingImage >
{
public:
  typedef HistogramImageToImageMetric                     Self;
  typedef ImageToImageMetric< TFixedImage, TMovingImage > Superclass;
  typedef SmartPointer< Self >                            Pointer;
  typedef SmartPointer< const Self >                      ConstPointer;

  itkTypeMacro(HistogramImageToImageMetric, 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::InputPointType             InputPointType;
  typedef typename Superclass::OutputPointType            OutputPointType;
  typedef typename Superclass::MeasureType                MeasureType;
  typedef typename Superclass::DerivativeType             DerivativeType;
  typedef typename Superclass::FixedImageType             FixedImageType;
  typedef typename Superclass::FixedImageType::PixelType  FixedImagePixelType;
  typedef typename Superclass::MovingImageType            MovingImageType;
  typedef typename Superclass::MovingImageType::PixelType MovingImagePixelType;
  typedef typename Superclass::FixedImageConstPointer
  FixedImageConstPointerType;
  typedef typename Superclass::MovingImageConstPointer
  MovingImageConstPointerType;

  typedef Statistics::Histogram< double > HistogramType;

  typedef typename HistogramType::MeasurementVectorType MeasurementVectorType;
  typedef typename HistogramType::SizeType              HistogramSizeType;
  typedef typename HistogramType::Pointer               HistogramPointer;

  void Initialize() throw ( ExceptionObject ) ITK_OVERRIDE;

  void SetTransform(TransformType *transform) ITK_OVERRIDE;

  itkSetMacro(HistogramSize, HistogramSizeType);

  itkGetConstReferenceMacro(HistogramSize, HistogramSizeType);

  itkSetMacro(UpperBoundIncreaseFactor, double);
  itkGetConstMacro(UpperBoundIncreaseFactor, double);

  itkSetMacro(PaddingValue, FixedImagePixelType);

  itkGetConstReferenceMacro(PaddingValue, FixedImagePixelType);

  itkGetConstReferenceMacro(Histogram, HistogramPointer);

  itkSetMacro(UsePaddingValue, bool);
  itkGetConstMacro(UsePaddingValue, bool);

  itkSetMacro(DerivativeStepLength, double);

  itkGetConstMacro(DerivativeStepLength, double);

  typedef Array< double > ScalesType;

  itkSetMacro(DerivativeStepLengthScales, ScalesType);

  itkGetConstReferenceMacro(DerivativeStepLengthScales, ScalesType);

  MeasureType GetValue(const TransformParametersType & parameters) const ITK_OVERRIDE;

  void GetDerivative(const TransformParametersType & parameters,
                     DerivativeType & derivative) const ITK_OVERRIDE;

  void GetValueAndDerivative(const TransformParametersType & parameters,
                             MeasureType & Value,
                             DerivativeType & Derivative) const ITK_OVERRIDE;

  void SetLowerBound(const MeasurementVectorType & bound);

  const MeasurementVectorType & GetLowerBound() const;

  void SetUpperBound(const MeasurementVectorType & bound);

  const MeasurementVectorType & GetUpperBound() const;

protected:
  HistogramImageToImageMetric();
  virtual ~HistogramImageToImageMetric() {}

  HistogramSizeType m_HistogramSize;

  mutable MeasurementVectorType m_LowerBound;

  mutable MeasurementVectorType m_UpperBound;

  double m_UpperBoundIncreaseFactor;

  bool m_LowerBoundSetByUser;

  bool m_UpperBoundSetByUser;

  void ComputeHistogram(const TransformParametersType & parameters,
                        HistogramType & histogram) const;

  void ComputeHistogram(const TransformParametersType & parameters,
                        unsigned int parameter,
                        double step,
                        HistogramType & histogram) const;

  void CopyHistogram(HistogramType & target, HistogramType & source) const;

  virtual MeasureType EvaluateMeasure(HistogramType & histogram) const = 0;

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

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

  FixedImagePixelType m_PaddingValue;

  bool m_UsePaddingValue;

  double m_DerivativeStepLength;

  ScalesType m_DerivativeStepLengthScales;

  HistogramPointer m_Histogram;
};
} // end namespace itk

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

#endif // itkHistogramImageToImageMetric_h