itkBSplineControlPointImageFunction.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 itkBSplineControlPointImageFunction_h
#define itkBSplineControlPointImageFunction_h

#include "itkImageFunction.h"

#include "itkBSplineKernelFunction.h"
#include "itkCoxDeBoorBSplineKernelFunction.h"
#include "itkFixedArray.h"
#include "itkImage.h"
#include "itkPointSet.h"
#include "itkVariableSizeMatrix.h"
#include "itkVector.h"
#include "itkVectorContainer.h"

#include "vnl/vnl_matrix.h"
#include "vnl/vnl_vector.h"

namespace itk
{
template <typename TInputImage, typename TCoordRep = double>
class BSplineControlPointImageFunction
: public ImageFunction<TInputImage, typename TInputImage::PixelType, TCoordRep>
{
public:
  typedef BSplineControlPointImageFunction              Self;
  typedef ImageFunction<TInputImage,
    typename TInputImage::PixelType, TCoordRep>         Superclass;
  typedef SmartPointer<Self>                            Pointer;
  typedef SmartPointer<const Self>                      ConstPointer;

  itkNewMacro(Self);

  itkStaticConstMacro( ImageDimension, unsigned int, TInputImage::ImageDimension );

  typedef TInputImage                         ControlPointLatticeType;
  typedef TInputImage                         InputImageType;
  typedef TCoordRep                           CoordRepType;
  typedef typename InputImageType::PixelType  PixelType;
  typedef typename InputImageType::RegionType RegionType;
  typedef typename InputImageType::IndexType  IndexType;
  typedef typename Superclass::PointType      PointType;
  typedef typename InputImageType::RegionType InputImageRegionType;

  typedef typename InputImageType::SpacingType   SpacingType;
  typedef typename InputImageType::PointType     OriginType;
  typedef typename InputImageType::SizeType      SizeType;

  typedef PixelType                           OutputType;
  typedef VariableSizeMatrix<CoordRepType>    GradientType;
  typedef VariableSizeMatrix<CoordRepType>    HessianComponentType;

  typedef FixedArray<unsigned, ImageDimension>       ArrayType;
  typedef Image<CoordRepType, ImageDimension>        RealImageType;
  typedef typename RealImageType::Pointer            RealImagePointer;
  typedef typename Superclass::ContinuousIndexType   ContinuousIndexType;

  typedef CoxDeBoorBSplineKernelFunction<3> KernelType;
  typedef BSplineKernelFunction<0>          KernelOrder0Type;
  typedef BSplineKernelFunction<1>          KernelOrder1Type;
  typedef BSplineKernelFunction<2>          KernelOrder2Type;
  typedef BSplineKernelFunction<3>          KernelOrder3Type;

  virtual void SetInputImage( const InputImageType * ) ITK_OVERRIDE;

  void SetSplineOrder( const unsigned int );

  void SetSplineOrder( const ArrayType & );

  itkGetConstReferenceMacro( SplineOrder, ArrayType );

  itkSetMacro( CloseDimension, ArrayType );

  itkGetConstReferenceMacro( CloseDimension, ArrayType );

  itkSetMacro( Spacing, SpacingType );

  itkGetConstMacro( Spacing, SpacingType );

  itkSetMacro( Origin, OriginType );

  itkGetConstMacro( Origin, OriginType );

  itkSetMacro( Size, SizeType );

  itkGetConstMacro( Size, SizeType );

  OutputType EvaluateAtParametricPoint( const PointType & ) const;

  virtual OutputType EvaluateAtIndex( const IndexType & ) const ITK_OVERRIDE;

  virtual OutputType EvaluateAtContinuousIndex(
    const ContinuousIndexType & ) const ITK_OVERRIDE;

  virtual OutputType Evaluate( const PointType & ) const ITK_OVERRIDE;

  GradientType EvaluateGradientAtParametricPoint( const PointType & ) const;

  GradientType EvaluateGradientAtIndex( const IndexType & ) const;

  GradientType EvaluateGradientAtContinuousIndex(
    const ContinuousIndexType & ) const;

  GradientType EvaluateGradient( const PointType & ) const;

  HessianComponentType EvaluateHessianAtParametricPoint(
    const PointType &, const unsigned int ) const;

  HessianComponentType EvaluateHessianAtIndex(
    const IndexType &, const unsigned int ) const;

  HessianComponentType EvaluateHessianAtContinuousIndex(
    const ContinuousIndexType &, const unsigned int ) const;

  HessianComponentType EvaluateHessian(
    const PointType &, const unsigned int ) const;

protected:
  BSplineControlPointImageFunction();
  virtual ~BSplineControlPointImageFunction();
  void PrintSelf( std::ostream& os, Indent indent ) const ITK_OVERRIDE;

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

  SizeType                                     m_Size;
  SpacingType                                  m_Spacing;
  OriginType                                   m_Origin;

  ArrayType                                    m_NumberOfControlPoints;
  ArrayType                                    m_CloseDimension;
  ArrayType                                    m_SplineOrder;

  RealImagePointer                             m_NeighborhoodWeightImage;

  typename KernelType::Pointer                 m_Kernel[ImageDimension];
  typename KernelOrder0Type::Pointer           m_KernelOrder0;
  typename KernelOrder1Type::Pointer           m_KernelOrder1;
  typename KernelOrder2Type::Pointer           m_KernelOrder2;
  typename KernelOrder3Type::Pointer           m_KernelOrder3;

  CoordRepType                                 m_BSplineEpsilon;

};

} // end namespace itk

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

#endif