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<
  class TCoordRep = float,
  unsigned int VSpaceDimension = 2,
  unsigned int VSplineOrder = 3
  >
class ITK_EXPORT BSplineInterpolationWeightFunction:
  public FunctionBase< ContinuousIndex< TCoordRep, VSpaceDimension >,
                       Array< double > >
{
public:
  typedef BSplineInterpolationWeightFunction Self;
  typedef FunctionBase< ContinuousIndex< TCoordRep, VSpaceDimension >,
                        Array< double > >                  Superclass;

  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(BSplineInterpolationWeightFunction, FunctionBase);

  itkStaticConstMacro(SpaceDimension, unsigned int, VSpaceDimension);

  itkStaticConstMacro(SplineOrder, unsigned int, VSplineOrder);

  typedef Array< double > WeightsType;

  typedef Index< VSpaceDimension > IndexType;
  typedef Size< VSpaceDimension >  SizeType;

  typedef ContinuousIndex< TCoordRep, VSpaceDimension > ContinuousIndexType;

  virtual WeightsType Evaluate(const ContinuousIndexType & index) const;

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

  itkGetConstMacro(SupportSize, SizeType);

  itkGetConstMacro(NumberOfWeights, unsigned long);

protected:
  BSplineInterpolationWeightFunction();
  ~BSplineInterpolationWeightFunction() {}
  void PrintSelf(std::ostream & os, Indent indent) const;

private:
  BSplineInterpolationWeightFunction(const Self &); //purposely not implemented
  void operator=(const Self &);                     //purposely not implemented

  unsigned long m_NumberOfWeights;

  SizeType m_SupportSize;

  typedef Array2D< unsigned long > TableType;

  TableType m_OffsetToIndexTable;

  typedef BSplineKernelFunction< itkGetStaticConstMacro(SplineOrder) > KernelType;

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

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

#endif