itkMultiTransform.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 __itkMultiTransform_h
#define __itkMultiTransform_h

#include "itkTransform.h"

#include <deque>

namespace itk
{

template
<class TScalar = double, unsigned int NDimensions = 3, unsigned int NSubDimensions = NDimensions>
class MultiTransform :
  public Transform<TScalar, NDimensions, NDimensions>
{
public:
  typedef MultiTransform                               Self;
  typedef Transform<TScalar, NDimensions, NDimensions> Superclass;
  typedef SmartPointer<Self>                           Pointer;
  typedef SmartPointer<const Self>                     ConstPointer;

  itkTypeMacro( MultiTransform, Transform );

  typedef Transform<TScalar, NSubDimensions, NSubDimensions > TransformType;
  typedef typename TransformType::Pointer                     TransformTypePointer;

  /* Types common to both container and sub transforms */

  typedef typename Superclass::ScalarType          ScalarType;

  typedef typename Superclass::ParametersType      ParametersType;
  typedef typename Superclass::ParametersValueType ParametersValueType;

  typedef typename Superclass::DerivativeType DerivativeType;

  typedef typename Superclass::JacobianType JacobianType;

  typedef typename Superclass::TransformCategoryType TransformCategoryType;

  /* Types relative to the container transform. */

  typedef typename Superclass::InverseTransformBasePointer    InverseTransformBasePointer;

  typedef typename Superclass::InputPointType             InputPointType;
  typedef typename Superclass::OutputPointType            OutputPointType;

  typedef typename Superclass::InputVectorType            InputVectorType;
  typedef typename Superclass::OutputVectorType           OutputVectorType;

  typedef typename Superclass::InputCovariantVectorType   InputCovariantVectorType;
  typedef typename Superclass::OutputCovariantVectorType  OutputCovariantVectorType;

  typedef typename Superclass::InputVnlVectorType         InputVnlVectorType;
  typedef typename Superclass::OutputVnlVectorType        OutputVnlVectorType;

  typedef typename Superclass::InputVectorPixelType       InputVectorPixelType;
  typedef typename Superclass::OutputVectorPixelType      OutputVectorPixelType;

  typedef typename Superclass::InputDiffusionTensor3DType  InputDiffusionTensor3DType;
  typedef typename Superclass::OutputDiffusionTensor3DType OutputDiffusionTensor3DType;

  typedef typename Superclass::InputSymmetricSecondRankTensorType InputSymmetricSecondRankTensorType;
  typedef typename Superclass::OutputSymmetricSecondRankTensorType  OutputSymmetricSecondRankTensorType;

  /* Types relative to the sub transform type. */

  typedef typename TransformType::InverseTransformBasePointer    SubTransformInverseTransformBasePointer;

  typedef std::deque<TransformTypePointer>  TransformQueueType;

  typedef typename Superclass::NumberOfParametersType NumberOfParametersType;

  itkStaticConstMacro( InputDimension, unsigned int, NDimensions );
  itkStaticConstMacro( OutputDimension, unsigned int, NDimensions );

  itkStaticConstMacro( SubInputDimension, unsigned int, NSubDimensions );
  itkStaticConstMacro( SubOutputDimension, unsigned int, NSubDimensions );

  virtual void AddTransform( TransformType *t  )
  {
    this->PushBackTransform( t );
  }

  virtual void AppendTransform( TransformType *t  )
  {
    this->AddTransform( t );
  }

  virtual void PrependTransform( TransformType *t  )
  {
    this->PushFrontTransform( t );
  }

  virtual void RemoveTransform()
  {
    this->PopBackTransform();
  }

  virtual const
  TransformType * GetFrontTransform() const
  {
    return this->m_TransformQueue.front().GetPointer();
  }

  virtual const
  TransformType * GetBackTransform() const
  {
    return this->m_TransformQueue.back().GetPointer();
  }

  virtual const
  TransformTypePointer GetNthTransform( SizeValueType n ) const
  {
    //NOTE: By returning a smart pointer type, the use of this function can
    //      be a significant bottleneck in multithreaded applications.
    return this->m_TransformQueue[n];
  }

  virtual
  TransformType * GetNthTransformModifiablePointer( const SizeValueType n ) const
  {
    return this->m_TransformQueue[n].GetPointer();
  }

  virtual const
  TransformType * GetNthTransformConstPointer( const SizeValueType n ) const
  {
    return this->m_TransformQueue[n].GetPointer();
  }

  virtual const TransformQueueType & GetTransformQueue() const
  {
    return this->m_TransformQueue;
  }

  virtual bool IsTransformQueueEmpty() const
  {
    return this->m_TransformQueue.empty();
  }

  virtual SizeValueType GetNumberOfTransforms() const
  {
    return this->m_TransformQueue.size();
  }

  virtual void ClearTransformQueue()
  {
    this->m_TransformQueue.clear();
    this->Modified();
  }

  virtual bool IsLinear() const;

  virtual TransformCategoryType GetTransformCategory() const;

  virtual const ParametersType & GetParameters(void) const;

  /* SetParameters for all sub-transforms.
   * See GetParameters() for parameter ordering. */
  virtual void  SetParameters(const ParametersType & p);

  /* GetFixedParameters for all sub-transforms.
   * See GetParameters() for parameter ordering. */
  virtual const ParametersType & GetFixedParameters(void) const;

  /* SetFixedParameters for all sub-transforms.
   * See GetParameters() for parameter ordering. */
  virtual void SetFixedParameters(const ParametersType & fixedParameters);

  /* Get total number of parameters. Sum of all sub-transforms. */
  virtual NumberOfParametersType GetNumberOfParameters(void) const;

  /* Get total number of local parameters, the sum of all sub-transforms. */
  virtual NumberOfParametersType GetNumberOfLocalParameters(void) const;

  /* Get total number of fixed parameters, the sum of all sub-transforms. */
  virtual NumberOfParametersType GetNumberOfFixedParameters(void) const;

  virtual void UpdateTransformParameters( const DerivativeType & update, ScalarType  factor = 1.0 );

  bool GetInverse( Self *inverse ) const;

//TODO - what do we need here?
//  virtual void FlattenTransformQueue();

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

  virtual void PushFrontTransform( TransformTypePointer t  )
  {
    this->m_TransformQueue.push_front( t );
    this->Modified();
  }

  virtual void PushBackTransform( TransformTypePointer t  )
  {
    this->m_TransformQueue.push_back( t );
    this->Modified();
  }

  virtual void PopFrontTransform()
  {
    this->m_TransformQueue.pop_front();
    this->Modified();
  }

  virtual void PopBackTransform()
  {
    this->m_TransformQueue.pop_back();
    this->Modified();
  }

  mutable TransformQueueType m_TransformQueue;

  mutable NumberOfParametersType  m_NumberOfLocalParameters;
  mutable ModifiedTimeType        m_LocalParametersUpdateTime;

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

};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkMultiTransform.hxx"
#endif

#endif // __itkMultiTransform_h