itkTransformBase.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 itkTransformBase_h
#define itkTransformBase_h
 
#include "ITKTransformExport.h"
 
#include "itkObject.h"
#include "itkPoint.h"
#include "itkCovariantVector.h"
#include "vnl/vnl_vector_fixed.h"
#include "itkArray2D.h"
#include "itkOptimizerParameters.h"
 
#include "itkObjectFactory.h"
#include "itkIntTypes.h"
 
namespace itk
{
class TransformBaseTemplateEnums
{
public:
  enum class TransformCategory : uint8_t
  {
    UnknownTransformCategory = 0,
    Linear = 1,
    BSpline = 2,
    Spline = 3,
    DisplacementField = 4,
    VelocityField = 5
  };
};
// Define how to print enumeration
extern ITKTransform_EXPORT std::ostream &
                           operator<<(std::ostream & out, const TransformBaseTemplateEnums::TransformCategory value);
 
  enum class TransformCategory : uint8_t
  {
    UnknownTransformCategory = 0,
    Linear = 1,
    BSpline = 2,
    Spline = 3,
    DisplacementField = 4,
    VelocityField = 5
  };
};
// Define how to print enumeration
extern ITKTransform_EXPORT std::ostream &
                           operator<<(std::ostream & out, const TransformBaseTemplateEnums::TransformCategory value);
 *
 * This class is an abstract class to represent a spatial transform.
 *
 * This class is templated over the scalar type used to store the transform's
 * parameters.
 *
 * \ingroup ITKTransform
 */
template <typename TParametersValueType>
class TransformBaseTemplate : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(TransformBaseTemplate);
  using Self = TransformBaseTemplate;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using ParametersValueType = TParametersValueType;
  using ParametersType = OptimizerParameters<ParametersValueType>;
  using FixedParametersValueType = double;
  using FixedParametersType = OptimizerParameters<FixedParametersValueType>;
 
  itkOverrideGetNameOfClassMacro(TransformBaseTemplate);
 
  using NumberOfParametersType = IdentifierType;
 
  /* For storing the  name of InputSpace */
  itkSetMacro(InputSpaceName, std::string);
  itkGetConstReferenceMacro(InputSpaceName, std::string);
 
  itkSetMacro(OutputSpaceName, std::string);
  itkGetConstReferenceMacro(OutputSpaceName, std::string);
 
  virtual NumberOfParametersType
  GetNumberOfParameters() const = 0;
 
  virtual const ParametersType &
  GetParameters() const = 0;
 
  virtual unsigned int
  GetInputSpaceDimension() const = 0;
 
  virtual unsigned int
  GetOutputSpaceDimension() const = 0;
 
  virtual void
  SetParameters(const ParametersType &) = 0;
 
  virtual void
  SetParametersByValue(const ParametersType & p) = 0;
 
  virtual void
  SetFixedParameters(const FixedParametersType &) = 0;
 
  virtual void
  CopyInParameters(const ParametersValueType * const begin, const ParametersValueType * const end) = 0;
 
  virtual void
  CopyInFixedParameters(const FixedParametersValueType * const begin, const FixedParametersValueType * const end) = 0;
 
  virtual const FixedParametersType &
  GetFixedParameters() const = 0;
 
  virtual std::string
  GetTransformTypeAsString() const = 0;
 
  using TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory;
#if !defined(ITK_LEGACY_REMOVE)
  // We need to expose the enum values at the class level
  // for backwards compatibility
  static constexpr TransformCategoryEnum UnknownTransformCategory = TransformCategoryEnum::UnknownTransformCategory;
  static constexpr TransformCategoryEnum Linear = TransformCategoryEnum::Linear;
  static constexpr TransformCategoryEnum BSpline = TransformCategoryEnum::BSpline;
  static constexpr TransformCategoryEnum Spline = TransformCategoryEnum::Spline;
  static constexpr TransformCategoryEnum DisplacementField = TransformCategoryEnum::DisplacementField;
  static constexpr TransformCategoryEnum VelocityField = TransformCategoryEnum::VelocityField;
 
  // Preserve old type name for backwards compatibility
  using TransformCategoryType = TransformCategoryEnum;
#endif
 
  virtual TransformCategoryEnum
  GetTransformCategory() const = 0;
 
protected:
  TransformBaseTemplate() = default;
  ~TransformBaseTemplate() override = default;
 
private:
  std::string m_InputSpaceName{};
  std::string m_OutputSpaceName{};
};
 
using TransformBase = TransformBaseTemplate<double>;
} // end namespace itk
 
#endif