SaveFocusedXYE.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
 
#include "MantidAPI/SerialAlgorithm.h"
#include "MantidDataHandling/DllConfig.h"
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL SaveFocusedXYE : public API::SerialAlgorithm {
public:
  enum HeaderType { XYE, MAUD, TOPAS };
  const std::string name() const override { return "SaveFocusedXYE"; }
  const std::string summary() const override {
    return "Saves a focused data set (usually the output of a diffraction "
           "focusing routine but not exclusively) into a three column format "
           "containing X_i, Y_i, and E_i.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"SaveFullprofResolution", "SaveAscii"}; }
  const std::string category() const override { return "Diffraction\\DataHandling;DataHandling\\Text"; }
 
private:
  void init() override;
  void exec() override;
  void writeHeaders(std::ostream &os, API::MatrixWorkspace_const_sptr &workspace) const;
  void writeXYEHeaders(std::ostream &os, API::MatrixWorkspace_const_sptr &workspace) const;
  void writeMAUDHeaders(std::ostream &os, API::MatrixWorkspace_const_sptr &workspace) const;
  void writeSpectraHeader(std::ostream &os, size_t index1, size_t index2, double flightPath, double tth,
                          const std::string &caption, const std::string &spectraAxisCaption,
                          const std::string &spectraAxisLabel, double observable);
  void writeXYESpectraHeader(std::ostream &os, size_t index1, const std::string &caption,
                             const std::string &spectrumAxisCaption, const std::string &spectraAxisLabel,
                             double observable);
  void writeMAUDSpectraHeader(std::ostream &os, size_t index1, size_t index2, double flightPath, double tth,
                              const std::string &caption);
  void setOtherProperties(IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue,
                          int perioidNum) override;
 
  HeaderType m_headerType{XYE};
  std::string m_comment;
};
} // namespace DataHandling
} // namespace Mantid