itkBSplineExponentialDiffeomorphicTransform.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 __itkBSplineExponentialDiffeomorphicTransform_h
#define __itkBSplineExponentialDiffeomorphicTransform_h

#include "itkConstantVelocityFieldTransform.h"
#include "itkDisplacementFieldToBSplineImageFilter.h"
#include "itkPointSet.h"

namespace itk
{

template<typename TScalar, unsigned int NDimensions>
class BSplineExponentialDiffeomorphicTransform :
  public ConstantVelocityFieldTransform<TScalar, NDimensions>
{
public:
  typedef BSplineExponentialDiffeomorphicTransform              Self;
  typedef ConstantVelocityFieldTransform<TScalar, NDimensions>  Superclass;
  typedef SmartPointer<Self>                                    Pointer;
  typedef SmartPointer<const Self>                              ConstPointer;

  itkTypeMacro( BSplineExponentialDiffeomorphicTransform, ConstantVelocityFieldTransform );

  itkNewMacro( Self );

  itkStaticConstMacro( ConstantVelocityFieldDimension, unsigned int, NDimensions );

  itkStaticConstMacro( Dimension, unsigned int, NDimensions );

  typedef typename Superclass::ScalarType               ScalarType;
  typedef typename Superclass::DerivativeType           DerivativeType;
  typedef typename DerivativeType::ValueType            DerivativeValueType;

  typedef typename Superclass::DisplacementFieldType        DisplacementFieldType;
  typedef typename Superclass::DisplacementFieldPointer     DisplacementFieldPointer;
  typedef typename Superclass::ConstantVelocityFieldType    ConstantVelocityFieldType;
  typedef typename Superclass::ConstantVelocityFieldPointer ConstantVelocityFieldPointer;

  typedef typename DisplacementFieldType::PixelType     DisplacementVectorType;

  typedef PointSet<ConstantVelocityFieldType, Dimension>            PointSetType;
  typedef unsigned int                                              SplineOrderType;
  typedef DisplacementFieldToBSplineImageFilter
    <ConstantVelocityFieldType, ConstantVelocityFieldType>          BSplineFilterType;
  typedef typename BSplineFilterType::WeightsContainerType          WeightsContainerType;
  typedef typename BSplineFilterType::ArrayType                     ArrayType;
  typedef typename ArrayType::ValueType                             ArrayValueType;

  virtual void UpdateTransformParameters( const DerivativeType & update, ScalarType factor = 1.0 );

  virtual ConstantVelocityFieldPointer BSplineSmoothConstantVelocityField( const ConstantVelocityFieldType *, const ArrayType & );

  itkSetMacro( SplineOrder, SplineOrderType );
  itkGetConstMacro( SplineOrder, SplineOrderType );

  itkSetMacro( NumberOfControlPointsForTheConstantVelocityField, ArrayType );
  itkGetConstMacro( NumberOfControlPointsForTheConstantVelocityField, ArrayType );

  itkSetMacro( NumberOfControlPointsForTheUpdateField, ArrayType );
  itkGetConstMacro( NumberOfControlPointsForTheUpdateField, ArrayType );

  void SetMeshSizeForTheConstantVelocityField( const ArrayType & );

  void SetMeshSizeForTheUpdateField( const ArrayType & );

protected:
  BSplineExponentialDiffeomorphicTransform();
  virtual ~BSplineExponentialDiffeomorphicTransform();

  void PrintSelf( std::ostream &, Indent ) const;

private:
  BSplineExponentialDiffeomorphicTransform( const Self& ); //purposely not implemented
  void operator=( const Self& ); //purposely not implemented

  ArrayType                               m_NumberOfControlPointsForTheConstantVelocityField;
  ArrayType                               m_NumberOfControlPointsForTheUpdateField;

  SplineOrderType                         m_SplineOrder;
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
# include "itkBSplineExponentialDiffeomorphicTransform.hxx"
#endif

#endif // __itkBSplineExponentialDiffeomorphicTransform_h