ConnectedComponentLabeling.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2014 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidAPI/IMDHistoWorkspace_fwd.h"
#include "MantidCrystal/DisjointElement.h"
#include "MantidCrystal/DllConfig.h"
#include "MantidKernel/V3D.h"
#include <boost/tuple/tuple.hpp>
#include <map>
#include <memory>
#include <optional>
#include <unordered_set>
 
namespace Mantid {
namespace API {
class Progress;
}
 
namespace Crystal {
class ICluster;
namespace ConnectedComponentMappingTypes {
using SignalErrorSQPair = boost::tuple<double, double>;
using LabelIdIntensityMap = std::map<size_t, SignalErrorSQPair>;
using PositionToLabelIdMap = std::map<Mantid::Kernel::V3D, size_t>;
using VecIndexes = std::vector<size_t>;
using VecElements = std::vector<DisjointElement>;
using SetIds = std::unordered_set<size_t>;
using ClusterMap = std::map<size_t, std::shared_ptr<Mantid::Crystal::ICluster>>;
using ClusterTuple = boost::tuple<Mantid::API::IMDHistoWorkspace_sptr, ClusterMap>;
} // namespace ConnectedComponentMappingTypes
 
class BackgroundStrategy;
 
class MANTID_CRYSTAL_DLL ConnectedComponentLabeling {
 
public:
  ConnectedComponentLabeling(const size_t &startId = 1, const std::optional<int> &nThreads = std::nullopt);
 
  size_t getStartLabelId() const;
 
  void startLabelingId(const size_t &id);
 
  std::shared_ptr<Mantid::API::IMDHistoWorkspace> execute(Mantid::API::IMDHistoWorkspace_sptr ws,
                                                          BackgroundStrategy *const strategy,
                                                          Mantid::API::Progress &progress) const;
 
  ConnectedComponentMappingTypes::ClusterTuple executeAndFetchClusters(Mantid::API::IMDHistoWorkspace_sptr ws,
                                                                       BackgroundStrategy *const strategy,
                                                                       Mantid::API::Progress &progress) const;
 
  virtual ~ConnectedComponentLabeling();
 
private:
  ConnectedComponentMappingTypes::ClusterMap calculateDisjointTree(const Mantid::API::IMDHistoWorkspace_sptr &ws,
                                                                   BackgroundStrategy *const baseStrategy,
                                                                   Mantid::API::Progress &progress) const;
 
  size_t m_startId;
 
  int m_nThreadsToUse;
};
 
} // namespace Crystal
} // namespace Mantid