Remove muon dependency from DataHandling (#39008)

* remove muon dependency from datahandling

* move tests to muon

* add moved tests to commit

* remove unused LoadInstrumentFromNexus import from test

* fix tests and doxygen

* remove copy and move default constructor to header to try and fix doxygen

* fix bug in sphinx directive

* convert pureposixpath to str

* commit removal of loadmuonlog src

Author: MialLewis

Framework/DataHandling/CMakeLists.txt

@@ -78,7 +78,6 @@ set(SRC_FILES
     src/LoadISISNexusHelper.cpp
     src/LoadISISPolarizationEfficiencies.cpp
     src/LoadInstrument.cpp
-    src/LoadInstrumentFromNexus.cpp
     src/LoadInstrumentFromRaw.cpp
     src/LoadIsawDetCal.cpp
     src/LoadLog.cpp
@@ -87,7 +86,6 @@ set(SRC_FILES
     src/LoadMask.cpp
     src/LoadMcStas.cpp
     src/LoadMcStasNexus.cpp
-    src/LoadMuonLog.cpp
     src/LoadMuonNexusV2.cpp
     src/LoadMuonNexusV2NexusHelper.cpp
     src/LoadMuonStrategy.cpp
@@ -299,7 +297,6 @@ set(INC_FILES
     inc/MantidDataHandling/LoadISISNexusHelper.h
     inc/MantidDataHandling/LoadISISPolarizationEfficiencies.h
     inc/MantidDataHandling/LoadInstrument.h
-    inc/MantidDataHandling/LoadInstrumentFromNexus.h
     inc/MantidDataHandling/LoadInstrumentFromRaw.h
     inc/MantidDataHandling/LoadIsawDetCal.h
     inc/MantidDataHandling/LoadLog.h
@@ -308,7 +305,6 @@ set(INC_FILES
     inc/MantidDataHandling/LoadMask.h
     inc/MantidDataHandling/LoadMcStas.h
     inc/MantidDataHandling/LoadMcStasNexus.h
-    inc/MantidDataHandling/LoadMuonLog.h
     inc/MantidDataHandling/LoadMuonNexusV2.h
     inc/MantidDataHandling/LoadMuonNexusV2NexusHelper.h
     inc/MantidDataHandling/LoadMuonStrategy.h
@@ -512,7 +508,6 @@ set(TEST_FILES
     LoadILLTest.h
     LoadISISNexusTest.h
     LoadISISPolarizationEfficienciesTest.h
-    LoadInstrumentFromNexusTest.h
     LoadInstrumentFromRawTest.h
     LoadInstrumentTest.h
     LoadIsawDetCalTest.h
@@ -522,7 +517,6 @@ set(TEST_FILES
     LoadMaskTest.h
     LoadMcStasNexusTest.h
     LoadMcStasTest.h
-    LoadMuonLogTest.h
     LoadMuonNexusV2Test.h
     LoadNGEMTest.h
     LoadNXSPETest.h
@@ -687,7 +681,6 @@ target_link_libraries(
          Mantid::Kernel
          Mantid::Indexing
          Mantid::Parallel
-         Mantid::Muon
   PRIVATE Mantid::Json Boost::filesystem Mantid::NexusGeometry Mantid::LegacyNexus
 )
 

Framework/DataHandling/inc/MantidDataHandling/LoadIDFFromNexus.h

@@ -14,7 +14,7 @@
 
 namespace Mantid {
 namespace DataHandling {
-/** @class LoadIDFFromNexus LoadInstrumentFromNexus.h
+/** @class LoadIDFFromNexus LoadIDFFromNexus.h
 DataHandling/LoadIDFFromNexus.h
 
 Load an IDF from a Nexus file, if found there.

Framework/DataHandling/test/UpdateInstrumentFromFileTest.h

@@ -15,7 +15,6 @@
 #include "MantidAPI/SpectrumInfo.h"
 #include "MantidDataHandling/GroupDetectors2.h"
 #include "MantidDataHandling/LoadInstrument.h"
-#include "MantidDataHandling/LoadInstrumentFromNexus.h"
 #include "MantidDataHandling/UpdateInstrumentFromFile.h"
 #include "MantidDataObjects/WorkspaceCreation.h"
 #include "MantidGeometry/Instrument.h"

Framework/Muon/CMakeLists.txt

@@ -10,10 +10,12 @@ set(SRC_FILES
     src/ConvertFitFunctionForMuonTFAsymmetry.cpp
     src/EstimateMuonAsymmetryFromCounts.cpp
     src/LoadAndApplyMuonDetectorGrouping.cpp
+    src/LoadInstrumentFromNexus.cpp
     src/LoadMuonNexus.cpp
     src/LoadMuonNexus1.cpp
     src/LoadMuonNexus2.cpp
     src/LoadMuonNexus3.cpp
+    src/LoadMuonLog.cpp
     src/MuonAlgorithmHelper.cpp
     src/MuonAsymmetryHelper.cpp
     src/MuonGroupDetectors.cpp
@@ -40,10 +42,12 @@ set(INC_FILES
     inc/MantidMuon/CalMuonDetectorPhases.h
     inc/MantidMuon/ConvertFitFunctionForMuonTFAsymmetry.h
     inc/MantidMuon/LoadAndApplyMuonDetectorGrouping.h
+    inc/MantidMuon/LoadInstrumentFromNexus.h
     inc/MantidMuon/LoadMuonNexus.h
     inc/MantidMuon/LoadMuonNexus1.h
     inc/MantidMuon/LoadMuonNexus2.h
     inc/MantidMuon/LoadMuonNexus3.h
+    inc/MantidMuon/LoadMuonLog.h
     inc/MantidMuon/EstimateMuonAsymmetryFromCounts.h
     inc/MantidMuon/MuonAlgorithmHelper.h
     inc/MantidMuon/MuonAsymmetryHelper.h
@@ -71,9 +75,11 @@ set(TEST_FILES
     CalMuonDetectorPhasesTest.h
     ConvertFitFunctionForMuonTFAsymmetryTest.h
     LoadAndApplyMuonDetectorGroupingTest.h
+    LoadInstrumentFromNexusTest.h
     LoadMuonNexus1Test.h
     LoadMuonNexus2Test.h
     LoadMuonNexus3Test.h
+    LoadMuonLogTest.h
     MuonAlgorithmHelperTest.h
     EstimateMuonAsymmetryFromCountsTest.h
     MuonGroupDetectorsTest.h

Framework/DataHandling/inc/MantidDataHandling/LoadInstrumentFromNexus.h renamed to Framework/Muon/inc/MantidMuon/LoadInstrumentFromNexus.h

@@ -10,7 +10,7 @@
 // Includes
 //----------------------------------------------------------------------
 #include "MantidAPI/Algorithm.h"
-#include "MantidDataHandling/DllConfig.h"
+#include "MantidMuon/DllConfig.h"
 
 namespace Mantid {
 
@@ -20,9 +20,9 @@ class Component;
 class Instrument;
 } // namespace Geometry
 
-namespace DataHandling {
+namespace Muon {
 /** @class LoadInstrumentFromNexus LoadInstrumentFromNexus.h
-DataHandling/LoadInstrumentFromNexus.h
+Muon/LoadInstrumentFromNexus.h
 
 Attempts to load information about the instrument from a ISIS NeXus file. In
 particular attempt to
@@ -37,7 +37,7 @@ other Loadxxx algorithms, rather than being used directly.
 It is used by LoadMuonNexus version 1.
 
 LoadInstrumentFromNexus is an algorithm and as such inherits
-from the Algorithm class, via DataHandlingCommand, and overrides
+from the Algorithm class, and overrides
 the init() & exec()  methods.
 
 Required Properties:
@@ -51,7 +51,7 @@ data to be added.</LI>
 @date 2/5/2008
 @author Ronald Fowler, ISIS, RAL (LoadInstrumentFromNexus)
 */
-class MANTID_DATAHANDLING_DLL LoadInstrumentFromNexus final : public API::Algorithm {
+class MANTID_MUON_DLL LoadInstrumentFromNexus final : public API::Algorithm {
 public:
   /// Default constructor
   LoadInstrumentFromNexus();
@@ -73,7 +73,7 @@ class MANTID_DATAHANDLING_DLL LoadInstrumentFromNexus final : public API::Algori
   const std::vector<std::string> seeAlso() const override { return {"LoadInstrument", "Load"}; }
 
   /// Algorithm's category for identification overriding a virtual method
-  const std::string category() const override { return "DataHandling\\Instrument"; }
+  const std::string category() const override { return "Muon\\DataHandling"; }
 
 private:
   /// Overwrites Algorithm method. Does nothing at present
@@ -86,5 +86,5 @@ class MANTID_DATAHANDLING_DLL LoadInstrumentFromNexus final : public API::Algori
   std::string m_filename;
 };
 
-} // namespace DataHandling
+} // namespace Muon
 } // namespace Mantid

Framework/DataHandling/inc/MantidDataHandling/LoadMuonLog.h renamed to Framework/Muon/inc/MantidMuon/LoadMuonLog.h

@@ -11,13 +11,13 @@
 //----------------------------------------------------------------------
 #include "MantidAPI/Algorithm.h"
 #include "MantidAPI/MatrixWorkspace.h"
-#include "MantidDataHandling/DllConfig.h"
+#include "MantidMuon/DllConfig.h"
 #include "MantidMuon/MuonNexusReader.h"
 
 namespace Mantid {
 
-namespace DataHandling {
-/** @class LoadMuonLog LoadMuonLog.h DataHandling/LoadMuonLog.h
+namespace Muon {
+/** @class LoadMuonLog LoadMuonLog.h Muon/LoadMuonLog.h
 
 Load ISIS Muon log data from a NeXus file. Sections of NXlog values within the
 first run will be loaded.
@@ -40,10 +40,10 @@ Required Properties:
 @author Ronald Fowler, based on LoadLog by Anders Markvardsen, ISIS, RAL
 @date 11/08/2008
 */
-class MANTID_DATAHANDLING_DLL LoadMuonLog final : public API::Algorithm {
+class MANTID_MUON_DLL LoadMuonLog final : public API::Algorithm {
 public:
   /// Default constructor
-  LoadMuonLog();
+  LoadMuonLog() = default;
   /// Algorithm's name for identification overriding a virtual method
   const std::string name() const override { return "LoadMuonLog"; };
   /// Summary of algorithms purpose
@@ -53,7 +53,7 @@ class MANTID_DATAHANDLING_DLL LoadMuonLog final : public API::Algorithm {
   int version() const override { return 1; };
   const std::vector<std::string> seeAlso() const override { return {"LoadLog", "LoadLogPropertyTable"}; }
   /// Algorithm's category for identification overriding a virtual method
-  const std::string category() const override { return "DataHandling\\Logs;Muon\\DataHandling"; }
+  const std::string category() const override { return "Muon\\DataHandling"; }
 
 private:
   /// Overwrites Algorithm method.
@@ -76,5 +76,5 @@ class MANTID_DATAHANDLING_DLL LoadMuonLog final : public API::Algorithm {
   bool isDateTimeString(const std::string &str);
 };
 
-} // namespace DataHandling
+} // namespace Muon
 } // namespace Mantid

Framework/DataHandling/src/LoadInstrumentFromNexus.cpp renamed to Framework/Muon/src/LoadInstrumentFromNexus.cpp

@@ -7,7 +7,7 @@
 //----------------------------------------------------------------------
 // Includes
 //----------------------------------------------------------------------
-#include "MantidDataHandling/LoadInstrumentFromNexus.h"
+#include "MantidMuon/LoadInstrumentFromNexus.h"
 #include "MantidAPI/FileProperty.h"
 #include "MantidAPI/MatrixWorkspace.h"
 #include "MantidGeometry/Instrument.h"
@@ -19,7 +19,7 @@
 
 #include <fstream>
 
-namespace Mantid::DataHandling {
+namespace Mantid::Muon {
 
 DECLARE_ALGORITHM(LoadInstrumentFromNexus)
 
@@ -86,4 +86,4 @@ void LoadInstrumentFromNexus::exec() {
   progress(1.0);
 }
 
-} // namespace Mantid::DataHandling
+} // namespace Mantid::Muon

Framework/DataHandling/src/LoadMuonLog.cpp renamed to Framework/Muon/src/LoadMuonLog.cpp

@@ -4,7 +4,7 @@
 //   NScD Oak Ridge National Laboratory, European Spallation Source,
 //   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
 // SPDX - License - Identifier: GPL - 3.0 +
-#include "MantidDataHandling/LoadMuonLog.h"
+#include "MantidMuon/LoadMuonLog.h"
 #include "MantidAPI/FileProperty.h"
 #include "MantidAPI/Run.h"
 #include "MantidAPI/Sample.h"
@@ -20,7 +20,7 @@ void toLower(std::string &name) {
 }
 } // namespace
 
-namespace Mantid::DataHandling {
+namespace Mantid::Muon {
 
 // Register the algorithm into the algorithm factory
 DECLARE_ALGORITHM(LoadMuonLog)
@@ -33,9 +33,6 @@ using API::Progress;
 using API::WorkspaceProperty;
 using DataObjects::Workspace2D_sptr;
 
-/// Empty default constructor
-LoadMuonLog::LoadMuonLog() = default;
-
 /// Initialisation method.
 void LoadMuonLog::init() {
   // When used as a Child Algorithm the workspace name is not used - hence the
@@ -70,9 +67,9 @@ void LoadMuonLog::exec() {
   localWorkspace->mutableSample().setName(nxload.getSampleName());
 
   std::set<std::string> logNames;
-  auto logs = localWorkspace->mutableRun().getLogData();
+  const auto &logs = localWorkspace->mutableRun().getLogData();
   // need to remove case
-  for (auto log : logs) {
+  for (const auto &log : logs) {
     std::string logName = log->name();
     toLower(logName);
     logNames.insert(logName);
@@ -156,4 +153,4 @@ bool LoadMuonLog::isDateTimeString(const std::string &str) {
   return false;
 }
 
-} // namespace Mantid::DataHandling
+} // namespace Mantid::Muon

Framework/DataHandling/test/LoadInstrumentFromNexusTest.h renamed to Framework/Muon/test/LoadInstrumentFromNexusTest.h

@@ -8,12 +8,11 @@
 
 #include <cxxtest/TestSuite.h>
 
-#include "MantidDataHandling/LoadInstrumentFromNexus.h"
 #include "MantidFrameworkTestHelpers/WorkspaceCreationHelper.h"
 #include "MantidGeometry/Instrument.h"
+#include "MantidMuon/LoadInstrumentFromNexus.h"
 
 using namespace Mantid;
-using namespace Mantid::DataHandling;
 using namespace Mantid::API;
 using namespace Mantid::Geometry;
 using Mantid::Kernel::V3D;
@@ -27,7 +26,7 @@ class LoadInstrumentFromNexusTest : public CxxTest::TestSuite {
 
   void testLoadInstrumentFromNexus() {
     // setup and run the algorithm (includes basic checks)
-    LoadInstrumentFromNexus alg;
+    Muon::LoadInstrumentFromNexus alg;
     const MatrixWorkspace_sptr ws = setupAlgorithm(alg, "MUSR00015189.nxs");
     runAlgorithm(alg);
 
@@ -60,7 +59,7 @@ class LoadInstrumentFromNexusTest : public CxxTest::TestSuite {
 
   // Initialise the algorithm and set the properties. Creates a fake
   // workspace for the input.
-  const MatrixWorkspace_sptr setupAlgorithm(LoadInstrumentFromNexus &alg, const std::string &filename) {
+  const MatrixWorkspace_sptr setupAlgorithm(Muon::LoadInstrumentFromNexus &alg, const std::string &filename) {
     // create the workspace
     const MatrixWorkspace_sptr inWS = makeFakeWorkspace();
 
@@ -74,7 +73,7 @@ class LoadInstrumentFromNexusTest : public CxxTest::TestSuite {
   }
 
   // Run the algorithm and do some basic checks
-  void runAlgorithm(LoadInstrumentFromNexus &alg) {
+  void runAlgorithm(Muon::LoadInstrumentFromNexus &alg) {
     // run the algorithm
     TS_ASSERT_THROWS_NOTHING(alg.execute());
     TS_ASSERT(alg.isExecuted());

Framework/DataHandling/test/LoadMuonLogTest.h renamed to Framework/Muon/test/LoadMuonLogTest.h

@@ -20,18 +20,18 @@
 #include "MantidAPI/Run.h"
 #include "MantidAPI/Workspace.h"
 #include "MantidAPI/WorkspaceFactory.h"
-#include "MantidDataHandling/LoadMuonLog.h"
 #include "MantidDataObjects/Workspace2D.h"
 #include "MantidGeometry/Instrument.h"
 #include "MantidKernel/Exception.h"
 #include "MantidKernel/TimeSeriesProperty.h"
+#include "MantidMuon/LoadMuonLog.h"
 #include <Poco/Path.h>
 #include <vector>
 
 using namespace Mantid::API;
 using namespace Mantid::Kernel;
 using namespace Mantid::DataObjects;
-using Mantid::DataHandling::LoadMuonLog;
+using Mantid::Muon::LoadMuonLog;
 
 class LoadMuonLogTest : public CxxTest::TestSuite {
 public: