itkFastMarchingUpwindGradientImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkFastMarchingUpwindGradientImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2007-04-20 11:52:27 $
  Version:   $Revision: 1.7 $

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

#include "itkFastMarchingImageFilter.h"
#include "itkImage.h"

namespace itk
{
template <
  class TLevelSet, 
  class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension> >
class ITK_EXPORT FastMarchingUpwindGradientImageFilter :
    public FastMarchingImageFilter<TLevelSet,TSpeedImage>
{

public:
  typedef FastMarchingUpwindGradientImageFilter          Self;
  typedef FastMarchingImageFilter<TLevelSet,TSpeedImage> Superclass;
  typedef SmartPointer<Self>                             Pointer;
  typedef SmartPointer<const Self>                       ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(FastMarchingUpwindGradientImageFilter, FastMarchingImageFilter);

  typedef typename Superclass::LevelSetType            LevelSetType;
  typedef typename Superclass::SpeedImageType          SpeedImageType;
  typedef typename Superclass::LevelSetImageType       LevelSetImageType;
  typedef typename Superclass::LevelSetPointer         LevelSetPointer;
  typedef typename Superclass::SpeedImageConstPointer  SpeedImageConstPointer;
  typedef typename Superclass::LabelImageType          LabelImageType;
  typedef typename Superclass::PixelType               PixelType;
  typedef typename Superclass::AxisNodeType            AxisNodeType;
  typedef typename Superclass::NodeType                NodeType;
  typedef typename Superclass::NodeContainer           NodeContainer;
  typedef typename Superclass::NodeContainerPointer    NodeContainerPointer;

  typedef typename Superclass::IndexType          IndexType;
  typedef typename Superclass::OutputSpacingType  OutputSpacingType;
  typedef typename Superclass::LevelSetIndexType  LevelSetIndexType;

  typedef typename Superclass::OutputPointType   PointType;


  itkStaticConstMacro(SetDimension, unsigned int,Superclass::SetDimension); 

  void SetTargetPoints( NodeContainer * points )
    { 
    m_TargetPoints = points;
    this->Modified();
    };

  NodeContainerPointer GetTargetPoints( )
    { return m_TargetPoints; }

  NodeContainerPointer GetReachedTargetPoints( )
    { return m_ReachedTargetPoints; }

  typedef CovariantVector<PixelType, 
          itkGetStaticConstMacro(SetDimension)> GradientPixelType;

  typedef Image<GradientPixelType, 
          itkGetStaticConstMacro(SetDimension)> GradientImageType;

  typedef typename GradientImageType::Pointer GradientImagePointer;

  GradientImagePointer GetGradientImage() const
    { return m_GradientImage; }

  itkSetMacro( GenerateGradientImage, bool );

  itkGetConstReferenceMacro( GenerateGradientImage, bool );
  itkBooleanMacro( GenerateGradientImage );

  itkSetMacro( TargetOffset, double );

  itkGetConstReferenceMacro( TargetOffset, double );

  itkSetMacro( TargetReachedMode, int );
  itkGetConstReferenceMacro( TargetReachedMode, int );
  void SetTargetReachedModeToNoTargets()
    { this->SetTargetReachedMode(NoTargets); }
  void SetTargetReachedModeToOneTarget() 
    { this->SetTargetReachedMode(OneTarget); }
  void SetTargetReachedModeToSomeTargets( long numberOfTargets )
    {
    this->SetTargetReachedMode(SomeTargets);
    m_NumberOfTargets = numberOfTargets;
    }
  void SetTargetReachedModeToAllTargets() 
    { this->SetTargetReachedMode(AllTargets); }

  itkGetConstReferenceMacro( NumberOfTargets, long );

  itkGetConstReferenceMacro( TargetValue, double );

  enum
    {
      NoTargets,
      OneTarget,
      SomeTargets,
      AllTargets
    };

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(LevelSetDoubleDivisionOperatorsCheck,
    (Concept::DivisionOperators<typename TLevelSet::PixelType, double>));

#endif

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

  virtual void Initialize( LevelSetImageType * );

  void GenerateData();

  virtual void UpdateNeighbors( const IndexType& index, 
                                const SpeedImageType *, LevelSetImageType * );

  virtual void ComputeGradient( const IndexType& index ,
                              const LevelSetImageType * output, 
                              const LabelImageType * labelImage,
                              GradientImageType * gradientImage);

private:
  FastMarchingUpwindGradientImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  NodeContainerPointer m_TargetPoints;
  NodeContainerPointer m_ReachedTargetPoints;

  GradientImagePointer m_GradientImage;
 
  bool m_GenerateGradientImage;

  double m_TargetOffset;

  int m_TargetReachedMode;

  double m_TargetValue;

  long m_NumberOfTargets;

};

} // namespace itk


#ifndef ITK_MANUAL_INSTANTIATION
#include "itkFastMarchingUpwindGradientImageFilter.txx"
#endif

#endif