itkSpeedFunctionToPathFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSpeedFunctionToPathFilter.h,v $
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

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

#include "itkArrivalFunctionToPathFilter.h"
#include "itkSpeedFunctionPathInformation.h"

namespace itk
{

template <class TInputImage,
          class TOutputPath = PolyLineParametricPath<TInputImage::ImageDimension> >
class ITK_EXPORT SpeedFunctionToPathFilter :
    public ArrivalFunctionToPathFilter<TInputImage,TOutputPath>
{
public:
  typedef SpeedFunctionToPathFilter                            Self;
  typedef ArrivalFunctionToPathFilter<TInputImage,TOutputPath> Superclass;
  typedef SmartPointer<Self>                                   Pointer;
  typedef SmartPointer<const Self>                             ConstPointer;

  itkTypeMacro(SpeedFunctionToPathFilter,ArrivalFunctionToPathFilter);

  itkNewMacro(Self);

  itkStaticConstMacro(InputImageDimension, unsigned int,
                      TInputImage::ImageDimension);

  typedef TInputImage                             InputImageType;
  typedef typename InputImageType::Pointer        InputImagePointer;
  typedef typename InputImageType::ConstPointer   InputImageConstPointer;
  typedef typename InputImageType::RegionType     InputImageRegionType;
  typedef typename InputImageType::PixelType      InputImagePixelType;

  typedef TOutputPath                             OutputPathType;
  typedef typename OutputPathType::Pointer        OutputPathPointer;
  typedef typename OutputPathType::ConstPointer   OutputPathConstPointer;

  typedef typename Superclass::ContinuousIndexType ContinuousIndexType;
  typedef typename Superclass::IndexType           IndexType;
  typedef typename Superclass::PointType           PointType;
  typedef typename Superclass::CostFunctionType    CostFunctionType;
  typedef typename Superclass::OptimizerType       OptimizerType;

  typedef SpeedFunctionPathInformation<PointType> PathInformationType;

  void SetPathEndPoint( const PointType& )
  {
    itkWarningMacro("SetPathEndPoint() is not valid for this filter. Use AddPathInfo() instead.");
  }

  void AddPathEndPoint( const PointType& )
  {
    itkWarningMacro("AddPathEndPoint() is not valid for this filter. Use AddPathInfo() instead.");
  }

  void ClearPathEndPoints()
  {
    itkWarningMacro("ClearPathEndPoints() is not valid for this filter. Use ClearPathInfo() instead.");
  }

  void AddPathInformation(PathInformationType * info )
  {
    m_Information.push_back( info );
  }

  void ClearPathInformation()
  {
    m_Information.clear( );
  }

  virtual void Execute( const itk::Object * object, const itk::EventObject & event );

protected:
  SpeedFunctionToPathFilter( );
  ~SpeedFunctionToPathFilter( );
  virtual void PrintSelf( std::ostream& os, Indent indent ) const;

  void GenerateData( void );

  virtual unsigned int GetNumberOfPathsToExtract( ) const;

  virtual InputImageType * ComputeArrivalFunction( );

  virtual const PointType & GetNextEndPoint( );

  std::vector< typename PathInformationType::Pointer > m_Information;
  InputImagePointer                                    m_CurrentArrivalFunction;

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

};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSpeedFunctionToPathFilter.hxx"
#endif

#endif