cmtkXform.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2010 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2440 $
//
//  $LastChangedDate: 2010-10-13 10:57:59 -0700 (Wed, 13 Oct 2010) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkXform_h_included_
#define __cmtkXform_h_included_

#include <cmtkconfig.h>

#include <Base/cmtkMetaInformationObject.h>
#include <Base/cmtkAnatomicalOrientationBase.h>
#include <Base/cmtkVector.h>
#include <Base/cmtkFixedVector.h>
#include <Base/cmtkBitVector.h>
#include <Base/cmtkMatchedLandmarkList.h>

#include <System/cmtkSmartPtr.h>

namespace
cmtk
{


class Xform :
  public MetaInformationObject
{
public:
  typedef Xform Self;

  typedef SmartPointer<Self> SmartPtr;

  typedef SmartConstPointer<Self> SmartConstPtr;

  typedef FixedVector<3,Types::Coordinate> SpaceVectorType;

  Types::Coordinate *m_Parameters;

  size_t m_NumberOfParameters;

  Xform( const Xform& other )
    : MetaInformationObject( other ),
      m_NumberOfParameters( other.m_NumberOfParameters ),
      m_ParameterVector( other.m_ParameterVector )
  {
    this->m_Parameters = this->m_ParameterVector->Elements;
    this->m_MetaInformation[cmtk::META_SPACE] = cmtk::AnatomicalOrientationBase::ORIENTATION_STANDARD;
  }

  Xform()
    : m_Parameters( NULL ),
      m_NumberOfParameters( 0 ) 
  {
    this->m_MetaInformation[cmtk::META_SPACE] = cmtk::AnatomicalOrientationBase::ORIENTATION_STANDARD;
  }

  virtual ~Xform() {}
  
  virtual bool InDomain( const Self::SpaceVectorType& ) const { return true; }
  
  virtual Types::Coordinate GetGlobalScaling() const { return 0.0; }

  virtual Self::SpaceVectorType Apply ( const Self::SpaceVectorType& ) const = 0;

  virtual void ApplyInPlace ( Self::SpaceVectorType& ) const = 0;

  virtual bool ApplyInverse ( const Self::SpaceVectorType&, Self::SpaceVectorType&, const Types::Coordinate = 0.01  ) const = 0;

  virtual bool ApplyInverseInPlace( Self::SpaceVectorType&, const Types::Coordinate = 0.01  ) const = 0;

  virtual bool ApplyInverseInPlaceWithInitial( Self::SpaceVectorType& v, const Self::SpaceVectorType&, const Types::Coordinate error = 0.01 ) const
  {
    return this->ApplyInverseInPlace( v, error );
  }

  Self::SmartPtr Clone () const 
  {
    return Self::SmartPtr( this->CloneVirtual() );
  }

  virtual size_t ParamVectorDim () const 
  {
    return this->m_NumberOfParameters;
  }

  virtual size_t VariableParamVectorDim () const
  {
    return this->ParamVectorDim();
  }

  virtual void SetParamVector ( CoordinateVector& v );

  virtual void CopyParamVector ( const Xform* other )
  {
    *(this->m_ParameterVector) = *(other->m_ParameterVector);
    this->m_Parameters = this->m_ParameterVector->Elements;
  }

  virtual void SetParamVector ( const CoordinateVector& v );

  virtual void SetParameter ( const size_t idx, const Types::Coordinate p )
  {
    this->m_Parameters[idx] = p;
  }

  virtual Types::Coordinate GetParameter ( const size_t idx ) const
  {
    return this->m_Parameters[idx];
  }

  virtual CoordinateVector& GetParamVector( CoordinateVector& v, const size_t targetOffset = 0 ) const;

  virtual Types::Coordinate GetParamStep( const size_t, const Self::SpaceVectorType&, const Types::Coordinate step_mm = 1 ) const
  { 
    return step_mm;
  }
  
  virtual Types::Coordinate GetJacobianDeterminant ( const Self::SpaceVectorType& ) const = 0;
  
  virtual Types::Coordinate GetLandmarksMSD( const MatchedLandmarkList* ll ) const;
  
  virtual void GetVolumeOfInfluence( const size_t idx, const Self::SpaceVectorType&, const Self::SpaceVectorType&, Self::SpaceVectorType&, Self::SpaceVectorType&, const int = -1 ) const;
  
protected:
  CoordinateVector::SmartPtr m_ParameterVector;

  void AllocateParameterVector( const size_t numberOfParameters );

  virtual Self* CloneVirtual () const = 0;
};


} // namespace cmtk

#endif // #ifdef __cmtkXform_h_included_