SaveGSS.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/Algorithm.h"
#include "MantidAPI/Run.h"
#include "MantidAPI/SpectrumInfo.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidKernel/cow_ptr.h"
 
#include <iosfwd>
#include <memory>
#include <string>
#include <vector>
 
// Forward declare
namespace Mantid {
namespace HistogramData {
class Histogram;
}
 
namespace DataHandling {
class MANTID_DATAHANDLING_DLL SaveGSS : public Mantid::API::Algorithm {
public:
  const std::string name() const override { return "SaveGSS"; }
  const std::string summary() const override { return "Saves a focused data set into a three column GSAS format."; }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override {
    return {"LoadGSS", "SaveVulcanGSS", "SaveGSASInstrumentFile", "SaveAscii"};
  }
  const std::string category() const override { return "Diffraction\\DataHandling;DataHandling\\Text"; }
 
private:
  void init() override;
  void exec() override;
 
  bool areAllDetectorsValid() const;
 
  void processUserSpecifiedHeaders();
 
  void generateBankData(std::stringstream &outBuf, size_t specIndex, const std::string &outputFormat,
                        const std::vector<int> &slog_xye_precisions) const;
 
  void generateBankHeader(std::stringstream &out, const API::SpectrumInfo &spectrumInfo, size_t specIndex) const;
 
  void generateGSASBuffer(size_t numOutFiles, size_t numOutSpectra);
 
  void generateInstrumentHeader(std::stringstream &out, double l1) const;
 
  void generateOutFileNames(size_t numberOfOutFiles);
 
  void getLogValue(std::stringstream &out, const API::Run &runInfo, const std::string &name,
                   const std::string &failsafeValue = "UNKNOWN") const;
 
  bool isInstrumentValid() const;
 
  void openFileStream(const std::string &outFilePath, std::ofstream &outStream);
 
  void setOtherProperties(IAlgorithm *alg, const std::string &propertyName, const std::string &propertyValue,
                          int periodNum) override;
 
  std::map<std::string, std::string> validateInputs() override;
 
  void writeBufferToFile(size_t numOutFiles, size_t numSpectra);
 
  // Writes the header for RALF data format to the buffer
  void writeRALFHeader(std::stringstream &out, int bank, const HistogramData::Histogram &histo) const;
 
  void writeRALF_ALTdata(std::stringstream &out, const int bank, const HistogramData::Histogram &histo) const;
 
  void writeRALF_XYEdata(const int bank, const bool MultiplyByBinWidth, std::stringstream &out,
                         const HistogramData::Histogram &histo) const;
 
  void writeSLOGdata(const size_t ws_index, const int bank, const bool MultiplyByBinWidth, std::stringstream &out,
                     const HistogramData::Histogram &histo, const std::vector<int> &xye_precision) const;
 
  API::MatrixWorkspace_const_sptr m_inputWS;
  std::vector<std::unique_ptr<std::stringstream>> m_outputBuffer{};
  std::vector<std::string> m_outFileNames{};
  bool m_allDetectorsValid{false};
  std::unique_ptr<API::Progress> m_progress{nullptr};
  std::vector<std::string> m_user_specified_gsas_header;
  bool m_overwrite_std_gsas_header{false};
  std::vector<std::string> m_user_specified_bank_headers;
  bool m_overwrite_std_bank_header{false};
};
} // namespace DataHandling
} // namespace Mantid