lib/fpa/Filters/Algorithm.h

   1 // =========================================================================
   2 // @author Leonardo Florez Valencia
   3 // @email florez-l@javeriana.edu.co
   4 // =========================================================================
   5 #ifndef __fpa__Filters__Algorithm__h__
   6 #define __fpa__Filters__Algorithm__h__
   7
   8 #include <set>
   9 #include <itkDataObject.h>
  10 #include <fpa/Config.h>
  11 #include <fpa/Filters/Event.h>
  12
  13 namespace fpa
  14 {
  15   namespace Filters
  16   {
  17     /**
  18      */
  19     template< class _TTraits >
  20     class Algorithm
  21       : public _TTraits::TFilterInterface,
  22         public _TTraits::TMarksInterface,
  23         public _TTraits::TSeedsInterface
  24     {
  25     public:
  26       typedef _TTraits TTraits;
  27       fpaTraitsMacro( typename TTraits );
  28
  29       typedef typename TTraits::TFilterInterface Superclass;
  30       typedef Algorithm                          Self;
  31       typedef itk::SmartPointer< Self >          Pointer;
  32       typedef itk::SmartPointer< const Self >    ConstPointer;
  33
  34       typedef fpa::Filters::Event< TVertex > TEvent;
  35
  36     public:
  37       itkTypeMacro( fpa::Filters::Algorithm, TTraits::TFilterInterface );
  38
  39       itkBooleanMacro( VisualDebug );
  40       itkGetConstMacro( VisualDebug, bool );
  41       itkSetMacro( VisualDebug, bool );
  42
  43       itkGetConstMacro( InitValue, TOutputValue );
  44       itkSetMacro( InitValue, TOutputValue );
  45
  46     public:
  47       virtual itk::ModifiedTimeType GetMTime( ) const override;
  48       virtual void InvokeEvent( const itk::EventObject& e );
  49       virtual void InvokeEvent( const itk::EventObject& e ) const;
  50
  51     protected:
  52       Algorithm( );
  53       virtual ~Algorithm( );
  54
  55       // Main algorithm method
  56       virtual void GenerateData( ) override;
  57
  58       // Object association
  59       void _Associate( itk::Object* o );
  60       void _Deassociate( itk::Object* o );
  61       void _DeassociateAll( );
  62
  63       // Pipeline related methods
  64       virtual void _BeforeGenerateData( );
  65       virtual void _AfterGenerateData( );
  66
  67       // Filter related methods
  68       virtual void _AssignOutputValue( const TNode& n ) = 0;
  69       virtual void _ConfigureOutputs( ) = 0;
  70       virtual TInputValue _GetInputValue( const TVertex& v ) const = 0;
  71       virtual TInputValue _GetInputValue( const TNode& n ) const;
  72       virtual TOutputValue _GetOutputValue( const TVertex& v ) const = 0;
  73       virtual TOutputValue _GetOutputValue( const TNode& n ) const;
  74       virtual TNeighborhood _GetNeighbors( const TVertex& v ) const = 0;
  75       virtual TNeighborhood _GetNeighbors( const TNode& n ) const;
  76       virtual const itk::DataObject* _GetReferenceInput( ) const;
  77
  78       // Marks related methods
  79       virtual bool _IsMarked( const TVertex& v ) const = 0;
  80       virtual bool _IsMarked( const TNode& n ) const;
  81       virtual bool _IsNotMarked( const TVertex& v ) const;
  82       virtual bool _IsNotMarked( const TNode& n ) const;
  83       virtual void _Mark( const TNode& n ) = 0;
  84
  85       // Queue related methods
  86       virtual void _QueueClear( ) = 0;
  87       virtual TNode _QueuePop( ) = 0;
  88       virtual void _QueuePush( const TNode& n ) = 0;
  89       virtual unsigned long _QueueSize( ) const = 0;
  90
  91       // Algoritm related methods
  92       virtual void _PostComputeOutputValue( TNode& n ) = 0;
  93       virtual void _PreComputeOutputValue( TNode& n ) = 0;
  94       virtual void _Reinitialize( );
  95
  96     private:
  97       Algorithm( const Self& other );
  98       Self& operator=( const Self& other );
  99
 100     protected:
 101       bool m_VisualDebug;
 102       TOutputValue m_InitValue;
 103       std::set< itk::Object* > m_AssociatedObjects;
 104     };
 105
 106   } // ecapseman
 107
 108 } // ecapseman
 109
 110 #ifndef ITK_MANUAL_INSTANTIATION
 111 #  include <fpa/Filters/Algorithm.hxx>
 112 #endif // ITK_MANUAL_INSTANTIATION
 113 #endif // __fpa__Filters__Algorithm__h__
 114 // eof - $RCSfile$