itkFiniteDifferenceFunction.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 __itkFiniteDifferenceFunction_h
#define __itkFiniteDifferenceFunction_h

#include "itkLightObject.h"
#include "itkConstNeighborhoodIterator.h"
#include "itkVector.h"

namespace itk
{
template< class TImageType >
class ITK_EXPORT FiniteDifferenceFunction:public LightObject
{
public:

  typedef FiniteDifferenceFunction   Self;
  typedef LightObject                Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkTypeMacro(FiniteDifferenceFunction, LightObject);

  typedef TImageType                    ImageType;
  typedef typename ImageType::PixelType PixelType;
  typedef double                        PixelRealType;

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

  typedef double TimeStepType;

  typedef ZeroFluxNeumannBoundaryCondition< ImageType >
  DefaultBoundaryConditionType;

  typedef typename ConstNeighborhoodIterator< TImageType >::RadiusType RadiusType;

  typedef ConstNeighborhoodIterator< TImageType, DefaultBoundaryConditionType > NeighborhoodType;

  typedef Vector< PixelRealType, itkGetStaticConstMacro(ImageDimension) > NeighborhoodScalesType;

  typedef Vector< float, itkGetStaticConstMacro(ImageDimension) > FloatOffsetType;

  virtual void InitializeIteration() {}

#if !defined( CABLE_CONFIGURATION )
  virtual PixelType  ComputeUpdate( const NeighborhoodType & neighborhood,
                                    void *globalData,
                                    const FloatOffsetType & offset = FloatOffsetType(0.0) ) = 0;

#endif

  void SetRadius(const RadiusType & r);

  const RadiusType & GetRadius() const;

  void SetScaleCoefficients(PixelRealType vals[ImageDimension]);

  const NeighborhoodScalesType ComputeNeighborhoodScales() const;

  virtual TimeStepType ComputeGlobalTimeStep(void *GlobalData) const = 0;

  virtual void * GetGlobalDataPointer() const = 0;

  virtual void ReleaseGlobalDataPointer(void *GlobalData) const = 0;

protected:
  FiniteDifferenceFunction();
  ~FiniteDifferenceFunction() {}

  void PrintSelf(std::ostream & os, Indent indent) const;

  RadiusType m_Radius;
  PixelRealType m_ScaleCoefficients[ImageDimension];
private:
  FiniteDifferenceFunction(const Self &); //purposely not implemented
  void operator=(const Self &);           //purposely not implemented
};
} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_FiniteDifferenceFunction(_, EXPORT, TypeX, TypeY)                        \
  namespace itk                                                                               \
  {                                                                                           \
  _( 1 ( class EXPORT FiniteDifferenceFunction< ITK_TEMPLATE_1 TypeX > ) )                    \
  namespace Templates                                                                         \
  {                                                                                           \
  typedef FiniteDifferenceFunction< ITK_TEMPLATE_1 TypeX > FiniteDifferenceFunction##TypeY; \
  }                                                                                           \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkFiniteDifferenceFunction+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkFiniteDifferenceFunction.hxx"
#endif

#endif