itkMultiTransform.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 <typename TParametersValueType = double, unsigned int VDimension = 3, unsigned int VSubDimensions = VDimension>
class ITK_TEMPLATE_EXPORT MultiTransform : public Transform<TParametersValueType, VDimension, VSubDimensions>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MultiTransform);

  using Self = MultiTransform;
  using Superclass = Transform<TParametersValueType, VDimension, VSubDimensions>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(MultiTransform);

  using TransformType = Transform<TParametersValueType, VSubDimensions, VSubDimensions>;
  using TransformTypePointer = typename TransformType::Pointer;
 
  /* Types common to both container and sub transforms */

  using typename Superclass::ParametersType;
  using typename Superclass::ParametersValueType;
  using typename Superclass::FixedParametersType;
  using typename Superclass::FixedParametersValueType;
  using ScalarType = ParametersValueType;

  using typename Superclass::DerivativeType;

  using typename Superclass::JacobianType;
  using typename Superclass::JacobianPositionType;
  using typename Superclass::InverseJacobianPositionType;

  using typename Superclass::TransformCategoryEnum;
 
  /* Types relative to the container transform. */

  using typename Superclass::InverseTransformBasePointer;

  using typename Superclass::InputPointType;
  using typename Superclass::OutputPointType;

  using typename Superclass::InputVectorType;
  using typename Superclass::OutputVectorType;

  using typename Superclass::InputCovariantVectorType;
  using typename Superclass::OutputCovariantVectorType;

  using typename Superclass::InputVnlVectorType;
  using typename Superclass::OutputVnlVectorType;

  using typename Superclass::InputVectorPixelType;
  using typename Superclass::OutputVectorPixelType;

  using typename Superclass::InputDiffusionTensor3DType;
  using typename Superclass::OutputDiffusionTensor3DType;

  using typename Superclass::InputSymmetricSecondRankTensorType;
  using typename Superclass::OutputSymmetricSecondRankTensorType;
 
  /* Types relative to the sub transform type. */

  using SubTransformInverseTransformBasePointer = typename TransformType::InverseTransformBasePointer;

  using TransformQueueType = std::deque<TransformTypePointer>;

  using typename Superclass::NumberOfParametersType;

  static constexpr unsigned int InputDimension = VDimension;
  static constexpr unsigned int OutputDimension = VDimension;
 
  static constexpr unsigned int SubInputDimension = VSubDimensions;
  static constexpr unsigned int SubOutputDimension = VSubDimensions;


  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 static_cast<SizeValueType>(this->m_TransformQueue.size());
  }

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


  bool
  IsLinear() const override;

  TransformCategoryEnum
  GetTransformCategory() const override;

  const ParametersType &
  GetParameters() const override;
 
  /* SetParameters for all sub-transforms.
   * See GetParameters() for parameter ordering. */
  void
  SetParameters(const ParametersType & inputParameters) override;
 
  /* GetFixedParameters for all sub-transforms.
   * See GetParameters() for parameter ordering. */
  const FixedParametersType &
  GetFixedParameters() const override;
 
  /* SetFixedParameters for all sub-transforms.
   * See GetParameters() for parameter ordering. */
  void
  SetFixedParameters(const FixedParametersType & inputParameters) override;
 
  /* Get total number of parameters. Sum of all sub-transforms. */
  NumberOfParametersType
  GetNumberOfParameters() const override;
 
  /* Get total number of local parameters, the sum of all sub-transforms. */
  NumberOfParametersType
  GetNumberOfLocalParameters() const override;
 
  /* Get total number of fixed parameters, the sum of all sub-transforms. */
  NumberOfParametersType
  GetNumberOfFixedParameters() const override;

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

  bool
  GetInverse(Self * inverse) const;

  // TODO - what do we need here?
  //  virtual void FlattenTransformQueue();
 
protected:
  MultiTransform() = default;
  ~MultiTransform() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  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{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMultiTransform.hxx"
#endif
 
#endif // itkMultiTransform_h