itkChainCodePath.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 __itkChainCodePath_h
#define __itkChainCodePath_h

#include "itkPath.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, TypeX, TypeY)     \
  namespace itk                                                 \
  {                                                             \
  _( 1 ( class EXPORT ChainCodePath< ITK_TEMPLATE_1 TypeX > ) ) \
  namespace Templates                                           \
  {                                                             \
  typedef ChainCodePath< ITK_TEMPLATE_1 TypeX >                 \
  ChainCodePath##TypeY;                                       \
  }                                                             \
  }

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

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

#endif