CreateDummyCalFile.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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
 
// To be compatible with MSVC++ Express Edition that does not have TR1 headers
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include <map>
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL CreateDummyCalFile final : public API::Algorithm {
public:
  const std::string name() const override { return "CreateDummyCalFile"; }
  const std::string summary() const override {
    return "Create a calibration file (extension .cal) from a workspace by "
           "harvesting the detector ids from the instrument. All of the "
           "offsets will be zero, and the pixels will be all grouped into "
           "group one and the final column should be one. This will allow "
           "generating powder patterns from instruments that have not done a "
           "proper calibration.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override {
    return {"ReadGroupsFromFile", "CreateCalFileByNames", "AlignDetectors", "DiffractionFocussing",
            "LoadCalFile",        "SaveCalFile",          "MergeCalFiles"};
  }
  const std::string category() const override { return "Diffraction\\DataHandling\\CalFiles"; }
 
private:
  using instrcalmap = std::map<int, std::pair<int, int>>;
  void init() override;
  void exec() override;
  std::string m_filename;
  bool groupingFileDoesExist(const std::string &filename) const;
  void saveGroupingFile(const std::string &, bool overwrite) const;
  static void writeCalEntry(std::ostream &os, int number, int udet, double offset, int select, int group);
  void writeHeaders(std::ostream &os, const std::string &filename, bool overwrite) const;
  std::string groups;
  instrcalmap instrcalib;
};
 
} // namespace Algorithms
} // namespace Mantid