CreateSampleWorkspace.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2014 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/MatrixWorkspace_fwd.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidGeometry/Instrument.h"
#include "MantidGeometry/Objects/CSGObject.h"
#include "MantidKernel/PseudoRandomNumberGenerator.h"
 
#include <span>
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL CreateSampleWorkspace final : public API::Algorithm {
public:
  CreateSampleWorkspace();
 
  const std::string name() const override;
  int version() const override;
  const std::vector<std::string> seeAlso() const override { return {"CreateWorkspace"}; }
  const std::string category() const override;
  const std::string summary() const override {
    return "Creates sample workspaces for usage examples and other situations.";
  }
 
private:
  void init() override;
  void exec() override;
 
  DataObjects::EventWorkspace_sptr createEventWorkspace(int numPixels, int numBins, int numMonitors, int numEvents,
                                                        double x0, double binDelta,
                                                        const Geometry::Instrument_sptr &inst,
                                                        const std::string &functionString, bool isRandom);
  API::MatrixWorkspace_sptr createHistogramWorkspace(int numPixels, int numBins, int numMonitors, double x0,
                                                     double binDelta, const Geometry::Instrument_sptr &inst,
                                                     const std::string &functionString, bool isRandom);
  API::MatrixWorkspace_sptr createScanningWorkspace(int numBins, double x0, double binDelta,
                                                    const Geometry::Instrument_sptr &inst,
                                                    const std::string &functionString, bool isRandom,
                                                    int numScanPoints);
  Geometry::Instrument_sptr createTestInstrumentRectangular(API::Progress &progress, int numBanks, int numMonitors,
                                                            int pixels, double pixelDiameter, double pixelHeight,
                                                            double pixelSpacing, const double bankDistanceFromSample,
                                                            const double sourceSampleDistance,
                                                            const std::string &instrName);
  Geometry::IObject_sptr createCappedCylinder(double radius, double height, const Kernel::V3D &baseCentre,
                                              const Kernel::V3D &axis, const std::string &id);
  Geometry::IObject_sptr createSphere(double radius, const Kernel::V3D &centre, const std::string &id);
  std::vector<double> evalFunction(const std::string &functionString, std::span<double const> xVal, double noiseScale);
  void replaceAll(std::string &str, const std::string &from, const std::string &to);
  void addChopperParameters(API::MatrixWorkspace_sptr &ws);
 
  std::unique_ptr<Kernel::PseudoRandomNumberGenerator> m_randGen;
  std::map<std::string, std::string> m_preDefinedFunctionmap;
};
 
} // namespace Algorithms
} // namespace Mantid