itkFiniteDifferenceSparseImageFunction.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkFiniteDifferenceSparseImageFunction.h,v $
  Language:  C++
  Date:      $Date: 2009-02-05 19:04:56 $
  Version:   $Revision: 1.9 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.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 __itkFiniteDifferenceSparseImageFunction_h
#define __itkFiniteDifferenceSparseImageFunction_h

#include "itkFiniteDifferenceFunction.h"

namespace itk {

template <class TSparseImageType>
class ITK_EXPORT FiniteDifferenceSparseImageFunction
  :public FiniteDifferenceFunction <TSparseImageType>
{
public:

  typedef FiniteDifferenceSparseImageFunction           Self;
  typedef FiniteDifferenceFunction<TSparseImageType>    Superclass;
  typedef SmartPointer<Self>                            Pointer;
  typedef SmartPointer<const Self>                      ConstPointer;

  itkTypeMacro( FiniteDifferenceSparseImageFunction, FiniteDifferenceFunction );

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

  typedef typename Superclass::PixelType        PixelType;
  typedef typename Superclass::TimeStepType     TimeStepType;
  typedef typename Superclass::RadiusType       RadiusType;
  typedef typename Superclass::NeighborhoodType NeighborhoodType;
  typedef typename Superclass::FloatOffsetType  FloatOffsetType;
  typedef typename Superclass::ImageType        SparseImageType;

  typedef typename SparseImageType::IndexType   IndexType;

  typedef typename SparseImageType::NodeType NodeType;

  typedef typename NodeType::NodeDataType    NodeDataType;

  virtual PixelType ComputeUpdate(const NeighborhoodType&,
                                  void*,
                                  const FloatOffsetType&)
    {
    return static_cast<PixelType>(0);
    }

  virtual NodeDataType
  ComputeSparseUpdate(NeighborhoodType &neighborhood,
                      void *globalData,
                      const FloatOffsetType &offset = FloatOffsetType(0.0))
    const = 0;

  virtual void PrecomputeSparseUpdate( NeighborhoodType& ) const {};

protected:
  FiniteDifferenceSparseImageFunction() {};
  ~FiniteDifferenceSparseImageFunction() {};
  void PrintSelf(std::ostream& os, Indent indent) const;
  
private:
  FiniteDifferenceSparseImageFunction(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkFiniteDifferenceSparseImageFunction.txx"
#endif

#endif