itkBSplineInterpolationWeightFunctionBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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 __itkBSplineInterpolationWeightFunctionBase_h
#define __itkBSplineInterpolationWeightFunctionBase_h
 
#include "itkFunctionBase.h"
#include "itkContinuousIndex.h"
#include "itkArray.h"
#include "itkArray2D.h"
#include "itkMatrix.h"
#include "itkBSplineKernelFunction2.h"
#include "itkBSplineDerivativeKernelFunction.h"
#include "itkBSplineSecondOrderDerivativeKernelFunction2.h"
 
namespace itk
{
 
template< unsigned int SplineOrder, unsigned int Dimension >
class GetConstNumberOfWeightsHack
{
public:
 
  typedef GetConstNumberOfWeightsHack< SplineOrder, Dimension - 1 > OneDimensionLess;
  itkStaticConstMacro( Value, unsigned long, ( SplineOrder + 1 ) * OneDimensionLess::Value );
};
 
template< unsigned int SplineOrder >
class GetConstNumberOfWeightsHack< SplineOrder, 0 >
{
public:
 
  itkStaticConstMacro( Value, unsigned long, 1 );
};
 
template< class TCoordRep    = float,
unsigned int VSpaceDimension = 2,
unsigned int VSplineOrder    = 3 >
class BSplineInterpolationWeightFunctionBase :
  public FunctionBase< ContinuousIndex< TCoordRep, VSpaceDimension >, Array< double > >
{
public:
 
  typedef BSplineInterpolationWeightFunctionBase Self;
  typedef FunctionBase<
    ContinuousIndex< TCoordRep, VSpaceDimension >,
    Array< double > >                               Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;
 
  itkTypeMacro( BSplineInterpolationWeightFunctionBase, FunctionBase );
 
  itkStaticConstMacro( SpaceDimension, unsigned int, VSpaceDimension );
 
  itkStaticConstMacro( SplineOrder, unsigned int, VSplineOrder );
 
  typedef GetConstNumberOfWeightsHack<
    itkGetStaticConstMacro( SplineOrder ),
    itkGetStaticConstMacro( SpaceDimension ) > GetConstNumberOfWeightsHackType;
  itkStaticConstMacro( NumberOfWeights, unsigned long, GetConstNumberOfWeightsHackType::Value );
 
  typedef Array< double > WeightsType;
 
  typedef Index< VSpaceDimension > IndexType;
  typedef Size< VSpaceDimension >  SizeType;
 
  typedef ContinuousIndex< TCoordRep, VSpaceDimension > ContinuousIndexType;
 
  WeightsType Evaluate( const ContinuousIndexType & index ) const override;
 
  virtual void Evaluate( const ContinuousIndexType & cindex,
    const IndexType & startIndex, WeightsType & weights ) const;
 
  void ComputeStartIndex( const ContinuousIndexType & index,
    IndexType & startIndex ) const;
 
  itkGetConstReferenceMacro( SupportSize, SizeType );
 
  itkGetConstMacro( NumberOfWeights, unsigned long );
 
protected:
 
  BSplineInterpolationWeightFunctionBase();
  ~BSplineInterpolationWeightFunctionBase() override {}
 
  typedef BSplineKernelFunction2< Self::SplineOrder >                      KernelType;
  typedef typename KernelType::Pointer                                     KernelPointer;
  typedef BSplineDerivativeKernelFunction< Self::SplineOrder >             DerivativeKernelType;
  typedef typename DerivativeKernelType::Pointer                           DerivativeKernelPointer;
  typedef BSplineSecondOrderDerivativeKernelFunction2< Self::SplineOrder > SecondOrderDerivativeKernelType;
  typedef typename SecondOrderDerivativeKernelType::Pointer                SecondOrderDerivativeKernelPointer;
  typedef typename KernelType::WeightArrayType                             WeightArrayType;
 
  typedef Array2D< unsigned long > TableType;
 
  typedef Matrix< double,
    itkGetStaticConstMacro( SpaceDimension ),
    itkGetStaticConstMacro( SplineOrder ) + 1 > OneDWeightsType;
 
  virtual void Compute1DWeights(
    const ContinuousIndexType & index,
    const IndexType & startIndex,
    OneDWeightsType & weights1D ) const = 0;
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  unsigned long m_NumberOfWeights;
  SizeType      m_SupportSize;
  TableType     m_OffsetToIndexTable;
 
  typename KernelType::Pointer m_Kernel;
  typename DerivativeKernelType::Pointer m_DerivativeKernel;
  typename SecondOrderDerivativeKernelType::Pointer m_SecondOrderDerivativeKernel;
 
private:
 
  BSplineInterpolationWeightFunctionBase( const Self & ); // purposely not implemented
  void operator=( const Self & );                         // purposely not implemented
 
  void InitializeSupport( void );
 
  void InitializeOffsetToIndexTable( void );
 
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkBSplineInterpolationWeightFunctionBase.hxx"
#endif
 
#endif