itkTransformBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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 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
{
template<typename TParametersValueType>
class TransformBaseTemplate:public Object
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(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>;

  itkTypeMacro(TransformBaseTemplate, Object);

  using NumberOfParametersType = IdentifierType;

  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;

  typedef enum {
    UnknownTransformCategory=0,
    Linear=1,
    BSpline=2,
    Spline=3,
    DisplacementField=4,
    VelocityField=5
  } TransformCategoryType;

  virtual TransformCategoryType GetTransformCategory() const = 0;

protected:

#if defined(__GNUC__) && __GNUC__ < 6
  // A bug in some versions of the gcc 5.4.0 compiler
  // result in a linker error when = default is requested
  TransformBaseTemplate() {};
  ~TransformBaseTemplate() override { };
#else
  TransformBaseTemplate() = default;
  ~TransformBaseTemplate() override = default;
#endif
};

using TransformBase = TransformBaseTemplate< double >;

} // end namespace itk

#endif