itkSegmentationLevelSetFunction.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkSegmentationLevelSetFunction_h
#define __itkSegmentationLevelSetFunction_h

#include "itkLevelSetFunction.h"
#include "itkLinearInterpolateImageFunction.h"
#include "itkVectorLinearInterpolateImageFunction.h"
#include "itkVectorCastImageFilter.h"

namespace itk
{
template< class TImageType, class TFeatureImageType = TImageType >
class ITK_EXPORT SegmentationLevelSetFunction:
  public LevelSetFunction< TImageType >
{
public:
  typedef SegmentationLevelSetFunction   Self;
  typedef LevelSetFunction< TImageType > Superclass;
  typedef SmartPointer< Self >           Pointer;
  typedef SmartPointer< const Self >     ConstPointer;

  itkTypeMacro(SegmentationLevelSetFunction, LevelSetFunction);

  typedef typename Superclass::ImageType        ImageType;
  typedef typename Superclass::RadiusType       RadiusType;
  typedef typename Superclass::PixelRealType    PixelRealType;
  typedef TFeatureImageType                     FeatureImageType;
  typedef typename Superclass::FloatOffsetType  FloatOffsetType;
  typedef typename Superclass::ScalarValueType  ScalarValueType;
  typedef typename Superclass::NeighborhoodType NeighborhoodType;
  typedef typename FeatureImageType::PixelType  FeatureScalarType;
  typedef typename ImageType::IndexType         IndexType;
  typedef typename Superclass::VectorType       VectorType;
  typedef typename Superclass::GlobalDataStruct GlobalDataStruct;

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

  typedef Image< VectorType, itkGetStaticConstMacro(ImageDimension) > VectorImageType;

  typedef LinearInterpolateImageFunction< ImageType > InterpolatorType;

  typedef VectorLinearInterpolateImageFunction< VectorImageType > VectorInterpolatorType;

  typedef typename InterpolatorType::ContinuousIndexType ContinuousIndexType;

  virtual const FeatureImageType * GetFeatureImage() const
  { return m_FeatureImage.GetPointer(); }
  virtual void SetFeatureImage(const FeatureImageType *f)
  {    m_FeatureImage = f;  }

  virtual ImageType * GetSpeedImage()
  { return m_SpeedImage.GetPointer(); }
  void SetSpeedImage(ImageType *s);

  virtual VectorImageType * GetAdvectionImage() const
  { return m_AdvectionImage.GetPointer(); }
  void SetAdvectionImage(VectorImageType *s);

  virtual void Initialize(const RadiusType & r);

  virtual void CalculateSpeedImage() {}

  virtual void CalculateAdvectionImage() {}

  virtual void AllocateSpeedImage();

  virtual void AllocateAdvectionImage();

  virtual void ReverseExpansionDirection();

protected:
  typename FeatureImageType::ConstPointer m_FeatureImage;

  typename ImageType::Pointer m_SpeedImage;

  typename VectorImageType::Pointer m_AdvectionImage;

  Functor::VectorCast< typename VectorInterpolatorType::OutputType,
                       VectorType > m_VectorCast;

  virtual ScalarValueType PropagationSpeed(const NeighborhoodType &,
                                           const FloatOffsetType &, GlobalDataStruct *gd) const;

  virtual VectorType AdvectionField(const NeighborhoodType &,
                                    const FloatOffsetType &, GlobalDataStruct *gd) const;

  virtual ~SegmentationLevelSetFunction() {}
  SegmentationLevelSetFunction()
  {
    m_SpeedImage = ImageType::New();
    m_AdvectionImage = VectorImageType::New();
    m_Interpolator = InterpolatorType::New();
    m_VectorInterpolator = VectorInterpolatorType::New();
  }

  typename InterpolatorType::Pointer m_Interpolator;

  typename VectorInterpolatorType::Pointer m_VectorInterpolator;
private:
  SegmentationLevelSetFunction(const Self &); //purposely not implemented
  void operator=(const Self &);               //purposely not implemented
};
} // end namespace

// Define instantiation macro for this template.
#define ITK_TEMPLATE_SegmentationLevelSetFunction(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                                \
  {                                                                            \
  _( 2 ( class EXPORT SegmentationLevelSetFunction< ITK_TEMPLATE_2 TypeX > ) ) \
  namespace Templates                                                          \
  {                                                                            \
  typedef SegmentationLevelSetFunction< ITK_TEMPLATE_2 TypeX >                 \
  SegmentationLevelSetFunction##TypeY;                                       \
  }                                                                            \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkSegmentationLevelSetFunction+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkSegmentationLevelSetFunction.hxx"
#endif

#endif