itkBSplineDeformableTransform.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 itkBSplineDeformableTransform_h
#define itkBSplineDeformableTransform_h

#include "itkBSplineBaseTransform.h"

namespace itk
{
template<typename TParametersValueType=double,
          unsigned int NDimensions = 3,
          unsigned int VSplineOrder = 3>
class ITK_TEMPLATE_EXPORT BSplineDeformableTransform :
  public BSplineBaseTransform<TParametersValueType,NDimensions,VSplineOrder>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(BSplineDeformableTransform);

  using Self = BSplineDeformableTransform;
  using Superclass = BSplineBaseTransform<TParametersValueType,NDimensions,VSplineOrder>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  // Explicit New() method, used here because we need to split the itkNewMacro()
  // in order to overload the CreateAnother() method so that we can copy the m_BulkTransform
  // explicitly.
  // TODO: shouldn't it be done with the Clone() method?
  itkSimpleNewMacro(Self);
  ::itk::LightObject::Pointer CreateAnother() const override
    {
    ::itk::LightObject::Pointer smartPtr;
    Pointer copyPtr = Self::New().GetPointer();
    //THE FOLLOWING LINE IS DIFFERENT FROM THE DEFAULT MACRO!
    copyPtr->m_BulkTransform =  this->GetBulkTransform();
    smartPtr = static_cast<Pointer>( copyPtr );
    return smartPtr;
    }

  itkCloneMacro(Self);

  itkTypeMacro( BSplineDeformableTransform, BSplineBaseTransform );

  static constexpr unsigned int SpaceDimension = NDimensions;

  static constexpr unsigned int SplineOrder = VSplineOrder;

  using ScalarType = TParametersValueType;

  using ParametersType = typename Superclass::ParametersType;
  using ParametersValueType = typename Superclass::ParametersValueType;
  using FixedParametersType = typename Superclass::FixedParametersType;
  using FixedParametersValueType = typename Superclass::FixedParametersValueType;

  using JacobianType = typename Superclass::JacobianType;
  using JacobianPositionType = typename Superclass::JacobianPositionType;
  using InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType;

  using NumberOfParametersType = typename Superclass::NumberOfParametersType;

  using InputVectorType = typename Superclass::InputVectorType;
  using OutputVectorType = typename Superclass::OutputVectorType;

  using InputCovariantVectorType = typename Superclass::InputCovariantVectorType;
  using OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType;

  using InputVnlVectorType = typename Superclass::InputVnlVectorType;
  using OutputVnlVectorType = typename Superclass::OutputVnlVectorType;

  using InputPointType = Point <TParametersValueType, Self::SpaceDimension >;
  using OutputPointType = Point <TParametersValueType, Self::SpaceDimension >;


  void SetFixedParameters( const FixedParametersType & parameters ) override;

  using ImageType = typename Superclass::ImageType;
  using ImagePointer = typename Superclass::ImagePointer;
  using CoefficientImageArray = typename Superclass::CoefficientImageArray;

  void SetCoefficientImages( const CoefficientImageArray & images ) override;

  using RegionType = typename Superclass::RegionType;

  using IndexType = typename Superclass::IndexType;
  using SizeType = typename Superclass::SizeType;
  using SpacingType = typename Superclass::SpacingType;
  using DirectionType = typename Superclass::DirectionType;
  using OriginType = typename Superclass::OriginType;

  using WeightsFunctionType = typename Superclass::WeightsFunctionType;

  using WeightsType = typename Superclass::WeightsType;
  using ContinuousIndexType = typename Superclass::ContinuousIndexType;

  using ParameterIndexArrayType = typename Superclass::ParameterIndexArrayType;

  using Superclass::TransformPoint;
  void TransformPoint( const InputPointType & inputPoint, OutputPointType & outputPoint,
    WeightsType & weights, ParameterIndexArrayType & indices, bool & inside ) const override;

  void ComputeJacobianWithRespectToParameters( const InputPointType &, JacobianType & ) const override;

  NumberOfParametersType GetNumberOfParameters() const override;

  NumberOfParametersType GetNumberOfParametersPerDimension() const override;

  using PhysicalDimensionsType = typename Superclass::SpacingType;
  using PixelType = typename Superclass::PixelType;

  using MeshSizeType = typename Superclass::MeshSizeType;

  virtual void SetGridOrigin( const OriginType & );

  itkGetConstMacro( GridOrigin, OriginType );

  virtual void SetGridSpacing( const SpacingType & );

  itkGetConstMacro( GridSpacing, SpacingType );

  virtual void SetGridDirection( const DirectionType & );

  itkGetConstMacro( GridDirection, DirectionType );

  virtual void SetGridRegion( const RegionType & );

  itkGetConstMacro( GridRegion, RegionType );

  using BulkTransformType = Transform<TParametersValueType,
                    Self::SpaceDimension,
                    Self::SpaceDimension>;
  using BulkTransformPointer = typename BulkTransformType::ConstPointer;
  itkSetConstObjectMacro(BulkTransform, BulkTransformType);
  itkGetConstObjectMacro(BulkTransform, BulkTransformType);

  itkGetConstReferenceMacro(ValidRegion, RegionType);

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

  BSplineDeformableTransform();
  ~BSplineDeformableTransform() override = default;

private:

  void SetFixedParametersGridSizeFromTransformDomainInformation() const override;

  void SetFixedParametersGridOriginFromTransformDomainInformation() const override;

  void SetFixedParametersGridSpacingFromTransformDomainInformation() const override;

  void SetFixedParametersGridDirectionFromTransformDomainInformation() const override;

  void SetCoefficientImageInformationFromFixedParameters() override;

  bool InsideValidRegion( ContinuousIndexType & ) const override;

  const RegionType &    m_GridRegion;
  const OriginType &    m_GridOrigin;
  const SpacingType &   m_GridSpacing;
  const DirectionType & m_GridDirection;

  BulkTransformPointer m_BulkTransform;

  RegionType m_ValidRegion;

  unsigned long m_Offset;
  bool          m_SplineOrderOdd;
  IndexType     m_ValidRegionLast;
  IndexType     m_ValidRegionFirst;

  void UpdateValidGridRegion();

}; // class BSplineDeformableTransform
}  // namespace itk

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

#endif /* itkBSplineDeformableTransform_h */