ReadGroupsFromFile.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
 
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/Workspace2D.h"
#include <unordered_map>
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL ReadGroupsFromFile final : public API::Algorithm {
public:
  ReadGroupsFromFile();
  const std::string name() const override { return "ReadGroupsFromFile"; }
  const std::string summary() const override {
    return "Read a diffraction calibration file (*.cal) or an XML grouping "
           "file (*.xml) and an instrument name, and output a 2D workspace "
           "containing on the Y-axis the values of the Group each detector "
           "belongs to.  This is used to visualise the grouping scheme for "
           "powder diffractometers, where a large number of detectors are "
           "grouped together. The output 2D workspace can be visualize using "
           "the show instrument method.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override {
    return {"CreateDummyCalFile", "CreateCalFileByNames", "AlignDetectors", "DiffractionFocussing",
            "LoadCalFile",        "SaveCalFile",          "MergeCalFiles"};
  }
  const std::string category() const override { return "Diffraction\\DataHandling\\CalFiles"; }
 
private:
  using calmap = std::unordered_map<int, std::pair<int, int>>;
  void init() override;
  void exec() override;
  void readGroupingFile(const std::string &filename);
  void readXMLGroupingFile(const std::string &filename);
  DataObjects::Workspace2D_sptr loadEmptyInstrument(const std::string &instrument_xml_name);
  calmap calibration;
};
 
} // namespace Algorithms
} // namespace Mantid