itkMultiOrderBSplineDecompositionImageFilter.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: itkMultiOrderBSplineDecompositionImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2010-03-19 07:06:01 $
  Version:   $Revision: 1.12 $
 
  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 __itkMultiOrderBSplineDecompositionImageFilter_h
#define __itkMultiOrderBSplineDecompositionImageFilter_h
 
#include <vector>
 
#include "itkImageLinearIteratorWithIndex.h"
#include "vnl/vnl_matrix.h"
 
#include "itkImageToImageFilter.h"
 
namespace itk
{
template< class TInputImage, class TOutputImage >
class ITK_EXPORT MultiOrderBSplineDecompositionImageFilter :
  public         ImageToImageFilter< TInputImage, TOutputImage >
{
public:
 
  typedef MultiOrderBSplineDecompositionImageFilter       Self;
  typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass;
  typedef SmartPointer< Self >                            Pointer;
  typedef SmartPointer< const Self >                      ConstPointer;
 
  itkTypeMacro( MultiOrderBSplineDecompositionImageFilter, ImageToImageFilter );
 
  itkNewMacro( Self );
 
  typedef typename Superclass::InputImageType         InputImageType;
  typedef typename Superclass::InputImagePointer      InputImagePointer;
  typedef typename Superclass::InputImageConstPointer InputImageConstPointer;
  typedef typename Superclass::OutputImagePointer     OutputImagePointer;
 
  typedef typename itk::NumericTraits< typename TOutputImage::PixelType >::RealType CoeffType;
 
  itkStaticConstMacro( ImageDimension, unsigned int, TInputImage::ImageDimension );
  itkStaticConstMacro( OutputImageDimension, unsigned int,
    TOutputImage::ImageDimension );
 
  typedef ImageLinearIteratorWithIndex< TOutputImage > OutputLinearIterator;
 
  void SetSplineOrder( unsigned int order );
 
  void SetSplineOrder( unsigned int dimension, unsigned int order );
 
  void GetSplineOrder( unsigned int dimension )
  {
    return m_SplineOrder[ dimension ];
  }
 
 
  //itkGetMacro( SplineOrder, unsigned int * );
 
#ifdef ITK_USE_CONCEPT_CHECKING
  itkConceptMacro( DimensionCheck,
    ( Concept::SameDimension< ImageDimension, OutputImageDimension > ) );
  itkConceptMacro( InputConvertibleToOutputCheck,
    ( Concept::Convertible< typename TInputImage::PixelType,
    typename TOutputImage::PixelType > ) );
  itkConceptMacro( DoubleConvertibleToOutputCheck,
    ( Concept::Convertible< double, typename TOutputImage::PixelType > ) );
#endif
 
protected:
 
  MultiOrderBSplineDecompositionImageFilter();
  ~MultiOrderBSplineDecompositionImageFilter() override {}
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  void GenerateData() override;
 
  void GenerateInputRequestedRegion() override;
 
  void EnlargeOutputRequestedRegion( DataObject * output ) override;
 
  std::vector< CoeffType > m_Scratch;             // temp storage for processing of Coefficients
  typename TInputImage::SizeType m_DataLength;    // Image size
 
  unsigned int m_SplineOrder[ ImageDimension ];            // User specified spline order per dimension (3rd or cubic is the default)
  double       m_SplinePoles[ 3 ];                         // Poles calculated for a given spline order
  int          m_NumberOfPoles;                            // number of poles
  double       m_Tolerance;                                // Tolerance used for determining initial causal coefficient
  unsigned int m_IteratorDirection;                        // Direction for iterator incrementing
 
private:
 
  MultiOrderBSplineDecompositionImageFilter( const Self & ); //purposely not implemented
  void operator=( const Self & );                            //purposely not implemented
 
  virtual void SetPoles( unsigned int dimension );
 
  virtual bool DataToCoefficients1D();
 
  void DataToCoefficientsND();
 
  virtual void SetInitialCausalCoefficient( double z );
 
  virtual void SetInitialAntiCausalCoefficient( double z );
 
  void CopyImageToImage();
 
  void CopyCoefficientsToScratch( OutputLinearIterator & );
 
  void CopyScratchToCoefficients( OutputLinearIterator & );
 
};
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkMultiOrderBSplineDecompositionImageFilter.hxx"
#endif
 
#endif