itkSpatialFunction.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSpatialFunction.h,v $
  Language:  C++
  Date:      $Date: 2009-03-03 15:09:33 $
  Version:   $Revision: 1.19 $

  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 __itkSpatialFunction_h
#define __itkSpatialFunction_h

#include "itkFunctionBase.h"
#include "itkPoint.h"

namespace itk
{

template <typename TOutput, 
          unsigned int VImageDimension=3,
          typename TInput=Point<double, VImageDimension> >
class ITK_EXPORT SpatialFunction : public FunctionBase<TInput, TOutput>
{
public:
  typedef SpatialFunction                Self;
  typedef FunctionBase< TInput, TOutput> Superclass;
  typedef SmartPointer<Self>             Pointer;
  typedef SmartPointer<const Self>       ConstPointer;

  itkTypeMacro(SpatialFunction, FunctionBase);

  typedef typename Superclass::InputType InputType;

  typedef typename Superclass::OutputType OutputType;

  itkStaticConstMacro(ImageDimension, unsigned int, VImageDimension);

  virtual OutputType Evaluate( const InputType& input ) const = 0;

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

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

};

} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_SpatialFunction(_, EXPORT, x, y) namespace itk { \
  _(3(class EXPORT SpatialFunction< ITK_TEMPLATE_3 x >)) \
  namespace Templates { typedef SpatialFunction< ITK_TEMPLATE_3 x > \
                                                  SpatialFunction##y; } \
  }

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

#if ITK_TEMPLATE_TXX
# include "itkSpatialFunction.txx"
#endif


#endif