sitkTransform.h

Go to the documentation of this file.

/*=========================================================================
*
*  Copyright Insight Software Consortium
*
*  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 sitkTransform_h
#define sitkTransform_h

#include "sitkCommon.h"
#include "sitkExceptionObject.h"
#include "sitkImage.h"
#include <vector>


namespace itk
{

// Forward declaration for pointer
// After ITK_VERSION 4.5 (Actually after June 20th, 2013) the ITK Transform
// classes are now templated.  This requires forward declarations to be defined
// differently.
#if ( ( SITK_ITK_VERSION_MAJOR == 4 ) && ( SITK_ITK_VERSION_MINOR < 5 ) )
class TransformBase;
#else
template< typename TScalar > class TransformBaseTemplate;
typedef TransformBaseTemplate<double> TransformBase;
#endif

template< typename TScalar, unsigned int NDimension> class CompositeTransform;

namespace simple
{

class PimpleTransformBase;


enum TransformEnum { sitkIdentity,
                     sitkTranslation,
                     sitkScale,
                     sitkScaleLogarithmic,
                     sitkEuler,
                     sitkSimilarity,
                     sitkQuaternionRigid,
                     sitkVersor,
                     sitkVersorRigid,
                     sitkScaleSkewVersor,
                     sitkAffine,
                     sitkComposite,
                     sitkDisplacementField,
                     sitkBSplineTransform
};


class SITKCommon_EXPORT Transform
{
public:
  typedef Transform Self;

  Transform( void );

  template<unsigned int NDimension>
  explicit Transform( itk::CompositeTransform< double, NDimension >* compositeTransform )
    : m_PimpleTransform( SITK_NULLPTR )
    {
      sitkStaticAssert( NDimension == 2 || NDimension == 3, "Only 2D and 3D transforms are supported" );
      if ( compositeTransform == SITK_NULLPTR )
        {
        sitkExceptionMacro( "Unable to construct a null transform!" );
        }
      this->InternalInitialization<NDimension>( sitkComposite, compositeTransform );
    }

  explicit Transform( itk::TransformBase *transform );

  Transform( unsigned int dimensions, TransformEnum type);

  Transform( Image &displacement, TransformEnum type = sitkDisplacementField );

  virtual ~Transform( void );

  Transform &operator=( const Transform & );
  Transform( const Transform & );
  itk::TransformBase* GetITKBase( void );
  const itk::TransformBase* GetITKBase( void ) const;
  unsigned int GetDimension( void ) const;

  // todo get transform type

  void SetParameters ( const std::vector<double>& parameters );
  std::vector<double> GetParameters( void ) const;
  unsigned int GetNumberOfParameters( void ) const;

  void SetFixedParameters ( const std::vector<double>& parameters );
  std::vector<double> GetFixedParameters( void ) const;
  unsigned int GetNumberOfFixedParameters( void ) const;

  // Make composition
  SITK_RETURN_SELF_TYPE_HEADER AddTransform( Transform t );


   SITK_RETURN_SELF_TYPE_HEADER FlattenTransform();

  std::vector< double > TransformPoint( const std::vector< double > &point ) const;

  std::vector< double > TransformVector( const std::vector< double > &vector, const std::vector< double > &point) const;

  // write
  void WriteTransform( const std::string &filename ) const;

  virtual bool IsLinear() const;

  virtual void SetIdentity();

  virtual bool SetInverse();

  Transform GetInverse() const;

  std::string ToString( void ) const;


  virtual std::string GetName() const;

  void MakeUnique( void );

protected:


  explicit Transform( PimpleTransformBase *pimpleTransform );

  // this method is called to set the private pimpleTransfrom outside
  // of the constructor, derived classes can override it of update the
  // state.
  virtual void SetPimpleTransform( PimpleTransformBase *pimpleTransform );

private:

  template< unsigned int VDimension>
  void InternalInitialization( TransformEnum type, itk::TransformBase *base = SITK_NULLPTR );

  struct TransformTryCastVisitor
  {
    itk::TransformBase *transform;
    Transform *that;
    template< typename TransformType >
    void operator() ( void ) const
      {
        TransformType *t = dynamic_cast<TransformType*>(transform);
        if (t)
          {
          that->InternalInitialization<TransformType>(t);
          }
      }
  };


  template< class TransformType>
  void InternalInitialization( TransformType *t );
  void InternalInitialization( itk::TransformBase *base );


  template< unsigned int >
    void InternalBSplineInitialization( Image & img );

  template< typename TDisplacementType >
    void InternalDisplacementInitialization( Image & img );

  template < class TMemberFunctionPointer >
    struct DisplacementInitializationMemberFunctionAddressor
  {
    typedef typename ::detail::FunctionTraits<TMemberFunctionPointer>::ClassType ObjectType;

    template< typename TImageType >
    TMemberFunctionPointer operator() ( void ) const
      {
        return &ObjectType::template InternalDisplacementInitialization< TImageType >;
      }
  };

  // As is the architecture of all SimpleITK pimples,
  // this pointer should never be null and should always point to a
  // valid object
  PimpleTransformBase *m_PimpleTransform;
};


// read
SITKCommon_EXPORT Transform ReadTransform( const std::string &filename );

// write
SITKCommon_EXPORT void WriteTransform( const Transform &transform, const std::string &filename);

}
}

#endif // sitkTransform_h