SaveSPE.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
 
//---------------------------------------------------
// Includes
//---------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidDataHandling/DllConfig.h"
#include "MantidKernel/cow_ptr.h"
#include <vector>
 
namespace Mantid {
namespace HistogramData {
class HistogramY;
class HistogramE;
} // namespace HistogramData
namespace DataHandling {
class MANTID_DATAHANDLING_DLL SaveSPE final : public API::Algorithm {
public:
  SaveSPE();
  const std::string name() const override { return "SaveSPE"; }
  const std::string summary() const override { return "Writes a workspace into a file the spe format."; }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"LoadSPE", "SavePAR", "SavePHX"}; }
  const std::string category() const override { return "DataHandling\\SPE;Inelastic\\DataHandling"; }
 
  static const double MASK_FLAG;
 
private:
  void init() override;
  void exec() override;
 
  void writeSPEFile(FILE *outSPEFile, const API::MatrixWorkspace_const_sptr &inputWS);
  void writeHists(const API::MatrixWorkspace_const_sptr &WS, FILE *const outFile);
  void writeHist(const API::MatrixWorkspace_const_sptr &WS, FILE *const outFile, const int wsIn) const;
  void writeMaskFlags(FILE *const outFile) const;
  void writeBins(const std::vector<double> &Vs, FILE *const outFile) const;
  void writeValue(const double value, FILE *const outFile) const;
  void logMissingMasked(const std::vector<int> &inds, const size_t nonMasked, const int masked) const;
 
  int m_remainder;
  size_t m_nBins;
 
  static const double MASK_ERROR;
 
  // temporary variable to keep verified signal values for current spectra
  mutable std::vector<double> m_tSignal;
  // temporary variable to keep verified error values for current spectra
  mutable std::vector<double> m_tError;
 
  // method verifies if a spectra contains any NaN or Inf values and replaces
  // these values with SPE-specified constants
  void check_and_copy_spectra(const HistogramData::HistogramY &inSignal, const HistogramData::HistogramE &inErr,
                              std::vector<double> &Signal, std::vector<double> &Error) const;
};
 
} // namespace DataHandling
} // namespace Mantid