itkSumSquaredTissueVolumeDifferenceImageToImageMetric.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 __itkSumSquaredTissueVolumeDifferenceImageToImageMetric_h
#define __itkSumSquaredTissueVolumeDifferenceImageToImageMetric_h
 
#include "itkAdvancedImageToImageMetric.h"
 
namespace itk
{
 
template < class TFixedImage, class TMovingImage >
class SumSquaredTissueVolumeDifferenceImageToImageMetric :
  public AdvancedImageToImageMetric< TFixedImage, TMovingImage>
{
public:
 
  typedef SumSquaredTissueVolumeDifferenceImageToImageMetric   Self;
  typedef AdvancedImageToImageMetric< TFixedImage, TMovingImage >      Superclass;
  typedef SmartPointer<Self>                      Pointer;
  typedef SmartPointer<const Self>                ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( SumSquaredTissueVolumeDifferenceImageToImageMetric, AdvancedImageToImageMetric );
 
  typedef typename Superclass::CoordinateRepresentationType CoordinateRepresentationType;
  typedef typename Superclass::MovingImageType            MovingImageType;
  typedef typename Superclass::MovingImagePixelType       MovingImagePixelType;
  typedef typename Superclass::MovingImageConstPointer    MovingImageConstPointer;
  typedef typename Superclass::FixedImageType             FixedImageType;
  typedef typename Superclass::FixedImageConstPointer     FixedImageConstPointer;
  typedef typename Superclass::FixedImageRegionType       FixedImageRegionType;
  typedef typename Superclass::InputPointType             InputPointType;
  typedef typename Superclass::OutputPointType            OutputPointType;
  typedef typename Superclass::TransformParametersType    TransformParametersType;
  typedef typename Superclass::TransformJacobianType      TransformJacobianType;
  typedef typename Superclass::InterpolatorType           InterpolatorType;
  typedef typename Superclass::InterpolatorPointer        InterpolatorPointer;
  typedef typename Superclass::RealType                   RealType;
  typedef typename Superclass::GradientPixelType          GradientPixelType;
  typedef typename Superclass::GradientImageType          GradientImageType;
  typedef typename Superclass::GradientImagePointer       GradientImagePointer;
  typedef typename Superclass::GradientImageFilterType    GradientImageFilterType;
  typedef typename Superclass::GradientImageFilterPointer GradientImageFilterPointer;
  typedef typename Superclass::FixedImageMaskType         FixedImageMaskType;
  typedef typename Superclass::FixedImageMaskPointer      FixedImageMaskPointer;
  typedef typename Superclass::MovingImageMaskType        MovingImageMaskType;
  typedef typename Superclass::MovingImageMaskPointer     MovingImageMaskPointer;
  typedef typename Superclass::MeasureType                MeasureType;
  typedef typename Superclass::DerivativeType             DerivativeType;
  typedef typename Superclass::DerivativeValueType        DerivativeValueType;
  typedef typename Superclass::ParametersType             ParametersType;
  typedef typename Superclass::FixedImagePixelType        FixedImagePixelType;
  typedef typename Superclass::MovingImageRegionType      MovingImageRegionType;
  typedef typename Superclass::ImageSamplerType           ImageSamplerType;
  typedef typename Superclass::ImageSamplerPointer        ImageSamplerPointer;
  typedef typename Superclass::ImageSampleContainerType   ImageSampleContainerType;
  typedef typename Superclass::ImageSampleContainerPointer               ImageSampleContainerPointer;
  typedef typename Superclass::FixedImageLimiterType      FixedImageLimiterType;
  typedef typename Superclass::MovingImageLimiterType     MovingImageLimiterType;
  typedef typename Superclass::FixedImageLimiterOutputType               FixedImageLimiterOutputType;
  typedef typename Superclass::MovingImageLimiterOutputType              MovingImageLimiterOutputType;
  typedef typename Superclass::MovingImageDerivativeScalesType           MovingImageDerivativeScalesType;
 
  typedef typename Superclass::AdvancedTransformType                        TransformType;
  typedef typename TransformType::SpatialJacobianType                       SpatialJacobianType;
  typedef typename TransformType::JacobianOfSpatialJacobianType             JacobianOfSpatialJacobianType;
  typedef typename TransformType::SpatialHessianType                        SpatialHessianType;
  typedef typename TransformType::JacobianOfSpatialHessianType              JacobianOfSpatialHessianType;
  typedef typename TransformType::InternalMatrixType                        InternalMatrixType;
 
  itkStaticConstMacro( FixedImageDimension, unsigned int, FixedImageType::ImageDimension );
 
  itkStaticConstMacro( MovingImageDimension, unsigned int, MovingImageType::ImageDimension );
 
  virtual MeasureType GetValueSingleThreaded( const TransformParametersType & parameters ) const;
 
  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 GetValueAndDerivativeSingleThreaded(const TransformParametersType & parameters,
    MeasureType & measure, DerivativeType & derivative) const;
 
  itkSetMacro( AirValue, RealType );
  itkGetMacro( AirValue, RealType );
 
  itkSetMacro( TissueValue, RealType );
  itkGetMacro( TissueValue, RealType );
 
protected:
  SumSquaredTissueVolumeDifferenceImageToImageMetric();
  ~SumSquaredTissueVolumeDifferenceImageToImageMetric() override {};
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  typedef typename Superclass::FixedImageIndexType                 FixedImageIndexType;
  typedef typename Superclass::FixedImageIndexValueType            FixedImageIndexValueType;
  typedef typename Superclass::MovingImageIndexType                MovingImageIndexType;
  typedef typename Superclass::FixedImagePointType                 FixedImagePointType;
  typedef typename Superclass::MovingImagePointType                MovingImagePointType;
  typedef typename Superclass::MovingImageContinuousIndexType      MovingImageContinuousIndexType;
  typedef typename Superclass::BSplineInterpolatorType             BSplineInterpolatorType;
  typedef typename Superclass::CentralDifferenceGradientFilterType CentralDifferenceGradientFilterType;
  typedef typename Superclass::MovingImageDerivativeType           MovingImageDerivativeType;
  typedef typename Superclass::NonZeroJacobianIndicesType          NonZeroJacobianIndicesType;
 
  void EvaluateTransformJacobianInnerProduct(
    const TransformJacobianType & jacobian,
    const MovingImageDerivativeType & movingImageDerivative,
    DerivativeType & imageJacobian) const override;
 
  void UpdateValueAndDerivativeTerms(
    const RealType fixedImageValue,
    const RealType movingImageValue,
    const DerivativeType & imageJacobian,
    const NonZeroJacobianIndicesType & nzji,
    const RealType spatialJacobianDeterminant,
    const DerivativeType & jacobianOfSpatialJacobianDeterminant,
    MeasureType & measure,
    DerivativeType & deriv ) const;
 
  bool EvaluateInverseSpatialJacobian(
    const SpatialJacobianType & spatialJacobian,
    const RealType spatialJacobianDeterminant,
    SpatialJacobianType & inverseSpatialJacobian ) const;
 
  void EvaluateJacobianOfSpatialJacobianDeterminantInnerProduct(
    const JacobianOfSpatialJacobianType & jacobianOfSpatialJacobian,
    const SpatialJacobianType & inverseSpatialJacobian,
    DerivativeType & jacobianOfSpatialJacobianDeterminant ) const;
 
  inline void ThreadedGetValue( ThreadIdType threadID ) override;
 
  inline void AfterThreadedGetValue( MeasureType & value ) const override;
 
  inline void ThreadedGetValueAndDerivative( ThreadIdType threadId ) override;
 
  inline void AfterThreadedGetValueAndDerivative(
    MeasureType & measure, DerivativeType & derivative ) const override;
 
private:
  SumSquaredTissueVolumeDifferenceImageToImageMetric(const Self&); // purposely not implemented
  void operator=(const Self&); // purposely not implemented
 
  RealType m_AirValue;
 
  RealType m_TissueValue;
 
}; // end class SumSquaredTissueVolumeDifferenceImageToImageMetric
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSumSquaredTissueVolumeDifferenceImageToImageMetric.hxx"
#endif
 
#endif // end #ifndef __itkSumSquaredTissueVolumeDifferenceImageToImageMetric_h