refs #6351. API changes.

Add new method on IMDWorkspace to get any special coordinate system settings. On concrete implementations add setters. Add tests for setters and default values.
mantidproject · Jan 14, 2013 · de5023f · de5023f
1 parent 134b486
commit de5023f
Show file tree

Hide file tree

Showing 13 changed files with 108 additions and 3 deletions.
diff --git a/Code/Mantid/Framework/API/inc/MantidAPI/IMDWorkspace.h b/Code/Mantid/Framework/API/inc/MantidAPI/IMDWorkspace.h
@@ -36,6 +36,16 @@ namespace Mantid
       NumEventsNormalization  = 2
     };
 
+
+    /// Special coordinate systems
+    enum SpecialCoordinateSystem
+    {
+      None = 0, 
+      HKL = 1, 
+      QLab = 2, 
+      QSample = 3
+    };
+
 
     /** Basic MD Workspace Abstract Class.
      *
@@ -110,6 +120,8 @@ namespace Mantid
 
       /// Clear existing masks
       virtual void clearMDMasking() = 0;
+
+      virtual Mantid::API::SpecialCoordinateSystem getSpecialCoordinateSystem() const = 0;
     };
 
     /// Shared pointer to the IMDWorkspace base class

diff --git a/Code/Mantid/Framework/API/inc/MantidAPI/MatrixWorkspace.h b/Code/Mantid/Framework/API/inc/MantidAPI/MatrixWorkspace.h
@@ -311,6 +311,9 @@ namespace Mantid
        /// Clear exsting masking.
        void clearMDMasking();
 
+       /// @return the special coordinate system used if any.
+       virtual Mantid::API::SpecialCoordinateSystem getSpecialCoordinateSystem() const;
+
       //=====================================================================================
       // End IMDWorkspace methods
       //=====================================================================================

diff --git a/Code/Mantid/Framework/API/src/MatrixWorkspace.cpp b/Code/Mantid/Framework/API/src/MatrixWorkspace.cpp
@@ -1797,6 +1797,14 @@ namespace Mantid
       throw std::runtime_error("MatrixWorkspace::clearMDMasking has no implementation");
     }
 
+     /**
+    @return the special coordinate system used if any.
+    */
+    Mantid::API::SpecialCoordinateSystem MatrixWorkspace::getSpecialCoordinateSystem() const
+    {
+      return Mantid::API::None;
+    }
+
 
   } // namespace API
 } // Namespace Mantid

diff --git a/Code/Mantid/Framework/API/test/MatrixWorkspaceTest.h b/Code/Mantid/Framework/API/test/MatrixWorkspaceTest.h
@@ -631,6 +631,12 @@ class MatrixWorkspaceTest : public CxxTest::TestSuite
     TSM_ASSERT_THROWS("Characterisation test. This is not implemented.", ws->clearMDMasking(), std::runtime_error);
   }
 
+  void test_getSpecialCoordinateSystem_default()
+  {
+    boost::shared_ptr<MatrixWorkspace> ws(new WorkspaceTester());
+    TSM_ASSERT_EQUALS("Should default to no special coordinate system.", Mantid::API::None, ws->getSpecialCoordinateSystem());
+  }
+
 private:
   boost::shared_ptr<MatrixWorkspace> ws;
 

diff --git a/Code/Mantid/Framework/Algorithms/test/RebinByPulseTimesTest.h b/Code/Mantid/Framework/Algorithms/test/RebinByPulseTimesTest.h
@@ -72,6 +72,7 @@ class MockIEventWorkspace : public Mantid::API::IEventWorkspace
   MOCK_METHOD1(getSpectrum, Mantid::API::ISpectrum*(const std::size_t));
   MOCK_CONST_METHOD1(getSpectrum, const Mantid::API::ISpectrum*(const std::size_t));
   MOCK_METHOD3(init, void(const size_t&, const size_t&, const size_t&));
+  MOCK_CONST_METHOD0(getSpecialCoordinateSystem, Mantid::API::SpecialCoordinateSystem()); 
   virtual ~MockIEventWorkspace(){}
 };
 

diff --git a/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDEventWorkspace.h b/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDEventWorkspace.h
@@ -145,6 +145,15 @@ namespace MDEvents
     /// Clear masking
     void clearMDMasking();
 
+     /// Get the special coordinate system.
+    virtual Mantid::API::SpecialCoordinateSystem getSpecialCoordinateSystem() const
+    {
+      return m_coordinateSystem;
+    }
+
+    /// Set the special coordinate system.
+    void setCoordinateSystem(const Mantid::API::SpecialCoordinateSystem coordinateSystem);
+
   protected:
 
     /** MDBox containing all of the events in the workspace. */
@@ -153,7 +162,10 @@ namespace MDEvents
     /// Box controller in use
     //Mantid::API::BoxController_sptr m_BoxController;
     boost::shared_ptr<BoxCtrlChangesList<MDBoxToChange<MDE,nd> > > m_BoxController;
-   private:
+  private:
+
+    /// The special coordinate system of the workspace.
+    Mantid::API::SpecialCoordinateSystem m_coordinateSystem;
 
   public:
     /// Typedef for a shared pointer of this kind of event workspace

diff --git a/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDHistoWorkspace.h b/Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDHistoWorkspace.h
@@ -161,6 +161,15 @@ namespace MDEvents
       return m_boxLength;
     }
 
+    /// Get the special coordinate system.
+    virtual Mantid::API::SpecialCoordinateSystem getSpecialCoordinateSystem() const
+    {
+      return m_coordinateSystem;
+    }
+
+    /// Set the special coordinate system.
+    void setCoordinateSystem(const Mantid::API::SpecialCoordinateSystem coordinateSystem);
+
     void setTo(signal_t signal, signal_t errorSquared, signal_t numEvents);
 
     void applyImplicitFunction(Mantid::Geometry::MDImplicitFunction * function, signal_t signal, signal_t errorSquared);
@@ -430,6 +439,8 @@ namespace MDEvents
     coord_t * m_origin;
     /// the number of events, contributed into the workspace;
     mutable uint64_t m_nEventsContributed;
+    /// The special coordinate system of the workspace.
+    Mantid::API::SpecialCoordinateSystem m_coordinateSystem;
   protected:
 
     /// Linear array of masks for each bin

diff --git a/Code/Mantid/Framework/MDEvents/src/MDEventWorkspace.cpp b/Code/Mantid/Framework/MDEvents/src/MDEventWorkspace.cpp
@@ -38,7 +38,8 @@ namespace MDEvents
   TMDE(
   MDEventWorkspace)::MDEventWorkspace()
     //m_BoxController(boost::make_shared<BoxController>(nd))
-  : m_BoxController(boost::make_shared<BoxCtrlChangesList<MDBoxToChange<MDE,nd> > >(nd))
+  : m_BoxController(boost::make_shared<BoxCtrlChangesList<MDBoxToChange<MDE,nd> > >(nd)),
+  m_coordinateSystem(Mantid::API::None)
   {
     // First box is at depth 0, and has this default boxController
     data = new MDBox<MDE, nd>(m_BoxController, 0);
@@ -814,6 +815,16 @@ namespace MDEvents
     }
   }
 
+  /**
+  Set the special coordinate system (if any) to use.
+  @param coordinateSystem : Special coordinate system to use.
+  */
+    TMDE(
+      void MDEventWorkspace)::setCoordinateSystem(const Mantid::API::SpecialCoordinateSystem coordinateSystem)
+  {
+    m_coordinateSystem = coordinateSystem;
+  }
+
 }//namespace MDEvents
 
 }//namespace Mantid

diff --git a/Code/Mantid/Framework/MDEvents/src/MDHistoWorkspace.cpp b/Code/Mantid/Framework/MDEvents/src/MDHistoWorkspace.cpp
@@ -31,7 +31,8 @@ namespace MDEvents
       Mantid::Geometry::MDHistoDimension_sptr dimZ, Mantid::Geometry::MDHistoDimension_sptr dimT)
   : IMDHistoWorkspace(),
     numDimensions(0),
-    m_nEventsContributed(std::numeric_limits<uint64_t>::quiet_NaN())
+    m_nEventsContributed(std::numeric_limits<uint64_t>::quiet_NaN()),
+    m_coordinateSystem(None)
   {
     std::vector<Mantid::Geometry::MDHistoDimension_sptr> dimensions;
     if (dimX) dimensions.push_back(dimX);
@@ -1259,6 +1260,15 @@ namespace MDEvents
     return sum;
   }
 
+  /**
+  Set the special coordinate system (if any) to use.
+  @param coordinateSystem : Special coordinate system to use.
+  */
+  void MDHistoWorkspace::setCoordinateSystem(const Mantid::API::SpecialCoordinateSystem coordinateSystem)
+  {
+    m_coordinateSystem = coordinateSystem;
+  }
+
 } // namespace Mantid
 } // namespace MDEvents
 
diff --git a/Code/Mantid/Framework/MDEvents/test/MDEventWorkspaceTest.h b/Code/Mantid/Framework/MDEvents/test/MDEventWorkspaceTest.h
@@ -590,6 +590,21 @@ class MDEventWorkspaceTest :    public CxxTest::TestSuite
     TS_ASSERT_THROWS_NOTHING(ws->clearMDMasking());
     TSM_ASSERT_EQUALS("Nothing should be masked.", 0, getNumberMasked(ws));
   }
+
+  void test_getSpecialCoordinateSystem_default()
+  {
+     MDEventWorkspace1Lean::sptr ws = MDEventsTestHelper::makeMDEW<1>(10, 0.0, 10.0, 1 /*event per box*/);
+    TSM_ASSERT_EQUALS("Should default to no special coordinate system.", Mantid::API::None, ws->getSpecialCoordinateSystem());
+  }
+
+  void test_setSpecialCoordinateSystem_default()
+  {
+     MDEventWorkspace1Lean::sptr ws = MDEventsTestHelper::makeMDEW<1>(10, 0.0, 10.0, 1 /*event per box*/);
+    TS_ASSERT_EQUALS(Mantid::API::None, ws->getSpecialCoordinateSystem());
+
+    ws->setCoordinateSystem(Mantid::API::QLab);
+    TS_ASSERT_EQUALS(Mantid::API::QLab, ws->getSpecialCoordinateSystem());
+  }
 };
 
 class MDEventWorkspaceTestPerformance :    public CxxTest::TestSuite

diff --git a/Code/Mantid/Framework/MDEvents/test/MDHistoWorkspaceTest.h b/Code/Mantid/Framework/MDEvents/test/MDHistoWorkspaceTest.h
@@ -949,6 +949,20 @@ class MDHistoWorkspaceTest : public CxxTest::TestSuite
     TSM_ASSERT_EQUALS("Nothing should be masked.", 0, getNumberMasked(ws));
   }
 
+  void test_getSpecialCoordinateSystem_default()
+  {
+    MDHistoWorkspace_sptr ws = MDEventsTestHelper::makeFakeMDHistoWorkspace(1, 1);
+    TSM_ASSERT_EQUALS("Should default to no special coordinate system.", Mantid::API::None, ws->getSpecialCoordinateSystem());
+  }
+
+  void test_setSpecialCoordinateSystem_default()
+  {
+    MDHistoWorkspace_sptr ws = MDEventsTestHelper::makeFakeMDHistoWorkspace(1, 1);
+    TS_ASSERT_EQUALS(Mantid::API::None, ws->getSpecialCoordinateSystem());
+
+    ws->setCoordinateSystem(Mantid::API::QLab);
+    TS_ASSERT_EQUALS(Mantid::API::QLab, ws->getSpecialCoordinateSystem());
+  }
 
 };
 

diff --git a/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/FakeObjects.h b/Code/Mantid/Framework/TestHelpers/inc/MantidTestHelpers/FakeObjects.h
@@ -105,6 +105,7 @@ class WorkspaceTester : public MatrixWorkspace
   ISpectrum * getSpectrum(const size_t index) { return &vec[index]; }
   const ISpectrum * getSpectrum(const size_t index) const { return &vec[index];; }
   void generateHistogram(const std::size_t , const MantidVec& , MantidVec& , MantidVec& , bool ) const { }
+  virtual Mantid::API::SpecialCoordinateSystem getSpecialCoordinateSystem() const { return Mantid::API::None;}
 
 private:
   std::vector<SpectrumTester> vec;

diff --git a/Code/Mantid/Vates/VatesAPI/test/MockObjects.h b/Code/Mantid/Vates/VatesAPI/test/MockObjects.h
@@ -84,6 +84,7 @@ class MockIMDWorkspace: public Mantid::API::IMDWorkspace
   MOCK_CONST_METHOD0(getNonIntegratedDimensions, Mantid::Geometry::VecIMDDimension_const_sptr());
   MOCK_METHOD1(setMDMasking, void(Mantid::Geometry::MDImplicitFunction*));
   MOCK_METHOD0(clearMDMasking,void());
+  MOCK_CONST_METHOD0(getSpecialCoordinateSystem, Mantid::API::SpecialCoordinateSystem()); 
 
   virtual void getLinePlot(const Mantid::Kernel::VMD & , const Mantid::Kernel::VMD & ,
     Mantid::API::MDNormalization , std::vector<Mantid::coord_t> & , std::vector<Mantid::signal_t> & , std::vector<Mantid::signal_t> & ) const