itkBSplineTransform.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 itkBSplineTransform_h
#define itkBSplineTransform_h

#include "itkBSplineBaseTransform.h"

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

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

  itkNewMacro( Self );

  itkTypeMacro( BSplineTransform, BSplineBaseTransform );

  static constexpr unsigned int SpaceDimension = NDimensions;

  static constexpr unsigned int SplineOrder = VSplineOrder;

  using ScalarType = typename Superclass::ScalarType;

  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 = typename Superclass::InputPointType;
  using OutputPointType = typename Superclass::OutputPointType;


  std::string GetTransformTypeAsString() const override;

  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 SetTransformDomainOrigin( const OriginType & );

  virtual OriginType GetTransformDomainOrigin( void ) const;

  virtual void SetTransformDomainPhysicalDimensions( const PhysicalDimensionsType & );

  virtual PhysicalDimensionsType GetTransformDomainPhysicalDimensions(void) const;

  virtual void SetTransformDomainDirection( const DirectionType & );

  virtual DirectionType GetTransformDomainDirection( void ) const;

  virtual void SetTransformDomainMeshSize( const MeshSizeType & );

  virtual MeshSizeType GetTransformDomainMeshSize( void ) const;

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

  BSplineTransform();
  ~BSplineTransform() override = default;

private:

  void SetCoefficientImageInformationFromFixedParameters() override;

  virtual void SetFixedParametersGridSizeFromTransformDomainInformation() const override { };
  virtual void SetFixedParametersGridOriginFromTransformDomainInformation() const override { };
  virtual void SetFixedParametersGridSpacingFromTransformDomainInformation() const override { }
  virtual void SetFixedParametersGridDirectionFromTransformDomainInformation() const override { };

  bool InsideValidRegion( ContinuousIndexType & ) const override;

  void SetFixedParametersFromCoefficientImageInformation();

  void SetFixedParametersFromTransformDomainInformation( const OriginType &meshOrigin,
                                                         const PhysicalDimensionsType & meshPhysical,
                                                         const DirectionType &meshDirection,
                                                         const MeshSizeType &meshSize);

}; // class BSplineTransform
}  // namespace itk

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

#endif /* itkBSplineTransform_h */