itkBSplineSmoothingOnUpdateDisplacementFieldTransform.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 itkBSplineSmoothingOnUpdateDisplacementFieldTransform_h
#define itkBSplineSmoothingOnUpdateDisplacementFieldTransform_h

#include "itkDisplacementFieldTransform.h"

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

namespace itk
{

template<typename TParametersValueType, unsigned int NDimensions>
class BSplineSmoothingOnUpdateDisplacementFieldTransform :
  public DisplacementFieldTransform<TParametersValueType, NDimensions>
{
public:
  typedef BSplineSmoothingOnUpdateDisplacementFieldTransform            Self;
  typedef DisplacementFieldTransform<TParametersValueType, NDimensions> Superclass;
  typedef SmartPointer<Self>                                            Pointer;
  typedef SmartPointer<const Self>                                      ConstPointer;

  itkTypeMacro( BSplineSmoothingOnUpdateDisplacementFieldTransform, DisplacementFieldTransform );

  itkNewMacro( Self );

  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::DisplacementFieldConstPointer DisplacementFieldConstPointer;

  typedef typename Transform<TParametersValueType,NDimensions, NDimensions>::Pointer
             TransformPointer;

  typedef typename DisplacementFieldType::PixelType                            DisplacementVectorType;
  typedef PointSet<DisplacementVectorType, Dimension>                          PointSetType;
  typedef unsigned int                                                         SplineOrderType;
  typedef DisplacementFieldToBSplineImageFilter<DisplacementFieldType>         BSplineFilterType;
  typedef typename BSplineFilterType::WeightsContainerType                     WeightsContainerType;
  typedef DisplacementFieldType                                                DisplacementFieldControlPointLatticeType;
  typedef typename BSplineFilterType::ArrayType                                ArrayType;
  typedef typename ArrayType::ValueType                                        ArrayValueType;

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

  itkSetMacro( SplineOrder, SplineOrderType );

  itkGetConstMacro( SplineOrder, SplineOrderType );

  itkSetMacro( NumberOfControlPointsForTheUpdateField, ArrayType );

  itkGetConstMacro( NumberOfControlPointsForTheUpdateField, ArrayType );

  void SetMeshSizeForTheUpdateField( const ArrayType & );

  itkSetMacro( NumberOfControlPointsForTheTotalField, ArrayType );

  itkGetConstMacro( NumberOfControlPointsForTheTotalField, ArrayType );

  void SetMeshSizeForTheTotalField( const ArrayType & );

  itkBooleanMacro( EnforceStationaryBoundary );
  itkSetMacro( EnforceStationaryBoundary, bool );
  itkGetConstMacro( EnforceStationaryBoundary, bool );

protected:
  BSplineSmoothingOnUpdateDisplacementFieldTransform();
  virtual ~BSplineSmoothingOnUpdateDisplacementFieldTransform();

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

  virtual typename LightObject::Pointer InternalClone() const ITK_OVERRIDE;

   DisplacementFieldPointer BSplineSmoothDisplacementField( const DisplacementFieldType *, const ArrayType & );

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

  SplineOrderType             m_SplineOrder;
  bool                        m_EnforceStationaryBoundary;
  ArrayType                   m_NumberOfControlPointsForTheUpdateField;
  ArrayType                   m_NumberOfControlPointsForTheTotalField;
};

} // end namespace itk

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

#endif // itkBSplineSmoothingOnUpdateDisplacementFieldTransform_h