itkParametricPath.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkParametricPath.h,v $
  Language:  C++
  Date:      $Date: 2009-02-19 19:41:22 $
  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.

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

#include "itkPath.h"
#include "itkContinuousIndex.h"
#include "itkIndex.h"
#include "itkOffset.h"
#include "itkVector.h"

namespace itk
{


template <unsigned int VDimension>
class ITK_EXPORT ParametricPath : public
Path< double, ContinuousIndex<double,VDimension>, VDimension >
{
public:
  typedef ParametricPath                                             Self;
  typedef Path<double,ContinuousIndex<double,VDimension>,VDimension> Superclass;
  typedef SmartPointer<Self>                                         Pointer;
  typedef SmartPointer<const Self>                                   ConstPointer;

  itkTypeMacro(ParametricPath, Path);

  typedef typename Superclass::InputType  InputType;

  typedef typename Superclass::OutputType OutputType;

  
  typedef ContinuousIndex<double,VDimension>  ContinuousIndexType;
  typedef Index<  VDimension >                IndexType;
  typedef Offset< VDimension >                OffsetType;
  typedef Vector<double,VDimension>           VectorType;


  virtual IndexType EvaluateToIndex( const InputType & input ) const;

  virtual OffsetType IncrementInput(InputType & input) const;

  virtual VectorType EvaluateDerivative(const InputType & input) const;

  itkSetMacro( DefaultInputStepSize, InputType )
  itkGetConstReferenceMacro( DefaultInputStepSize, InputType )
  
  
protected:
  ParametricPath();
  ~ParametricPath(){}
  void PrintSelf(std::ostream &os, Indent indent) const;
  
  InputType m_DefaultInputStepSize;

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


// There are non-templated subclasses of ParametricPath
// (ex. OrthogonallyCorrected2DParametricPath which is a subclass of
// ParametricPath<2>).  We need force all consumers of
// ParametericPath<2> to get it from the ITKCommon library.
// itkParametricPath.cxx will put ParametricPath<2> in the the
// ITKCommon library. Everyone else using a ParametericPath<2> will
// load it from the dll.
#if (defined(_WIN32) || defined(WIN32)) && !defined(ITKSTATIC) 
#  ifndef ITKCommon_EXPORTS
     template class __declspec(dllimport) ParametricPath<2>;
#endif
#endif

} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_ParametricPath(_, EXPORT, x, y) namespace itk { \
  _(1(class EXPORT ParametricPath< ITK_TEMPLATE_1 x >)) \
  namespace Templates { typedef ParametricPath< ITK_TEMPLATE_1 x > \
                                         ParametricPath##y; } \
  }

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

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

#endif