SaveDetectorsGrouping.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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/Algorithm.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidDataObjects/GroupingWorkspace.h"
 
namespace Mantid {
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL SaveDetectorsGrouping final : public API::Algorithm {
public:
  const std::string name() const override { return "SaveDetectorsGrouping"; };
  const std::string summary() const override { return "Save a GroupingWorkspace to an XML file."; }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override { return {"LoadDetectorsGroupingFile", "GroupDetectors"}; }
  const std::string category() const override { return "DataHandling\\Grouping;Transforms\\Grouping"; }
 
private:
  void init() override;
 
  void exec() override;
 
  void createGroupDetectorIDMap(std::map<int, std::vector<detid_t>> &groupwkspmap);
 
  void convertToDetectorsRanges(std::map<int, std::vector<detid_t>> groupdetidsmap,
                                std::map<int, std::vector<detid_t>> &groupdetidrangemap);
 
  void printToXML(const std::map<int, std::vector<detid_t>> &groupdetidrangemap, const std::string &xmlfilename);
 
  // GroupingWorkspace
  DataObjects::GroupingWorkspace_const_sptr mGroupWS;
};
 
} // namespace DataHandling
} // namespace Mantid