itkSegmentationLevelSetImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSegmentationLevelSetImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-04-23 03:53:37 $
  Version:   $Revision: 1.36 $

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

#include "itkSparseFieldLevelSetImageFilter.h"
#include "itkSegmentationLevelSetFunction.h"

namespace itk {

template <class TInputImage,
          class TFeatureImage,
          class TOutputPixelType = float >
class ITK_EXPORT SegmentationLevelSetImageFilter
  : public SparseFieldLevelSetImageFilter<TInputImage, Image<TOutputPixelType,
                                     ::itk::GetImageDimension<TInputImage>::ImageDimension> >
{
public:
  typedef SegmentationLevelSetImageFilter Self;

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

  typedef Image<TOutputPixelType, itkGetStaticConstMacro(InputImageDimension)> OutputImageType;
  
  typedef SparseFieldLevelSetImageFilter<TInputImage, OutputImageType>
                                    Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  typedef typename Superclass::ValueType       ValueType;
  typedef typename Superclass::IndexType       IndexType;
  typedef typename Superclass::TimeStepType    TimeStepType;
  typedef typename Superclass::InputImageType  InputImageType;

  typedef TFeatureImage FeatureImageType;

  typedef SegmentationLevelSetFunction<OutputImageType, FeatureImageType>
  SegmentationFunctionType;
    
  typedef typename SegmentationFunctionType::VectorImageType VectorImageType;
  typedef typename SegmentationFunctionType::ImageType       SpeedImageType;
  
  itkTypeMacro(SegmentationLevelSetImageFilter, SparseFieldLevelSetImageFilter);

  void SetMaximumIterations (unsigned int i)
    {
    itkWarningMacro("SetMaximumIterations is deprecated.  Please use SetNumberOfIterations instead.");
    this->SetNumberOfIterations(i);
    }
  unsigned int GetMaximumIterations()
    {
    itkWarningMacro("GetMaximumIterations is deprecated. Please use GetNumberOfIterations instead.");
    return this->GetNumberOfIterations();
    }

  virtual void SetFeatureImage(const FeatureImageType *f)
    {
    this->ProcessObject::SetNthInput( 1, const_cast< FeatureImageType * >(f) );
    m_SegmentationFunction->SetFeatureImage(f);
    }
  virtual FeatureImageType * GetFeatureImage()
    { return ( static_cast< FeatureImageType *>(this->ProcessObject::GetInput(1)) ); }

  virtual void SetInitialImage(InputImageType *f)
    {
    this->SetInput(f);
    }

  void SetInput2(const FeatureImageType *input)
    {
    this->SetFeatureImage( input );
    }

  void SetSpeedImage( SpeedImageType *s )
    {  m_SegmentationFunction->SetSpeedImage( s ); }

  void SetAdvectionImage( VectorImageType *v)
    { m_SegmentationFunction->SetAdvectionImage( v ); }

  virtual const SpeedImageType *GetSpeedImage() const
    { return m_SegmentationFunction->GetSpeedImage(); }

  virtual const VectorImageType *GetAdvectionImage() const
    { return m_SegmentationFunction->GetAdvectionImage(); }

  void SetUseNegativeFeaturesOn()
    {
    itkWarningMacro( << "SetUseNegativeFeaturesOn has been deprecated.  Please use ReverseExpansionDirectionOn() instead" );
    this->ReverseExpansionDirectionOn();
    }
  void SetUseNegativeFeaturesOff()
    {
    itkWarningMacro( << "SetUseNegativeFeaturesOff has been deprecated.  Please use ReverseExpansionDirectionOff() instead" );
    this->ReverseExpansionDirectionOff();
    }

  void SetUseNegativeFeatures( bool u )
    {
    itkWarningMacro( << "SetUseNegativeFeatures has been deprecated.  Please use SetReverseExpansionDirection instead" );
    if (u == true)
      {
      this->SetReverseExpansionDirection(false);
      }
    else
      {
      this->SetReverseExpansionDirection(true);
      }
    }
  bool GetUseNegativeFeatures() const
    {
    itkWarningMacro( << "GetUseNegativeFeatures has been deprecated.  Please use GetReverseExpansionDirection() instead" );
    if ( m_ReverseExpansionDirection == false)
      {
      return true;
      }
    else
      {
      return false;
      }
    }

  itkSetMacro(ReverseExpansionDirection, bool);
  itkGetConstMacro(ReverseExpansionDirection, bool);
  itkBooleanMacro(ReverseExpansionDirection);

  itkSetMacro(AutoGenerateSpeedAdvection, bool);
  itkGetConstMacro(AutoGenerateSpeedAdvection, bool);
  itkBooleanMacro(AutoGenerateSpeedAdvection);
  
  void SetFeatureScaling(ValueType v)
    {
    if (v != m_SegmentationFunction->GetPropagationWeight())
      {
      this->SetPropagationScaling(v);
      }
    if (v != m_SegmentationFunction->GetAdvectionWeight())
      {
      this->SetAdvectionScaling(v);
      }
    }

  void SetPropagationScaling(ValueType v)
    {
    if (v != m_SegmentationFunction->GetPropagationWeight())
      {
      m_SegmentationFunction->SetPropagationWeight(v);
      this->Modified();
      }
    }
  ValueType GetPropagationScaling() const
    {
    return m_SegmentationFunction->GetPropagationWeight();
    }

  void SetAdvectionScaling(ValueType v)
    {
    if (v != m_SegmentationFunction->GetAdvectionWeight())
      {
      m_SegmentationFunction->SetAdvectionWeight(v);
      this->Modified();
      }
    }
  ValueType GetAdvectionScaling() const
    {
    return m_SegmentationFunction->GetAdvectionWeight();
    }

  void SetCurvatureScaling(ValueType v)
    {
    if (v != m_SegmentationFunction->GetCurvatureWeight())
      {
      m_SegmentationFunction->SetCurvatureWeight(v);
      this->Modified();
      }
    }
  ValueType GetCurvatureScaling() const
    {
    return m_SegmentationFunction->GetCurvatureWeight();
    }

  void SetUseMinimalCurvature( bool b )
    {
    if ( m_SegmentationFunction->GetUseMinimalCurvature() != b)
      {
      m_SegmentationFunction->SetUseMinimalCurvature( b );
      this->Modified();
      }
    }
  bool GetUseMinimalCurvature() const
    {
    return m_SegmentationFunction->GetUseMinimalCurvature();
    }
  void UseMinimalCurvatureOn()
    {
    this->SetUseMinimalCurvature(true);
    }
  void UseMinimalCurvatureOff()
    {
    this->SetUseMinimalCurvature(false);
    }
  
  
  virtual void SetSegmentationFunction(SegmentationFunctionType *s)
    {
    m_SegmentationFunction = s; 
  
    typename SegmentationFunctionType::RadiusType r;
    r.Fill( 1 );
  
    m_SegmentationFunction->Initialize(r);
    this->SetDifferenceFunction(m_SegmentationFunction);
    this->Modified();
    }

  virtual SegmentationFunctionType *GetSegmentationFunction()
    { return m_SegmentationFunction; }

  
  void SetMaximumCurvatureTimeStep(double n)
    {
    if ( n != m_SegmentationFunction->GetMaximumCurvatureTimeStep() )
      {
      m_SegmentationFunction->SetMaximumCurvatureTimeStep(n);
      this->Modified();
      }
    }
  double GetMaximumCurvatureTimeStep() const
    {
    return m_SegmentationFunction->GetMaximumCurvatureTimeStep();
    }

  void SetMaximumPropagationTimeStep(double n)
    {
    if (n != m_SegmentationFunction->GetMaximumPropagationTimeStep() )
      {
      m_SegmentationFunction->SetMaximumPropagationTimeStep(n);
      this->Modified();
      }
    }
  double GetMaximumPropagationTimeStep() const
    {
    return m_SegmentationFunction->GetMaximumPropagationTimeStep();
    }

  void GenerateSpeedImage();

  void GenerateAdvectionImage();
  
#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(OutputHasNumericTraitsCheck,
                  (Concept::HasNumericTraits<TOutputPixelType>));
#endif

protected:
  virtual ~SegmentationLevelSetImageFilter() {}
  SegmentationLevelSetImageFilter();

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

  virtual void InitializeIteration()
    {
    Superclass::InitializeIteration();
    // Estimate the progress of the filter
    this->SetProgress( (float) ((float)this->GetElapsedIterations()
                                / (float)this->GetNumberOfIterations()) );
    }
  
  void GenerateData();

  bool m_ReverseExpansionDirection;

  bool m_AutoGenerateSpeedAdvection;
  
private:
  SegmentationLevelSetImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  SegmentationFunctionType *m_SegmentationFunction;
};

} // end namespace itk

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

#endif