itkNarrowBandLevelSetImageFilter.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkNarrowBandLevelSetImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2009-01-26 21:45:53 $
  Version:   $Revision: 1.11 $

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

#include "itkNarrowBandImageFilterBase.h"
#include "itkSegmentationLevelSetFunction.h"
#include "itkFastChamferDistanceImageFilter.h"
#include "itkIsoContourDistanceImageFilter.h"

namespace itk {

template <class TInputImage,
          class TFeatureImage,
          class TOutputPixelType = float,
          class TOutputImage = Image<TOutputPixelType,
                                     ::itk::GetImageDimension<TInputImage>::ImageDimension> >
class ITK_EXPORT NarrowBandLevelSetImageFilter
  : public NarrowBandImageFilterBase<TInputImage, TOutputImage>
{
public:
  typedef NarrowBandLevelSetImageFilter                        Self;
  typedef NarrowBandImageFilterBase<TInputImage, TOutputImage> 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 TOutputImage   OutputImageType;
  typedef TFeatureImage  FeatureImageType;

  typedef SegmentationLevelSetFunction <OutputImageType, FeatureImageType>
  SegmentationFunctionType;

  typedef typename SegmentationFunctionType::VectorImageType VectorImageType;
    
  itkTypeMacro(NarrowBandLevelSetImageFilter, NarrowBandImageFilterBase);

  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);
    }
  
  virtual const typename SegmentationFunctionType::ImageType *GetSpeedImage() const
  { return m_SegmentationFunction->GetSpeedImage(); }

  virtual const typename SegmentationFunctionType::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 ( this->GetReverseExpansionDirection() == false)
      {
      return true;
      }
    else
      {
      return false;
      }
    }

  itkSetMacro(ReverseExpansionDirection, bool);
  itkGetConstMacro(ReverseExpansionDirection, bool);
  itkBooleanMacro(ReverseExpansionDirection);
  
  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);
      }
    }
  ValueType GetPropagationScaling() const
    {
    return m_SegmentationFunction->GetPropagationWeight();
    }

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

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

  virtual void SetSegmentationFunction(SegmentationFunctionType *s);
  virtual SegmentationFunctionType *GetSegmentationFunction()
    { return m_SegmentationFunction; }

  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 SetMaximumRMSError(const double)
    {
    itkWarningMacro("The current implmentation of this solver does not compute maximum RMS change. The maximum RMS error value will not be set or used.");
    }

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(OutputHasNumericTraitsCheck,
    (Concept::HasNumericTraits<typename TOutputImage::PixelType>));
#endif

protected:
  virtual ~NarrowBandLevelSetImageFilter() {}
  NarrowBandLevelSetImageFilter();
  NarrowBandLevelSetImageFilter(const Self &); //purposely not implemented

  virtual void PrintSelf(std::ostream& os, Indent indent) const;
  void operator=(const Self&); //purposely not implemented
  
  virtual void InitializeIteration()
    {
    Superclass::InitializeIteration();
    // Estimate the progress of the filter
    this->SetProgress( (float) ((float)this->GetElapsedIterations()
                                / (float)this->GetNumberOfIterations()) );
    }
  
  virtual void CreateNarrowBand ();

  void GenerateData();

  bool m_ReverseExpansionDirection;
  
  typedef IsoContourDistanceImageFilter<OutputImageType,OutputImageType>
          IsoFilterType;
  typedef FastChamferDistanceImageFilter<OutputImageType,OutputImageType>
          ChamferFilterType; 

  typename IsoFilterType::Pointer     m_IsoFilter;
  typename ChamferFilterType::Pointer m_ChamferFilter;

private:
  SegmentationFunctionType *m_SegmentationFunction;
};

} // end namespace itk

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

#endif