itkChainCodePath.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkChainCodePath.h,v $
  Language:  C++
  Date:      $Date: 2007-12-23 17:59:28 $
  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 __itkChainCodePath_h
#define __itkChainCodePath_h

#include "itkPath.h"
#include "itkIndex.h"
#include "itkOffset.h"
#include "itkObjectFactory.h"

#include <vector>

namespace itk
{


template <unsigned int VDimension>
class ITK_EXPORT ChainCodePath : public
Path< unsigned int, Offset< VDimension >, VDimension >
{
public:
  itkStaticConstMacro(Dimension, unsigned int, VDimension);

  typedef ChainCodePath<VDimension>                               Self;
  typedef Path< unsigned int, Offset< VDimension >, VDimension >  Superclass;

  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;
  
  itkTypeMacro(ChainCodePath, Path);

  
  typedef typename Superclass::OutputType   OutputType;
  typedef typename Superclass::InputType    InputType;

  typedef OutputType               OffsetType;
  typedef Index<VDimension>        IndexType;

  typedef std::vector<OffsetType>  ChainCodeType;

  typedef typename ChainCodeType::size_type ChainCodeSizeType;

  // Functions inherited from Path
  
  virtual OutputType Evaluate( const InputType & input ) const
    {
    return m_Chain[input];
    }

  virtual IndexType EvaluateToIndex( const InputType & input ) const;

  virtual OffsetType IncrementInput(InputType & input) const;

  virtual inline InputType EndOfInput() const
    {
    return NumberOfSteps();  // 0 is before the first step, 1 is after it
    }

  itkNewMacro( Self );

  itkSetMacro( Start, IndexType );
  itkGetConstReferenceMacro( Start, IndexType );

  virtual inline void InsertStep( InputType position, OffsetType step )
    {
    m_Chain.insert( m_Chain.begin()+position, step );
    this->Modified();
    }

  virtual inline void ChangeStep( InputType position, OffsetType step )
    {
    m_Chain[position]=step;
    this->Modified();
    }

  virtual inline void Clear()
    {
    m_Chain.clear();
    this->Modified();
    }

  virtual inline ChainCodeSizeType NumberOfSteps() const
    {
    return m_Chain.size();
    }

  virtual void Initialize(void)
    {
    m_Start = this->GetZeroIndex();
    this->Clear();
    }

protected:
  ChainCodePath();
  ~ChainCodePath() {}
  void PrintSelf(std::ostream& os, Indent indent) const;


private:
  ChainCodePath(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  IndexType     m_Start;            // origin image index for the path
  ChainCodeType m_Chain;            // the chain code (vector of offsets)
};

} // end namespace itk

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

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

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

#endif