itkSinglePhaseLevelSetSegmentationModule.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    itkSinglePhaseLevelSetSegmentationModule.h
  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 itkSinglePhaseLevelSetSegmentationModule_h
#define itkSinglePhaseLevelSetSegmentationModule_h

#include "itkSegmentationModule.h"
#include "itkImageSpatialObject.h"

namespace itk
{

template <unsigned int NDimension>
class ITK_EXPORT SinglePhaseLevelSetSegmentationModule : public SegmentationModule<NDimension>
{
public:
  typedef SinglePhaseLevelSetSegmentationModule         Self;
  typedef SegmentationModule<NDimension>                Superclass;
  typedef SmartPointer<Self>                            Pointer;
  typedef SmartPointer<const Self>                      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(SinglePhaseLevelSetSegmentationModule, SegmentationModule);

  itkStaticConstMacro(Dimension, unsigned int, NDimension);

  typedef typename Superclass::SpatialObjectType         SpatialObjectType;
  typedef typename Superclass::SpatialObjectPointer      SpatialObjectPointer;

  typedef float                                         InputPixelType;
  typedef float                                         FeaturePixelType;
  typedef float                                         OutputPixelType;
  typedef Image< InputPixelType, NDimension >           InputImageType;
  typedef Image< FeaturePixelType, NDimension >         FeatureImageType;
  typedef Image< OutputPixelType, NDimension >          OutputImageType;

  typedef ImageSpatialObject< NDimension, InputPixelType >     InputSpatialObjectType;
  typedef ImageSpatialObject< NDimension, FeaturePixelType >   FeatureSpatialObjectType;
  typedef ImageSpatialObject< NDimension, OutputPixelType >    OutputSpatialObjectType;

  itkSetMacro( PropagationScaling, double );
  itkGetMacro( PropagationScaling, double );

  itkSetMacro( CurvatureScaling, double );
  itkGetMacro( CurvatureScaling, double );

  itkSetMacro( AdvectionScaling, double );
  itkGetMacro( AdvectionScaling, double );

  itkSetMacro( MaximumRMSError, double );
  itkGetMacro( MaximumRMSError, double );

  itkSetMacro( MaximumNumberOfIterations, unsigned int );
  itkGetMacro( MaximumNumberOfIterations, unsigned int );

  itkSetMacro( InvertOutputIntensities, bool );
  itkGetMacro( InvertOutputIntensities, bool );
  itkBooleanMacro( InvertOutputIntensities );

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

  void  GenerateData ();

  void PackOutputImageInOutputSpatialObject( OutputImageType * outputImage );

  const InputImageType * GetInternalInputImage() const;

  const FeatureImageType * GetInternalFeatureImage() const;

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

  double        m_PropagationScaling;
  double        m_CurvatureScaling;
  double        m_AdvectionScaling;

  unsigned int  m_MaximumNumberOfIterations;
  double        m_MaximumRMSError;

  bool          m_InvertOutputIntensities;

  typedef typename InputImageType::ConstPointer  ImageConstPointer;
  mutable ImageConstPointer m_ZeroSetInputImage;
};

} // end namespace itk

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

#endif