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 ITK_TEMPLATE_EXPORT HistogramImageToImageMetric:
  public ImageToImageMetric< TFixedImage, TMovingImage >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(HistogramImageToImageMetric);

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

  itkTypeMacro(HistogramImageToImageMetric, ImageToImageMetric);

  using RealType = typename Superclass::RealType;
  using TransformType = typename Superclass::TransformType;
  using TransformPointer = typename Superclass::TransformPointer;
  using TransformParametersType = typename Superclass::TransformParametersType;
  using TransformJacobianType = typename Superclass::TransformJacobianType;
  using GradientPixelType = typename Superclass::GradientPixelType;
  using InputPointType = typename Superclass::InputPointType;
  using OutputPointType = typename Superclass::OutputPointType;
  using MeasureType = typename Superclass::MeasureType;
  using DerivativeType = typename Superclass::DerivativeType;
  using FixedImageType = typename Superclass::FixedImageType;
  using FixedImagePixelType = typename Superclass::FixedImageType::PixelType;
  using MovingImageType = typename Superclass::MovingImageType;
  using MovingImagePixelType = typename Superclass::MovingImageType::PixelType;
  using FixedImageConstPointerType = typename Superclass::FixedImageConstPointer;
  using MovingImageConstPointerType = typename Superclass::MovingImageConstPointer;

  using HistogramType = Statistics::Histogram< double >;

  using MeasurementVectorType = typename HistogramType::MeasurementVectorType;
  using HistogramSizeType = typename HistogramType::SizeType;
  using HistogramPointer = typename HistogramType::Pointer;

  void Initialize() override;

  void SetTransform(TransformType *transform) 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);

  using ScalesType = Array< double >;

  itkSetMacro(DerivativeStepLengthScales, ScalesType);

  itkGetConstReferenceMacro(DerivativeStepLengthScales, ScalesType);

  MeasureType GetValue(const TransformParametersType & parameters) const override;

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

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

  void SetLowerBound(const MeasurementVectorType & bound);

  const MeasurementVectorType & GetLowerBound() const;

  void SetUpperBound(const MeasurementVectorType & bound);

  const MeasurementVectorType & GetUpperBound() const;

protected:
  HistogramImageToImageMetric();
  ~HistogramImageToImageMetric() override = default;

  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 override;

private:
  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