Moved RotateSampleShape into MantidDataHandling

Author: warunawickramasingha

Framework/Crystal/CMakeLists.txt

@@ -72,7 +72,6 @@ set(SRC_FILES
     src/SortPeaksWorkspace.cpp
     src/StatisticsOfPeaksWorkspace.cpp
     src/TransformHKL.cpp
-    src/RotateSampleShape.cpp
 )
 
 set(INC_FILES
@@ -152,7 +151,6 @@ set(INC_FILES
     inc/MantidCrystal/SortPeaksWorkspace.h
     inc/MantidCrystal/StatisticsOfPeaksWorkspace.h
     inc/MantidCrystal/TransformHKL.h
-    inc/MantidCrystal/RotateSampleShape.h
 )
 
 set(TEST_FILES
@@ -225,7 +223,6 @@ set(TEST_FILES
     SortPeaksWorkspaceTest.h
     StatisticsOfPeaksWorkspaceTest.h
     TransformHKLTest.h
-    RotateSampleShapeTest.h
 )
 
 if(COVERAGE)

Framework/DataHandling/CMakeLists.txt

@@ -218,6 +218,7 @@ set(SRC_FILES
     src/StartAndEndTimeFromNexusFileExtractor.cpp
     src/UpdateInstrumentFromFile.cpp
     src/XmlHandler.cpp
+    src/RotateSampleShape.cpp
 )
 
 set(INC_FILES
@@ -444,6 +445,7 @@ set(INC_FILES
     src/LoadRaw/isisraw2.h
     src/LoadRaw/item_struct.h
     src/LoadRaw/vms_convert.h
+    inc/MantidDataHandling/RotateSampleShape.h
 )
 
 set(TEST_FILES
@@ -642,6 +644,7 @@ set(TEST_FILES
     StartAndEndTimeFromNexusFileExtractorTest.h
     UpdateInstrumentFromFileTest.h
     XMLInstrumentParameterTest.h
+    RotateSampleShapeTest.h
 )
 
 if(COVERAGE)

Framework/DataHandling/inc/MantidDataHandling/CreateSampleShape.h

@@ -27,7 +27,7 @@ namespace DataHandling {
 */
 class MANTID_DATAHANDLING_DLL CreateSampleShape final : public API::Algorithm {
 public:
-  static void setSampleShape(API::ExperimentInfo &expt, const std::string &shapeXML);
+  static void setSampleShape(API::ExperimentInfo &expt, const std::string &shapeXML, bool addTypeTag = true);
 
 public:
   const std::string name() const override { return "CreateSampleShape"; }

Framework/Crystal/inc/MantidCrystal/RotateSampleShape.h renamed to Framework/DataHandling/inc/MantidDataHandling/RotateSampleShape.h

@@ -8,7 +8,7 @@
 
 #include "MantidAPI/Algorithm.h"
 #include "MantidAPI/MultipleExperimentInfos.h"
-#include "MantidCrystal/DllConfig.h"
+#include "MantidDataHandling/DllConfig.h"
 
 namespace Mantid {
 namespace Geometry {
@@ -17,14 +17,14 @@ class Goniometer;
 } // namespace Mantid
 
 namespace Mantid {
-namespace Crystal {
+namespace DataHandling {
 
 using Mantid::Geometry::Goniometer;
 
 /** Define the initial orientation of the sample with respect to the beam and instrument by giving the axes and
  *directions of rotations.
  */
-class MANTID_CRYSTAL_DLL RotateSampleShape final : public API::Algorithm {
+class MANTID_DATAHANDLING_DLL RotateSampleShape final : public API::Algorithm {
 public:
   /// Algorithm's name for identification
   const std::string name() const override { return "RotateSampleShape"; };
@@ -38,7 +38,7 @@ class MANTID_CRYSTAL_DLL RotateSampleShape final : public API::Algorithm {
   int version() const override { return 1; };
   const std::vector<std::string> seeAlso() const override { return {"SetGoniometer"}; }
   /// Algorithm's category for identification
-  const std::string category() const override { return "Crystal\\Goniometer"; }
+  const std::string category() const override { return "DataHandling\\Instrument"; }
 
 private:
   /// Initialise the properties
@@ -47,8 +47,7 @@ class MANTID_CRYSTAL_DLL RotateSampleShape final : public API::Algorithm {
   void exec() override;
   void prepareGoniometerAxes(Goniometer &gon);
   bool checkIsValidShape(const API::ExperimentInfo_sptr &ei, std::string &shapeXML, bool &isMeshShape);
-  void setSampleShape(API::ExperimentInfo &expt, const std::string &shapeXML, bool addTypeTag);
 };
 
-} // namespace Crystal
+} // namespace DataHandling
 } // namespace Mantid

Framework/DataHandling/src/CreateSampleShape.cpp

@@ -26,11 +26,12 @@ using namespace Mantid::API;
  * @brief Set the shape via an XML string on the given experiment
  * @param expt A reference to the experiment holding the sample object
  * @param shapeXML XML defining the object's shape
+ * @param addTypeTag true to wrap a \<type\> tag around the XML supplied(default)
  */
-void CreateSampleShape::setSampleShape(API::ExperimentInfo &expt, const std::string &shapeXML) {
+void CreateSampleShape::setSampleShape(API::ExperimentInfo &expt, const std::string &shapeXML, bool addTypeTag) {
   Geometry::ShapeFactory sFactory;
   // Create the object
-  auto shape = sFactory.createShape(shapeXML);
+  auto shape = sFactory.createShape(shapeXML, addTypeTag);
   // Check it's valid and attach it to the workspace sample but preserve any
   // material
   if (shape->hasValidShape()) {

Framework/Crystal/src/RotateSampleShape.cpp renamed to Framework/DataHandling/src/RotateSampleShape.cpp

@@ -4,10 +4,11 @@
 //   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 "MantidCrystal/RotateSampleShape.h"
+#include "MantidDataHandling/RotateSampleShape.h"
 #include "MantidAPI/MatrixWorkspace.h"
 #include "MantidAPI/Run.h"
 #include "MantidAPI/Sample.h"
+#include "MantidDataHandling/CreateSampleShape.h"
 #include "MantidGeometry/Instrument/Goniometer.h"
 #include "MantidGeometry/Objects/MeshObject.h"
 #include "MantidGeometry/Objects/ShapeFactory.h"
@@ -16,7 +17,7 @@
 #include <boost/algorithm/string/classification.hpp>
 #include <boost/algorithm/string/split.hpp>
 
-namespace Mantid::Crystal {
+namespace Mantid::DataHandling {
 
 // Register the algorithm into the AlgorithmFactory
 DECLARE_ALGORITHM(RotateSampleShape)
@@ -27,7 +28,6 @@ using namespace Mantid::API;
 
 /// How many axes (max) to define
 const size_t NUM_AXES = 6;
-Mantid::Kernel::Logger g_log("RotateSampleShape");
 
 /** Initialize the algorithm's properties.
  */
@@ -90,34 +90,7 @@ void RotateSampleShape::exec() {
     meshShape->rotate(newSampleShapeRot);
   } else {
     shapeXML = Geometry::ShapeFactory().addGoniometerTag(newSampleShapeRot, shapeXML);
-    setSampleShape(*ei, shapeXML, false);
-  }
-}
-
-/**
- * @brief Set the shape via an XML string on the given experiment
- * @param expt A reference to the experiment holding the sample object
- * @param shapeXML XML defining the object's shape
- * @param addTypeTag true to wrap a \<type\> tag around the XML supplied(default)
- */
-void RotateSampleShape::setSampleShape(API::ExperimentInfo &expt, const std::string &shapeXML, bool addTypeTag) {
-  Geometry::ShapeFactory sFactory;
-  // Create the object
-  auto shape = sFactory.createShape(shapeXML, addTypeTag);
-  // Check it's valid and attach it to the workspace sample but preserve any
-  // material
-  if (shape->hasValidShape()) {
-    const auto mat = expt.sample().getMaterial();
-    shape->setMaterial(mat);
-    expt.mutableSample().setShape(shape);
-  } else {
-    std::ostringstream msg;
-    msg << "Object has invalid shape.";
-    if (auto csgShape = dynamic_cast<Geometry::CSGObject *>(shape.get())) {
-      msg << " TopRule = " << csgShape->topRule() << ", number of surfaces = " << csgShape->getSurfacePtr().size()
-          << "\n";
-    }
-    throw std::runtime_error(msg.str());
+    Mantid::DataHandling::CreateSampleShape::setSampleShape(*ei, shapeXML, false);
   }
 }
 
@@ -188,4 +161,4 @@ void RotateSampleShape::prepareGoniometerAxes(Goniometer &gon) {
   }
 }
 
-} // namespace Mantid::Crystal
+} // namespace Mantid::DataHandling

Framework/Crystal/test/RotateSampleShapeTest.h renamed to Framework/DataHandling/test/RotateSampleShapeTest.h

@@ -7,7 +7,7 @@
 #pragma once
 
 #include "MantidAPI/Sample.h"
-#include "MantidCrystal/RotateSampleShape.h"
+#include "MantidDataHandling/RotateSampleShape.h"
 #include "MantidFrameworkTestHelpers/ComponentCreationHelper.h"
 #include "MantidFrameworkTestHelpers/WorkspaceCreationHelper.h"
 #include "MantidGeometry/Instrument/Goniometer.h"