Run.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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/DllConfig.h"
#include "MantidAPI/LogManager.h"
#include "MantidKernel/FilteredTimeSeriesProperty.h"
#include "MantidKernel/SplittingInterval.h"
 
#include <span>
#include <vector>
 
namespace Mantid {
 
namespace Kernel {
template <class T> class Matrix;
}
 
namespace Geometry {
class Goniometer;
}
 
namespace API {
 
class MANTID_API_DLL Run : public LogManager {
public:
  Run();
  Run(const Run &other);
  ~Run() override;
  Run &operator=(const Run &other);
  bool operator==(const Run &other);
  bool operator!=(const Run &other);
 
  std::shared_ptr<Run> clone();
 
  Run &operator+=(const Run &rhs);
 
  void filterByTime(const Types::Core::DateAndTime start, const Types::Core::DateAndTime stop) override;
  void setTimeROI(const Kernel::TimeROI &timeroi) override;
 
  size_t getMemorySize() const override;
 
  void setProtonCharge(const double charge);
  double getProtonCharge() const;
  void integrateProtonCharge(const std::string &logname = "proton_charge") const;
  std::tuple<double, double, double> getBadPulseRange(const std::string &logname = "proton_charge",
                                                      const double &cutoff = 95.) const;
 
  void setDuration();
 
  void storeHistogramBinBoundaries(std::span<double const> histoBins);
  std::pair<double, double> histogramBinBoundaries(const double value) const;
  std::vector<double> getBinBoundaries() const;
 
  void setGoniometer(const Geometry::Goniometer &goniometer, const bool useLogValues);
  void setGoniometers(const Geometry::Goniometer &goniometer);
  const Geometry::Goniometer &getGoniometer() const;
 
  Geometry::Goniometer &mutableGoniometer();
 
  const Kernel::Matrix<double> &getGoniometerMatrix() const;
 
  const Geometry::Goniometer &getGoniometer(const size_t index) const;
  Geometry::Goniometer &mutableGoniometer(const size_t index);
  size_t getNumGoniometers() const;
  const Kernel::Matrix<double> &getGoniometerMatrix(const size_t index) const;
  size_t addGoniometer(const Geometry::Goniometer &goniometer);
  void clearGoniometers();
  const std::vector<Kernel::Matrix<double>> getGoniometerMatrices() const;
 
  void saveNexus(Nexus::File *file, const std::string &group, bool keepOpen = false) const override;
 
  void loadNexus(Nexus::File *file, const std::string &group, const std::string &prefix,
                 bool keepOpen = false) override;
  void loadNexus(Nexus::File *file, const std::string &group, bool keepOpen = false) override;
 
private:
  void calculateAverageGoniometerMatrix();
  void calculateGoniometerMatrices(const Geometry::Goniometer &goniometer);
 
  std::vector<std::unique_ptr<Geometry::Goniometer>> m_goniometers;
  std::vector<double> m_histoBins;
 
  void mergeMergables(Mantid::Kernel::PropertyManager &sum, const Mantid::Kernel::PropertyManager &toAdd);
  void copyGoniometers(const Run &other);
 
  // Function common to loadNexus overloads populating relevant members
  void loadNexusCommon(Nexus::File *file, const std::string &nameClass);
};
} // namespace API
} // namespace Mantid