sitkBSplineTransform.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 sitkBSplineTransform_h
#define sitkBSplineTransform_h
 
#include "sitkCommon.h"
#include "sitkTransform.h"
 
namespace itk::simple
{

class SITKCommon_EXPORT BSplineTransform : public Transform
{
public:
  using Self = BSplineTransform;
  using Superclass = Transform;
 
  ~BSplineTransform() override;
 
  explicit BSplineTransform(unsigned int dimensions, unsigned int order = 3);

  explicit BSplineTransform(const std::vector<Image> & coefficientImages, unsigned int order = 3);
 
  BSplineTransform(const BSplineTransform &);
 
  explicit BSplineTransform(const Transform &);
 
  BSplineTransform &
  operator=(const BSplineTransform &);

  std::string
  GetName() const override
  {
    return std::string("BSplineTransform");
  }


  SITK_RETURN_SELF_TYPE_HEADER
  SetTransformDomainDirection(const std::vector<double> &);
  std::vector<double>
  GetTransformDomainDirection() const;
  SITK_RETURN_SELF_TYPE_HEADER
  SetTransformDomainMeshSize(const std::vector<unsigned int> &);
  std::vector<unsigned int>
  GetTransformDomainMeshSize() const;
  SITK_RETURN_SELF_TYPE_HEADER
  SetTransformDomainOrigin(const std::vector<double> &);
  std::vector<double>
  GetTransformDomainOrigin() const;
  SITK_RETURN_SELF_TYPE_HEADER
  SetTransformDomainPhysicalDimensions(const std::vector<double> &);
  std::vector<double>
  GetTransformDomainPhysicalDimensions() const;
 
  /* additional methods */

  std::vector<Image>
  GetCoefficientImages() const;
 
  unsigned int
  GetOrder() const;
 
protected:
  void
  SetPimpleTransform(std::unique_ptr<PimpleTransformBase> && pimpleTransform) override;
 
private:
  struct MyVisitor
  {
    itk::TransformBase * transform;
    BSplineTransform *   that;
    template <typename TransformType>
    void
    operator()() const
    {
      TransformType * t = dynamic_cast<TransformType *>(transform);
      if (t && (typeid(*t) == typeid(TransformType)))
      {
        that->InternalInitialization<TransformType>(t);
      }
    }
  };
 
  void
  InternalInitialization(itk::TransformBase * transform);
 
  template <typename TransformType>
  void
  InternalInitialization(TransformType * transform);
 
  static PimpleTransformBase *
  CreateBSplinePimpleTransform(unsigned int dimension, unsigned int order);
 
  template <unsigned int ND>
  static PimpleTransformBase *
  CreateBSplinePimpleTransform(unsigned int order);
 
  std::function<std::vector<double>()>                   m_pfGetTransformDomainDirection;
  std::function<void(const std::vector<double> &)>       m_pfSetTransformDomainDirection;
  std::function<std::vector<unsigned int>()>             m_pfGetTransformDomainMeshSize;
  std::function<void(const std::vector<unsigned int> &)> m_pfSetTransformDomainMeshSize;
  std::function<std::vector<double>()>                   m_pfGetTransformDomainOrigin;
  std::function<void(const std::vector<double> &)>       m_pfSetTransformDomainOrigin;
  std::function<std::vector<double>()>                   m_pfGetTransformDomainPhysicalDimensions;
  std::function<void(const std::vector<double> &)>       m_pfSetTransformDomainPhysicalDimensions;
 
  std::function<std::vector<Image>()> m_pfGetCoefficientImages;
  std::function<unsigned int()>       m_pfGetOrder;
 
  std::function<void(const std::vector<Image> &)> m_pfSetCoefficientImages;
};
 
} // namespace itk::simple
 
#endif // sitkBSplineTransform_h