itkReducedDimensionBSplineInterpolateImageFunction.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.
 *
 *=========================================================================*/
 
/*=========================================================================
 
  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkReducedDimBSplineInterpolateImageFunction.h,v $
  Language:  C++
  Date:      $Date: 2009-04-25 12:27:05 $
  Version:   $Revision: 1.24 $
 
  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
 
  Portions of this code are covered under the VTK copyright.
  See VTKCopyright.txt or http://www.kitware.com/VTKCopyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.
 
=========================================================================*/
#ifndef __itkReducedDimensionBSplineInterpolateImageFunction_h
#define __itkReducedDimensionBSplineInterpolateImageFunction_h
 
#include <vector>
 
#include "itkImageLinearIteratorWithIndex.h"
#include "itkInterpolateImageFunction.h"
#include "vnl/vnl_matrix.h"
 
#include "itkMultiOrderBSplineDecompositionImageFilter.h"
#include "itkConceptChecking.h"
#include "itkCovariantVector.h"
 
namespace itk
{
template<
class TImageType,
class TCoordRep        = double,
class TCoefficientType = double >
class ITK_EXPORT ReducedDimensionBSplineInterpolateImageFunction :
  public         InterpolateImageFunction< TImageType, TCoordRep >
{
public:
 
  typedef ReducedDimensionBSplineInterpolateImageFunction   Self;
  typedef InterpolateImageFunction< TImageType, TCoordRep > Superclass;
  typedef SmartPointer< Self >                              Pointer;
  typedef SmartPointer< const Self >                        ConstPointer;
 
  itkTypeMacro( ReducedDimensionBSplineInterpolateImageFunction, InterpolateImageFunction );
 
  itkNewMacro( Self );
 
  typedef typename Superclass::OutputType OutputType;
 
  using SizeType = typename TImageType::SizeType;
 
  typedef typename Superclass::InputImageType InputImageType;
 
  itkStaticConstMacro( ImageDimension, unsigned int, Superclass::ImageDimension );
 
  typedef typename Superclass::IndexType IndexType;
 
  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;
 
  typedef typename Superclass::PointType PointType;
 
  typedef ImageLinearIteratorWithIndex< TImageType > Iterator;
 
  typedef TCoefficientType CoefficientDataType;
  typedef Image< CoefficientDataType,
    itkGetStaticConstMacro( ImageDimension )
    >                      CoefficientImageType;
 
  typedef MultiOrderBSplineDecompositionImageFilter< TImageType, CoefficientImageType >
    CoefficientFilter;
 
  typedef typename CoefficientFilter::Pointer CoefficientFilterPointer;
 
  OutputType EvaluateAtContinuousIndex(
    const ContinuousIndexType & index ) const override;
 
  typedef CovariantVector< OutputType,
    itkGetStaticConstMacro( ImageDimension )
    > CovariantVectorType;
 
  CovariantVectorType EvaluateDerivative( const PointType & point ) const
  {
    ContinuousIndexType index;
    this->GetInputImage()->TransformPhysicalPointToContinuousIndex( point, index );
    return ( this->EvaluateDerivativeAtContinuousIndex( index ) );
  }
 
 
  CovariantVectorType EvaluateDerivativeAtContinuousIndex(
    const ContinuousIndexType & x ) const;
 
  void SetSplineOrder( unsigned int SplineOrder );
 
  itkGetConstMacro( SplineOrder, int );
 
  void SetInputImage( const TImageType * inputData ) override;
 
  itkSetMacro( UseImageDirection, bool );
  itkGetConstMacro( UseImageDirection, bool );
  itkBooleanMacro( UseImageDirection );
 
protected:
 
  ReducedDimensionBSplineInterpolateImageFunction();
  ~ReducedDimensionBSplineInterpolateImageFunction() override {}
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  // These are needed by the smoothing spline routine.
  std::vector< CoefficientDataType > m_Scratch;      // temp storage for processing of Coefficients
  typename TImageType::SizeType m_DataLength;        // Image size
  unsigned int m_SplineOrder;                        // User specified spline order (3rd or cubic is the default)
 
  typename CoefficientImageType::ConstPointer m_Coefficients;       // Spline coefficients
 
private:
 
  ReducedDimensionBSplineInterpolateImageFunction( const Self & ); //purposely not implemented
  void operator=( const Self & );                                  //purposely not implemented
 
  SizeType GetRadius() const override
  {
    return SizeType::Filled(m_SplineOrder + 1);
  }
 
  void SetInterpolationWeights( const ContinuousIndexType & x,
    const vnl_matrix< long > & EvaluateIndex,
    vnl_matrix< double > & weights,
    unsigned int splineOrder ) const;
 
  void SetDerivativeWeights( const ContinuousIndexType & x,
    const vnl_matrix< long > & EvaluateIndex,
    vnl_matrix< double > & weights,
    unsigned int splineOrder ) const;
 
  void GeneratePointsToIndex();
 
  void DetermineRegionOfSupport( vnl_matrix< long > & evaluateIndex,
    const ContinuousIndexType & x,
    unsigned int splineOrder ) const;
 
  void ApplyMirrorBoundaryConditions( vnl_matrix< long > & evaluateIndex,
    unsigned int splineOrder ) const;
 
  Iterator                 m_CIterator;                    // Iterator for traversing spline coefficients.
  unsigned long            m_MaxNumberInterpolationPoints; // number of neighborhood points used for interpolation
  std::vector< IndexType > m_PointsToIndex;                // Preallocation of interpolation neighborhood indicies
 
  CoefficientFilterPointer m_CoefficientFilter;
 
  // flag to take or not the image direction into account when computing the
  // derivatives.
  bool m_UseImageDirection;
 
};
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkReducedDimensionBSplineInterpolateImageFunction.hxx"
#endif
 
#endif