new bilby loader (#39928)

The ANSTO Bilby instrument has had an upgrade and is now able to save a
new file format, in parallel to the existing file, that supports
timestamping of all events. This submission is a loader for the new file
format so that scientists can transition to the new file structure and
it assess it's new capabilities. The submission includes minimal unit
and doc tests to demonstrate that it is ready to be evaluated.

Author: geishm-ansto

Framework/DataHandling/CMakeLists.txt

@@ -38,6 +38,7 @@ set(SRC_FILES
     src/LoadAscii2.cpp
     src/LoadAsciiStl.cpp
     src/LoadBBY.cpp
+    src/LoadBBY2.cpp
     src/LoadBankFromDiskTask.cpp
     src/LoadBinaryStl.cpp
     src/LoadCSNSNexus.cpp
@@ -258,6 +259,7 @@ set(INC_FILES
     inc/MantidDataHandling/LoadAscii2.h
     inc/MantidDataHandling/LoadAsciiStl.h
     inc/MantidDataHandling/LoadBBY.h
+    inc/MantidDataHandling/LoadBBY2.h
     inc/MantidDataHandling/LoadBankFromDiskTask.h
     inc/MantidDataHandling/LoadBinaryStl.h
     inc/MantidDataHandling/LoadCSNSNexus.h
@@ -475,6 +477,7 @@ set(TEST_FILES
     LoadAsciiStlTest.h
     LoadAsciiTest.h
     LoadBBYTest.h
+    LoadBBY2Test.h
     LoadBinaryStlTest.h
     LoadCSNSNexusTest.h
     LoadCalFileTest.h

Framework/DataHandling/inc/MantidDataHandling/LoadANSTOHelper.h

@@ -11,9 +11,11 @@
 //---------------------------------------------------
 
 #include "MantidAPI/IFileLoader.h"
+#include "MantidAPI/LogManager.h"
 #include "MantidDataObjects/EventWorkspace.h"
 #include "MantidGeometry/Instrument.h"
 #include "MantidNexus/NexusClasses_fwd.h"
+#include <algorithm>
 #include <regex>
 
 #define TarTypeFlag_NormalFile '0'
@@ -55,6 +57,7 @@ class ProgressTracker {
   // methods
   void update(int64_t position);
   void complete();
+  void setTarget(int64_t target);
 };
 
 class EventProcessor {
@@ -219,12 +222,12 @@ class File {
   size_t m_bufferAvailable;
 
   // not supported
-  File(const File &);
-  File &operator=(const File &);
+  File(const File &) = delete;
+  File &operator=(const File &) = delete;
 
 public:
   // construction
-  File(const std::string &path);
+  explicit File(const std::string &path);
   void close();
 
   // properties
@@ -246,6 +249,34 @@ class File {
 };
 
 } // namespace Tar
+
+namespace Anxs {
+// options to capture timeseries data
+enum class ScanLog { Start, End, Mean };
+
+std::string extractWorkspaceTitle(const std::string &nxsFile);
+
+int64_t epochRelDateTimeBase(int64_t epochInNanoSeconds);
+
+template <typename T> bool loadNXDataSet(const Nexus::NXEntry &entry, const std::string &path, T &value, int index);
+bool loadNXString(const Nexus::NXEntry &entry, const std::string &path, std::string &value);
+
+bool isTimedDataSet(const Nexus::NXEntry &entry, const std::string &path);
+std::pair<uint64_t, uint64_t> getTimeScanLimits(const Nexus::NXEntry &entry, int datasetIx);
+std::pair<uint64_t, uint64_t> getHMScanLimits(const Nexus::NXEntry &entry, int datasetIx);
+
+template <typename T>
+uint64_t extractTimedDataSet(const Nexus::NXEntry &entry, const std::string &path, uint64_t startTime, uint64_t endTime,
+                             std::vector<uint64_t> &times, std::vector<T> &events, std::string &units);
+template <typename T>
+bool extractTimedDataSet(const Nexus::NXEntry &entry, const std::string &path, uint64_t startTime, uint64_t endTime,
+                         ScanLog valueOption, uint64_t &eventTime, T &eventValue, std::string &units);
+
+void ReadEventData(ProgressTracker &prog, const Nexus::NXEntry &entry, EventProcessor *handler, uint64_t start_nsec,
+                   uint64_t end_nsec, const std::string &neutron_path, int tube_resolution = 1024);
+
+} // namespace Anxs
+
 } // namespace ANSTO
 } // namespace DataHandling
 } // namespace Mantid

Framework/DataHandling/inc/MantidDataHandling/LoadBBY2.h

@@ -0,0 +1,86 @@
+// 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
+
+//---------------------------------------------------
+// Includes
+//---------------------------------------------------
+
+// #include "MantidAPI/IFileLoader.h"
+#include "MantidAPI/NexusFileLoader.h"
+#include "MantidDataHandling/DllConfig.h"
+#include "MantidDataHandling/LoadANSTOHelper.h"
+#include "MantidDataObjects/EventWorkspace.h"
+#include "MantidGeometry/Instrument.h"
+#include "MantidNexus/NexusClasses_fwd.h"
+#include "MantidNexus/NexusDescriptor.h"
+
+namespace Mantid {
+namespace DataHandling {
+/*
+Loads a Bilby data file. Implements API::IFileLoader and its file check methods
+to recognise a file as the one containing Bilby data.
+
+@author David Mannicke (ANSTO), Anders Markvardsen (ISIS), Roman Tolchenov
+(Tessella plc)
+@date 11/07/2014
+*/
+
+class MANTID_DATAHANDLING_DLL LoadBBY2 : public API::NexusFileLoader {
+
+  struct InstrumentInfo {
+    // core values or non standard conversion
+    std::string sample_name;
+    std::string sample_description;
+    std::string start_time;
+    int64_t bm_counts;
+    int32_t att_pos;
+    int64_t master1_chopper_id;
+    int64_t master2_chopper_id;
+    bool is_tof;       // tof or wavelength data
+    double wavelength; // -> /nvs067/lambda
+    double period_master;
+    double period_slave;
+    double phase_slave;
+  };
+
+public:
+  // description
+  LoadBBY2();
+  int version() const override { return 1; }
+  const std::vector<std::string> seeAlso() const override { return {"Load", "LoadBBY"}; }
+  const std::string name() const override { return "LoadBBY2"; }
+  const std::string category() const override { return "DataHandling\\ANSTO"; }
+  const std::string summary() const override { return "Loads a Bilby data file into a workspace."; }
+
+  // returns a confidence value that this algorithm can load a specified file
+  int confidence(Nexus::NexusDescriptor &descriptor) const override;
+
+protected:
+  // initialisation
+  void init() override;
+  // execution
+  void execLoader() override;
+
+private:
+  // region of interest
+  static std::vector<bool> createRoiVector(const std::string &maskfile);
+
+  // instrument creation
+  void createInstrument(const Nexus::NXEntry &entry, uint64_t startTime, uint64_t endTime,
+                        InstrumentInfo &instrumentInfo, std::map<std::string, double> &logParams,
+                        std::map<std::string, std::string> &logStrings, std::map<std::string, std::string> &allParams);
+  void loadInstrumentParameters(const Nexus::NXEntry &entry, uint64_t startTime, uint64_t endTime,
+                                std::map<std::string, double> &logParams,
+                                std::map<std::string, std::string> &logStrings,
+                                std::map<std::string, std::string> &allParams);
+
+  bool useHMScanTime{false};
+};
+
+} // namespace DataHandling
+} // namespace Mantid