itkBSplineInterpolationWeightFunction.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 itkBSplineInterpolationWeightFunction_h
#define itkBSplineInterpolationWeightFunction_h

#include "itkFunctionBase.h"
#include "itkContinuousIndex.h"
#include "itkBSplineKernelFunction.h"
#include "itkArray.h"
#include "itkArray2D.h"

namespace itk
{
template<
  typename TCoordRep = float,
  unsigned int VSpaceDimension = 2,
  unsigned int VSplineOrder = 3
  >
class ITK_TEMPLATE_EXPORT BSplineInterpolationWeightFunction:
  public FunctionBase< ContinuousIndex< TCoordRep, VSpaceDimension >,
                       Array< double > >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(BSplineInterpolationWeightFunction);

  using Self = BSplineInterpolationWeightFunction;
  using Superclass = FunctionBase< ContinuousIndex< TCoordRep, VSpaceDimension >,
                        Array< double > >;

  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(BSplineInterpolationWeightFunction, FunctionBase);

  static constexpr unsigned int SpaceDimension = VSpaceDimension;

  static constexpr unsigned int SplineOrder = VSplineOrder;

  using WeightsType = Array< double >;

  using IndexType = Index< VSpaceDimension >;
  using SizeType = Size< VSpaceDimension >;

  using ContinuousIndexType = ContinuousIndex< TCoordRep, VSpaceDimension >;

  WeightsType Evaluate(const ContinuousIndexType & index) const override;

  virtual void Evaluate(const ContinuousIndexType & index,
                        WeightsType & weights, IndexType & startIndex) const;

  itkGetConstMacro(SupportSize, SizeType);

  itkGetConstMacro(NumberOfWeights, unsigned int);

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

private:
  unsigned int m_NumberOfWeights;

  SizeType m_SupportSize;

  using TableType = Array2D< unsigned int >;

  TableType m_OffsetToIndexTable;

  using KernelType = BSplineKernelFunction< Self::SplineOrder >;

  typename KernelType::Pointer m_Kernel;
};
} // end namespace itk

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

#endif