WIP Add a metadata only flag.

This loads everything but the pixel data. Refs #11056
mantidproject · Dec 11, 2015 · bb1760c · bb1760c
1 parent 4cf729a
commit bb1760c
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 32 deletions.
diff --git a/Framework/MDAlgorithms/src/LoadSQW2.cpp b/Framework/MDAlgorithms/src/LoadSQW2.cpp
@@ -93,10 +93,15 @@ int LoadSQW2::confidence(Kernel::FileDescriptor &descriptor) const {
 /// Initialize the algorithm's properties.
 void LoadSQW2::init() {
   using namespace API;
+  using Kernel::PropertyWithValue;
 
+  // Inputs
   declareProperty(
       new FileProperty("Filename", "", FileProperty::Load, {".sqw"}),
       "File of type SQW format");
+  declareProperty(new PropertyWithValue<bool>("MetadataOnly", false),
+                  "Load Metadata without events.");
+  // Outputs
   declareProperty(new WorkspaceProperty<IMDEventWorkspace>(
                       "OutputWorkspace", "", Kernel::Direction::Output),
                   "Output IMDEventWorkspace reflecting SQW data");
@@ -279,7 +284,9 @@ void LoadSQW2::skipDetectorSection() {
 void LoadSQW2::readDataSection() {
   skipDataSectionMetadata();
   readSQWDimensions();
-  readPixelData();
+  bool metadataOnly = getProperty("MetadataOnly");
+  if (!metadataOnly)
+    readPixelData();
 }
 
 /**

diff --git a/Framework/MDAlgorithms/test/LoadSQW2Test.h b/Framework/MDAlgorithms/test/LoadSQW2Test.h
@@ -56,11 +56,23 @@ class LoadSQW2Test : public CxxTest::TestSuite {
   }
 
   void test_OutputWorkspace_Has_Correct_Data() {
-    IMDEventWorkspace_sptr outputWS = runAlgorithm();
+    Arguments args;
+    args.metadataOnly = false;
+    IMDEventWorkspace_sptr outputWS = runAlgorithm(args);
 
     checkGeometryAsExpected(*outputWS);
     checkExperimentInfoAsExpected(*outputWS);
-    checkDataAsExpected(*outputWS);
+    checkDataAsExpected(*outputWS, args);
+  }
+
+  void test_OutputWorkspace_Has_No_Events_When_MetaDataOnly_Selected() {
+    Arguments args;
+    args.metadataOnly = true;
+    IMDEventWorkspace_sptr outputWS = runAlgorithm(args);
+
+    checkGeometryAsExpected(*outputWS);
+    checkExperimentInfoAsExpected(*outputWS);
+    checkDataAsExpected(*outputWS, args);
   }
 
   //----------------------------------------------------------------------------
@@ -73,10 +85,16 @@ class LoadSQW2Test : public CxxTest::TestSuite {
   }
 
 private:
-  IMDEventWorkspace_sptr runAlgorithm() {
+  struct Arguments {
+    Arguments() : metadataOnly(false) {}
+    bool metadataOnly;
+  };
+
+  IMDEventWorkspace_sptr runAlgorithm(Arguments args) {
     auto algm = createAlgorithm();
     algm->setProperty("Filename", m_filename);
     algm->setProperty("OutputWorkspace", "__unused_value_for_child_algorithm");
+    algm->setProperty("MetadataOnly", args.metadataOnly);
     algm->execute();
     return algm->getProperty("OutputWorkspace");
   }
@@ -168,34 +186,39 @@ class LoadSQW2Test : public CxxTest::TestSuite {
     TS_ASSERT_DELTA(0.0, vVec[2], 1e-04);
   }
 
-  void checkDataAsExpected(const IMDEventWorkspace &outputWS) {
-    TS_ASSERT_EQUALS(580, outputWS.getNEvents());
-    // equal split between experiments
-    size_t nexpt1(0), nexpt2(0);
-    // 10 detector Ids split evenly
-    std::vector<int> ids(10, 0);
-    auto iter = std::unique_ptr<IMDIterator>(outputWS.createIterator());
-    do {
-      auto nevents = iter->getNumEvents();
-      for (size_t i = 0; i < nevents; ++i) {
-        auto irun = iter->getInnerRunIndex(i);
-        TSM_ASSERT("Expected run index 0 or 1. Found " + std::to_string(irun),
-                   irun == 0 || irun == 1);
-        if (irun == 0)
-          nexpt1++;
-        else
-          nexpt2++;
-        auto idet = iter->getInnerDetectorID(i);
-        TSM_ASSERT("Expected 1 <= det ID <= 10. Found " + std::to_string(idet),
-                   1 <= idet || idet <= 10);
-        ids[idet - 1] += 1;
-      }
-    } while (iter->next());
-    TS_ASSERT_EQUALS(290, nexpt1);
-    TS_ASSERT_EQUALS(290, nexpt2);
-    // 58 events in each detector
-    std::vector<int> expectedIds(10, 58);
-    TS_ASSERT_EQUALS(expectedIds, ids);
+  void checkDataAsExpected(const IMDEventWorkspace &outputWS, Arguments args) {
+    if (args.metadataOnly) {
+      TS_ASSERT_EQUALS(0, outputWS.getNEvents());
+    } else {
+      TS_ASSERT_EQUALS(580, outputWS.getNEvents());
+      // equal split between experiments
+      size_t nexpt1(0), nexpt2(0);
+      // 10 detector Ids split evenly
+      std::vector<int> ids(10, 0);
+      auto iter = std::unique_ptr<IMDIterator>(outputWS.createIterator());
+      do {
+        auto nevents = iter->getNumEvents();
+        for (size_t i = 0; i < nevents; ++i) {
+          auto irun = iter->getInnerRunIndex(i);
+          TSM_ASSERT("Expected run index 0 or 1. Found " + std::to_string(irun),
+                     irun == 0 || irun == 1);
+          if (irun == 0)
+            nexpt1++;
+          else
+            nexpt2++;
+          auto idet = iter->getInnerDetectorID(i);
+          TSM_ASSERT("Expected 1 <= det ID <= 10. Found " +
+                         std::to_string(idet),
+                     1 <= idet || idet <= 10);
+          ids[idet - 1] += 1;
+        }
+      } while (iter->next());
+      TS_ASSERT_EQUALS(290, nexpt1);
+      TS_ASSERT_EQUALS(290, nexpt2);
+      // 58 events in each detector
+      std::vector<int> expectedIds(10, 58);
+      TS_ASSERT_EQUALS(expectedIds, ids);
+    }
   }
 
   //----------------------------------------------------------------------------