itkPath.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkPath.h,v $
  Language:  C++
  Date:      $Date: 2007-02-10 14:31:15 $
  Version:   $Revision: 1.11 $

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

#include "itkDataObject.h"
#include "itkIndex.h"
#include "itkOffset.h"
#include "itkNumericTraits.h"

namespace itk
{


template <class TInput, class TOutput, unsigned int VDimension>
class ITK_EXPORT Path : public DataObject
{
public:
  typedef Path                      Self;
  typedef DataObject                Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  itkStaticConstMacro(PathDimension, unsigned int, VDimension);

  itkTypeMacro(Path, FunctionBase);

  typedef TInput  InputType;

  typedef TOutput OutputType;

  
  typedef Index<  VDimension >  IndexType;
  typedef Offset< VDimension >  OffsetType;


  virtual inline InputType StartOfInput() const
    {
    return NumericTraits<InputType>::Zero;
    }

  virtual inline InputType EndOfInput() const
    {
    return NumericTraits<InputType>::One;
    }

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

  virtual IndexType EvaluateToIndex( const InputType & input ) const = 0;

  virtual OffsetType IncrementInput(InputType & input) const = 0;

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

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

  itkGetConstMacro(ZeroOffset,OffsetType);
  itkGetConstMacro(ZeroIndex,IndexType);

private:
  Path(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  // These "constants" are initialized in the constructor
  OffsetType  m_ZeroOffset; // = 0 for all dimensions
  IndexType   m_ZeroIndex;  // = 0 for all dimensions
  
};

} // namespace itk

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

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

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