itkNarrowBandLevelSetImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkNarrowBandLevelSetImageFilter_h
#define itkNarrowBandLevelSetImageFilter_h
 
#include "itkNarrowBandImageFilterBase.h"
#include "itkSegmentationLevelSetFunction.h"
#include "itkFastChamferDistanceImageFilter.h"
#include "itkIsoContourDistanceImageFilter.h"
#include "itkMath.h"
 
namespace itk
{
template <typename TInputImage,
          typename TFeatureImage,
          typename TOutputPixelType = float,
          typename TOutputImage = Image<TOutputPixelType, TInputImage::ImageDimension>>
class ITK_TEMPLATE_EXPORT NarrowBandLevelSetImageFilter : public NarrowBandImageFilterBase<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(NarrowBandLevelSetImageFilter);

  using Self = NarrowBandLevelSetImageFilter;
  using Superclass = NarrowBandImageFilterBase<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

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

  using OutputImageType = TOutputImage;
  using FeatureImageType = TFeatureImage;

  using SegmentationFunctionType = SegmentationLevelSetFunction<OutputImageType, FeatureImageType>;

  using VectorImageType = typename SegmentationFunctionType::VectorImageType;

  itkOverrideGetNameOfClassMacro(NarrowBandLevelSetImageFilter);

  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)
    {
      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;
    }
 
    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 (Math::NotExactlyEquals(v, m_SegmentationFunction->GetPropagationWeight()))
    {
      m_SegmentationFunction->SetPropagationWeight(v);
    }
  }
 
  ValueType
  GetPropagationScaling() const
  {
    return m_SegmentationFunction->GetPropagationWeight();
  }


  void
  SetAdvectionScaling(ValueType v)
  {
    if (Math::NotExactlyEquals(v, m_SegmentationFunction->GetAdvectionWeight()))
    {
      m_SegmentationFunction->SetAdvectionWeight(v);
    }
  }
 
  ValueType
  GetAdvectionScaling() const
  {
    return m_SegmentationFunction->GetAdvectionWeight();
  }


  void
  SetCurvatureScaling(ValueType v)
  {
    if (Math::NotExactlyEquals(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();
  }

 
  void
  SetMaximumRMSError(const double) override
  {
    itkWarningMacro("The current implementation of this solver does not compute maximum RMS change. The maximum RMS "
                    "error value will not be set or used.");
  }
 
  itkConceptMacro(OutputHasNumericTraitsCheck, (Concept::HasNumericTraits<typename TOutputImage::PixelType>));
 
protected:
  ~NarrowBandLevelSetImageFilter() override = default;
  NarrowBandLevelSetImageFilter();
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 

  void
  InitializeIteration() override
  {
    Superclass::InitializeIteration();
    // Estimate the progress of the filter
    this->UpdateProgress(static_cast<float>(this->GetElapsedIterations()) /
                         static_cast<float>(this->GetNumberOfIterations()));
  }

 
  void
  CreateNarrowBand() override;

  void
  GenerateData() override;

  bool m_ReverseExpansionDirection{};


  using IsoFilterType = IsoContourDistanceImageFilter<OutputImageType, OutputImageType>;
  using ChamferFilterType = FastChamferDistanceImageFilter<OutputImageType, OutputImageType>;
 
  typename IsoFilterType::Pointer m_IsoFilter{};
 
  typename ChamferFilterType::Pointer m_ChamferFilter{};
 
private:
  SegmentationFunctionType * m_SegmentationFunction{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkNarrowBandLevelSetImageFilter.hxx"
#endif
 
#endif