LoadCalFile.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 "MantidAPI/IAlgorithm.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidDataObjects/GroupingWorkspace.h"
#include "MantidDataObjects/MaskWorkspace.h"
#include "MantidDataObjects/OffsetsWorkspace.h"
#include "MantidGeometry/Instrument.h"
 
namespace Mantid {
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL LoadCalFile final : public API::Algorithm {
public:
  const std::string name() const override { return "LoadCalFile"; };
  const std::string summary() const override {
    return "Loads a 5-column ASCII .cal file into up to 3 workspaces: a "
           "GroupingWorkspace, OffsetsWorkspace and/or MaskWorkspace.";
  }
 
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override {
    return {"LoadDiffCal",    "ReadGroupsFromFile",   "CreateDummyCalFile", "CreateCalFileByNames",
            "AlignDetectors", "DiffractionFocussing", "SaveCalFile",        "MergeCalFiles"};
  }
  const std::string category() const override { return R"(DataHandling\Text;Diffraction\DataHandling\CalFiles)"; }
 
  static void getInstrument3WaysInit(Mantid::API::Algorithm *alg);
 
  static Geometry::Instrument_const_sptr getInstrument3Ways(API::Algorithm *alg);
  static bool instrumentIsSpecified(API::Algorithm *alg);
 
  static void readCalFile(const std::string &calFileName, const Mantid::DataObjects::GroupingWorkspace_sptr &groupWS,
                          const Mantid::DataObjects::OffsetsWorkspace_sptr &offsetsWS,
                          const Mantid::DataObjects::MaskWorkspace_sptr &maskWS);
 
protected:
  Parallel::ExecutionMode
  getParallelExecutionMode(const std::map<std::string, Parallel::StorageMode> &storageModes) const override;
 
private:
  void init() override;
  void exec() override;
 
  static bool idIsMonitor(const Mantid::Geometry::Instrument_const_sptr &inst, int detID);
};
 
} // namespace DataHandling
} // namespace Mantid