itkStackTransform.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 itkStackTransform_h
#define itkStackTransform_h
 
#include "itkAdvancedTransform.h"
#include "itkIndex.h"
 
#include <cassert>
 
namespace itk
{

template <class TScalarType, unsigned int NInputDimensions, unsigned int NOutputDimensions>
class ITK_TEMPLATE_EXPORT StackTransform : public AdvancedTransform<TScalarType, NInputDimensions, NOutputDimensions>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(StackTransform);

  using Self = StackTransform;
  using Superclass = AdvancedTransform<TScalarType, NInputDimensions, NOutputDimensions>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkTypeMacro(StackTransform, AdvancedTransform);

  itkStaticConstMacro(InputSpaceDimension, unsigned int, NInputDimensions);
  itkStaticConstMacro(OutputSpaceDimension, unsigned int, NOutputDimensions);
  itkStaticConstMacro(ReducedInputSpaceDimension, unsigned int, NInputDimensions - 1);
  itkStaticConstMacro(ReducedOutputSpaceDimension, unsigned int, NOutputDimensions - 1);

  using typename Superclass::ScalarType;
  using typename Superclass::ParametersType;
  using typename Superclass::FixedParametersType;
  using typename Superclass::NumberOfParametersType;
  using typename Superclass::ParametersValueType;
  using typename Superclass::JacobianType;
  using typename Superclass::SpatialJacobianType;
  using typename Superclass::JacobianOfSpatialJacobianType;
  using typename Superclass::SpatialHessianType;
  using typename Superclass::JacobianOfSpatialHessianType;
  using typename Superclass::NonZeroJacobianIndicesType;
  using typename Superclass::InputPointType;
  using typename Superclass::InputVectorType;
  using typename Superclass::OutputVectorType;
  using typename Superclass::InputVnlVectorType;
  using typename Superclass::OutputVnlVectorType;
  using typename Superclass::OutputCovariantVectorType;
  using typename Superclass::InputCovariantVectorType;
  using typename Superclass::OutputPointType;
  using typename Superclass::OutputVectorPixelType;
  using typename Superclass::InputVectorPixelType;

  using SubTransformType =
    AdvancedTransform<TScalarType, Self::ReducedInputSpaceDimension, Self::ReducedOutputSpaceDimension>;
  using SubTransformPointer = typename SubTransformType::Pointer;
  using SubTransformJacobianType = typename SubTransformType::JacobianType;

  using SubTransformInputPointType = typename SubTransformType::InputPointType;
  using SubTransformOutputPointType = typename SubTransformType::OutputPointType;

  using ParametersArrayType = typename ParametersType::ArrayType;

  OutputPointType
  TransformPoint(const InputPointType & inputPoint) const override;

  void
  GetJacobian(const InputPointType & inputPoint, JacobianType & jac, NonZeroJacobianIndicesType & nzji) const override;

  void
  SetParameters(const ParametersType & param) override;

  const ParametersType &
  GetParameters() const override;

  void
  SetFixedParameters(const FixedParametersType & fixedParameters) override
  {
    const auto numberOfFixedParameters = fixedParameters.size();
    if (numberOfFixedParameters < NumberOfGeneralFixedParametersOfStack)
    {
      itkExceptionMacro("The number of FixedParameters (" << numberOfFixedParameters << ") should be at least "
                                                          << NumberOfGeneralFixedParametersOfStack);
    }
 
    if (Superclass::m_FixedParameters != fixedParameters)
    {
      Superclass::m_FixedParameters = fixedParameters;
 
      CreateSubTransforms(FixedParametersType(fixedParameters.data_block() + NumberOfGeneralFixedParametersOfStack,
                                              numberOfFixedParameters - NumberOfGeneralFixedParametersOfStack));
      UpdateStackSpacingAndOrigin();
      this->Modified();
    }
  }
 

  NumberOfParametersType
  GetNumberOfParameters() const override
  {
    if (this->m_SubTransformContainer.empty())
    {
      return 0;
    }
    else
    {
      return this->m_SubTransformContainer.size() * m_SubTransformContainer[0]->GetNumberOfParameters();
    }
  }
 

  void
  SetNumberOfSubTransforms(const unsigned int num)
  {
    if (this->m_SubTransformContainer.size() != num)
    {
      this->m_SubTransformContainer.clear();
      this->m_SubTransformContainer.resize(num);
      this->Modified();
    }
  }
 
 
  auto
  GetNumberOfSubTransforms() const
  {
    return static_cast<unsigned>(m_SubTransformContainer.size());
  }
 

  itkSetMacro(StackSpacing, TScalarType);
  itkGetConstMacro(StackSpacing, TScalarType);
  itkSetMacro(StackOrigin, TScalarType);
  itkGetConstMacro(StackOrigin, TScalarType);

  void
  SetSubTransform(unsigned int i, SubTransformType * transform)
  {
    this->m_SubTransformContainer[i] = transform;
    this->Modified();
  }
 

  void
  UpdateFixedParameters()
  {
    const SubTransformType * const subTransform =
      m_SubTransformContainer.empty() ? nullptr : m_SubTransformContainer.front();
    this->UpdateFixedParametersInternally((subTransform == nullptr) ? FixedParametersType()
                                                                    : subTransform->GetFixedParameters());
  }
 

  void
  SetAllSubTransforms(const SubTransformType & transform)
  {
    const auto & fixedParametersOfSubTransform = transform.GetFixedParameters();
    const auto & parametersOfSubTransform = transform.GetParameters();
 
    UpdateFixedParametersInternally(fixedParametersOfSubTransform);
 
    for (auto & subTransform : m_SubTransformContainer)
    {
      // Copy transform
      SubTransformPointer transformcopy = dynamic_cast<SubTransformType *>(transform.CreateAnother().GetPointer());
      transformcopy->SetFixedParameters(fixedParametersOfSubTransform);
      transformcopy->SetParameters(parametersOfSubTransform);
      // Set sub transform
      subTransform = transformcopy;
    }
  }
 

  SubTransformPointer
  GetSubTransform(unsigned int i)
  {
    return this->m_SubTransformContainer[i];
  }
 

  NumberOfParametersType
  GetNumberOfNonZeroJacobianIndices() const override;
 
protected:
  StackTransform() = default;
  ~StackTransform() override = default;
 
  // Indices of the general fixed parameters into the FixedParameters array, and the number of those parameters.
  enum
  {
    IndexOfNumberOfSubTransforms,
    IndexOfStackSpacing,
    IndexOfStackOrigin,
    NumberOfGeneralFixedParametersOfStack
  };
 
  void
  CreateSubTransforms(const FixedParametersType & fixedParametersOfSubTransform)
  {
    assert(Superclass::m_FixedParameters.size() >= NumberOfGeneralFixedParametersOfStack);
    const auto numberOfSubTransforms = Superclass::m_FixedParameters[IndexOfNumberOfSubTransforms];
 
    if (numberOfSubTransforms >= 0.0 && numberOfSubTransforms <= UINT_MAX &&
        static_cast<double>(static_cast<unsigned>(numberOfSubTransforms)) == numberOfSubTransforms)
    {
      m_SubTransformContainer.resize(static_cast<unsigned>(numberOfSubTransforms));
    }
    else
    {
      itkExceptionMacro("The FixedParameters element (" << numberOfSubTransforms
                                                        << ") should be a valid number (the number of subtransforms).");
    }
 
    for (auto & subTransform : m_SubTransformContainer)
    {
      subTransform = this->CreateSubTransform();
      subTransform->SetFixedParameters(fixedParametersOfSubTransform);
    }
  }
 
  void
  UpdateStackSpacingAndOrigin()
  {
    assert(Superclass::m_FixedParameters.size() >= NumberOfGeneralFixedParametersOfStack);
    m_StackSpacing = Superclass::m_FixedParameters[IndexOfStackSpacing];
    m_StackOrigin = Superclass::m_FixedParameters[IndexOfStackOrigin];
  }
 

  virtual void
  UpdateFixedParametersInternally(const FixedParametersType & fixedParametersOfSubTransform)
  {
    const auto numberOfFixedParametersOfSubTransform = fixedParametersOfSubTransform.size();
 
    FixedParametersType & fixedParametersOfStack = this->Superclass::m_FixedParameters;
 
    const auto minimumNumberOfFixedParametersOfStack =
      NumberOfGeneralFixedParametersOfStack + numberOfFixedParametersOfSubTransform;
 
    if (fixedParametersOfStack.size() < minimumNumberOfFixedParametersOfStack)
    {
      fixedParametersOfStack.set_size(minimumNumberOfFixedParametersOfStack);
    }
    fixedParametersOfStack[IndexOfNumberOfSubTransforms] = m_SubTransformContainer.size();
    fixedParametersOfStack[IndexOfStackOrigin] = m_StackOrigin;
    fixedParametersOfStack[IndexOfStackSpacing] = m_StackSpacing;
    std::copy_n(fixedParametersOfSubTransform.begin(),
                numberOfFixedParametersOfSubTransform,
                fixedParametersOfStack.begin() + NumberOfGeneralFixedParametersOfStack);
  }
 
private:
  // Private using-declarations, to avoid `-Woverloaded-virtual` warnings from GCC (GCC 11.4).
  using Superclass::TransformCovariantVector;
  using Superclass::TransformVector;

  virtual SubTransformPointer
  CreateSubTransform() const = 0;
 
 
  static constexpr const char * unimplementedOverrideMessage = "Not implemented for StackTransform";

  OutputVectorType
  TransformVector(const InputVectorType &) const override
  {
    itkExceptionMacro(<< unimplementedOverrideMessage);
  }
 
  OutputVnlVectorType
  TransformVector(const InputVnlVectorType &) const override
  {
    itkExceptionMacro(<< unimplementedOverrideMessage);
  }
 
  OutputCovariantVectorType
  TransformCovariantVector(const InputCovariantVectorType &) const override
  {
    itkExceptionMacro(<< unimplementedOverrideMessage);
  }
 

  void
  GetSpatialJacobian(const InputPointType &, SpatialJacobianType &) const override
  {
    itkExceptionMacro(<< unimplementedOverrideMessage);
  }
 
  void
  GetSpatialHessian(const InputPointType &, SpatialHessianType &) const override
  {
    itkExceptionMacro(<< unimplementedOverrideMessage);
  }
 
  void
  GetJacobianOfSpatialJacobian(const InputPointType &,
                               JacobianOfSpatialJacobianType &,
                               NonZeroJacobianIndicesType &) const override
  {
    itkExceptionMacro(<< unimplementedOverrideMessage);
  }
 
  void
  GetJacobianOfSpatialJacobian(const InputPointType &,
                               SpatialJacobianType &,
                               JacobianOfSpatialJacobianType &,
                               NonZeroJacobianIndicesType &) const override
  {
    itkExceptionMacro(<< unimplementedOverrideMessage);
  }
 
  void
  GetJacobianOfSpatialHessian(const InputPointType &,
                              JacobianOfSpatialHessianType &,
                              NonZeroJacobianIndicesType &) const override
  {
    itkExceptionMacro(<< unimplementedOverrideMessage);
  }
 
 
  void
  GetJacobianOfSpatialHessian(const InputPointType &,
                              SpatialHessianType &,
                              JacobianOfSpatialHessianType &,
                              NonZeroJacobianIndicesType &) const override
  {
    itkExceptionMacro(<< unimplementedOverrideMessage);
  }
 
 
  // Transform container
  std::vector<SubTransformPointer> m_SubTransformContainer{};
 
  // Stack spacing and origin of last dimension
  TScalarType m_StackSpacing{ 1.0 };
  TScalarType m_StackOrigin{ 0.0 };
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkStackTransform.hxx"
#endif
 
#endif