itkANTSNeighborhoodCorrelationImageToImageMetricv4.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 itkANTSNeighborhoodCorrelationImageToImageMetricv4_h
#define itkANTSNeighborhoodCorrelationImageToImageMetricv4_h
 
#include "itkImageToImageMetricv4.h"
#include "itkANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader.h"
 
namespace itk
{

template <typename TFixedImage,
          typename TMovingImage,
          typename TVirtualImage = TFixedImage,
          typename TInternalComputationValueType = double,
          typename TMetricTraits =
            DefaultImageToImageMetricTraitsv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType>>
class ITK_TEMPLATE_EXPORT ANTSNeighborhoodCorrelationImageToImageMetricv4
  : public ImageToImageMetricv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ANTSNeighborhoodCorrelationImageToImageMetricv4);

  using Self = ANTSNeighborhoodCorrelationImageToImageMetricv4;
  using Superclass =
    ImageToImageMetricv4<TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ANTSNeighborhoodCorrelationImageToImageMetricv4);

  using typename Superclass::MeasureType;
  using typename Superclass::DerivativeType;
  using typename Superclass::DerivativeValueType;
  using typename Superclass::VirtualPointType;
  using typename Superclass::FixedImagePointType;
  using typename Superclass::FixedImagePixelType;
  using typename Superclass::FixedTransformType;
  using typename Superclass::FixedImageGradientType;
  using FixedImageJacobianType = typename FixedTransformType::JacobianType;
 
  using typename Superclass::MovingImagePointType;
  using typename Superclass::MovingImagePixelType;
  using typename Superclass::MovingImageGradientType;
  using typename Superclass::MovingTransformType;
  using MovingImageJacobianType = typename MovingTransformType::JacobianType;
  using typename Superclass::JacobianType;
 
  using typename Superclass::VirtualImageGradientType;
 
  using typename Superclass::FixedImageType;
  using typename Superclass::MovingImageType;
  using VirtualImageType = typename Superclass::VirtualImageType;
  using typename Superclass::FixedOutputPointType;
  using typename Superclass::MovingOutputPointType;
 
  using FixedTransformJacobianType = typename Superclass::FixedTransformType::JacobianType;
  using MovingTransformJacobianType = typename Superclass::MovingTransformType::JacobianType;
 
  using typename Superclass::NumberOfParametersType;
  using typename Superclass::ImageDimensionType;
 
  using ImageRegionType = typename VirtualImageType::RegionType;
  using RadiusType = typename VirtualImageType::SizeType;
  using IndexType = typename VirtualImageType::IndexType;
 
  /* Image dimension accessors */
  static constexpr ImageDimensionType FixedImageDimension = FixedImageType::ImageDimension;
 
  static constexpr ImageDimensionType MovingImageDimension = MovingImageType::ImageDimension;
 
  static constexpr ImageDimensionType VirtualImageDimension = VirtualImageType::ImageDimension;
 
  // Set the radius of the neighborhood window centered at each pixel.
  // See the note above about using a radius less than 2.
  itkSetMacro(Radius, RadiusType);
 
  // Get the Radius of the neighborhood window centered at each pixel
  itkGetMacro(Radius, RadiusType);
  itkGetConstMacro(Radius, RadiusType);
 
  void
  Initialize() override;
 
protected:
  ANTSNeighborhoodCorrelationImageToImageMetricv4();
  ~ANTSNeighborhoodCorrelationImageToImageMetricv4() override = default;
 
  friend class ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader<
    ThreadedImageRegionPartitioner<VirtualImageDimension>,
    Superclass,
    Self>;
  using ANTSNeighborhoodCorrelationImageToImageMetricv4DenseGetValueAndDerivativeThreaderType =
    ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader<
      ThreadedImageRegionPartitioner<VirtualImageDimension>,
      Superclass,
      Self>;
 
  friend class ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader<
    ThreadedIndexedContainerPartitioner,
    Superclass,
    Self>;
  using ANTSNeighborhoodCorrelationImageToImageMetricv4SparseGetValueAndDerivativeThreaderType =
    ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader<ThreadedIndexedContainerPartitioner,
                                                                                 Superclass,
                                                                                 Self>;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  // Radius of the neighborhood window centered at each pixel
  RadiusType m_Radius{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkANTSNeighborhoodCorrelationImageToImageMetricv4.hxx"
#endif
 
#endif