ICluster.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 "MantidCrystal/DisjointElement.h"
#include "MantidCrystal/DllConfig.h"
#include "MantidKernel/System.h"
#include <boost/tuple/tuple.hpp>
#include <memory>
#include <vector>
 
namespace Mantid {
namespace API {
class IMDHistoWorkspace;
}
namespace Crystal {
 
class MANTID_CRYSTAL_DLL ICluster {
public:
  using ClusterIntegratedValues = boost::tuple<double, double>;
 
  virtual ClusterIntegratedValues integrate(std::shared_ptr<const Mantid::API::IMDHistoWorkspace> ws) const = 0;
 
  virtual void writeTo(std::shared_ptr<Mantid::API::IMDHistoWorkspace> ws) const = 0;
 
  virtual size_t getOriginalLabel() const = 0;
 
  virtual size_t getLabel() const = 0;
 
  virtual size_t size() const = 0;
 
  virtual void addIndex(const size_t &index) = 0;
 
  virtual void toUniformMinimum(std::vector<DisjointElement> &disjointSet) = 0;
 
  virtual ~ICluster() = default;
 
  virtual void setRootCluster(ICluster const *root) = 0;
 
  virtual size_t getRepresentitiveIndex() const = 0;
 
  virtual bool containsLabel(const size_t &label) const = 0;
};
 
} // namespace Crystal
} // namespace Mantid