itkSLICImageFilter.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 itkSLICImageFilter_h
#define itkSLICImageFilter_h
 
#include "itkImageToImageFilter.h"
#include <mutex>
 
namespace itk
{

template <typename TInputImage, typename TOutputImage, typename TDistancePixel = float>
class ITK_TEMPLATE_EXPORT SLICImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SLICImageFilter);

  using Self = SLICImageFilter;
  using Superclass = ImageToImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(SLICImageFilter);

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
 

  using InputImageType = TInputImage;
  using InputPixelType = typename InputImageType::PixelType;
  using OutputImageType = TOutputImage;
  using OutputPixelType = typename OutputImageType::PixelType;
  using DistanceType = TDistancePixel;
  using DistanceImageType = Image<DistanceType, ImageDimension>;
 
  using IndexType = typename InputImageType::IndexType;
  using PointType = typename InputImageType::PointType;
  using ContinuousIndexType = ContinuousIndex<typename PointType::ValueType, ImageDimension>;
 
  using ClusterComponentType = double;
  using ClusterType = vnl_vector_ref<ClusterComponentType>;
 
  using OutputImageRegionType = typename OutputImageType::RegionType;
 
  using SuperGridSizeType = FixedArray<unsigned int, ImageDimension>;

  itkSetMacro(SpatialProximityWeight, double);
  itkGetConstMacro(SpatialProximityWeight, double);

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

  itkSetMacro(SuperGridSize, SuperGridSizeType);
  itkGetConstMacro(SuperGridSize, SuperGridSizeType);
  void
  SetSuperGridSize(unsigned int factor);
  void
  SetSuperGridSize(unsigned int i, unsigned int factor);

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

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

  itkGetConstMacro(AverageResidual, double);
 
protected:
  SLICImageFilter();
  ~SLICImageFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  EnlargeOutputRequestedRegion(DataObject * output) override;
 
  void
  BeforeThreadedGenerateData() override;
 
  void
  ThreadedUpdateDistanceAndLabel(const OutputImageRegionType & outputRegionForThread);
 
  void
  ThreadedUpdateClusters(const OutputImageRegionType & updateRegionForThread);
 
  void
  ThreadedPerturbClusters(SizeValueType clusterIndex);
 
  void
  ThreadedConnectivity(SizeValueType clusterIndex);
 
  void
  SingleThreadedConnectivity();
 
  void
  GenerateData() override;
 
 
  void
  AfterThreadedGenerateData() override;
 
  DistanceType
  Distance(const ClusterType & cluster1, const ClusterType & cluster2);
 
  DistanceType
  Distance(const ClusterType & cluster, const InputPixelType & _v, const PointType & pt);
 
private:
  SuperGridSizeType m_SuperGridSize{};
  unsigned int      m_MaximumNumberOfIterations{};
  double            m_SpatialProximityWeight{ 10.0 };
 
  FixedArray<double, ImageDimension> m_DistanceScales{};
  std::vector<ClusterComponentType>  m_Clusters{};
  std::vector<ClusterComponentType>  m_OldClusters{};
 
 
  void
  RelabelConnectedRegion(const IndexType &        seed,
                         OutputPixelType          requiredLabel,
                         OutputPixelType          outputLabel,
                         std::vector<IndexType> & indexStack);
 
  struct UpdateCluster
  {
    size_t                           count;
    vnl_vector<ClusterComponentType> cluster;
  };
 
  using UpdateClusterMap = std::map<size_t, UpdateCluster>;
 
  using MarkerImageType = Image<unsigned char, ImageDimension>;
 
  std::vector<UpdateClusterMap> m_UpdateClusterPerThread{};
 
  typename DistanceImageType::Pointer m_DistanceImage{};
  typename MarkerImageType::Pointer   m_MarkerImage{};
 
  bool m_EnforceConnectivity{ true };
 
  bool m_InitializationPerturbation{ true };
 
  double     m_AverageResidual{};
  std::mutex m_Mutex{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSLICImageFilter.hxx"
#endif
 
#endif // itkSLICImageFilter_h