itkAdvancedIdentityTransform.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkIdentityTransform.h,v $
  Language:  C++
  Date:      $Date: 2009-06-28 14:41:47 $
  Version:   $Revision: 1.19 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkAdvancedIdentityTransform_h
#define __itkAdvancedIdentityTransform_h

#include "itkObject.h"
#include "itkPoint.h"
#include "itkVector.h"
#include "itkCovariantVector.h"
#include "vnl/vnl_vector_fixed.h"
#include "itkArray.h"
#include "itkArray2D.h"
#include "itkAdvancedTransform.h"

#include "itkObjectFactory.h"

namespace itk
{

template< class TScalarType,
unsigned int NDimensions = 3 >
class AdvancedIdentityTransform :
  public AdvancedTransform< TScalarType, NDimensions, NDimensions >
{
public:

  typedef AdvancedIdentityTransform Self;
  typedef AdvancedTransform<
    TScalarType, NDimensions, NDimensions >                    Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkNewMacro( Self );

  itkTypeMacro( AdvancedIdentityTransform, AdvancedTransform );

  itkStaticConstMacro( InputSpaceDimension, unsigned int, NDimensions );
  itkStaticConstMacro( OutputSpaceDimension, unsigned int, NDimensions );
  itkStaticConstMacro( ParametersDimension, unsigned int, 1 );

  typedef  TScalarType ScalarType;

  typedef typename Superclass::ParametersType         ParametersType;
  typedef typename Superclass::NumberOfParametersType NumberOfParametersType;
  typedef typename Superclass::TransformCategoryType  TransformCategoryType;

  typedef typename Superclass::JacobianType JacobianType;

  typedef Vector< TScalarType,
    itkGetStaticConstMacro( InputSpaceDimension ) >  InputVectorType;
  typedef Vector< TScalarType,
    itkGetStaticConstMacro( OutputSpaceDimension ) > OutputVectorType;

  typedef CovariantVector< TScalarType,
    itkGetStaticConstMacro( InputSpaceDimension ) >  InputCovariantVectorType;
  typedef CovariantVector< TScalarType,
    itkGetStaticConstMacro( OutputSpaceDimension ) > OutputCovariantVectorType;

  typedef vnl_vector_fixed< TScalarType,
    itkGetStaticConstMacro( InputSpaceDimension ) >  InputVnlVectorType;
  typedef vnl_vector_fixed< TScalarType,
    itkGetStaticConstMacro( OutputSpaceDimension ) > OutputVnlVectorType;

  typedef Point< TScalarType,
    itkGetStaticConstMacro( InputSpaceDimension ) > InputPointType;
  typedef Point< TScalarType,
    itkGetStaticConstMacro( OutputSpaceDimension ) > OutputPointType;

  typedef typename Superclass::InverseTransformBaseType InverseTransformBaseType;
  typedef typename InverseTransformBaseType::Pointer    InverseTransformBasePointer;

  typedef typename Superclass
    ::NonZeroJacobianIndicesType NonZeroJacobianIndicesType;
  typedef typename Superclass::SpatialJacobianType SpatialJacobianType;
  typedef typename Superclass
    ::JacobianOfSpatialJacobianType JacobianOfSpatialJacobianType;
  typedef typename Superclass::SpatialHessianType SpatialHessianType;
  typedef typename Superclass
    ::JacobianOfSpatialHessianType JacobianOfSpatialHessianType;
  typedef typename Superclass::InternalMatrixType InternalMatrixType;

  virtual OutputPointType TransformPoint( const InputPointType  & point ) const
  { return point; }

  virtual OutputVectorType TransformVector( const InputVectorType & vector ) const
  { return vector; }

  virtual OutputVnlVectorType TransformVector( const InputVnlVectorType & vector ) const
  { return vector; }

  virtual OutputCovariantVectorType TransformCovariantVector(
    const InputCovariantVectorType & vector ) const
  { return vector; }

  void SetIdentity( void ) {}

  virtual InverseTransformBasePointer GetInverseTransform( void ) const
  {
    return this->New().GetPointer();
  }


  virtual bool IsLinear() const { return true; }

  virtual TransformCategoryType GetTransformCategory() const
  {
    return Self::Linear;
  }


  virtual const ParametersType & GetFixedParameters( void ) const
  {
    return this->m_FixedParameters;
  }


  virtual void SetFixedParameters( const ParametersType & ) {}

  virtual const ParametersType & GetParameters( void ) const
  {
    return this->m_Parameters;
  }


  virtual void SetParameters( const ParametersType & ) {}

  virtual void GetJacobian(
    const InputPointType &,
    JacobianType & j,
    NonZeroJacobianIndicesType & nonZeroJacobianIndices ) const
  {
    j                      = this->m_LocalJacobian;
    nonZeroJacobianIndices = this->m_NonZeroJacobianIndices;
  }


  virtual void GetSpatialJacobian(
    const InputPointType &,
    SpatialJacobianType & sj ) const
  {
    sj = this->m_SpatialJacobian;
  }


  virtual void GetSpatialHessian(
    const InputPointType &,
    SpatialHessianType & sh ) const
  {
    sh = this->m_SpatialHessian;
  }


  virtual void GetJacobianOfSpatialJacobian(
    const InputPointType &,
    JacobianOfSpatialJacobianType & jsj,
    NonZeroJacobianIndicesType & nonZeroJacobianIndices ) const
  {
    jsj                    = this->m_JacobianOfSpatialJacobian;
    nonZeroJacobianIndices = this->m_NonZeroJacobianIndices;
  }


  virtual void GetJacobianOfSpatialJacobian(
    const InputPointType &,
    SpatialJacobianType & sj,
    JacobianOfSpatialJacobianType & jsj,
    NonZeroJacobianIndicesType & nonZeroJacobianIndices ) const
  {
    sj                     = this->m_SpatialJacobian;
    jsj                    = this->m_JacobianOfSpatialJacobian;
    nonZeroJacobianIndices = this->m_NonZeroJacobianIndices;
  }


  virtual void GetJacobianOfSpatialHessian(
    const InputPointType &,
    JacobianOfSpatialHessianType & jsh,
    NonZeroJacobianIndicesType & nonZeroJacobianIndices ) const
  {
    jsh                    = this->m_JacobianOfSpatialHessian;
    nonZeroJacobianIndices = this->m_NonZeroJacobianIndices;
  }


  virtual void GetJacobianOfSpatialHessian(
    const InputPointType &,
    SpatialHessianType & sh,
    JacobianOfSpatialHessianType & jsh,
    NonZeroJacobianIndicesType & nonZeroJacobianIndices ) const
  {
    sh                     = this->m_SpatialHessian;
    jsh                    = this->m_JacobianOfSpatialHessian;
    nonZeroJacobianIndices = this->m_NonZeroJacobianIndices;
  }


protected:

  AdvancedIdentityTransform() :
    AdvancedTransform< TScalarType, NDimensions, NDimensions >( NDimensions )
  {
    // The Jacobian is constant, therefore it can be initialized in the constructor.
    this->m_LocalJacobian = JacobianType( NDimensions, 1 );
    this->m_LocalJacobian.Fill( 0.0 );

    this->m_SpatialJacobian.SetIdentity();

    this->m_NonZeroJacobianIndices.resize( ParametersDimension );
    for( unsigned int i = 0; i < ParametersDimension; ++i )
    {
      this->m_NonZeroJacobianIndices[ i ] = i;
    }

    this->m_HasNonZeroSpatialHessian           = false;
    this->m_HasNonZeroJacobianOfSpatialHessian = false;
    this->m_JacobianOfSpatialJacobian.resize( ParametersDimension );
    this->m_JacobianOfSpatialHessian.resize( ParametersDimension );

  }


  virtual ~AdvancedIdentityTransform() {}

private:

  AdvancedIdentityTransform( const Self & ); // purposely not implemented
  void operator=( const Self & );            // purposely not implemented

  JacobianType                  m_LocalJacobian;
  SpatialJacobianType           m_SpatialJacobian;
  SpatialHessianType            m_SpatialHessian;
  NonZeroJacobianIndicesType    m_NonZeroJacobianIndices;
  JacobianOfSpatialJacobianType m_JacobianOfSpatialJacobian;
  JacobianOfSpatialHessianType  m_JacobianOfSpatialHessian;

};

} // end namespace itk

#endif