itkCompareHistogramImageToImageMetric.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 itkCompareHistogramImageToImageMetric_h
#define itkCompareHistogramImageToImageMetric_h
 
#include "itkHistogramImageToImageMetric.h"
 
namespace itk
{
template <typename TFixedImage, typename TMovingImage>
class ITK_TEMPLATE_EXPORT CompareHistogramImageToImageMetric
  : public HistogramImageToImageMetric<TFixedImage, TMovingImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(CompareHistogramImageToImageMetric);

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

  itkOverrideGetNameOfClassMacro(CompareHistogramImageToImageMetric);

  using typename Superclass::RealType;
  using typename Superclass::TransformType;
  using typename Superclass::TransformPointer;
  using TransformConstPointer = typename TransformType::ConstPointer;
 
  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::HistogramType;
  using typename Superclass::HistogramSizeType;
  using HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType;
  using HistogramAbsoluteFrequencyType = typename HistogramType::AbsoluteFrequencyType;
  using HistogramFrequencyType = HistogramAbsoluteFrequencyType;
 
  using HistogramIteratorType = typename HistogramType::Iterator;
  using HistogramPointerType = typename HistogramType::Pointer;
 
  using typename Superclass::InterpolatorType;
  using typename Superclass::InterpolatorPointer;
 
  using typename Superclass::FixedImageRegionType;

  itkSetMacro(TrainingHistogram, HistogramPointerType);
  itkGetConstReferenceMacro(TrainingHistogram, HistogramPointerType);

  itkSetConstObjectMacro(TrainingFixedImage, FixedImageType);
  itkGetConstObjectMacro(TrainingFixedImage, FixedImageType);

  itkSetConstObjectMacro(TrainingMovingImage, MovingImageType);
  itkGetConstObjectMacro(TrainingMovingImage, MovingImageType);

  itkSetObjectMacro(TrainingTransform, TransformType);
  itkGetModifiableObjectMacro(TrainingTransform, TransformType);

  itkSetObjectMacro(TrainingInterpolator, InterpolatorType);
  itkGetModifiableObjectMacro(TrainingInterpolator, InterpolatorType);

  itkSetMacro(TrainingFixedImageRegion, FixedImageRegionType);
  itkGetConstReferenceMacro(TrainingFixedImageRegion, FixedImageRegionType);

  unsigned int
  GetNumberOfParameters() const override
  {
    return this->GetTransform()->GetNumberOfParameters();
  }

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

  void
  FormTrainingHistogram();

  MeasureType
  EvaluateMeasure(HistogramType & histogram) const override = 0;
 
private:
  FixedImageConstPointer  m_TrainingFixedImage{};
  MovingImageConstPointer m_TrainingMovingImage{};
  TransformPointer        m_TrainingTransform{};
  InterpolatorPointer     m_TrainingInterpolator{};
  FixedImageRegionType    m_TrainingFixedImageRegion{};
  HistogramPointerType    m_TrainingHistogram{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkCompareHistogramImageToImageMetric.hxx"
#endif
 
#endif // itkCompareHistogramImageToImageMetric_h