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:
  typedef TransformBaseTemplate    Self;
  typedef Object                   Superclass;
  typedef SmartPointer<Self>       Pointer;
  typedef SmartPointer<const Self> ConstPointer;

  typedef  TParametersValueType                          ParametersValueType;
  typedef  OptimizerParameters<ParametersValueType>      ParametersType;
  typedef  double                                        FixedParametersValueType;
  typedef  OptimizerParameters<FixedParametersValueType> FixedParametersType;

// The ITK_FIXED_PARAMETERS_ARE_DOUBLE is intended
// to facilitate transition of ITK for those very
// rare cases where multiple versions of ITK
// may need to be supported simultaneously.
#if defined( ITK_LEGACY_REMOVE )
  #undef  ITK_FIXED_PARAMETERS_ARE_DOUBLE
#else
  #define ITK_FIXED_PARAMETERS_ARE_DOUBLE
  // #if !defined(ITK_FIXED_PARAMETERS_ARE_DOUBLE)
  // typedef ParametersValueType FixedParametersValueType;
  // #endif
#endif

  itkTypeMacro(TransformBaseTemplate, Object);

  typedef IdentifierType      NumberOfParametersType;

  virtual NumberOfParametersType GetNumberOfParameters(void) const = 0;

  virtual const ParametersType & GetParameters(void) const = 0;

  virtual unsigned int GetInputSpaceDimension(void) const = 0;

  virtual unsigned int GetOutputSpaceDimension(void) 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:
  TransformBaseTemplate(){}
  virtual ~TransformBaseTemplate() ITK_OVERRIDE {}

private:
  ITK_DISALLOW_COPY_AND_ASSIGN(TransformBaseTemplate);
};

typedef TransformBaseTemplate< double > TransformBase;

} // end namespace itk

#endif