CreateSimulationWorkspace.h

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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 "MantidGeometry/Instrument.h"
#include "MantidKernel/cow_ptr.h"

namespace Mantid {
namespace HistogramData {
class BinEdges;
}
namespace DataHandling {

class DLLExport CreateSimulationWorkspace : public API::Algorithm {
public:
  const std::string name() const override;
  /// Summary of algorithms purpose
  const std::string summary() const override {
    return "Create a blank workspace for a given instrument.";
  }

  int version() const override;
  const std::string category() const override;

private:
  void init() override;
  void exec() override;

  /// Create the instrument
  void createInstrument();
  /// Creates the output workspace
  void createOutputWorkspace();
  /// Creates the detector grouping list
  size_t createDetectorMapping();
  /// Create a one to one mapping from the spectrum numbers to detector IDs
  void createOneToOneMapping();
  /// Load the detector mapping from a file
  void loadMappingFromFile(const std::string &filename);
  /// Load the detector mapping from a RAW file
  void loadMappingFromRAW(const std::string &filename);
  /// Load the detector mapping from a NXS file
  void loadMappingFromISISNXS(const std::string &filename);
  /// Create the grouping map from the tables
  void createGroupingsFromTables(int *specTable, int *udetTable, int ndets);
  /// Returns new Xbins
  HistogramData::BinEdges createBinBoundaries() const;
  /// Apply the created mapping to the workspace
  void applyDetectorMapping();
  /// Apply any instrument adjustments from the file
  void adjustInstrument(const std::string &filename);
  /// Set start date for dummy workspace
  void setStartDate(API::MatrixWorkspace_sptr workspace);

  /// Pointer to a progress object
  boost::shared_ptr<API::Progress> m_progress;
  /// Pointer to the new instrument
  Geometry::Instrument_const_sptr m_instrument;
  /// Pointer to the new workspace
  API::MatrixWorkspace_sptr m_outputWS;
  /// List of detector groupings
  std::map<specnum_t, std::set<detid_t>> m_detGroups;
};

} // namespace DataHandling
} // namespace Mantid