itkCompositeTransform.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 __itkCompositeTransform_h
#define __itkCompositeTransform_h

#include "itkTransform.h"

#include <deque>

namespace itk
{

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

  itkTypeMacro( CompositeTransform, Transform );

  itkSimpleNewMacro( Self );

  virtual::itk::LightObject::Pointer CreateAnother(void) const
  {
    itkExceptionMacro("CreateAnother unimplemented. See source comments.");
  }

  typedef Superclass                   TransformType;
  typedef typename Superclass::Pointer TransformTypePointer;

  typedef typename Superclass::InverseTransformBasePointer
  InverseTransformBasePointer;

  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::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;

  typedef std::deque<TransformTypePointer> TransformQueueType;

  typedef std::deque<bool> TransformsToOptimizeFlagsType;

  typedef typename Superclass::NumberOfParametersType NumberOfParametersType;

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

  void AddTransform( TransformType *t  )
  {
    this->PushBackTransform( t ); /* Also adds to TransformsToOptimize list */
  }

  void RemoveTransform()
  {
    this->PopBackTransform(); /* Also removes to TransformsToOptimize list */
  }

  const
  TransformTypePointer GetFrontTransform()
  {
    return this->m_TransformQueue.front();
  }

  const
  TransformTypePointer GetBackTransform()
  {
    return this->m_TransformQueue.back();
  }

  const
  TransformTypePointer GetNthTransform( size_t n ) const
  {
    return this->m_TransformQueue[n];
  }

  void SetNthTransformToOptimize( size_t i, bool state )
  {
    this->m_TransformsToOptimizeFlags.at(i) = state;
    this->Modified();
  }

  void SetNthTransformToOptimizeOn( size_t i )
  {
    this->SetNthTransformToOptimize( i, true );
  }

  void SetNthTransformToOptimizeOff( size_t i )
  {
    this->SetNthTransformToOptimize( i, false );
  }

  void SetAllTransformsToOptimize( bool state )
  {
    this->m_TransformsToOptimizeFlags.assign(
      this->m_TransformsToOptimizeFlags.size(), state );
    this->Modified();
  }

  void SetAllTransformsToOptimizeOn()
  {
    this->SetAllTransformsToOptimize( true );
  }

  void SetAllTransformsToOptimizeOff()
  {
    this->SetAllTransformsToOptimize( false );
  }

  /* With AddTransform() as the only way to add a transform, we
   * can have this method to easily allow user to optimize only
   * the transform added most recenlty. */
  void SetOnlyMostRecentTransformToOptimizeOn()
  {
    this->SetAllTransformsToOptimize( false );
    this->SetNthTransformToOptimizeOn( this->GetNumberOfTransforms() - 1 );
  }

  /* Get whether the Nth transform is set to be optimzied */
  /* NOTE: ambiguous function name here - are we getting if the Nth transform
      is set to be optimized, or the Nth of the transforms that are set to be
      optimized? */
  bool GetNthTransformToOptimize( size_t i ) const
  {
    return this->m_TransformsToOptimizeFlags.at(i);
  }

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

  const TransformsToOptimizeFlagsType & GetTransformsToOptimizeFlags() const
  {
    return this->m_TransformsToOptimizeFlags;
  }

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

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

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

  bool GetInverse( Self *inverse ) const;

  virtual InverseTransformBasePointer GetInverseTransform() const;

  virtual OutputPointType TransformPoint( const InputPointType & inputPoint ) const;

  /* Note: why was the 'isInsideTransformRegion' flag used below?
  {
    bool isInside = true;

    return this->TransformPoint( inputPoint, isInside );
  }
  virtual OutputPointType TransformPoint( const InputPointType& thisPoint,
                                          bool &isInsideTransformRegion ) const;
  */
  using Superclass::TransformVector;
  virtual OutputVectorType TransformVector(const InputVectorType &) const;

  virtual OutputVnlVectorType TransformVector(const InputVnlVectorType & inputVector) const;

  virtual OutputVectorPixelType TransformVector(const InputVectorPixelType & inputVector ) const;

  virtual OutputVectorType TransformVector(const InputVectorType & inputVector,
                                           const InputPointType & inputPoint ) const;

  virtual OutputVnlVectorType TransformVector(const InputVnlVectorType & inputVector,
                                              const InputPointType & inputPoint ) const;

  virtual OutputVectorPixelType TransformVector(const InputVectorPixelType & inputVector,
                                                const InputPointType & inputPoint ) const;

  using Superclass::TransformCovariantVector;
  virtual OutputCovariantVectorType TransformCovariantVector(const InputCovariantVectorType &) const;

  virtual OutputVectorPixelType TransformCovariantVector(const InputVectorPixelType &) const;

  virtual OutputCovariantVectorType TransformCovariantVector(const InputCovariantVectorType & inputVector,
                                                             const InputPointType & inputPoint ) const;

  virtual OutputVectorPixelType TransformCovariantVector(const InputVectorPixelType & inputVector,
                                                         const InputPointType & inputPoint ) const;

  using Superclass::TransformDiffusionTensor3D;
  virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D(
    const InputDiffusionTensor3DType & inputTensor) const;

  virtual OutputVectorPixelType TransformDiffusionTensor3D(
    const InputVectorPixelType & inputTensor) const;

  virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D(
    const InputDiffusionTensor3DType & inputTensor,
    const InputPointType & inputPoint ) const;

  virtual OutputVectorPixelType TransformDiffusionTensor3D(
    const InputVectorPixelType & inputTensor,
    const InputPointType & inputPoint ) const;

  using Superclass::TransformSymmetricSecondRankTensor;
  virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor(
    const InputSymmetricSecondRankTensorType & inputTensor) const;

  virtual OutputVectorPixelType TransformSymmetricSecondRankTensor(
    const InputVectorPixelType & inputTensor) const;

  virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor(
    const InputSymmetricSecondRankTensorType & inputTensor,
    const InputPointType & inputPoint ) const;

  virtual OutputVectorPixelType TransformSymmetricSecondRankTensor(
    const InputVectorPixelType & inputTensor,
    const InputPointType & inputPoint ) const;

  virtual bool IsLinear() const;

  virtual const ParametersType & GetParameters(void) const;

  /* SetParameters only for transforms that are set to be optimized */
  virtual void  SetParameters(const ParametersType & p);

  /* GetFixedParameters only for transforms that are set to be optimized */
  virtual const ParametersType & GetFixedParameters(void) const;

  /* SetFixedParameters only for transforms that are set to be optimized */
  virtual void  SetFixedParameters(const ParametersType & fixedParameters);

  /* Get total number of parameters for transforms that are set to be
   * optimized */
  virtual NumberOfParametersType GetNumberOfParameters(void) const;

  /* Get total number of local parameters for transforms that are set
   * to be optimized */
  virtual NumberOfParametersType GetNumberOfLocalParameters(void) const;

  /* Get total number of fixed parameters for transforms that are set
   * to be optimized */
  virtual NumberOfParametersType GetNumberOfFixedParameters(void) const;

  /* Prepare the transform for use, e.g. in registration framework.
   * Must be called before registration to optimize parameter storage
   * for more efficient operation, particularly with high-dimensionality
   * sub-transforms. */
  // virtual void PrepareForUse(void);

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

  virtual bool HasLocalSupport() const;

  virtual void ComputeJacobianWithRespectToParameters(const InputPointType  & p, JacobianType & j) const;

  virtual void ComputeJacobianWithRespectToPosition(const InputPointType &,
                                                    JacobianType &) const
  {
    itkExceptionMacro( "ComputeJacobianWithRespectToPosition not yet implemented "
                       "for " << this->GetNameOfClass() );
  }

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

  void PushFrontTransform( TransformTypePointer t  )
  {
    this->m_TransformQueue.push_front( t );
    /* Add element to list of flags, and set true by default */
    this->m_TransformsToOptimizeFlags.push_front( true );
    this->Modified();
  }

  void PushBackTransform( TransformTypePointer t  )
  {
    this->m_TransformQueue.push_back( t );
    /* Add element to list of flags, and set true by default */
    this->m_TransformsToOptimizeFlags.push_back( true );
    this->Modified();
  }

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

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

  // void UnifyParameterMemory(void);

  mutable TransformQueueType m_TransformQueue;

  TransformQueueType & GetTransformsToOptimizeQueue() const;

  mutable TransformQueueType            m_TransformsToOptimizeQueue;
  mutable TransformsToOptimizeFlagsType m_TransformsToOptimizeFlags;
private:
  CompositeTransform( const Self & ); // purposely not implemented
  void operator=( const Self & );     // purposely not implemented

  mutable unsigned long m_PreviousTransformsToOptimizeUpdateTime;
};

} // end namespace itk

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkCompositeTransform+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkCompositeTransform.hxx"
#endif

#endif // __itkCompositeTransform_h