itkSparseFieldLevelSetImageFilter.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 itkSparseFieldLevelSetImageFilter_h
#define itkSparseFieldLevelSetImageFilter_h
 
#include "itkFiniteDifferenceImageFilter.h"
#include "itkMultiThreaderBase.h"
#include "itkSparseFieldLayer.h"
#include "itkObjectStore.h"
#include <vector>
#include "itkNeighborhoodIterator.h"
 
namespace itk
{
template <typename TValue>
class ITK_TEMPLATE_EXPORT SparseFieldLevelSetNode
{
public:
  TValue                    m_Value;
  SparseFieldLevelSetNode * Next;
  SparseFieldLevelSetNode * Previous;
};

template <typename TNeighborhoodType>
class ITK_TEMPLATE_EXPORT SparseFieldCityBlockNeighborList
{
public:
  using NeighborhoodType = TNeighborhoodType;
  using OffsetType = typename NeighborhoodType::OffsetType;
  using RadiusType = typename NeighborhoodType::RadiusType;
  static constexpr unsigned int Dimension = NeighborhoodType::Dimension;
 
  const RadiusType &
  GetRadius() const
  {
    return m_Radius;
  }
 
  const unsigned int &
  GetArrayIndex(unsigned int i) const
  {
    return m_ArrayIndex[i];
  }
 
  const OffsetType &
  GetNeighborhoodOffset(unsigned int i) const
  {
    return m_NeighborhoodOffset[i];
  }
 
  const unsigned int &
  GetSize() const
  {
    return m_Size;
  }
 
  int
  GetStride(unsigned int i)
  {
    return m_StrideTable[i];
  }
 
  SparseFieldCityBlockNeighborList();
  ~SparseFieldCityBlockNeighborList() = default;
 
  void
  Print(std::ostream & os, Indent indent) const;
 
private:
  unsigned int              m_Size;
  RadiusType                m_Radius;
  std::vector<unsigned int> m_ArrayIndex;
  std::vector<OffsetType>   m_NeighborhoodOffset;

  unsigned int m_StrideTable[Dimension];
};

template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT SparseFieldLevelSetImageFilter : public FiniteDifferenceImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SparseFieldLevelSetImageFilter);

  using Self = SparseFieldLevelSetImageFilter;
  using Superclass = FiniteDifferenceImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using typename Superclass::TimeStepType;
  using typename Superclass::RadiusType;
  using typename Superclass::NeighborhoodScalesType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(SparseFieldLevelSetImageFilter);

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;
  using IndexType = typename OutputImageType::IndexType;
  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;

  using ValueType = typename OutputImageType::ValueType;

  using LayerNodeType = SparseFieldLevelSetNode<IndexType>;

  using LayerType = SparseFieldLayer<LayerNodeType>;
  using LayerPointerType = typename LayerType::Pointer;

  using LayerListType = std::vector<LayerPointerType>;

  using StatusType = signed char;

  using StatusImageType = Image<StatusType, Self::ImageDimension>;

  using LayerNodeStorageType = ObjectStore<LayerNodeType>;

  using UpdateBufferType = std::vector<ValueType>;

  itkSetMacro(NumberOfLayers, unsigned int);
  itkGetConstMacro(NumberOfLayers, unsigned int);

  itkSetMacro(IsoSurfaceValue, ValueType);
  itkGetConstMacro(IsoSurfaceValue, ValueType);

  //  itkGetConstMacro(RMSChange, ValueType);

  itkSetMacro(InterpolateSurfaceLocation, bool);
  itkGetConstMacro(InterpolateSurfaceLocation, bool);

  void
  InterpolateSurfaceLocationOn()
  {
    this->SetInterpolateSurfaceLocation(true);
  }
  void
  InterpolateSurfaceLocationOff()
  {
    this->SetInterpolateSurfaceLocation(false);
  }

 
  itkConceptMacro(OutputEqualityComparableCheck, (Concept::EqualityComparable<typename TOutputImage::PixelType>));
  itkConceptMacro(DoubleConvertibleToOutputCheck, (Concept::Convertible<double, typename TOutputImage::PixelType>));
  itkConceptMacro(OutputOStreamWritableCheck, (Concept::OStreamWritable<typename TOutputImage::PixelType>));
 
protected:
  SparseFieldLevelSetImageFilter();
  ~SparseFieldLevelSetImageFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  inline virtual ValueType
  CalculateUpdateValue(const IndexType &    itkNotUsed(idx),
                       const TimeStepType & dt,
                       const ValueType &    value,
                       const ValueType &    change)
  {
    return (value + dt * change);
  }

  void
  PostProcessOutput() override;

  virtual void
  InitializeBackgroundPixels();

  void
  Initialize() override;

  void
  CopyInputToOutput() override;

  void
  AllocateUpdateBuffer() override;

  void
  ApplyUpdate(const TimeStepType & dt) override;

  TimeStepType
  CalculateChange() override;

  void
  ConstructLayer(StatusType from, StatusType to);

  void
  ConstructActiveLayer();

  void
  InitializeActiveLayerValues();

  void
  PropagateLayerValues(StatusType from, StatusType to, StatusType promote, int InOrOut);

  void
  PropagateAllLayerValues();

  void
  UpdateActiveLayerValues(TimeStepType dt, LayerType * UpList, LayerType * DownList);

  void
  ProcessStatusList(LayerType * InputList,
                    LayerType * OutputList,
                    StatusType  ChangeToStatus,
                    StatusType  SearchForStatus);

  void
  ProcessOutsideList(LayerType * OutsideList, StatusType ChangeToStatus);
 
  itkGetConstMacro(ValueZero, ValueType);
  itkGetConstMacro(ValueOne, ValueType);

  SparseFieldCityBlockNeighborList<NeighborhoodIterator<OutputImageType>> m_NeighborList{};

  double m_ConstantGradientValue{ 1.0 };

  static ValueType m_ValueOne;

  static ValueType m_ValueZero;

  static StatusType m_StatusChanging;

  static StatusType m_StatusActiveChangingUp;

  static StatusType m_StatusActiveChangingDown;

  static StatusType m_StatusBoundaryPixel;

  static StatusType m_StatusNull;

  typename OutputImageType::Pointer m_ShiftedImage{};

  LayerListType m_Layers{};

  unsigned int m_NumberOfLayers{ 2 };

  typename StatusImageType::Pointer m_StatusImage{};

  typename LayerNodeStorageType::Pointer m_LayerNodeStore{};

  ValueType m_IsoSurfaceValue{};

  UpdateBufferType m_UpdateBuffer{};

  //  ValueType m_RMSChange;

  bool m_InterpolateSurfaceLocation{ true };
 
  const InputImageType * m_InputImage{};
  OutputImageType *      m_OutputImage{};
 
private:
  bool m_BoundsCheckingActive{ false };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSparseFieldLevelSetImageFilter.hxx"
#endif
 
#endif