sitkTransform.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
 *
 *         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 "sitkPathType.h"
#include <vector>
 
 
namespace itk
{
 
template <typename TScalar>
class TransformBaseTemplate;
using TransformBase = TransformBaseTemplate<double>;
 
#if !defined(SWIG)
template <typename TScalar, unsigned int NDimension>
class CompositeTransform;
#endif
 
namespace simple
{
 
class PimpleTransformBase;
 
 
enum TransformEnum
{
  sitkUnknownTransform = -1,
  sitkIdentity,
  sitkTranslation,
  sitkScale,
  sitkScaleLogarithmic,
  sitkEuler,
  sitkSimilarity,
  sitkQuaternionRigid,
  sitkVersor,
  sitkVersorRigid,
  sitkScaleSkewVersor,
  sitkComposeScaleSkewVersor,
  sitkScaleVersor,
  sitkAffine,
  sitkComposite,
  sitkDisplacementField,
  sitkBSplineTransform
};
 

class SITKCommon_EXPORT Transform
{
public:
  using Self = Transform;

  Transform();

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

  Transform(unsigned int dimensions, TransformEnum type);

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

  Transform &
  operator=(const Transform &);
  Transform(const Transform &);
 

  itk::TransformBase *
  GetITKBase();
  const itk::TransformBase *
  GetITKBase() const;

  unsigned int
  GetDimension() const;
 
  // todo get transform type

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

  unsigned int
  GetNumberOfParameters() const;

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

  unsigned int
  GetNumberOfFixedParameters() const;

  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;

  void
  ApplyToImageMetadata(Image & image) 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() const;
 

  virtual std::string
  GetName() const;

  void
  MakeUnique();

  TransformEnum
  GetTransformEnum() const;
 
protected:
  explicit Transform(PimpleTransformBase * pimpleTransform);
 
  // this method is called to set the private pimpleTransform outside
  // the constructor, derived classes can override it of update the
  // state.
  virtual void
  SetPimpleTransform(std::unique_ptr<PimpleTransformBase> && pimpleTransform);
 
private:
  template <unsigned int VDimension>
  void
  InternalInitialization(TransformEnum type, itk::TransformBase * base = nullptr);
 
  struct TransformTryCastVisitor
  {
    itk::TransformBase * transform;
    Transform *          that;
    template <typename TransformType>
    void
    operator()() 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
  {
    using ObjectType = typename ::detail::FunctionTraits<TMemberFunctionPointer>::ClassType;
 
    template <typename TImageType>
    constexpr TMemberFunctionPointer
    operator()() 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
  std::unique_ptr<PimpleTransformBase> m_PimpleTransform;
};
 
 
// read
SITKCommon_EXPORT Transform
ReadTransform(const PathType & filename);
 
// write
SITKCommon_EXPORT void
WriteTransform(const Transform & transform, const PathType & filename);
 
} // namespace simple
} // namespace itk
 
#endif // sitkTransform_h