itkCoxDeBoorBSplineKernelFunction.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 itkCoxDeBoorBSplineKernelFunction_h
#define itkCoxDeBoorBSplineKernelFunction_h

#include "itkKernelFunctionBase.h"
#include "vnl/vnl_real_polynomial.h"
#include "vnl/vnl_matrix.h"

namespace itk
{
template<unsigned int VSplineOrder = 3, typename TRealValueType = double>
class ITK_TEMPLATE_EXPORT CoxDeBoorBSplineKernelFunction:
  public KernelFunctionBase<TRealValueType>
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(CoxDeBoorBSplineKernelFunction);

  using Self = CoxDeBoorBSplineKernelFunction;
  using Superclass = KernelFunctionBase<TRealValueType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using RealType = typename Superclass::RealType;

  itkNewMacro( Self );

  itkTypeMacro( CoxDeBoorBSplineKernelFunction, KernelFunctionBase );

  using VectorType = vnl_vector<TRealValueType>;
  using PolynomialType = vnl_real_polynomial;
  using MatrixType = vnl_matrix<TRealValueType>;

  void SetSplineOrder( const unsigned int );

  itkGetConstMacro( SplineOrder, unsigned int );

  TRealValueType Evaluate( const TRealValueType & ) const override;

  TRealValueType EvaluateDerivative( const TRealValueType & ) const;

  TRealValueType EvaluateNthDerivative( const TRealValueType &, const unsigned int ) const;

  MatrixType GetShapeFunctions();

  MatrixType GetShapeFunctionsInZeroToOneInterval();

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

private:
  void GenerateBSplineShapeFunctions( const unsigned int );

  PolynomialType CoxDeBoor( const unsigned short, const VectorType,
    const unsigned int, const unsigned int );

  MatrixType                       m_BSplineShapeFunctions;
  unsigned int                     m_SplineOrder;
};
} // end namespace itk

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

#endif