animaBaseOrientedModelImageToImageMetric.h

Go to the documentation of this file.

#pragma once

#include <itkImageBase.h>
#include <itkTransform.h>
#include <itkInterpolateImageFunction.h>
#include <itkSingleValuedCostFunction.h>
#include <itkMacro.h>
#include <itkSpatialObject.h>

namespace anima
{
template <class TFixedImage,  class TMovingImage>
class BaseOrientedModelImageToImageMetric : public itk::SingleValuedCostFunction
{
public:
    typedef BaseOrientedModelImageToImageMetric Self;
    typedef itk::SingleValuedCostFunction Superclass;
    typedef itk::SmartPointer<Self> Pointer;
    typedef itk::SmartPointer<const Self> ConstPointer;

    typedef typename Superclass::ParametersValueType CoordinateRepresentationType;

    itkTypeMacro(BaseOrientedModelImageToImageMetric, SingleValuedCostFunction)

    
    typedef TMovingImage                               MovingImageType;
    typedef typename TMovingImage::PixelType           MovingImagePixelType;
    typedef typename MovingImageType::ConstPointer     MovingImageConstPointer;

    typedef TFixedImage                                FixedImageType;
    typedef typename FixedImageType::ConstPointer      FixedImageConstPointer;
    typedef typename FixedImageType::RegionType        FixedImageRegionType;

    itkStaticConstMacro(MovingImageDimension, unsigned int, TMovingImage::ImageDimension);
    itkStaticConstMacro(FixedImageDimension, unsigned int, TFixedImage::ImageDimension);

    typedef itk::Transform<CoordinateRepresentationType,
    itkGetStaticConstMacro(MovingImageDimension),
    itkGetStaticConstMacro(FixedImageDimension)>
    TransformType;

    typedef typename TransformType::Pointer            TransformPointer;
    typedef typename TransformType::InputPointType     InputPointType;
    typedef typename TransformType::OutputPointType    OutputPointType;
    typedef typename TransformType::ParametersType     TransformParametersType;
    typedef typename TransformType::JacobianType       TransformJacobianType;

    typedef itk::InterpolateImageFunction<
    MovingImageType,
    CoordinateRepresentationType > InterpolatorType;

    typedef typename InterpolatorType::Pointer         InterpolatorPointer;

    typedef itk::SpatialObject< itkGetStaticConstMacro(FixedImageDimension) >
    FixedImageMaskType;
    typedef typename FixedImageMaskType::Pointer       FixedImageMaskPointer;
    typedef typename FixedImageMaskType::ConstPointer  FixedImageMaskConstPointer;


    typedef itk::SpatialObject< itkGetStaticConstMacro(MovingImageDimension) >
    MovingImageMaskType;
    typedef typename MovingImageMaskType::Pointer      MovingImageMaskPointer;
    typedef typename MovingImageMaskType::ConstPointer MovingImageMaskConstPointer;

    typedef double RealType;

    typedef typename Superclass::MeasureType                    MeasureType;

    typedef typename Superclass::DerivativeType                 DerivativeType;

    typedef typename Superclass::ParametersType                 ParametersType;

    itkSetConstObjectMacro( FixedImage, FixedImageType )

    itkGetConstObjectMacro( FixedImage, FixedImageType )

    itkSetConstObjectMacro( MovingImage, MovingImageType )

    itkGetConstObjectMacro( MovingImage, MovingImageType )

    itkSetObjectMacro( Transform, TransformType )

    itkGetConstObjectMacro( Transform, TransformType )

    itkSetObjectMacro( Interpolator, InterpolatorType )

    itkGetConstObjectMacro( Interpolator, InterpolatorType )

    itkGetConstReferenceMacro( NumberOfPixelsCounted, unsigned long )

    itkSetMacro( FixedImageRegion, FixedImageRegionType )

    itkGetConstReferenceMacro( FixedImageRegion, FixedImageRegionType )

    itkSetObjectMacro( MovingImageMask, MovingImageMaskType )
    itkSetConstObjectMacro( MovingImageMask, MovingImageMaskType )
    itkGetConstObjectMacro( MovingImageMask, MovingImageMaskType )

    itkSetObjectMacro( FixedImageMask, FixedImageMaskType )
    itkSetConstObjectMacro( FixedImageMask, FixedImageMaskType )
    itkGetConstObjectMacro( FixedImageMask, FixedImageMaskType )

    void SetTransformParameters( const ParametersType & parameters ) const;

    unsigned int GetNumberOfParameters(void) const ITK_OVERRIDE
    { return m_Transform->GetNumberOfParameters(); }

    virtual void Initialize();

    void GetDerivative( const ParametersType & parameters,
                        DerivativeType & derivative ) const ITK_OVERRIDE
    {
        itkExceptionMacro("No derivatives implemented for tensor metrics...");
    }

    void GetValueAndDerivative(const TransformParametersType & parameters,
                               MeasureType & value, DerivativeType  & derivative) const ITK_OVERRIDE
    {
        itkExceptionMacro("No derivatives implemented for tensor metrics...");
    }

    enum ModelReorientationType
    {
        NONE = 0,
        FINITE_STRAIN,
        PPD
    };

    itkSetMacro(ModelRotation, ModelReorientationType)
    itkGetConstMacro(ModelRotation, ModelReorientationType)

protected:
    BaseOrientedModelImageToImageMetric();
    virtual ~BaseOrientedModelImageToImageMetric();
    void PrintSelf(std::ostream& os, itk::Indent indent) const ITK_OVERRIDE;

    mutable unsigned long       m_NumberOfPixelsCounted;

    FixedImageConstPointer      m_FixedImage;
    MovingImageConstPointer     m_MovingImage;

    mutable TransformPointer    m_Transform;
    mutable vnl_matrix <double> m_OrientationMatrix;
    InterpolatorPointer         m_Interpolator;

    FixedImageMaskConstPointer  m_FixedImageMask;
    MovingImageMaskConstPointer m_MovingImageMask;

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

    FixedImageRegionType        m_FixedImageRegion;

    ModelReorientationType m_ModelRotation;
};

} // end of namespace anima

#include "animaBaseOrientedModelImageToImageMetric.hxx"