itkShortestPathCostFunction.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/
#ifndef __itkShortestPathCostFunction_h
#define __itkShortestPathCostFunction_h

#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkShapedNeighborhoodIterator.h"

namespace itk
{
  // \brief this is a pure virtual superclass for all cost functions used in itkShortestPathImageFilter
  template <class TInputImageType>
  class ShortestPathCostFunction : public Object
  {
  public:
    typedef ShortestPathCostFunction Self;
    typedef Object Superclass;
    typedef SmartPointer<Self> Pointer;
    typedef SmartPointer<const Self> ConstPointer;
    typedef ShapedNeighborhoodIterator<TInputImageType> ShapedNeighborhoodIteratorType;

    itkTypeMacro(ShortestPathCostFunction, Object);

    typedef TInputImageType ImageType;

    // More typdefs for convenience
    typedef typename TInputImageType::Pointer ImagePointer;
    typedef typename TInputImageType::ConstPointer ImageConstPointer;
    typedef typename TInputImageType::PixelType PixelType;
    typedef typename TInputImageType::IndexType IndexType;

    // \brief Set the input image.
    itkSetConstObjectMacro(Image, TInputImageType);

    // \brief Calculate the cost for going from pixel p1 to pixel p2
    virtual double GetCost(IndexType p1, IndexType p2) = 0;

    // \brief Return the minimal possible cost (needed for A*)
    virtual double GetMinCost() = 0;

    // \brief Initialize the metric
    virtual void Initialize() = 0;

    // \brief Set the starting index of a path
    void SetStartIndex(const IndexType &index);

    // \brief Set the ending index of a path
    void SetEndIndex(const IndexType &index);

  protected:
    ShortestPathCostFunction(){};
    ~ShortestPathCostFunction() override{};
    void PrintSelf(std::ostream &os, Indent indent) const override;
    ImageConstPointer m_Image;
    IndexType m_StartIndex, m_EndIndex;

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

} // end namespace itk

#include "itkShortestPathCostFunction.txx"

#endif /* __itkShortestPathCostFunction_h */