diff --git a/CMakeLists.txt b/CMakeLists.txt
index eb0616ea5b0154213add9fd9ca00e1a84f9227e4..049a178058045db87fe149ddb32a0ed7aeca59a9 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -92,6 +92,9 @@ endif()
###########################################################################
# Call our setup script
###########################################################################
+if (NOT ENABLE_OPENCASCADE)
+ set ( ENABLE_OPENCASCADE ON CACHE BOOL "Enable OpenCascade-based 3D visualisation")
+endif()
include ( CommonSetup )
###########################################################################
@@ -132,7 +135,6 @@ set( DOCS_BUILDDIR ${CMAKE_BINARY_DIR}/docs )
# Framework Build options
set ( CXXTEST_SINGLE_LOGFILE CACHE BOOL "Switch to have the tests for each package run together")
set ( CXXTEST_ADD_PERFORMANCE OFF CACHE BOOL "Switch to add Performance tests to the list of tests run by ctest?")
-set ( ENABLE_OPENCASCADE ON CACHE BOOL "Enable OpenCascade-based 3D visualisation")
add_subdirectory ( Framework )
diff --git a/Framework/API/inc/MantidAPI/Sample.h b/Framework/API/inc/MantidAPI/Sample.h
index a64532cd7e97dbef4e04d3d4ff2e5a2d5d5250fc..f4f3ca7e2f0b7e017239fa9456982d51f3160af3 100644
--- a/Framework/API/inc/MantidAPI/Sample.h
+++ b/Framework/API/inc/MantidAPI/Sample.h
@@ -15,6 +15,7 @@ namespace Mantid {
//------------------------------------------------------------------------------
namespace Geometry {
class OrientedLattice;
+class CrystalStructure;
}
namespace API {
@@ -103,6 +104,15 @@ public:
bool hasOrientedLattice() const;
//@}
+ /** @name Access the sample's crystal structure */
+ //@{
+ const Geometry::CrystalStructure &getCrystalStructure() const;
+ void
+ setCrystalStructure(const Geometry::CrystalStructure &newCrystalStructure);
+ bool hasCrystalStructure() const;
+ void clearCrystalStructure();
+ //@}
+
// Required for SANS work until we define a proper
// sample object from the raw file information
/**@name Legacy functions */
@@ -137,6 +147,9 @@ private:
/// Pointer to the OrientedLattice of the sample, NULL if not set.
Geometry::OrientedLattice *m_lattice;
+ /// CrystalStructure of the sample
+ std::unique_ptr<Geometry::CrystalStructure> m_crystalStructure;
+
/// Vector of child samples
std::vector<boost::shared_ptr<Sample>> m_samples;
diff --git a/Framework/API/inc/MantidAPI/SpectrumDetectorMapping.h b/Framework/API/inc/MantidAPI/SpectrumDetectorMapping.h
index 8f2ee4c75e4458b5bccffd1db5c0d386e2bf0652..e80c0584109c1f92f4f7c111ac2d46e325aa472d 100644
--- a/Framework/API/inc/MantidAPI/SpectrumDetectorMapping.h
+++ b/Framework/API/inc/MantidAPI/SpectrumDetectorMapping.h
@@ -4,7 +4,7 @@
#include <vector>
#include <set>
#ifndef Q_MOC_RUN
-#include <boost/unordered_map.hpp>
+#include <unordered_map>
#endif
#include "MantidGeometry/IDTypes.h"
@@ -50,7 +50,7 @@ class MatrixWorkspace;
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class MANTID_API_DLL SpectrumDetectorMapping {
- typedef boost::unordered_map<specid_t, std::set<detid_t>> sdmap;
+ typedef std::unordered_map<specid_t, std::set<detid_t>> sdmap;
public:
explicit SpectrumDetectorMapping(const MatrixWorkspace *const workspace,
diff --git a/Framework/API/src/Sample.cpp b/Framework/API/src/Sample.cpp
index b472d32a98ffbdc69f43152c13b2c43a5c8e5342..6f0aba1134fb46419fb66e69ee834add02338928 100644
--- a/Framework/API/src/Sample.cpp
+++ b/Framework/API/src/Sample.cpp
@@ -4,6 +4,7 @@
#include "MantidAPI/Sample.h"
#include "MantidAPI/SampleEnvironment.h"
#include "MantidGeometry/IComponent.h"
+#include "MantidGeometry/Crystal/CrystalStructure.h"
#include "MantidGeometry/Crystal/OrientedLattice.h"
#include "MantidGeometry/Objects/ShapeFactory.h"
#include "MantidKernel/Strings.h"
@@ -22,8 +23,9 @@ using Geometry::ShapeFactory;
* Default constructor. Required for cow_ptr.
*/
Sample::Sample()
- : m_name(), m_shape(), m_environment(), m_lattice(NULL), m_samples(),
- m_geom_id(0), m_thick(0.0), m_height(0.0), m_width(0.0) {}
+ : m_name(), m_shape(), m_environment(), m_lattice(NULL),
+ m_crystalStructure(), m_samples(), m_geom_id(0), m_thick(0.0),
+ m_height(0.0), m_width(0.0) {}
/**
* Copy constructor
@@ -31,11 +33,16 @@ Sample::Sample()
*/
Sample::Sample(const Sample ©)
: m_name(copy.m_name), m_shape(copy.m_shape),
- m_environment(copy.m_environment), m_lattice(NULL),
+ m_environment(copy.m_environment), m_lattice(NULL), m_crystalStructure(),
m_samples(copy.m_samples), m_geom_id(copy.m_geom_id),
m_thick(copy.m_thick), m_height(copy.m_height), m_width(copy.m_width) {
if (copy.m_lattice)
m_lattice = new OrientedLattice(copy.getOrientedLattice());
+
+ if (copy.hasCrystalStructure()) {
+ m_crystalStructure.reset(
+ new Geometry::CrystalStructure(copy.getCrystalStructure()));
+ }
}
/// Destructor
@@ -64,6 +71,12 @@ Sample &Sample::operator=(const Sample &rhs) {
else
m_lattice = NULL;
+ m_crystalStructure.reset();
+ if (rhs.hasCrystalStructure()) {
+ m_crystalStructure.reset(
+ new Geometry::CrystalStructure(rhs.getCrystalStructure()));
+ }
+
return *this;
}
@@ -161,6 +174,35 @@ void Sample::setOrientedLattice(OrientedLattice *latt) {
/** @return true if the sample has an OrientedLattice */
bool Sample::hasOrientedLattice() const { return (m_lattice != NULL); }
+const Geometry::CrystalStructure &Sample::getCrystalStructure() const {
+ if (!hasCrystalStructure()) {
+ throw std::runtime_error(
+ "Sample::getCrystalStructure - No CrystalStructure has been defined.");
+ }
+
+ return *m_crystalStructure;
+}
+
+/// Resets the internal pointer to the new CrystalStructure (it's copied).
+void Sample::setCrystalStructure(
+ const Geometry::CrystalStructure &newCrystalStructure) {
+ m_crystalStructure.reset(new Geometry::CrystalStructure(newCrystalStructure));
+}
+
+/// Returns true if the sample actually holds a CrystalStructure.
+bool Sample::hasCrystalStructure() const {
+ // Conversion to bool seems to be a problem in VS2012, so this is a bit more
+ // verbose than it should be.
+ if (m_crystalStructure) {
+ return true;
+ }
+
+ return false;
+}
+
+/// Destroys the internally stored CrystalStructure-object.
+void Sample::clearCrystalStructure() { m_crystalStructure.reset(); }
+
/**
* Set the geometry flag that is specfied in the raw file within the SPB_STRUCT
* 1 = cylinder, 2 = flat plate, 3 = disc, 4 = single crystal
diff --git a/Framework/API/test/MDGeometryTest.h b/Framework/API/test/MDGeometryTest.h
index a933cffc4b1c7135d5d45caf1c2ad7a91196e7fc..8e689b090dc9be85de20f2d3d47ee5335f32453c 100644
--- a/Framework/API/test/MDGeometryTest.h
+++ b/Framework/API/test/MDGeometryTest.h
@@ -10,6 +10,7 @@
#include "MantidAPI/IMDWorkspace.h"
#include "MantidTestHelpers/FakeObjects.h"
#include "MantidAPI/NullCoordTransform.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
using namespace Mantid;
using namespace Mantid::Kernel;
@@ -26,8 +27,9 @@ public:
void test_initGeometry() {
MDGeometry g;
std::vector<IMDDimension_sptr> dims;
- IMDDimension_sptr dim1(new MDHistoDimension("Qx", "Qx", "Ang", -1, +1, 10));
- IMDDimension_sptr dim2(new MDHistoDimension("Qy", "Qy", "Ang", -1, +1, 20));
+ const Mantid::Geometry::QSample frame;
+ IMDDimension_sptr dim1(new MDHistoDimension("Qx", "Qx", frame, -1, +1, 10));
+ IMDDimension_sptr dim2(new MDHistoDimension("Qy", "Qy", frame, -1, +1, 20));
dims.push_back(dim1);
dims.push_back(dim2);
g.initGeometry(dims);
@@ -84,8 +86,9 @@ public:
void test_copy_constructor() {
MDGeometry g;
std::vector<IMDDimension_sptr> dims;
- IMDDimension_sptr dim0(new MDHistoDimension("Qx", "Qx", "Ang", -1, +1, 0));
- IMDDimension_sptr dim1(new MDHistoDimension("Qy", "Qy", "Ang", -1, +1, 0));
+ const Mantid::Geometry::QSample frame;
+ IMDDimension_sptr dim0(new MDHistoDimension("Qx", "Qx", frame, -1, +1, 0));
+ IMDDimension_sptr dim1(new MDHistoDimension("Qy", "Qy", frame, -1, +1, 0));
dims.push_back(dim0);
dims.push_back(dim1);
g.initGeometry(dims);
@@ -134,11 +137,12 @@ public:
/** Adding dimension info and searching for it back */
void test_addDimension_getDimension() {
MDGeometry g;
+ const Mantid::Geometry::QSample frame;
MDHistoDimension_sptr dim(
- new MDHistoDimension("Qx", "Qx", "Ang", -1, +1, 0));
+ new MDHistoDimension("Qx", "Qx", frame, -1, +1, 0));
TS_ASSERT_THROWS_NOTHING(g.addDimension(dim);)
MDHistoDimension_sptr dim2(
- new MDHistoDimension("Qy", "Qy", "Ang", -1, +1, 0));
+ new MDHistoDimension("Qy", "Qy", frame, -1, +1, 0));
TS_ASSERT_THROWS_NOTHING(g.addDimension(dim2);)
TS_ASSERT_EQUALS(g.getNumDims(), 2);
TS_ASSERT_EQUALS(g.getDimension(0)->getName(), "Qx");
@@ -150,11 +154,12 @@ public:
void test_transformDimensions() {
MDGeometry g;
+ const Mantid::Geometry::QSample frame;
MDHistoDimension_sptr dim(
- new MDHistoDimension("Qx", "Qx", "Ang", -1, +1, 0));
+ new MDHistoDimension("Qx", "Qx", frame, -1, +1, 0));
TS_ASSERT_THROWS_NOTHING(g.addDimension(dim);)
MDHistoDimension_sptr dim2(
- new MDHistoDimension("Qy", "Qy", "Ang", -2, +2, 0));
+ new MDHistoDimension("Qy", "Qy", frame, -2, +2, 0));
TS_ASSERT_THROWS_NOTHING(g.addDimension(dim2);)
TS_ASSERT_EQUALS(g.getNumDims(), 2);
boost::shared_ptr<WorkspaceTester> ws(new WorkspaceTester());
@@ -260,8 +265,9 @@ public:
void test_all_normalized() {
MDGeometry geometry;
std::vector<IMDDimension_sptr> dims;
- IMDDimension_sptr dim1(new MDHistoDimension("Qx", "Qx", "Ang", -1, +1, 10));
- IMDDimension_sptr dim2(new MDHistoDimension("Qy", "Qy", "Ang", -1, +1, 20));
+ const Mantid::Geometry::QSample frame;
+ IMDDimension_sptr dim1(new MDHistoDimension("Qx", "Qx", frame, -1, +1, 10));
+ IMDDimension_sptr dim2(new MDHistoDimension("Qy", "Qy", frame, -1, +1, 20));
dims.push_back(dim1);
dims.push_back(dim2);
geometry.initGeometry(dims);
diff --git a/Framework/API/test/SampleTest.h b/Framework/API/test/SampleTest.h
index ba20d5cf7b0e0db6ce23d31c7b4d9e06c046c47d..f9670998c27f2f63215df9d2ae07c87634f864f5 100644
--- a/Framework/API/test/SampleTest.h
+++ b/Framework/API/test/SampleTest.h
@@ -3,6 +3,7 @@
#include "MantidAPI/Sample.h"
#include "MantidAPI/SampleEnvironment.h"
+#include "MantidGeometry/Crystal/CrystalStructure.h"
#include "MantidGeometry/Crystal/OrientedLattice.h"
#include "MantidKernel/Exception.h"
#include "MantidTestHelpers/ComponentCreationHelper.h"
@@ -199,6 +200,59 @@ public:
delete latticeA;
}
+ void test_setCrystalStructure() {
+ Sample sample;
+ TS_ASSERT(!sample.hasCrystalStructure());
+ TS_ASSERT_THROWS(sample.getCrystalStructure(), std::runtime_error);
+
+ CrystalStructure structure("3 4 5 90 90 90", "C m m m",
+ "Fe 0.12 0.23 0.121");
+
+ TS_ASSERT_THROWS_NOTHING(sample.setCrystalStructure(structure));
+ TS_ASSERT(sample.hasCrystalStructure());
+ CrystalStructure fromSample = sample.getCrystalStructure();
+
+ TS_ASSERT(fromSample.spaceGroup());
+ TS_ASSERT_EQUALS(fromSample.spaceGroup()->hmSymbol(), "C m m m");
+ }
+
+ void test_clearCrystalStructure() {
+ Sample sample;
+ TS_ASSERT(!sample.hasCrystalStructure());
+ TS_ASSERT_THROWS(sample.getCrystalStructure(), std::runtime_error);
+
+ CrystalStructure structure("3 4 5 90 90 90", "C m m m",
+ "Fe 0.12 0.23 0.121");
+ sample.setCrystalStructure(structure);
+ TS_ASSERT(sample.hasCrystalStructure());
+
+ TS_ASSERT_THROWS_NOTHING(sample.clearCrystalStructure());
+ TS_ASSERT(!sample.hasCrystalStructure());
+ }
+
+ void test_crystalStructureCopyConstructorAndAssignment() {
+ Sample sampleA;
+
+ CrystalStructure structure("3 4 5 90 90 90", "C m m m",
+ "Fe 0.12 0.23 0.121");
+ sampleA.setCrystalStructure(structure);
+ TS_ASSERT(sampleA.hasCrystalStructure());
+
+ Sample sampleB = sampleA;
+ TS_ASSERT(sampleB.hasCrystalStructure());
+
+ CrystalStructure fromA = sampleA.getCrystalStructure();
+ CrystalStructure fromB = sampleB.getCrystalStructure();
+ TS_ASSERT_EQUALS(fromA.spaceGroup()->hmSymbol(),
+ fromB.spaceGroup()->hmSymbol());
+
+ Sample sampleC(sampleA);
+
+ CrystalStructure fromC = sampleC.getCrystalStructure();
+ TS_ASSERT_EQUALS(fromA.spaceGroup()->hmSymbol(),
+ fromC.spaceGroup()->hmSymbol());
+ }
+
void test_Material_Returns_The_Correct_Value() {
Material vanBlock("vanBlock",
Mantid::PhysicalConstants::getNeutronAtom(23, 0), 0.072);
diff --git a/Framework/Algorithms/inc/MantidAlgorithms/MaskDetectorsIf.h b/Framework/Algorithms/inc/MantidAlgorithms/MaskDetectorsIf.h
index 936522c1d930cb015b3abbd2ba9bc320e4d82444..8188ac663a49542c7e003111f53cc7819d2d4c3f 100644
--- a/Framework/Algorithms/inc/MantidAlgorithms/MaskDetectorsIf.h
+++ b/Framework/Algorithms/inc/MantidAlgorithms/MaskDetectorsIf.h
@@ -10,7 +10,7 @@
// To be compatible with VSC Express edition that does not have tr1
-#include <boost/unordered_map.hpp>
+#include <unordered_map>
namespace Mantid {
namespace Algorithms {
@@ -69,7 +69,7 @@ private:
/// Returns an allowed values statement to insert into decumentation
std::string allowedValuesStatement(std::vector<std::string> vals);
// Typedef for det to value map
- typedef boost::unordered_map<detid_t, bool> udet2valuem;
+ typedef std::unordered_map<detid_t, bool> udet2valuem;
/// A map of detector numbers to mask boolean
udet2valuem umap;
/// Get the properties
diff --git a/Framework/Algorithms/inc/MantidAlgorithms/ReadGroupsFromFile.h b/Framework/Algorithms/inc/MantidAlgorithms/ReadGroupsFromFile.h
index 824703b06c949bc9f06c88796a7e144852a2ea6b..81115c430ab233007bdc3fae6281a07e18de4e50 100644
--- a/Framework/Algorithms/inc/MantidAlgorithms/ReadGroupsFromFile.h
+++ b/Framework/Algorithms/inc/MantidAlgorithms/ReadGroupsFromFile.h
@@ -5,7 +5,7 @@
// Includes
//----------------------------------------------------------------------
-#include <boost/unordered_map.hpp>
+#include <unordered_map>
#include "MantidAPI/Algorithm.h"
#include "MantidDataObjects/Workspace2D.h"
@@ -98,7 +98,7 @@ public:
private:
/// Map containing the detector entries found in the *.cal file. The key is
/// the udet number, the value of is a pair of <group,selected>.
- typedef boost::unordered_map<int, std::pair<int, int>> calmap;
+ typedef std::unordered_map<int, std::pair<int, int>> calmap;
/// Initialisation code
void init();
/// Execution code
diff --git a/Framework/Crystal/src/IntegratePeaksHybrid.cpp b/Framework/Crystal/src/IntegratePeaksHybrid.cpp
index efe1ea26ade9d1716a5813c20126d3ffcda9bcd7..61293d241dec0d2354f96e56e41ecedb016f74fd 100644
--- a/Framework/Crystal/src/IntegratePeaksHybrid.cpp
+++ b/Framework/Crystal/src/IntegratePeaksHybrid.cpp
@@ -172,8 +172,9 @@ void IntegratePeaksHybrid::exec() {
mdWS->getSpecialCoordinateSystem();
if (mdCoordinates == None) {
throw std::invalid_argument("The coordinate system of the input "
- "MDWorkspace cannot be established. Run "
- "SetSpecialCoordinates on InputWorkspace.");
+ "MDWorkspace cannot be established. Create "
+ "your workspace with the an MDFrame which is "
+ "not a General Frame or Unknown Frame.");
}
}
diff --git a/Framework/Crystal/src/IntegratePeaksUsingClusters.cpp b/Framework/Crystal/src/IntegratePeaksUsingClusters.cpp
index 301f18e55605e2c05feba3151838742d1b1bc19a..41727475e5924a404f49e09232eeb1b4472e335c 100644
--- a/Framework/Crystal/src/IntegratePeaksUsingClusters.cpp
+++ b/Framework/Crystal/src/IntegratePeaksUsingClusters.cpp
@@ -128,8 +128,9 @@ void IntegratePeaksUsingClusters::exec() {
mdWS->getSpecialCoordinateSystem();
if (mdCoordinates == None) {
throw std::invalid_argument("The coordinate system of the input "
- "MDWorkspace cannot be established. Run "
- "SetSpecialCoordinates on InputWorkspace.");
+ "MDWorkspace cannot be established. Create "
+ "your workspace with an MDFrame which is "
+ "not a General Frame or Unknown Frame.");
}
}
diff --git a/Framework/Crystal/src/SetSpecialCoordinates.cpp b/Framework/Crystal/src/SetSpecialCoordinates.cpp
index c10532d4ada95fd4149429df5ee6f549d6340b47..28c6e5755b5ba2ab4a4db81dcf2c45ad9bd54dc5 100644
--- a/Framework/Crystal/src/SetSpecialCoordinates.cpp
+++ b/Framework/Crystal/src/SetSpecialCoordinates.cpp
@@ -3,10 +3,15 @@
#include "MantidAPI/IMDEventWorkspace.h"
#include "MantidAPI/IMDHistoWorkspace.h"
#include "MantidKernel/ListValidator.h"
+#include "MantidKernel/Logger.h"
using namespace Mantid::Kernel;
using namespace Mantid::API;
+namespace {
+Mantid::Kernel::Logger g_log("SetSpecialCoordinates");
+}
+
namespace Mantid {
namespace Crystal {
@@ -69,7 +74,9 @@ const std::string SetSpecialCoordinates::category() const { return "Crystal"; }
void SetSpecialCoordinates::init() {
declareProperty(
new WorkspaceProperty<Workspace>("InputWorkspace", "", Direction::InOut),
- "An input/output workspace. The new log will be added to it.");
+ "An input/output workspace. The new log will be added to it. Important "
+ "Note: This has now only an effect on PeaksWorkspaces. MDEvent and "
+ "MDHisto worksapces are not affaceted by this algorithm");
declareProperty(
"SpecialCoordinates", "Q (lab frame)",
@@ -82,20 +89,24 @@ void SetSpecialCoordinates::init() {
}
bool SetSpecialCoordinates::writeCoordinatesToMDEventWorkspace(
- Workspace_sptr inWS, SpecialCoordinateSystem coordinateSystem) {
+ Workspace_sptr inWS, SpecialCoordinateSystem) {
bool written = false;
if (auto mdEventWS = boost::dynamic_pointer_cast<IMDEventWorkspace>(inWS)) {
- mdEventWS->setCoordinateSystem(coordinateSystem);
+ g_log.warning("SetSpecialCoordinates: This algorithm cannot set the "
+ "special coordinate system for an MDEvent workspace any "
+ "longer.");
written = true;
}
return written;
}
bool SetSpecialCoordinates::writeCoordinatesToMDHistoWorkspace(
- Workspace_sptr inWS, SpecialCoordinateSystem coordinateSystem) {
+ Workspace_sptr inWS, SpecialCoordinateSystem) {
bool written = false;
if (auto mdHistoWS = boost::dynamic_pointer_cast<IMDHistoWorkspace>(inWS)) {
- mdHistoWS->setCoordinateSystem(coordinateSystem);
+ g_log.warning("SetSpecialCoordinates: This algorithm cannot set the "
+ "special coordinate system for an MDHisto workspace any "
+ "longer.");
written = true;
}
return written;
diff --git a/Framework/Crystal/test/ClusterIntegrationBaseTest.h b/Framework/Crystal/test/ClusterIntegrationBaseTest.h
index f188e5cc847f430352375475582427e88dd1f930..d10eadb3f53157ead1fc555c3525ba2ced8cd47c 100644
--- a/Framework/Crystal/test/ClusterIntegrationBaseTest.h
+++ b/Framework/Crystal/test/ClusterIntegrationBaseTest.h
@@ -14,8 +14,10 @@
#include "MantidTestHelpers/ComponentCreationHelper.h"
#include "MantidAPI/AlgorithmManager.h"
#include "MantidAPI/Workspace.h"
+#include "MantidKernel/UnitLabelTypes.h"
#include "MantidKernel/V3D.h"
#include "MantidDataObjects/PeaksWorkspace.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
#include <boost/assign/list_of.hpp>
#include <boost/tuple/tuple.hpp>
@@ -78,7 +80,14 @@ protected:
.convert_to_container<std::vector<double>>();
mdworkspaceAlg->setProperty("Extents", extents);
mdworkspaceAlg->setPropertyValue("Names", "H,K,L");
- mdworkspaceAlg->setPropertyValue("Units", "-,-,-");
+ std::string units = Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii();
+ mdworkspaceAlg->setProperty("Units", units);
+ std::string frames = Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName;
+ mdworkspaceAlg->setProperty("Frames", frames);
mdworkspaceAlg->setPropertyValue("OutputWorkspace",
"IntegratePeaksMDTest_MDEWS");
mdworkspaceAlg->execute();
diff --git a/Framework/Crystal/test/FindClusterFacesTest.h b/Framework/Crystal/test/FindClusterFacesTest.h
index 012e4bf6d0fa56f5ce4f4cf09629db87eda1e955..a17e21ccb53783f29bf3decc34dfa3ca590065f2 100644
--- a/Framework/Crystal/test/FindClusterFacesTest.h
+++ b/Framework/Crystal/test/FindClusterFacesTest.h
@@ -9,8 +9,11 @@
#include "MantidAPI/FrameworkManager.h"
#include "MantidDataObjects/PeaksWorkspace.h"
#include "MantidGeometry/Instrument.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
#include "MantidTestHelpers/ComponentCreationHelper.h"
#include "MantidTestHelpers/MDEventsTestHelper.h"
+#include "MantidKernel/UnitLabelTypes.h"
+
#include <boost/assign/list_of.hpp>
using namespace Mantid::API;
@@ -54,7 +57,14 @@ IMDHistoWorkspace_sptr create_HKL_MDWS(double min = -10, double max = 10,
std::vector<double> errorValues(totalBins, errorValue);
mdworkspaceAlg->setProperty("ErrorInput", errorValues);
mdworkspaceAlg->setPropertyValue("Names", "H,K,L");
- mdworkspaceAlg->setPropertyValue("Units", "-,-,-");
+ std::string units = Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii();
+ std::string frames = Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName;
+ TS_ASSERT_THROWS_NOTHING(mdworkspaceAlg->setProperty("Frames", frames));
+ TS_ASSERT_THROWS_NOTHING(mdworkspaceAlg->setProperty("Units", units));
mdworkspaceAlg->setPropertyValue("OutputWorkspace",
"IntegratePeaksMDTest_MDEWS");
mdworkspaceAlg->execute();
diff --git a/Framework/Crystal/test/PeakClusterProjectionTest.h b/Framework/Crystal/test/PeakClusterProjectionTest.h
index d8706454d67717c0aa1fe5cc66af7e3b4d644d2a..83250c9ae1645276a297833b3852e656f8924c7a 100644
--- a/Framework/Crystal/test/PeakClusterProjectionTest.h
+++ b/Framework/Crystal/test/PeakClusterProjectionTest.h
@@ -9,10 +9,13 @@
#include "MantidAPI/IMDHistoWorkspace.h"
#include "MantidAPI/IPeaksWorkspace.h"
#include "MantidGeometry/Crystal/IPeak.h"
-
+#include "MantidGeometry/MDGeometry/HKL.h"
+#include "MantidGeometry/MDGeometry/MDFrameFactory.h"
#include "MantidDataObjects/PeaksWorkspace.h"
#include "MantidTestHelpers/MDEventsTestHelper.h"
#include "MantidTestHelpers/ComponentCreationHelper.h"
+#include "MantidKernel/UnitLabelTypes.h"
+
#include <boost/math/special_functions/fpclassify.hpp>
#include <boost/assign/list_of.hpp>
#include <math.h>
@@ -60,7 +63,14 @@ private:
std::vector<double> errorValues(totalBins, errorValue);
mdworkspaceAlg->setProperty("ErrorInput", errorValues);
mdworkspaceAlg->setPropertyValue("Names", "H,K,L");
- mdworkspaceAlg->setPropertyValue("Units", "-,-,-");
+ std::string units = Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii();
+ std::string frames = Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName;
+ TS_ASSERT_THROWS_NOTHING(mdworkspaceAlg->setProperty("Frames", frames));
+ TS_ASSERT_THROWS_NOTHING(mdworkspaceAlg->setProperty("Units", units));
mdworkspaceAlg->setPropertyValue("OutputWorkspace",
"IntegratePeaksMDTest_MDEWS");
mdworkspaceAlg->execute();
@@ -89,8 +99,9 @@ public:
PeakClusterProjectionTest() { FrameworkManager::Instance(); }
void test_throws_if_mdws_has_no_coordinate_system() {
+ Mantid::Geometry::UnknownFrame frame("testunit");
IMDHistoWorkspace_sptr inWS =
- MDEventsTestHelper::makeFakeMDHistoWorkspace(1, 3, 1);
+ MDEventsTestHelper::makeFakeMDHistoWorkspaceWithMDFrame(1, 3, frame, 1);
inWS->setCoordinateSystem(Mantid::Kernel::None);
TSM_ASSERT_THROWS("Must have a known coordinate system",
@@ -99,8 +110,13 @@ public:
}
void test_throws_if_mdws_is_less_than_three_dimensional() {
+ auto frameFactory = Mantid::Geometry::makeMDFrameFactoryChain();
+ Mantid::Geometry::MDFrameArgument frameArg(
+ Mantid::Geometry::HKL::HKLName, Mantid::Kernel::Units::Symbol::RLU);
+ auto frame = frameFactory->create(frameArg);
IMDHistoWorkspace_sptr inWS =
- MDEventsTestHelper::makeFakeMDHistoWorkspace(1, 2, 1);
+ MDEventsTestHelper::makeFakeMDHistoWorkspaceWithMDFrame(1, 2, *frame,
+ 1);
inWS->setCoordinateSystem(Mantid::Kernel::HKL);
TSM_ASSERT_THROWS("Must be +3 dimensional",
diff --git a/Framework/Crystal/test/SetSpecialCoordinatesTest.h b/Framework/Crystal/test/SetSpecialCoordinatesTest.h
index c7df78605e09cbf9c365e8dc7f1de6b11ee280a0..23a0d46695afeb6cd26d2545cb1af21189dfdc91 100644
--- a/Framework/Crystal/test/SetSpecialCoordinatesTest.h
+++ b/Framework/Crystal/test/SetSpecialCoordinatesTest.h
@@ -90,8 +90,10 @@ public:
auto outWS =
AnalysisDataService::Instance().retrieveWS<IMDWorkspace>("inWS");
- TS_ASSERT_EQUALS(Mantid::Kernel::QSample,
- outWS->getSpecialCoordinateSystem());
+ TSM_ASSERT_EQUALS(
+ "Should still be still with the same special coordinate system",
+ inWS->getSpecialCoordinateSystem(),
+ outWS->getSpecialCoordinateSystem());
AnalysisDataService::Instance().remove("inWS");
}
@@ -109,8 +111,10 @@ public:
auto outWS =
AnalysisDataService::Instance().retrieveWS<IMDWorkspace>("inWS");
- TS_ASSERT_EQUALS(Mantid::Kernel::QSample,
- outWS->getSpecialCoordinateSystem());
+ TSM_ASSERT_EQUALS(
+ "Should still be still with the same special coordinate system",
+ inWS->getSpecialCoordinateSystem(),
+ outWS->getSpecialCoordinateSystem());
AnalysisDataService::Instance().remove("inWS");
}
diff --git a/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/CalculateGammaBackground.h b/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/CalculateGammaBackground.h
index ac575bb8035a120fd8e0e3cc51739cd693b26f2d..11a870adec6328f4dbb98b3bed5fa14c0f64a5d0 100644
--- a/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/CalculateGammaBackground.h
+++ b/Framework/CurveFitting/inc/MantidCurveFitting/Algorithms/CalculateGammaBackground.h
@@ -3,7 +3,7 @@
#include "MantidAPI/Algorithm.h"
-#include <boost/unordered_map.hpp>
+#include <unordered_map>
namespace Mantid {
namespace CurveFitting {
@@ -104,7 +104,7 @@ private:
/// Input TOF data
API::MatrixWorkspace_const_sptr m_inputWS;
/// Sorted indices to correct
- boost::unordered_map<size_t, size_t> m_indices;
+ std::unordered_map<size_t, size_t> m_indices;
/// Function that defines the mass profile
std::string m_profileFunction;
/// The number of peaks in spectrum
diff --git a/Framework/CurveFitting/src/Algorithms/PlotPeakByLogValue.cpp b/Framework/CurveFitting/src/Algorithms/PlotPeakByLogValue.cpp
index 1478d845126c02fd1f1acc413dd612f3e9d521e8..62d813090d543f1013877392a48ab2a4afde41d9 100644
--- a/Framework/CurveFitting/src/Algorithms/PlotPeakByLogValue.cpp
+++ b/Framework/CurveFitting/src/Algorithms/PlotPeakByLogValue.cpp
@@ -326,7 +326,8 @@ void PlotPeakByLogValue::exec() {
row << chi2;
Prog += dProg;
- progress(Prog);
+ std::string current = boost::lexical_cast<std::string>(i);
+ progress(Prog, ("Fitting Workspace: (" + current + ") - "));
interruption_point();
if (individual) {
diff --git a/Framework/DataHandling/inc/MantidDataHandling/LoadFITS.h b/Framework/DataHandling/inc/MantidDataHandling/LoadFITS.h
index fdcbd0e32ac3455b50d1284f925c729173d59292..5fde56823b2848b7e5fb8ded443e2722059f2ebc 100644
--- a/Framework/DataHandling/inc/MantidDataHandling/LoadFITS.h
+++ b/Framework/DataHandling/inc/MantidDataHandling/LoadFITS.h
@@ -97,31 +97,43 @@ private:
/// Execution code
void exec();
- /// Loads files into workspace(s)
- void doLoadFiles(const std::vector<std::string> &paths,
- const std::string &outWSName, bool loadAsRectImg = false);
-
/// Loads the FITS header(s) into a struct
void doLoadHeaders(const std::vector<std::string> &paths,
std::vector<FITSInfo> &headers);
+ /// Once loaded, check against standard and limitations of this algorithm
+ void headerSanityCheck(const FITSInfo &hdr, const FITSInfo &hdrFirst);
+
+ /// Loads files into workspace(s)
+ void doLoadFiles(const std::vector<std::string> &paths,
+ const std::string &outWSName, bool loadAsRectImg,
+ int binSize, double noiseThresh);
+
/// Parses the header values for the FITS file
void parseHeader(FITSInfo &headerInfo);
/// Initialises a workspace with IDF and fills it with data
- DataObjects::Workspace2D_sptr
- makeWorkspace(const FITSInfo &fileInfo, size_t &newFileNumber,
- std::vector<char> &buffer, API::MantidImage &imageY,
- API::MantidImage &imageE,
- const DataObjects::Workspace2D_sptr parent,
- bool loadAsRectImg = false);
-
- // Reads the data from a single FITS file into a workspace
+ DataObjects::Workspace2D_sptr makeWorkspace(
+ const FITSInfo &fileInfo, size_t &newFileNumber,
+ std::vector<char> &buffer, API::MantidImage &imageY,
+ API::MantidImage &imageE, const DataObjects::Workspace2D_sptr parent,
+ bool loadAsRectImg = false, int binSize = 1, double noiseThresh = false);
+
+ void addAxesInfoAndLogs(DataObjects::Workspace2D_sptr ws, bool loadAsRectImg,
+ const FITSInfo &fileInfo, int binSize, double cmpp);
+
+ // Reads the data from a single FITS file into a workspace (directly, fast)
+ void readDataToWorkspace(const FITSInfo &fileInfo, double cmpp,
+ DataObjects::Workspace2D_sptr ws,
+ std::vector<char> &buffer);
+
+ // Reads the data from a single FITS file into image objects (Y and E) that
+ // then can/will be copied into a workspace
void readDataToImgs(const FITSInfo &fileInfo, API::MantidImage &imageY,
API::MantidImage &imageE, std::vector<char> &buffer);
- /// Once loaded, check against standard and limitations of this algorithm
- void headerSanityCheck(const FITSInfo &hdr, const FITSInfo &hdrFirst);
+ void readInBuffer(const FITSInfo &fileInfo, std::vector<char> &buffer,
+ size_t len);
/// filter noise pixel by pixel
void doFilterNoise(double thresh, API::MantidImage &imageY,
@@ -136,16 +148,16 @@ private:
void setupDefaultKeywordNames();
+ // Maps the header keys to specified values
+ void mapHeaderKeys();
+
/// Returns the trailing number from a string minus leading 0's (so 25 from
- /// workspace_00025)
+ /// workspace_000025)
size_t fetchNumber(const std::string &name);
// Adds a number of leading 0's to another number up to the totalDigitCount.
std::string padZeros(const size_t number, const size_t totalDigitCount);
- // Maps the header keys to specified values
- void mapHeaderKeys();
-
// Strings used to map header keys
std::string m_headerScaleKey;
std::string m_headerOffsetKey;
@@ -162,17 +174,11 @@ private:
std::string m_sampleRotation;
std::string m_imageType;
- std::string m_baseName;
size_t m_pixelCount;
- // rebin block size (m_rebin x m_rebin) cells
- int m_rebin;
- // noise threshold level
- double m_noiseThresh;
- API::Progress *m_progress;
// Number of digits for the fixed width appendix number added to
// workspace names, i.e. 3=> workspace_001; 5 => workspace_00001
- static const size_t g_DIGIT_SIZE_APPEND = 5;
+ static const size_t g_DIGIT_SIZE_APPEND = 6;
/// size of a FITS header block (room for 36 entries, of 80
/// characters each), in bytes. A FITS header always comes in
/// multiples of this block.
diff --git a/Framework/DataHandling/src/LoadFITS.cpp b/Framework/DataHandling/src/LoadFITS.cpp
index 1734ed99eda06498bfa23cd22d68a6b5bf332f8e..533ec1fa764fa4540486146706daf982914b9989 100644
--- a/Framework/DataHandling/src/LoadFITS.cpp
+++ b/Framework/DataHandling/src/LoadFITS.cpp
@@ -11,6 +11,7 @@
#include <Poco/BinaryReader.h>
#include <Poco/FileStream.h>
+#include <Poco/Path.h>
using namespace Mantid::DataHandling;
using namespace Mantid::DataObjects;
@@ -36,8 +37,7 @@ const std::string LoadFITS::g_defaultImgType = "SAMPLE";
LoadFITS::LoadFITS()
: m_headerScaleKey(), m_headerOffsetKey(), m_headerBitDepthKey(),
m_headerRotationKey(), m_headerImageKeyKey(), m_headerAxisNameKeys(),
- m_mapFile(), m_baseName(), m_pixelCount(0), m_rebin(1),
- m_noiseThresh(0.0), m_progress(NULL) {
+ m_mapFile(), m_pixelCount(0) {
setupDefaultKeywordNames();
}
@@ -55,31 +55,6 @@ int LoadFITS::confidence(Kernel::FileDescriptor &descriptor) const {
: 0;
}
-/**
- * Sets several keyword names with default (and standard) values. You
- * don't want to change these unless you want to break compatibility
- * with the FITS standard.
- */
-void LoadFITS::setupDefaultKeywordNames() {
- // Inits all the absolutely necessary keywords
- // standard headers (If SIMPLE=T)
- m_headerScaleKey = "BSCALE";
- m_headerOffsetKey = "BZERO";
- m_headerBitDepthKey = "BITPIX";
- m_headerImageKeyKey = "IMAGE_TYPE"; // This is a "HIERARCH Image/Type= "
- m_headerRotationKey = "ROTATION";
-
- m_headerNAxisNameKey = "NAXIS";
- m_headerAxisNameKeys.push_back("NAXIS1");
- m_headerAxisNameKeys.push_back("NAXIS2");
-
- m_mapFile = "";
-
- // extensions
- m_sampleRotation = "HIERARCH Sample/Tomo_Angle";
- m_imageType = "HIERARCH Image/Type";
-}
-
/**
* Initialise the algorithm. Declare properties which can be set before execution
* (input) or
@@ -146,143 +121,12 @@ void LoadFITS::exec() {
std::vector<std::string> paths;
boost::split(paths, fName, boost::is_any_of(","));
- m_rebin = getProperty("BinSize");
- m_noiseThresh = getProperty("FilterNoiseLevel");
+ int binSize = getProperty("BinSize");
+ double noiseThresh = getProperty("FilterNoiseLevel");
bool loadAsRectImg = getProperty("LoadAsRectImg");
const std::string outWSName = getPropertyValue("OutputWorkspace");
- doLoadFiles(paths, outWSName, loadAsRectImg);
-}
-
-/**
- * Create FITS file information for each file selected. Loads headers
- * and data from the files and creates and fills the output
- * workspace(s).
- *
- * @param paths File names as given in the algorithm input property
- *
- * @param outWSName name of the output (group) workspace to create
- *
- * @param loadAsRectImg Load files with 1 spectrum per row and 1 bin
- * per column, so a color fill plot displays the image
- *
- * @throw std::runtime_error when load fails (for example a memory
- * allocation issue, wrong rebin requested, etc.)
- */
-void LoadFITS::doLoadFiles(const std::vector<std::string> &paths,
- const std::string &outWSName, bool loadAsRectImg) {
- std::vector<FITSInfo> headers;
-
- doLoadHeaders(paths, headers);
-
- // No extension is set -> it's the standard format which we can parse.
- if (headers[0].numberOfAxis > 0)
- m_pixelCount += headers[0].axisPixelLengths[0];
-
- // Presumably 2 axis, but futureproofing.
- for (int i = 1; i < headers[0].numberOfAxis; ++i) {
- m_pixelCount *= headers[0].axisPixelLengths[i];
- }
-
- // Check consistency of m_rebin asap
- for (int i = 0; i < headers[0].numberOfAxis; ++i) {
- if (0 != (headers[0].axisPixelLengths[i] % m_rebin)) {
- throw std::runtime_error(
- "Cannot rebin this image in blocks of " +
- boost::lexical_cast<std::string>(m_rebin) + " x " +
- boost::lexical_cast<std::string>(m_rebin) +
- " pixels as requested because the size of dimension " +
- boost::lexical_cast<std::string>(i + 1) + " (" +
- boost::lexical_cast<std::string>(headers[0].axisPixelLengths[i]) +
- ") is not a multiple of the bin size.");
- }
- }
-
- MantidImage imageY(headers[0].axisPixelLengths[1],
- std::vector<double>(headers[0].axisPixelLengths[0]));
- MantidImage imageE(headers[0].axisPixelLengths[1],
- std::vector<double>(headers[0].axisPixelLengths[0]));
-
- size_t bytes = (headers[0].bitsPerPixel / 8) * m_pixelCount;
- std::vector<char> buffer;
- try {
- buffer.resize(bytes);
- } catch (std::exception &) {
- throw std::runtime_error(
- "Could not allocate enough memory to run when trying to allocate " +
- boost::lexical_cast<std::string>(bytes) + " bytes.");
- }
-
- // Create a group for these new workspaces, if the group already exists, add
- // to it.
- std::string groupName = outWSName;
-
- // This forms the name of the group
- m_baseName = getPropertyValue("OutputWorkspace") + "_";
-
- size_t fileNumberInGroup = 0;
- WorkspaceGroup_sptr wsGroup;
-
- if (!AnalysisDataService::Instance().doesExist(groupName)) {
- wsGroup = WorkspaceGroup_sptr(new WorkspaceGroup);
- wsGroup->setTitle(groupName);
- } else {
- // Get the name of the latest file in group to start numbering from
- if (AnalysisDataService::Instance().doesExist(groupName))
- wsGroup =
- AnalysisDataService::Instance().retrieveWS<WorkspaceGroup>(groupName);
-
- std::string latestName = wsGroup->getNames().back();
- // Set next file number
- fileNumberInGroup = fetchNumber(latestName) + 1;
- }
-
- // Create a progress reporting object
- m_progress = new Progress(this, 0, 1, headers.size() + 1);
-
- // Create first workspace (with instrument definition). This is also used as
- // a template for creating others
- Workspace2D_sptr latestWS;
- latestWS = makeWorkspace(headers[0], fileNumberInGroup, buffer, imageY,
- imageE, latestWS, loadAsRectImg);
-
- std::map<size_t, Workspace2D_sptr> wsOrdered;
- wsOrdered[0] = latestWS;
-
- if (isInstrOtherThanIMAT(headers[0])) {
- // For now we assume IMAT except when specific headers are found by
- // isInstrOtherThanIMAT()
- //
- // TODO: do this conditional on INSTR='IMAT' when we have proper IMAT .fits
- // files
- try {
- IAlgorithm_sptr loadInst = createChildAlgorithm("LoadInstrument");
- std::string directoryName =
- Kernel::ConfigService::Instance().getInstrumentDirectory();
- directoryName = directoryName + "/IMAT_Definition.xml";
- loadInst->setPropertyValue("Filename", directoryName);
- loadInst->setProperty<MatrixWorkspace_sptr>(
- "Workspace", boost::dynamic_pointer_cast<MatrixWorkspace>(latestWS));
- loadInst->execute();
- } catch (std::exception &ex) {
- g_log.information("Cannot load the instrument definition. " +
- std::string(ex.what()));
- }
- }
-
- PARALLEL_FOR_NO_WSP_CHECK()
- for (int64_t i = 1; i < static_cast<int64_t>(headers.size()); ++i) {
- latestWS = makeWorkspace(headers[i], fileNumberInGroup, buffer, imageY,
- imageE, latestWS, loadAsRectImg);
- wsOrdered[i] = latestWS;
- }
-
- // Add to group - done here to maintain sequence
- for (auto it = wsOrdered.begin(); it != wsOrdered.end(); ++it) {
- wsGroup->addWorkspace(it->second);
- }
-
- setProperty("OutputWorkspace", wsGroup);
+ doLoadFiles(paths, outWSName, loadAsRectImg, binSize, noiseThresh);
}
/**
@@ -303,6 +147,7 @@ void LoadFITS::doLoadHeaders(const std::vector<std::string> &paths,
for (size_t i = 0; i < paths.size(); ++i) {
headers[i].extension = "";
headers[i].filePath = paths[i];
+
// Get various pieces of information from the file header which are used
// to
// create the workspace
@@ -374,9 +219,10 @@ void LoadFITS::doLoadHeaders(const std::vector<std::string> &paths,
for (int j = 0; headers.size() > i && j < headers[i].numberOfAxis; ++j) {
headers[i].axisPixelLengths.push_back(boost::lexical_cast<size_t>(
headers[i].headerKeys[m_headerAxisNameKeys[j]]));
- g_log.information()
- << "Found axis length header entry: " << m_headerAxisNameKeys[j]
- << " = " << headers[i].axisPixelLengths.back() << std::endl;
+ // only debug level, when loading multiple files this is very verbose
+ g_log.debug() << "Found axis length header entry: "
+ << m_headerAxisNameKeys[j] << " = "
+ << headers[i].axisPixelLengths.back() << std::endl;
}
// Various extensions to the FITS format are used elsewhere, and
@@ -450,42 +296,270 @@ void LoadFITS::doLoadHeaders(const std::vector<std::string> &paths,
}
}
+/**
+ * Checks that a FITS header (once loaded) is valid/supported:
+ * standard (no extension to FITS), and has two axis with the expected
+ * dimensions.
+ *
+ * @param hdr FITS header struct loaded from a file - to check
+ *
+ * @param hdrFirst FITS header struct loaded from a (first) reference file -
+ *to
+ * compare against
+ *
+ * @throws std::exception if there's any issue or unsupported entry in the
+ * header
+ */
+void LoadFITS::headerSanityCheck(const FITSInfo &hdr,
+ const FITSInfo &hdrFirst) {
+ bool valid = true;
+ if (hdr.extension != "") {
+ valid = false;
+ g_log.error() << "File " << hdr.filePath
+ << ": extensions found in the header." << std::endl;
+ }
+ if (hdr.numberOfAxis != 2) {
+ valid = false;
+ g_log.error() << "File " << hdr.filePath
+ << ": the number of axes is not 2 but: " << hdr.numberOfAxis
+ << std::endl;
+ }
+
+ // Test current item has same axis values as first item.
+ if (hdr.axisPixelLengths[0] != hdrFirst.axisPixelLengths[0]) {
+ valid = false;
+ g_log.error() << "File " << hdr.filePath
+ << ": the number of pixels in the first dimension differs "
+ "from the first file loaded (" << hdrFirst.filePath
+ << "): " << hdr.axisPixelLengths[0]
+ << " != " << hdrFirst.axisPixelLengths[0] << std::endl;
+ }
+ if (hdr.axisPixelLengths[1] != hdrFirst.axisPixelLengths[1]) {
+ valid = false;
+ g_log.error() << "File " << hdr.filePath
+ << ": the number of pixels in the second dimension differs"
+ "from the first file loaded (" << hdrFirst.filePath
+ << "): " << hdr.axisPixelLengths[0]
+ << " != " << hdrFirst.axisPixelLengths[0] << std::endl;
+ }
+
+ // Check the format is correct and create the Workspace
+ if (!valid) {
+ // Invalid files, record error
+ throw std::runtime_error(
+ "An issue has been found in the header of this FITS file: " +
+ hdr.filePath +
+ ". This algorithm currently doesn't support FITS files with "
+ "non-standard extensions, more than two axis "
+ "of data, or has detected that all the files are "
+ "not similar.");
+ }
+}
+
+/**
+ * Create FITS file information for each file selected. Loads headers
+ * and data from the files and creates and fills the output
+ * workspace(s).
+ *
+ * @param paths File names as given in the algorithm input property
+ *
+ * @param outWSName name of the output (group) workspace to create
+ *
+ * @param loadAsRectImg Load files with 1 spectrum per row and 1 bin
+ * per column, so a color fill plot displays the image
+ *
+ * @param binSize size to rebin (1 == no re-bin == default)
+ *
+ * @param noiseThresh threshold for noise filtering
+ *
+ * @throw std::runtime_error when load fails (for example a memory
+ * allocation issue, wrong rebin requested, etc.)
+ */
+void LoadFITS::doLoadFiles(const std::vector<std::string> &paths,
+ const std::string &outWSName, bool loadAsRectImg,
+ int binSize, double noiseThresh) {
+ std::vector<FITSInfo> headers;
+
+ doLoadHeaders(paths, headers);
+
+ // No extension is set -> it's the standard format which we can parse.
+ if (headers[0].numberOfAxis > 0)
+ m_pixelCount += headers[0].axisPixelLengths[0];
+
+ // Presumably 2 axis, but futureproofing.
+ for (int i = 1; i < headers[0].numberOfAxis; ++i) {
+ m_pixelCount *= headers[0].axisPixelLengths[i];
+ }
+
+ // Check consistency of binSize asap
+ for (int i = 0; i < headers[0].numberOfAxis; ++i) {
+ if (0 != (headers[0].axisPixelLengths[i] % binSize)) {
+ throw std::runtime_error(
+ "Cannot rebin this image in blocks of " +
+ boost::lexical_cast<std::string>(binSize) + " x " +
+ boost::lexical_cast<std::string>(binSize) +
+ " pixels as requested because the size of dimension " +
+ boost::lexical_cast<std::string>(i + 1) + " (" +
+ boost::lexical_cast<std::string>(headers[0].axisPixelLengths[i]) +
+ ") is not a multiple of the bin size.");
+ }
+ }
+
+ MantidImage imageY(headers[0].axisPixelLengths[1],
+ std::vector<double>(headers[0].axisPixelLengths[0]));
+ MantidImage imageE(headers[0].axisPixelLengths[1],
+ std::vector<double>(headers[0].axisPixelLengths[0]));
+
+ size_t bytes = (headers[0].bitsPerPixel / 8) * m_pixelCount;
+ std::vector<char> buffer;
+ try {
+ buffer.resize(bytes);
+ } catch (std::exception &) {
+ throw std::runtime_error(
+ "Could not allocate enough memory to run when trying to allocate " +
+ boost::lexical_cast<std::string>(bytes) + " bytes.");
+ }
+
+ // Create a group for these new workspaces, if the group already exists, add
+ // to it.
+ std::string groupName = outWSName;
+
+ size_t fileNumberInGroup = 0;
+ WorkspaceGroup_sptr wsGroup;
+
+ if (!AnalysisDataService::Instance().doesExist(groupName)) {
+ wsGroup = WorkspaceGroup_sptr(new WorkspaceGroup());
+ wsGroup->setTitle(groupName);
+ } else {
+ // Get the name of the latest file in group to start numbering from
+ if (AnalysisDataService::Instance().doesExist(groupName))
+ wsGroup =
+ AnalysisDataService::Instance().retrieveWS<WorkspaceGroup>(groupName);
+
+ std::string latestName = wsGroup->getNames().back();
+ // Set next file number
+ fileNumberInGroup = fetchNumber(latestName) + 1;
+ }
+
+ size_t totalWS = headers.size();
+ // Create a progress reporting object
+ API::Progress progress(this, 0, 1, totalWS + 1);
+ progress.report(0, "Loading file(s) into workspace(s)");
+
+ // Create first workspace (with instrument definition). This is also used as
+ // a template for creating others
+ Workspace2D_sptr imgWS;
+ imgWS = makeWorkspace(headers[0], fileNumberInGroup, buffer, imageY, imageE,
+ imgWS, loadAsRectImg, binSize, noiseThresh);
+ progress.report(1, "First file loaded.");
+
+ wsGroup->addWorkspace(imgWS);
+
+ if (isInstrOtherThanIMAT(headers[0])) {
+ // For now we assume IMAT except when specific headers are found by
+ // isInstrOtherThanIMAT()
+ //
+ // TODO: do this conditional on INSTR='IMAT' when we have proper IMAT .fits
+ // files
+ try {
+ IAlgorithm_sptr loadInst = createChildAlgorithm("LoadInstrument");
+ std::string directoryName =
+ Kernel::ConfigService::Instance().getInstrumentDirectory();
+ directoryName = directoryName + "/IMAT_Definition.xml";
+ loadInst->setPropertyValue("Filename", directoryName);
+ loadInst->setProperty<MatrixWorkspace_sptr>(
+ "Workspace", boost::dynamic_pointer_cast<MatrixWorkspace>(imgWS));
+ loadInst->execute();
+ } catch (std::exception &ex) {
+ g_log.information("Cannot load the instrument definition. " +
+ std::string(ex.what()));
+ }
+ }
+
+ // don't feel tempted to parallelize this loop as it is - it uses the same
+ // imageY and imageE buffers for all the workspaces
+ for (int64_t i = 1; i < static_cast<int64_t>(totalWS); ++i) {
+ imgWS = makeWorkspace(headers[i], fileNumberInGroup, buffer, imageY, imageE,
+ imgWS, loadAsRectImg, binSize, noiseThresh);
+ progress.report("Loaded file " + boost::lexical_cast<std::string>(i + 1) +
+ " of " + boost::lexical_cast<std::string>(totalWS));
+ wsGroup->addWorkspace(imgWS);
+ }
+
+ setProperty("OutputWorkspace", wsGroup);
+}
+
/**
* Read a single files header and populate an object with the information.
*
* @param headerInfo A FITSInfo file object to parse header
* information into. This object must have its field filePath set to
* the input file
+ *
+ * A typical simple FITS header looks like this:
+@verbatim
+SIMPLE = T / file does conform to FITS standard
+BITPIX = 16 / number of bits per data pixel
+NAXIS = 2 / number of data axes
+NAXIS1 = 512 / length of data axis 1
+NAXIS2 = 512 / length of data axis 2
+EXTEND = T / FITS dataset may contain extensions
+COMMENT FITS (Flexible Image Transport System) format is defined in 'Astronomy
+COMMENT and Astrophysics', volume 376, page 359; bibcode: 2001A&A...376..359H
+TOF = 0.0595897599999995 / Ttime of flight from the external trigger
+TIMEBIN = 4.096E-005 / Time width of this image
+N_COUNTS= 182976 / Total counts in this image
+N_TRIGS = 4426 / Number of triggers acquired
+END
+@endverbatim
*
* @throws various std::runtime_error etc. on read failure
*/
void LoadFITS::parseHeader(FITSInfo &headerInfo) {
headerInfo.headerSizeMultiplier = 0;
std::ifstream istr(headerInfo.filePath.c_str(), std::ios::binary);
+ istr.seekg(0, istr.end);
+ if (!(istr.tellg() > 0)) {
+ throw std::runtime_error(
+ "Found a file that is readable but empty (0 bytes size): " +
+ headerInfo.filePath);
+ }
+ istr.seekg(0, istr.beg);
+
Poco::BinaryReader reader(istr);
// Iterate 80 bytes at a time until header is parsed | 2880 bytes is the
// fixed header length of FITS
// 2880/80 = 36 iterations required
+ const std::string commentKW = "COMMENT";
bool endFound = false;
while (!endFound) {
headerInfo.headerSizeMultiplier++;
- for (int i = 0; i < 36; ++i) {
+ const int entriesPerHDU = 36;
+ for (int i = 0; i < entriesPerHDU; ++i) {
// Keep vect of each header item, including comments, and also keep a
// map of individual keys.
std::string part;
reader.readRaw(80, part);
headerInfo.headerItems.push_back(part);
- // Add key/values - these are separated by the = symbol.
- // If it doesn't have an = it's a comment to ignore. All keys should be
- // unique
+ // from the FITS standard about COMMENT: This keyword shall have no
+ // associated value; columns 9-80 may contain any ASCII text.
+ // That includes '='
+ if (boost::iequals(commentKW, part.substr(0, commentKW.size()))) {
+ continue;
+ }
+
+ // Add non-comment key/values. These hey and value are separated by the
+ // character '='. All keys should be unique.
+ // This will simply and silenty ignore any entry without the '='
auto eqPos = part.find('=');
if (eqPos > 0) {
std::string key = part.substr(0, eqPos);
std::string value = part.substr(eqPos + 1);
- // Comments are added after the value separated by a / symbol. Remove.
+ // Comments on header entries are added after the value separated by a /
+ // symbol. Exclude those comments.
auto slashPos = value.find('/');
if (slashPos > 0)
value = value.substr(0, slashPos);
@@ -510,7 +584,10 @@ void LoadFITS::parseHeader(FITSInfo &headerInfo) {
* with data
*
* @param fileInfo information for the current file
- * @param newFileNumber number for the new file when added into ws group
+ *
+ * @param newFileNumber sequence number for the new file when added
+ * into ws group
+ *
* @param buffer pre-allocated buffer to contain data values
* @param imageY Object to set the Y data values in
* @param imageE Object to set the E data values in
@@ -522,27 +599,23 @@ void LoadFITS::parseHeader(FITSInfo &headerInfo) {
* spectrum per row and one bin per column, instead of the (default)
* as many spectra as pixels.
*
+ * @param binSize size to rebin (1 == no re-bin == default)
+ *
+ * @param noiseThresh threshold for noise filtering
+ *
* @returns A newly created Workspace2D, as a shared pointer
*/
-Workspace2D_sptr
-LoadFITS::makeWorkspace(const FITSInfo &fileInfo, size_t &newFileNumber,
- std::vector<char> &buffer, MantidImage &imageY,
- MantidImage &imageE, const Workspace2D_sptr parent,
- bool loadAsRectImg) {
-
- std::string currNumberS = padZeros(newFileNumber, g_DIGIT_SIZE_APPEND);
- ++newFileNumber;
-
- std::string baseName = m_baseName + currNumberS;
-
- // set data
- readDataToImgs(fileInfo, imageY, imageE, buffer);
-
- // Create ws
+Workspace2D_sptr
+LoadFITS::makeWorkspace(const FITSInfo &fileInfo, size_t &newFileNumber,
+ std::vector<char> &buffer, MantidImage &imageY,
+ MantidImage &imageE, const Workspace2D_sptr parent,
+ bool loadAsRectImg, int binSize, double noiseThresh) {
+ // Create workspace (taking into account already here if rebinning is
+ // going to happen)
Workspace2D_sptr ws;
if (!parent) {
if (!loadAsRectImg) {
- size_t finalPixelCount = m_pixelCount / m_rebin * m_rebin;
+ size_t finalPixelCount = m_pixelCount / binSize * binSize;
ws = boost::dynamic_pointer_cast<Workspace2D>(
WorkspaceFactory::Instance().create("Workspace2D", finalPixelCount, 2,
1));
@@ -550,47 +623,82 @@ LoadFITS::makeWorkspace(const FITSInfo &fileInfo, size_t &newFileNumber,
ws = boost::dynamic_pointer_cast<Workspace2D>(
WorkspaceFactory::Instance().create(
"Workspace2D",
- fileInfo.axisPixelLengths[1] / m_rebin, // one bin per column
- fileInfo.axisPixelLengths[0] / m_rebin +
+ fileInfo.axisPixelLengths[1] / binSize, // one bin per column
+ fileInfo.axisPixelLengths[0] / binSize +
1, // one spectrum per row
- fileInfo.axisPixelLengths[0] / m_rebin));
+ fileInfo.axisPixelLengths[0] / binSize));
}
} else {
ws = boost::dynamic_pointer_cast<Workspace2D>(
WorkspaceFactory::Instance().create(parent));
}
- doFilterNoise(m_noiseThresh, imageY, imageE);
-
// this pixel scale property is used to set the workspace X values
double cm_1 = getProperty("Scale");
// amount of width units (e.g. cm) per pixel
double cmpp = 1; // cm per pixel == bin width
if (0.0 != cm_1)
cmpp /= cm_1;
- cmpp *= static_cast<double>(m_rebin);
+ cmpp *= static_cast<double>(binSize);
- // Set in WS
- // Note this can change the sizes of the images and the number of pixels
- if (1 == m_rebin) {
- ws->setImageYAndE(imageY, imageE, 0, loadAsRectImg, cmpp,
- false /* no parallel load */);
+ if (loadAsRectImg && 1 == binSize) {
+ // set data directly into workspace
+ readDataToWorkspace(fileInfo, cmpp, ws, buffer);
} else {
- MantidImage rebinnedY(imageY.size() / m_rebin,
- std::vector<double>(imageY[0].size() / m_rebin));
- MantidImage rebinnedE(imageE.size() / m_rebin,
- std::vector<double>(imageE[0].size() / m_rebin));
-
- doRebin(m_rebin, imageY, imageE, rebinnedY, rebinnedE);
- ws->setImageYAndE(rebinnedY, rebinnedE, 0, loadAsRectImg, cmpp,
- false /* no parallel load */);
+ readDataToImgs(fileInfo, imageY, imageE, buffer);
+ doFilterNoise(noiseThresh, imageY, imageE);
+
+ // Note this can change the sizes of the images and the number of pixels
+ if (1 == binSize) {
+ ws->setImageYAndE(imageY, imageE, 0, loadAsRectImg, cmpp,
+ false /* no parallel load */);
+
+ } else {
+ MantidImage rebinnedY(imageY.size() / binSize,
+ std::vector<double>(imageY[0].size() / binSize));
+ MantidImage rebinnedE(imageE.size() / binSize,
+ std::vector<double>(imageE[0].size() / binSize));
+
+ doRebin(binSize, imageY, imageE, rebinnedY, rebinnedE);
+ ws->setImageYAndE(rebinnedY, rebinnedE, 0, loadAsRectImg, cmpp,
+ false /* no parallel load */);
+ }
+ }
+
+ try {
+ ws->setTitle(Poco::Path(fileInfo.filePath).getFileName());
+ } catch (std::runtime_error &) {
+ ws->setTitle(padZeros(newFileNumber, g_DIGIT_SIZE_APPEND));
}
+ ++newFileNumber;
+
+ addAxesInfoAndLogs(ws, loadAsRectImg, fileInfo, binSize, cmpp);
- ws->setTitle(baseName);
+ return ws;
+}
+/**
+ * Add information to the workspace being loaded: labels, units, logs related to
+ * the image size, etc.
+ *
+ * @param ws workspace to manipulate
+ *
+ * @param loadAsRectImg if true, the workspace has one spectrum per
+ * row and one bin per column
+ *
+ * @param fileInfo information for the current file
+ *
+ * @param binSize size to rebin (1 == no re-bin == default)
+ *
+ * @param cmpp centimeters per pixel (already taking into account
+ * possible rebinning)
+ */
+void LoadFITS::addAxesInfoAndLogs(Workspace2D_sptr ws, bool loadAsRectImg,
+ const FITSInfo &fileInfo, int binSize,
+ double cmpp) {
// add axes
- size_t width = fileInfo.axisPixelLengths[0] / m_rebin;
- size_t height = fileInfo.axisPixelLengths[1] / m_rebin;
+ size_t width = fileInfo.axisPixelLengths[0] / binSize;
+ size_t height = fileInfo.axisPixelLengths[1] / binSize;
if (loadAsRectImg) {
// width/X axis
auto axw = new Mantid::API::NumericAxis(width + 1);
@@ -656,14 +764,79 @@ LoadFITS::makeWorkspace(const FITSInfo &fileInfo, size_t &newFileNumber,
ws->mutableRun().removeLogData("ImageKey", true);
ws->mutableRun().addLogData(
new PropertyWithValue<std::string>("ImageKey", fileInfo.imageKey));
+}
- m_progress->report();
+/**
+ * Reads the data (FITS matrix) from a single FITS file into a
+ * workspace (directly into the spectra, using one spectrum per image
+ * row).
+ *
+ * @param fileInfo information on the FITS file to load, including its path
+ * @param cmpp centimeters per pixel, to scale/normalize values
+ * @param ws workspace with the required dimensions
+ * @param buffer pre-allocated buffer to read from file
+ *
+ * @throws std::runtime_error if there are file input issues
+ */
+void LoadFITS::readDataToWorkspace(const FITSInfo &fileInfo, double cmpp,
+ Workspace2D_sptr ws,
+ std::vector<char> &buffer) {
- return ws;
+ size_t bytespp = (fileInfo.bitsPerPixel / 8);
+ size_t len = m_pixelCount * bytespp;
+ readInBuffer(fileInfo, buffer, len);
+
+ // create pointer of correct data type to void pointer of the buffer:
+ uint8_t *buffer8 = reinterpret_cast<uint8_t *>(&buffer[0]);
+
+ PARALLEL_FOR_NO_WSP_CHECK()
+ for (int i = 0; i < static_cast<int>(fileInfo.axisPixelLengths[1]);
+ ++i) { // rows
+ Mantid::API::ISpectrum *specRow = ws->getSpectrum(i);
+ double xval = static_cast<double>(i) * cmpp;
+ std::fill(specRow->dataX().begin(), specRow->dataX().end(), xval);
+
+ for (size_t j = 0; j < fileInfo.axisPixelLengths[0]; ++j) { // columns
+
+ size_t start =
+ ((i * (bytespp)) * fileInfo.axisPixelLengths[1]) + (j * (bytespp));
+
+ char tmpbuf;
+ char *tmp = &tmpbuf;
+
+ // Reverse byte order of current value
+ std::reverse_copy(buffer8 + start, buffer8 + start + bytespp, tmp);
+
+ double val = 0;
+ if (fileInfo.bitsPerPixel == 8)
+ val = static_cast<double>(*reinterpret_cast<uint8_t *>(tmp));
+ else if (fileInfo.bitsPerPixel == 16)
+ val = static_cast<double>(*reinterpret_cast<uint16_t *>(tmp));
+ else if (fileInfo.bitsPerPixel == 32 && !fileInfo.isFloat)
+ val = static_cast<double>(*reinterpret_cast<uint32_t *>(tmp));
+ else if (fileInfo.bitsPerPixel == 64 && !fileInfo.isFloat)
+ val = static_cast<double>(*reinterpret_cast<uint64_t *>(tmp));
+
+ // cppcheck doesn't realise that these are safe casts
+ else if (fileInfo.bitsPerPixel == 32 && fileInfo.isFloat) {
+ // cppcheck-suppress invalidPointerCast
+ val = static_cast<double>(*reinterpret_cast<float *>(tmp));
+ } else if (fileInfo.bitsPerPixel == 64 && fileInfo.isFloat) {
+ // cppcheck-suppress invalidPointerCast
+ val = *reinterpret_cast<double *>(tmp);
+ }
+
+ val = fileInfo.scale * val - fileInfo.offset;
+
+ specRow->dataY()[j] = val;
+ specRow->dataE()[j] = sqrt(val);
+ }
+ }
}
/**
- * Reads the data (matrix) from a single FITS file into image objects.
+ * Reads the data (FITS matrix) from a single FITS file into image
+ * objects (Y and E). E is filled with the sqrt() of Y.
*
* @param fileInfo information on the FITS file to load, including its path
* @param imageY Object to set the Y data values in
@@ -674,43 +847,29 @@ LoadFITS::makeWorkspace(const FITSInfo &fileInfo, size_t &newFileNumber,
*/
void LoadFITS::readDataToImgs(const FITSInfo &fileInfo, MantidImage &imageY,
MantidImage &imageE, std::vector<char> &buffer) {
- std::string filename = fileInfo.filePath;
- Poco::FileStream file(filename, std::ios::in);
size_t bytespp = (fileInfo.bitsPerPixel / 8);
size_t len = m_pixelCount * bytespp;
- file.seekg(g_BASE_HEADER_SIZE * fileInfo.headerSizeMultiplier);
- file.read(&buffer[0], len);
- if (!file) {
- throw std::runtime_error(
- "Error while reading file: " + filename + ". Tried to read " +
- boost::lexical_cast<std::string>(len) + " bytes but got " +
- boost::lexical_cast<std::string>(file.gcount()) +
- " bytes. The file and/or its headers may be wrong.");
- }
- // all is loaded
- file.close();
+ readInBuffer(fileInfo, buffer, len);
// create pointer of correct data type to void pointer of the buffer:
uint8_t *buffer8 = reinterpret_cast<uint8_t *>(&buffer[0]);
-
std::vector<char> buf(bytespp);
char *tmp = &buf.front();
size_t start = 0;
+
for (size_t i = 0; i < fileInfo.axisPixelLengths[1]; ++i) { // width
for (size_t j = 0; j < fileInfo.axisPixelLengths[0]; ++j) { // height
// If you wanted to PARALLEL_...ize these loops (which doesn't
- // seem to provide any speed up, you cannot use the
- // start+=bytespp at the end of this loop. You'd need something
- // like this:
+ // seem to provide any speed up when loading images one at a
+ // time, you cannot use the start+=bytespp at the end of this
+ // loop. You'd need something like this:
//
// size_t start =
- // ((i * (bytespp)) * fileInfo.axisPixelLengths[1]) +
- // (j * (bytespp));
-
+ // ((i * (bytespp)) * fileInfo.axisPixelLengths[1]) +
+ // (j * (bytespp));
// Reverse byte order of current value
std::reverse_copy(buffer8 + start, buffer8 + start + bytespp, tmp);
-
double val = 0;
if (fileInfo.bitsPerPixel == 8)
val = static_cast<double>(*reinterpret_cast<uint8_t *>(tmp));
@@ -720,7 +879,6 @@ void LoadFITS::readDataToImgs(const FITSInfo &fileInfo, MantidImage &imageY,
val = static_cast<double>(*reinterpret_cast<uint32_t *>(tmp));
if (fileInfo.bitsPerPixel == 64 && !fileInfo.isFloat)
val = static_cast<double>(*reinterpret_cast<uint64_t *>(tmp));
-
// cppcheck doesn't realise that these are safe casts
if (fileInfo.bitsPerPixel == 32 && fileInfo.isFloat) {
// cppcheck-suppress invalidPointerCast
@@ -730,17 +888,42 @@ void LoadFITS::readDataToImgs(const FITSInfo &fileInfo, MantidImage &imageY,
// cppcheck-suppress invalidPointerCast
val = *reinterpret_cast<double *>(tmp);
}
-
val = fileInfo.scale * val - fileInfo.offset;
-
imageY[i][j] = val;
imageE[i][j] = sqrt(val);
-
start += bytespp;
}
}
}
+/**
+ * Reads the data (FITS matrix) from a single FITS file into a
+ * buffer. This simply reads the raw block of data, without doing any
+ * re-scaling or adjustment.
+ *
+ * @param fileInfo information on the FITS file to load, including its path
+ * @param buffer pre-allocated buffer where to read data
+ * @param len amount of chars/bytes/octets to read
+ *
+ * @throws std::runtime_error if there are file input issues
+ */
+void LoadFITS::readInBuffer(const FITSInfo &fileInfo, std::vector<char> &buffer,
+ size_t len) {
+ std::string filename = fileInfo.filePath;
+ Poco::FileStream file(filename, std::ios::in);
+ file.seekg(g_BASE_HEADER_SIZE * fileInfo.headerSizeMultiplier);
+ file.read(&buffer[0], len);
+ if (!file) {
+ throw std::runtime_error(
+ "Error while reading file: " + filename + ". Tried to read " +
+ boost::lexical_cast<std::string>(len) + " bytes but got " +
+ boost::lexical_cast<std::string>(file.gcount()) +
+ " bytes. The file and/or its headers may be wrong.");
+ }
+ // all is loaded
+ file.close();
+}
+
/**
* Apply a simple noise filter by averaging threshold-filtered
* neighbor pixels (with 4-neighbohood / 4-connectivity). The
@@ -838,66 +1021,6 @@ void LoadFITS::doRebin(size_t rebin, MantidImage &imageY, MantidImage &imageE,
}
}
-/**
- * Checks that a FITS header (once loaded) is valid/supported:
- * standard (no extension to FITS), and has two axis with the expected
- * dimensions.
- *
- * @param hdr FITS header struct loaded from a file - to check
- *
- * @param hdrFirst FITS header struct loaded from a (first) reference file -
- *to
- * compare against
- *
- * @throws std::exception if there's any issue or unsupported entry in the
- * header
- */
-void LoadFITS::headerSanityCheck(const FITSInfo &hdr,
- const FITSInfo &hdrFirst) {
- bool valid = true;
- if (hdr.extension != "") {
- valid = false;
- g_log.error() << "File " << hdr.filePath
- << ": extensions found in the header." << std::endl;
- }
- if (hdr.numberOfAxis != 2) {
- valid = false;
- g_log.error() << "File " << hdr.filePath
- << ": the number of axes is not 2 but: " << hdr.numberOfAxis
- << std::endl;
- }
-
- // Test current item has same axis values as first item.
- if (hdr.axisPixelLengths[0] != hdrFirst.axisPixelLengths[0]) {
- valid = false;
- g_log.error() << "File " << hdr.filePath
- << ": the number of pixels in the first dimension differs "
- "from the first file loaded (" << hdrFirst.filePath
- << "): " << hdr.axisPixelLengths[0]
- << " != " << hdrFirst.axisPixelLengths[0] << std::endl;
- }
- if (hdr.axisPixelLengths[1] != hdrFirst.axisPixelLengths[1]) {
- valid = false;
- g_log.error() << "File " << hdr.filePath
- << ": the number of pixels in the second dimension differs"
- "from the first file loaded (" << hdrFirst.filePath
- << "): " << hdr.axisPixelLengths[0]
- << " != " << hdrFirst.axisPixelLengths[0] << std::endl;
- }
-
- // Check the format is correct and create the Workspace
- if (!valid) {
- // Invalid files, record error
- throw std::runtime_error(
- "An issue has been found in the header of this FITS file: " +
- hdr.filePath +
- ". This algorithm currently doesn't support FITS files with "
- "non-standard extensions, more than two axis "
- "of data, or has detected that all the files are "
- "not similar.");
- }
-}
-
/**
* Looks for headers used by specific instruments/cameras, or finds if
* the instrument does not appear to be IMAT, which is the only one
@@ -924,7 +1047,7 @@ bool LoadFITS::isInstrOtherThanIMAT(FITSInfo &hdr) {
<< it->second
<< ". This file seems to come from a Starlight camera, "
"as used for calibration of the instruments HiFi and EMU (and"
- "possibly others). Not "
+ "possibly others). Note: not "
"loading instrument definition." << std::endl;
}
@@ -932,43 +1055,28 @@ bool LoadFITS::isInstrOtherThanIMAT(FITSInfo &hdr) {
}
/**
- * Returns the trailing number from a string minus leading 0's (so 25 from
- * workspace_00025)the confidence with with this algorithm can load the file
- *
- * @param name string with a numerical suffix
- *
- * @returns A numerical representation of the string minus leading characters
- * and leading 0's
+ * Sets several keyword names with default (and standard) values. You
+ * don't want to change these unless you want to break compatibility
+ * with the FITS standard.
*/
-size_t LoadFITS::fetchNumber(const std::string &name) {
- std::string tmpStr = "";
- for (auto it = name.end() - 1; isdigit(*it); --it) {
- tmpStr.insert(0, 1, *it);
- }
- while (tmpStr.length() > 0 && tmpStr[0] == '0') {
- tmpStr.erase(tmpStr.begin());
- }
- return (tmpStr.length() > 0) ? boost::lexical_cast<size_t>(tmpStr) : 0;
-}
+void LoadFITS::setupDefaultKeywordNames() {
+ // Inits all the absolutely necessary keywords
+ // standard headers (If SIMPLE=T)
+ m_headerScaleKey = "BSCALE";
+ m_headerOffsetKey = "BZERO";
+ m_headerBitDepthKey = "BITPIX";
+ m_headerImageKeyKey = "IMAGE_TYPE"; // This is a "HIERARCH Image/Type= "
+ m_headerRotationKey = "ROTATION";
-/**
- * Adds 0's to the front of a number to create a string of size
- * totalDigitCount including number
- *
- * @param number input number to add padding to
- *
- * @param totalDigitCount width of the resulting string with 0s followed by
- * number
- *
- * @return A string with the 0-padded number
- */
-std::string LoadFITS::padZeros(const size_t number,
- const size_t totalDigitCount) {
- std::ostringstream ss;
- ss << std::setw(static_cast<int>(totalDigitCount)) << std::setfill('0')
- << static_cast<int>(number);
+ m_headerNAxisNameKey = "NAXIS";
+ m_headerAxisNameKeys.push_back("NAXIS1");
+ m_headerAxisNameKeys.push_back("NAXIS2");
- return ss.str();
+ m_mapFile = "";
+
+ // extensions
+ m_sampleRotation = "HIERARCH Sample/Tomo_Angle";
+ m_imageType = "HIERARCH Image/Type";
}
/**
@@ -1019,5 +1127,44 @@ void LoadFITS::mapHeaderKeys() {
}
}
+/**
+ * Returns the trailing number from a string minus leading 0's (so 25 from
+ * workspace_00025).
+ *
+ * @param name string with a numerical suffix
+ *
+ * @returns A numerical representation of the string minus leading characters
+ * and leading 0's
+ */
+size_t LoadFITS::fetchNumber(const std::string &name) {
+ std::string tmpStr = "";
+ for (auto it = name.end() - 1; isdigit(*it); --it) {
+ tmpStr.insert(0, 1, *it);
+ }
+ while (tmpStr.length() > 0 && tmpStr[0] == '0') {
+ tmpStr.erase(tmpStr.begin());
+ }
+ return (tmpStr.length() > 0) ? boost::lexical_cast<size_t>(tmpStr) : 0;
+}
+
+/**
+ * Adds 0's to the front of a number to create a string of size
+ * totalDigitCount including number
+ *
+ * @param number input number to add padding to
+ *
+ * @param totalDigitCount width of the resulting string with 0s followed by
+ * number
+ *
+ * @return A string with the 0-padded number
+ */
+std::string LoadFITS::padZeros(const size_t number,
+ const size_t totalDigitCount) {
+ std::ostringstream ss;
+ ss << std::setw(static_cast<int>(totalDigitCount)) << std::setfill('0')
+ << static_cast<int>(number);
+
+ return ss.str();
+}
} // namespace DataHandling
} // namespace Mantid
diff --git a/Framework/DataHandling/test/LoadFITSTest.h b/Framework/DataHandling/test/LoadFITSTest.h
index 091099bd16c5645b30d89d33305479d58a3bc180..ace4e8874b3cd1678b681febbe3e4b8109d7fe94 100644
--- a/Framework/DataHandling/test/LoadFITSTest.h
+++ b/Framework/DataHandling/test/LoadFITSTest.h
@@ -48,7 +48,7 @@ public:
void test_propertiesMissing() {
LoadFITS lf;
TS_ASSERT_THROWS_NOTHING(lf.initialize());
- TS_ASSERT_THROWS_NOTHING(lf.setPropertyValue("Filename", smallFname1));
+ TS_ASSERT_THROWS_NOTHING(lf.setPropertyValue("Filename", g_smallFname1));
TS_ASSERT_THROWS(lf.execute(), std::runtime_error);
TS_ASSERT(!lf.isExecuted());
@@ -101,7 +101,7 @@ public:
// Should fail because mandatory parameter has not been set
TS_ASSERT_THROWS(algToBeTested.execute(), std::runtime_error);
- inputFile = smallFname1 + ", " + smallFname2;
+ inputFile = g_smallFname1 + ", " + g_smallFname2;
algToBeTested.setPropertyValue("Filename", inputFile);
// Set the ImageKey to be 0 (this used to be required, but the key
@@ -130,24 +130,24 @@ public:
// basic FITS headers
const auto run = ws1->run();
- TS_ASSERT_EQUALS(run.getLogData("SIMPLE")->value(), hdrSIMPLE);
- TS_ASSERT_EQUALS(run.getLogData("BITPIX")->value(), hdrBITPIX);
- TS_ASSERT_EQUALS(run.getLogData("NAXIS")->value(), hdrNAXIS);
- TS_ASSERT_EQUALS(run.getLogData("NAXIS1")->value(), hdrNAXIS1);
- TS_ASSERT_EQUALS(run.getLogData("NAXIS2")->value(), hdrNAXIS2);
+ TS_ASSERT_EQUALS(run.getLogData("SIMPLE")->value(), g_hdrSIMPLE);
+ TS_ASSERT_EQUALS(run.getLogData("BITPIX")->value(), g_hdrBITPIX);
+ TS_ASSERT_EQUALS(run.getLogData("NAXIS")->value(), g_hdrNAXIS);
+ TS_ASSERT_EQUALS(run.getLogData("NAXIS1")->value(), g_hdrNAXIS1);
+ TS_ASSERT_EQUALS(run.getLogData("NAXIS2")->value(), g_hdrNAXIS2);
// Number of spectra
- TS_ASSERT_EQUALS(ws1->getNumberHistograms(), SPECTRA_COUNT);
- TS_ASSERT_EQUALS(ws2->getNumberHistograms(), SPECTRA_COUNT);
+ TS_ASSERT_EQUALS(ws1->getNumberHistograms(), g_SPECTRA_COUNT);
+ TS_ASSERT_EQUALS(ws2->getNumberHistograms(), g_SPECTRA_COUNT);
// Sum the two bins from the last spectra - should be 70400
double sumY =
- ws1->readY(SPECTRA_COUNT - 1)[0] + ws2->readY(SPECTRA_COUNT - 1)[0];
+ ws1->readY(g_SPECTRA_COUNT - 1)[0] + ws2->readY(g_SPECTRA_COUNT - 1)[0];
TS_ASSERT_EQUALS(sumY, 275);
// Check the sum of the error values for the last spectra in each file -
// should be 375.183
double sumE =
- ws1->readE(SPECTRA_COUNT - 1)[0] + ws2->readE(SPECTRA_COUNT - 1)[0];
+ ws1->readE(g_SPECTRA_COUNT - 1)[0] + ws2->readE(g_SPECTRA_COUNT - 1)[0];
TS_ASSERT_LESS_THAN(std::abs(sumE - 23.4489), 0.0001); // Include a small
// tolerance check with
// the assert - not
@@ -165,7 +165,7 @@ public:
testAlg->setPropertyValue("OutputWorkspace", outputSpace);
testAlg->setProperty("FilterNoiseLevel", 200.0);
- inputFile = smallFname1 + ", " + smallFname2;
+ inputFile = g_smallFname1 + ", " + g_smallFname2;
testAlg->setPropertyValue("Filename", inputFile);
TS_ASSERT_THROWS_NOTHING(testAlg->execute());
@@ -185,12 +185,12 @@ public:
TS_ASSERT_THROWS_NOTHING(
ws = boost::dynamic_pointer_cast<MatrixWorkspace>(out->getItem(i)));
- TS_ASSERT_EQUALS(ws->getNumberHistograms(), SPECTRA_COUNT);
+ TS_ASSERT_EQUALS(ws->getNumberHistograms(), g_SPECTRA_COUNT);
// check Y and Error
- TS_ASSERT_EQUALS(ws->readY(SPECTRA_COUNT - 100)[0], expectedY[i]);
+ TS_ASSERT_EQUALS(ws->readY(g_SPECTRA_COUNT - 100)[0], expectedY[i]);
TS_ASSERT_LESS_THAN(
- std::abs(ws->readE(SPECTRA_COUNT - 100)[0] - expectedE[i]), 0.0001);
+ std::abs(ws->readE(g_SPECTRA_COUNT - 100)[0] - expectedE[i]), 0.0001);
}
}
@@ -201,7 +201,7 @@ public:
TS_ASSERT_THROWS_NOTHING(testAlg->initialize());
TS_ASSERT(testAlg->isInitialized());
- inputFile = smallFname1 + ", " + smallFname2;
+ inputFile = g_smallFname1 + ", " + g_smallFname2;
testAlg->setPropertyValue("Filename", inputFile);
testAlg->setProperty("BinSize", 3);
// this should fail - width and height not multiple of 3
@@ -219,7 +219,7 @@ public:
TS_ASSERT_THROWS_NOTHING(testAlg->initialize());
TS_ASSERT(testAlg->isInitialized());
- inputFile = smallFname1 + ", " + smallFname2;
+ inputFile = g_smallFname1 + ", " + g_smallFname2;
testAlg->setPropertyValue("Filename", inputFile);
int binSize = 2;
testAlg->setProperty("BinSize", 2);
@@ -242,7 +242,7 @@ public:
ws = boost::dynamic_pointer_cast<MatrixWorkspace>(out->getItem(i)));
TS_ASSERT_EQUALS(ws->getNumberHistograms(),
- SPECTRA_COUNT_ASRECT / binSize);
+ g_SPECTRA_COUNT_ASRECT / binSize);
}
// try 8, 512x512 => 64x64 image
@@ -253,7 +253,7 @@ public:
TS_ASSERT_THROWS_NOTHING(testAlg->initialize());
TS_ASSERT(testAlg->isInitialized());
- inputFile = smallFname1 + ", " + smallFname2;
+ inputFile = g_smallFname1 + ", " + g_smallFname2;
testAlg->setPropertyValue("Filename", inputFile);
testAlg->setProperty("BinSize", binSize);
testAlg->setProperty("LoadAsRectImg", true);
@@ -274,7 +274,7 @@ public:
ws = boost::dynamic_pointer_cast<MatrixWorkspace>(out->getItem(i)));
TS_ASSERT_EQUALS(ws->getNumberHistograms(),
- SPECTRA_COUNT_ASRECT / binSize);
+ g_SPECTRA_COUNT_ASRECT / binSize);
}
}
@@ -289,7 +289,7 @@ public:
testAlg->setPropertyValue("OutputWorkspace", outputSpace);
testAlg->setProperty("LoadAsRectImg", true);
- inputFile = smallFname1 + ", " + smallFname2;
+ inputFile = g_smallFname1 + ", " + g_smallFname2;
testAlg->setPropertyValue("Filename", inputFile);
TS_ASSERT_THROWS_NOTHING(testAlg->execute());
@@ -306,8 +306,71 @@ public:
TS_ASSERT_THROWS_NOTHING(
ws = boost::dynamic_pointer_cast<MatrixWorkspace>(out->getItem(i)));
- TS_ASSERT_EQUALS(ws->getNumberHistograms(), SPECTRA_COUNT_ASRECT);
+ TSM_ASSERT_EQUALS("The number of histograms should be the expected, "
+ "dimension of the image",
+ ws->getNumberHistograms(), g_SPECTRA_COUNT_ASRECT);
}
+
+ TSM_ASSERT_EQUALS("The output workspace group should have two workspaces",
+ out->size(), 2);
+
+ // and finally a basic check of values in the image, to be safe
+ MatrixWorkspace_sptr ws0;
+ TS_ASSERT_THROWS_NOTHING(
+ ws0 = boost::dynamic_pointer_cast<MatrixWorkspace>(out->getItem(0)));
+
+ TSM_ASSERT_EQUALS("The title of the first output workspace is not the name "
+ "of the first file",
+ ws0->getTitle(), g_smallFname1);
+
+ size_t n = ws0->getNumberHistograms();
+ TSM_ASSERT_EQUALS(
+ "The value at a given spectrum and bin (first one) is not as expected",
+ ws0->readY(n - 1)[0], 137);
+
+ TSM_ASSERT_EQUALS(
+ "The value at a given spectrum and bin (middle one) is not as expected",
+ ws0->readY(n - 1)[g_SPECTRA_COUNT_ASRECT / 2], 159);
+
+ TSM_ASSERT_EQUALS(
+ "The value at a given spectrum and bin (last one) is not as expected",
+ ws0->readY(n - 1).back(), 142);
+
+ MatrixWorkspace_sptr ws1;
+ TS_ASSERT_THROWS_NOTHING(
+ ws1 = boost::dynamic_pointer_cast<MatrixWorkspace>(out->getItem(1)));
+
+ TSM_ASSERT_EQUALS("The title of the second output workspace is not the "
+ "name of the second file",
+ ws1->getTitle(), g_smallFname2);
+ TSM_ASSERT_EQUALS(
+ "The value at a given spectrum and bin (first one) is not as expected",
+ ws1->readY(n - 1)[0], 155);
+
+ TSM_ASSERT_EQUALS(
+ "The value at a given spectrum and bin (middle one) is not as expected",
+ ws1->readY(n - 1)[g_SPECTRA_COUNT_ASRECT / 2], 199);
+
+ TSM_ASSERT_EQUALS(
+ "The value at a given spectrum and bin (last one) is not as expected",
+ ws1->readY(n - 1).back(), 133);
+ }
+
+ void test_loadEmpty() {
+ testAlg =
+ Mantid::API::AlgorithmManager::Instance().create("LoadFITS" /*, 1*/);
+
+ TS_ASSERT_THROWS_NOTHING(testAlg->initialize());
+ TS_ASSERT(testAlg->isInitialized());
+
+ outputSpace = "I_should_not_load_correctly";
+ testAlg->setPropertyValue("OutputWorkspace", outputSpace);
+ testAlg->setProperty("LoadAsRectImg", true);
+
+ testAlg->setPropertyValue("Filename", g_emptyFileName);
+
+ TS_ASSERT_THROWS_NOTHING(testAlg->execute());
+ TS_ASSERT(!AnalysisDataService::Instance().doesExist(outputSpace));
}
private:
@@ -316,28 +379,38 @@ private:
std::string inputFile;
std::string outputSpace;
- static const std::string smallFname1;
- static const std::string smallFname2;
+ static const std::string g_smallFname1;
+ static const std::string g_smallFname2;
+
+ const static std::string g_emptyFileName;
+
+ const static size_t g_xdim;
+ const static size_t g_ydim;
+ const static size_t g_SPECTRA_COUNT;
+ const static size_t g_SPECTRA_COUNT_ASRECT;
- const static size_t xdim = 512;
- const static size_t ydim = 512;
- const static size_t SPECTRA_COUNT = xdim * ydim;
- const static size_t SPECTRA_COUNT_ASRECT = ydim;
// FITS headers
- const static std::string hdrSIMPLE;
- const static std::string hdrBITPIX;
- const static std::string hdrNAXIS;
- const static std::string hdrNAXIS1;
- const static std::string hdrNAXIS2;
+ const static std::string g_hdrSIMPLE;
+ const static std::string g_hdrBITPIX;
+ const static std::string g_hdrNAXIS;
+ const static std::string g_hdrNAXIS1;
+ const static std::string g_hdrNAXIS2;
};
-const std::string LoadFITSTest::smallFname1 = "FITS_small_01.fits";
-const std::string LoadFITSTest::smallFname2 = "FITS_small_02.fits";
+const std::string LoadFITSTest::g_smallFname1 = "FITS_small_01.fits";
+const std::string LoadFITSTest::g_smallFname2 = "FITS_small_02.fits";
+
+const std::string LoadFITSTest::g_emptyFileName = "FITS_empty_file.fits";
+
+const size_t LoadFITSTest::g_xdim = 512;
+const size_t LoadFITSTest::g_ydim = 512;
+const size_t LoadFITSTest::g_SPECTRA_COUNT = g_xdim * g_ydim;
+const size_t LoadFITSTest::g_SPECTRA_COUNT_ASRECT = g_ydim;
-const std::string LoadFITSTest::hdrSIMPLE = "T";
-const std::string LoadFITSTest::hdrBITPIX = "16";
-const std::string LoadFITSTest::hdrNAXIS = "2";
-const std::string LoadFITSTest::hdrNAXIS1 = "512";
-const std::string LoadFITSTest::hdrNAXIS2 = "512";
+const std::string LoadFITSTest::g_hdrSIMPLE = "T";
+const std::string LoadFITSTest::g_hdrBITPIX = "16";
+const std::string LoadFITSTest::g_hdrNAXIS = "2";
+const std::string LoadFITSTest::g_hdrNAXIS1 = "512";
+const std::string LoadFITSTest::g_hdrNAXIS2 = "512";
#endif // MANTID_DATAHANDLING_LOADFITSTEST_H_
diff --git a/Framework/DataObjects/CMakeLists.txt b/Framework/DataObjects/CMakeLists.txt
index 95c2c041db2e67c74ed906cf8c478547d02960b8..fcf089876e6fef8fe28d56f0e640d7462e0c39b9 100644
--- a/Framework/DataObjects/CMakeLists.txt
+++ b/Framework/DataObjects/CMakeLists.txt
@@ -19,6 +19,7 @@ set ( SRC_FILES
src/MDBoxFlatTree.cpp
src/MDBoxSaveable.cpp
src/MDEventFactory.cpp
+ src/MDFramesToSpecialCoordinateSystem.cpp
src/MDHistoWorkspace.cpp
src/MDHistoWorkspaceIterator.cpp
src/MDLeanEvent.cpp
@@ -90,6 +91,7 @@ set ( INC_FILES
inc/MantidDataObjects/MDEventInserter.h
inc/MantidDataObjects/MDEventWorkspace.h
inc/MantidDataObjects/MDEventWorkspace.tcc
+ inc/MantidDataObjects/MDFramesToSpecialCoordinateSystem.h
inc/MantidDataObjects/MDGridBox.h
inc/MantidDataObjects/MDGridBox.tcc
inc/MantidDataObjects/MDHistoWorkspace.h
@@ -149,6 +151,7 @@ set ( TEST_FILES
MDEventInserterTest.h
MDEventTest.h
MDEventWorkspaceTest.h
+ MDFramesToSpecialCoordinateSystemTest.h
MDGridBoxTest.h
MDHistoWorkspaceIteratorTest.h
MDHistoWorkspaceTest.h
diff --git a/Framework/DataObjects/inc/MantidDataObjects/MDEventWorkspace.tcc b/Framework/DataObjects/inc/MantidDataObjects/MDEventWorkspace.tcc
index bead61c930ea1c0d4afcdadde34ce9a17ef7e7de..6a0470c99964107a06a5d9f9246503099e180ec9 100644
--- a/Framework/DataObjects/inc/MantidDataObjects/MDEventWorkspace.tcc
+++ b/Framework/DataObjects/inc/MantidDataObjects/MDEventWorkspace.tcc
@@ -12,6 +12,7 @@
#include "MantidDataObjects/MDBoxBase.h"
#include "MantidDataObjects/MDBox.h"
#include "MantidDataObjects/MDEventWorkspace.h"
+#include "MantidDataObjects/MDFramesToSpecialCoordinateSystem.h"
#include "MantidDataObjects/MDGridBox.h"
#include "MantidDataObjects/MDLeanEvent.h"
#include <iomanip>
@@ -796,7 +797,14 @@ Get the coordinate system (if any) to use.
*/
TMDE(Kernel::SpecialCoordinateSystem
MDEventWorkspace)::getSpecialCoordinateSystem() const {
- return m_coordSystem;
+ MDFramesToSpecialCoordinateSystem converter;
+ auto coordinatesFromMDFrames = converter(this);
+ auto coordinates = m_coordSystem;
+
+ if (coordinatesFromMDFrames) {
+ coordinates = coordinatesFromMDFrames.get();
+ }
+ return coordinates;
}
/**
diff --git a/Framework/DataObjects/inc/MantidDataObjects/MDFramesToSpecialCoordinateSystem.h b/Framework/DataObjects/inc/MantidDataObjects/MDFramesToSpecialCoordinateSystem.h
new file mode 100644
index 0000000000000000000000000000000000000000..0b3aa9947471050a7f525c5bec39058203eededa
--- /dev/null
+++ b/Framework/DataObjects/inc/MantidDataObjects/MDFramesToSpecialCoordinateSystem.h
@@ -0,0 +1,55 @@
+#ifndef MANTID_DATAOBJECTS_MDFRAMESTOSPECIALCOORDINATESYTEM_H_
+#define MANTID_DATAOBJECTS_MDFRAMESTOSPECIALCOORDINATESYTEM_H_
+
+#include "MantidKernel/System.h"
+#include "MantidKernel/SpecialCoordinateSystem.h"
+#include "MantidAPI/IMDWorkspace.h"
+#include "MantidGeometry/MDGeometry/IMDDimension.h"
+#include "boost/optional.hpp"
+namespace Mantid {
+namespace DataObjects {
+
+/** MDFrameFromMDWorkspace: Each dimension of the MDWorkspace contains an
+ MDFrame. The acutal frame which is common to all dimensions is extracted.
+
+ Copyright © 2015 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
+ National Laboratory & European Spallation Source
+
+ This file is part of Mantid.
+
+ Mantid is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ Mantid is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ File change history is stored at: <https://github.com/mantidproject/mantid>
+ Code Documentation is available at: <http://doxygen.mantidproject.org>
+*/
+class DLLExport MDFramesToSpecialCoordinateSystem {
+public:
+ MDFramesToSpecialCoordinateSystem();
+ ~MDFramesToSpecialCoordinateSystem();
+ boost::optional<Mantid::Kernel::SpecialCoordinateSystem>
+ operator()(const Mantid::API::IMDWorkspace *workspace) const;
+
+private:
+ void checkQCompatibility(
+ Mantid::Kernel::SpecialCoordinateSystem specialCoordinateSystem,
+ boost::optional<Mantid::Kernel::SpecialCoordinateSystem> qFrameType)
+ const;
+ bool
+ isUnknownFrame(Mantid::Geometry::IMDDimension_const_sptr dimension) const;
+};
+
+} // namespace DataObjects
+} // namespace Mantid
+
+#endif /* MANTID_DATAOBJECTS_MDFRAMESTOSPECIALCOORDINATESYTEM_H_ */
diff --git a/Framework/DataObjects/inc/MantidDataObjects/ReflectometryTransform.h b/Framework/DataObjects/inc/MantidDataObjects/ReflectometryTransform.h
index 88785293ff8374ce5fd1fb00345a6385e97d542f..3406e1dd1faaa6d67bfbfc490f1d535a95f478b8 100644
--- a/Framework/DataObjects/inc/MantidDataObjects/ReflectometryTransform.h
+++ b/Framework/DataObjects/inc/MantidDataObjects/ReflectometryTransform.h
@@ -75,7 +75,8 @@ public:
// Execute the strategy to produce a transformed, output MDWorkspace
Mantid::API::IMDEventWorkspace_sptr
executeMD(Mantid::API::MatrixWorkspace_const_sptr inputWs,
- Mantid::API::BoxController_sptr boxController) const;
+ Mantid::API::BoxController_sptr boxController,
+ Mantid::Geometry::MDFrame_uptr frame) const;
// Execute the strategy to produce a transformed, output group of Matrix (2D)
// Workspaces
diff --git a/Framework/DataObjects/src/MDFramesToSpecialCoordinateSystem.cpp b/Framework/DataObjects/src/MDFramesToSpecialCoordinateSystem.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..7519d4c018083177d6510fbe678ca531fb5ebcd4
--- /dev/null
+++ b/Framework/DataObjects/src/MDFramesToSpecialCoordinateSystem.cpp
@@ -0,0 +1,102 @@
+#include "MantidDataObjects/MDFramesToSpecialCoordinateSystem.h"
+#include "MantidAPI/IMDEventWorkspace.h"
+#include "MantidAPI/IMDHistoWorkspace.h"
+#include "MantidKernel/WarningSuppressions.h"
+
+namespace Mantid {
+namespace DataObjects {
+
+MDFramesToSpecialCoordinateSystem::MDFramesToSpecialCoordinateSystem() {}
+
+MDFramesToSpecialCoordinateSystem::~MDFramesToSpecialCoordinateSystem() {}
+
+/**
+ * Get the Special Coordinate System based on the MDFrame information.
+ * @param workspace: the workspace which is being queried
+ * @returns either a special coordinate or an empty optional
+ */
+boost::optional<Mantid::Kernel::SpecialCoordinateSystem>
+ MDFramesToSpecialCoordinateSystem::
+ operator()(const Mantid::API::IMDWorkspace *workspace) const {
+ // Make sure that the workspaces are either an MDHisto or MDEvent workspaces
+ if (!dynamic_cast<const Mantid::API::IMDEventWorkspace *>(workspace) &&
+ !dynamic_cast<const Mantid::API::IMDHistoWorkspace *>(workspace)) {
+ throw std::invalid_argument("Error in MDFrameFromWorkspace: Can only "
+ "extract MDFrame from MDEvent and MDHisto "
+ "workspaces");
+ }
+
+ // Requirements for the special coordinate are: If there are more than one
+ // Q-compatible (QSample, QLab, HKL) dimension, then they have to be identical
+ // This dimension will define the special coordinate system. Otherwise, we
+ // don't have a special coordinate system
+
+ boost::optional<Mantid::Kernel::SpecialCoordinateSystem> qFrameType =
+ Mantid::Kernel::SpecialCoordinateSystem::None; // Set to none just to have
+ // it initialized
+ auto hasQFrame = false;
+ auto isUnknown = false;
+ for (size_t dimIndex = 0; dimIndex < workspace->getNumDims(); ++dimIndex) {
+ auto dimension = workspace->getDimension(dimIndex);
+ auto &frame = dimension->getMDFrame();
+ // Check for QCompatibility. This has gotten a bit more complicated than
+ // necessary since the boost optional
+ // caused a GCC error, when it was not initialized. Using -Wuninitialized
+ // didn't make the compiler happy.
+ if (frame.getMDUnit().isQUnit()) {
+ auto specialCoordinteSystem = frame.equivalientSpecialCoordinateSystem();
+ if (hasQFrame) {
+ checkQCompatibility(specialCoordinteSystem, qFrameType);
+ }
+ qFrameType = specialCoordinteSystem;
+ hasQFrame = true;
+ }
+
+ isUnknown = isUnknownFrame(dimension);
+ }
+
+ boost::optional<Mantid::Kernel::SpecialCoordinateSystem> output;
+ if (hasQFrame) {
+ output = qFrameType;
+ } else {
+ // If the frame is unknown then keep the optional empty
+ if (!isUnknown) {
+ output = Mantid::Kernel::SpecialCoordinateSystem::None;
+ }
+ }
+
+ return output;
+}
+
+/**
+ * Make sure that the QFrame types are the same.
+ * @param specialCoordinateSystem: the q frame type to test.
+ * @param qFrameType: the current q frame type
+ */
+void MDFramesToSpecialCoordinateSystem::checkQCompatibility(
+ Mantid::Kernel::SpecialCoordinateSystem specialCoordinateSystem,
+ boost::optional<Mantid::Kernel::SpecialCoordinateSystem> qFrameType) const {
+ if (qFrameType) {
+ if (specialCoordinateSystem != qFrameType.get()) {
+ throw std::invalid_argument("Error in MDFrameFromWorkspace: Coordinate "
+ "system in the different dimensions don't "
+ "match.");
+ }
+ }
+}
+
+/* Checks if an MDFrame is an UnknownFrame
+* @param dimension: a dimension
+* @returns true if the MDFrame is of UnknownFrame type.
+*/
+bool MDFramesToSpecialCoordinateSystem::isUnknownFrame(
+ Mantid::Geometry::IMDDimension_const_sptr dimension) const {
+ Mantid::Geometry::MDFrame_uptr replica(dimension->getMDFrame().clone());
+ auto isUnknown = false;
+ if (dynamic_cast<Mantid::Geometry::UnknownFrame *>(replica.get())) {
+ isUnknown = true;
+ }
+ return isUnknown;
+}
+}
+}
\ No newline at end of file
diff --git a/Framework/DataObjects/src/MDHistoWorkspace.cpp b/Framework/DataObjects/src/MDHistoWorkspace.cpp
index f7863a323796a3121c62a7fd1add7a342085356d..7b3a67b2c95ce649bc30a40b0555405daf0bdb59 100644
--- a/Framework/DataObjects/src/MDHistoWorkspace.cpp
+++ b/Framework/DataObjects/src/MDHistoWorkspace.cpp
@@ -3,8 +3,10 @@
#include "MantidKernel/System.h"
#include "MantidKernel/Utils.h"
#include "MantidKernel/VMD.h"
+#include "MantidKernel/WarningSuppressions.h"
#include "MantidDataObjects/MDHistoWorkspace.h"
#include "MantidDataObjects/MDHistoWorkspaceIterator.h"
+#include "MantidDataObjects/MDFramesToSpecialCoordinateSystem.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
#include "MantidGeometry/MDGeometry/MDDimensionExtents.h"
#include <map>
@@ -13,6 +15,7 @@
#include <boost/scoped_array.hpp>
#include <boost/make_shared.hpp>
#include <boost/math/special_functions/fpclassify.hpp>
+#include <boost/optional.hpp>
using namespace Mantid::Kernel;
using namespace Mantid::Geometry;
@@ -1212,11 +1215,20 @@ uint64_t MDHistoWorkspace::sumNContribEvents() const {
}
/**
-Get the special coordinate system (if any) to use.
+ * Get the Q frame system (if any) to use.
*/
+// clang-format off
+GCC_DIAG_OFF(strict-aliasing)
+// clang-format on
Kernel::SpecialCoordinateSystem
MDHistoWorkspace::getSpecialCoordinateSystem() const {
- return m_coordSystem;
+ MDFramesToSpecialCoordinateSystem converter;
+ auto coordinatesFromMDFrames = converter(this);
+ auto coordinates = m_coordSystem;
+ if (coordinatesFromMDFrames) {
+ coordinates = coordinatesFromMDFrames.get();
+ }
+ return coordinates;
}
/**
diff --git a/Framework/DataObjects/src/ReflectometryTransform.cpp b/Framework/DataObjects/src/ReflectometryTransform.cpp
index dbd709079bb54cd5f8f2712449254d47c76636bf..55b51737a92a9b56ea0cd346c26578a14feba4ba 100644
--- a/Framework/DataObjects/src/ReflectometryTransform.cpp
+++ b/Framework/DataObjects/src/ReflectometryTransform.cpp
@@ -204,16 +204,18 @@ void createVerticalAxis(MatrixWorkspace *const ws, const MantidVec &xAxisVec,
* Performs centre-point rebinning and produces an MDWorkspace
* @param inputWs : The workspace you wish to perform centre-point rebinning on.
* @param boxController : controls how the MDWorkspace will be split
+ * @param frame: the md frame for the two MDHistoDimensions
* @returns An MDWorkspace based on centre-point rebinning of the inputWS
*/
Mantid::API::IMDEventWorkspace_sptr ReflectometryTransform::executeMD(
Mantid::API::MatrixWorkspace_const_sptr inputWs,
- BoxController_sptr boxController) const {
+ BoxController_sptr boxController,
+ Mantid::Geometry::MDFrame_uptr frame) const {
MDHistoDimension_sptr dim0 = MDHistoDimension_sptr(new MDHistoDimension(
- m_d0Label, m_d0ID, "(Ang^-1)", static_cast<Mantid::coord_t>(m_d0Min),
+ m_d0Label, m_d0ID, *frame, static_cast<Mantid::coord_t>(m_d0Min),
static_cast<Mantid::coord_t>(m_d0Max), m_d0NumBins));
MDHistoDimension_sptr dim1 = MDHistoDimension_sptr(new MDHistoDimension(
- m_d1Label, m_d1ID, "(Ang^-1)", static_cast<Mantid::coord_t>(m_d1Min),
+ m_d1Label, m_d1ID, *frame, static_cast<Mantid::coord_t>(m_d1Min),
static_cast<Mantid::coord_t>(m_d1Max), m_d1NumBins));
auto ws = createMDWorkspace(dim0, dim1, boxController);
@@ -312,7 +314,7 @@ IMDHistoWorkspace_sptr ReflectometryTransform::executeMDNormPoly(
MDHistoDimension_sptr dim0 = MDHistoDimension_sptr(new MDHistoDimension(
input_x_dim->getName(), input_x_dim->getDimensionId(),
- input_x_dim->getUnits(),
+ input_x_dim->getMDFrame(),
static_cast<Mantid::coord_t>(input_x_dim->getMinimum()),
static_cast<Mantid::coord_t>(input_x_dim->getMaximum()),
input_x_dim->getNBins()));
@@ -321,7 +323,7 @@ IMDHistoWorkspace_sptr ReflectometryTransform::executeMDNormPoly(
MDHistoDimension_sptr dim1 = MDHistoDimension_sptr(new MDHistoDimension(
input_y_dim->getName(), input_y_dim->getDimensionId(),
- input_y_dim->getUnits(),
+ input_y_dim->getMDFrame(),
static_cast<Mantid::coord_t>(input_y_dim->getMinimum()),
static_cast<Mantid::coord_t>(input_y_dim->getMaximum()),
input_y_dim->getNBins()));
diff --git a/Framework/DataObjects/test/MDEventInserterTest.h b/Framework/DataObjects/test/MDEventInserterTest.h
index 3285149b0e1373af9fbbfc85da073fee30056fbc..2fc05b5ecaa53cd4ec5e974c2d1262c2e2adecc3 100644
--- a/Framework/DataObjects/test/MDEventInserterTest.h
+++ b/Framework/DataObjects/test/MDEventInserterTest.h
@@ -28,13 +28,14 @@ private:
/// specified event type.
IMDEventWorkspace_sptr createInputWorkspace(const std::string &eventType) {
using Mantid::Geometry::MDHistoDimension;
-
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "m");
IMDEventWorkspace_sptr ws = MDEventFactory::CreateMDWorkspace(2, eventType);
coord_t min(-10.0f), max(10.0f);
ws->addDimension(
- boost::make_shared<MDHistoDimension>("A", "A", "m", min, max, 1));
+ boost::make_shared<MDHistoDimension>("A", "A", frame, min, max, 1));
ws->addDimension(
- boost::make_shared<MDHistoDimension>("B", "B", "m", min, max, 1));
+ boost::make_shared<MDHistoDimension>("B", "B", frame, min, max, 1));
ws->initialize();
// Split to level 1
ws->splitBox();
diff --git a/Framework/DataObjects/test/MDEventWorkspaceTest.h b/Framework/DataObjects/test/MDEventWorkspaceTest.h
index 8604897e557861ccd74422304f19fc015a56a86a..bf8d4863f790e03801d5d4d94b3d6c9f83cf5177 100644
--- a/Framework/DataObjects/test/MDEventWorkspaceTest.h
+++ b/Framework/DataObjects/test/MDEventWorkspaceTest.h
@@ -6,6 +6,7 @@
#include "MantidGeometry/MDGeometry/MDDimensionExtents.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
#include "MantidGeometry/MDGeometry/MDBoxImplicitFunction.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
#include "MantidKernel/ProgressText.h"
#include "MantidKernel/Timer.h"
#include "MantidAPI/BoxController.h"
@@ -91,10 +92,10 @@ public:
void test_copy_constructor() {
MDEventWorkspace<MDLeanEvent<3>, 3> ew3;
-
+ Mantid::Geometry::GeneralFrame frame("m", "m");
for (size_t i = 0; i < 3; i++) {
- ew3.addDimension(
- MDHistoDimension_sptr(new MDHistoDimension("x", "x", "m", -1, 1, 0)));
+ ew3.addDimension(MDHistoDimension_sptr(
+ new MDHistoDimension("x", "x", frame, -1, 1, 0)));
}
ew3.initialize();
ew3.getBoxController()->setSplitThreshold(1);
@@ -153,20 +154,22 @@ public:
void test_initialize_throws() {
IMDEventWorkspace *ew = new MDEventWorkspace<MDLeanEvent<3>, 3>();
+ Mantid::Geometry::GeneralFrame frame("m", "m");
TS_ASSERT_THROWS(ew->initialize(), std::runtime_error);
for (size_t i = 0; i < 5; i++)
- ew->addDimension(
- MDHistoDimension_sptr(new MDHistoDimension("x", "x", "m", -1, 1, 0)));
+ ew->addDimension(MDHistoDimension_sptr(
+ new MDHistoDimension("x", "x", frame, -1, 1, 0)));
TS_ASSERT_THROWS(ew->initialize(), std::runtime_error);
delete ew;
}
void test_initialize() {
IMDEventWorkspace *ew = new MDEventWorkspace<MDLeanEvent<3>, 3>();
+ Mantid::Geometry::GeneralFrame frame("m", "m");
TS_ASSERT_THROWS(ew->initialize(), std::runtime_error);
for (size_t i = 0; i < 3; i++)
- ew->addDimension(
- MDHistoDimension_sptr(new MDHistoDimension("x", "x", "m", -1, 1, 0)));
+ ew->addDimension(MDHistoDimension_sptr(
+ new MDHistoDimension("x", "x", frame, -1, 1, 0)));
TS_ASSERT_THROWS_NOTHING(ew->initialize());
delete ew;
}
@@ -493,13 +496,17 @@ public:
Mantid::Kernel::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::Kernel::None, ws->getSpecialCoordinateSystem());
-
- ws->setCoordinateSystem(Mantid::Kernel::QLab);
- TS_ASSERT_EQUALS(Mantid::Kernel::QLab, ws->getSpecialCoordinateSystem());
+ void test_getSpecialCoordinateSystem_when_MDFrames_are_set() {
+ // Arrange
+ const Mantid::Geometry::QSample frame;
+ auto ws = MDEventsTestHelper::makeAnyMDEWWithFrames<MDLeanEvent<2>, 2>(
+ 10, 0.0, 10.0, frame, 1);
+ // Act
+ auto specialCoordinateSystem = ws->getSpecialCoordinateSystem();
+ // Assert
+ TSM_ASSERT_EQUALS("Should detect QSample as the SpecialCoordinate",
+ specialCoordinateSystem,
+ Mantid::Kernel::SpecialCoordinateSystem::QSample);
}
void test_getLinePlot() {
diff --git a/Framework/DataObjects/test/MDFramesToSpecialCoordinateSystemTest.h b/Framework/DataObjects/test/MDFramesToSpecialCoordinateSystemTest.h
new file mode 100644
index 0000000000000000000000000000000000000000..79a47217c8cb3f6ad03c163738d6e4cf25f7b6fa
--- /dev/null
+++ b/Framework/DataObjects/test/MDFramesToSpecialCoordinateSystemTest.h
@@ -0,0 +1,193 @@
+#ifndef MANTID_DATAOBJECTS_MDFRAMESTOSPECIALCOORDINATESYTEMTEST_H_
+#define MANTID_DATAOBJECTS_MDFRAMESTOSPECIALCOORDINATESYTEMTEST_H_
+
+#include <cxxtest/TestSuite.h>
+
+#include "MantidDataObjects/MDFramesToSpecialCoordinateSystem.h"
+#include "MantidTestHelpers/FakeObjects.h"
+#include "MantidGeometry/MDGeometry/QLab.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
+#include "MantidGeometry/MDGeometry/GeneralFrame.h"
+#include "MantidGeometry/MDGeometry/UnknownFrame.h"
+#include "MantidKernel/MDUnit.h"
+#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
+#include "MantidDataObjects/MDHistoWorkspace.h"
+
+#include "boost/make_shared.hpp"
+
+using namespace Mantid::Geometry;
+
+class MDFramesToSpecialCoordinateSystemTest : public CxxTest::TestSuite {
+public:
+ void test_that_throws_for_non_md_workspace() {
+ // Arrange
+ const boost::shared_ptr<MatrixWorkspace> ws(new WorkspaceTester());
+ Mantid::DataObjects::MDFramesToSpecialCoordinateSystem converter;
+ // Act + Assert
+ TSM_ASSERT_THROWS(
+ "Should throw as only MDEvent and MDHisto workspaces are allowed",
+ converter(ws.get()), std::invalid_argument);
+ }
+
+ void test_that_throws_for_non_uniform_Q_coodinate_system() {
+ // Arrange
+ Mantid::Geometry::QLab frame1;
+ Mantid::Geometry::QSample frame2;
+ Mantid::coord_t min = 0;
+ Mantid::coord_t max = 10;
+ size_t bins = 2;
+ auto dimension1 = boost::make_shared<MDHistoDimension>(
+ "QLabX", "QLabX", frame1, min, max, bins);
+ auto dimension2 = boost::make_shared<MDHistoDimension>(
+ "QSampleY", "QSampleY", frame2, min, max, bins);
+ auto ws = boost::make_shared<Mantid::DataObjects::MDHistoWorkspace>(
+ dimension1, dimension2);
+ Mantid::DataObjects::MDFramesToSpecialCoordinateSystem converter;
+
+ // Act + Assert
+ TSM_ASSERT_THROWS(
+ "Should throw as coordinate system is mixed with several Q types.",
+ converter(ws.get()), std::invalid_argument);
+ }
+
+ void test_that_doesn_not_throw_for_non_uniform_Q_coodinate_system() {
+ // Arrange
+ Mantid::Geometry::QLab frame1;
+ Mantid::Geometry::GeneralFrame frame2("test", "Test");
+ Mantid::coord_t min = 0;
+ Mantid::coord_t max = 10;
+ size_t bins = 2;
+ auto dimension1 = boost::make_shared<MDHistoDimension>(
+ "QLabX", "QLabX", frame1, min, max, bins);
+ auto dimension2 = boost::make_shared<MDHistoDimension>(
+ "General Frame", "General Frame", frame2, min, max, bins);
+ auto ws = boost::make_shared<Mantid::DataObjects::MDHistoWorkspace>(
+ dimension1, dimension2);
+ Mantid::DataObjects::MDFramesToSpecialCoordinateSystem converter;
+
+ // Act + Assert
+ boost::optional<Mantid::Kernel::SpecialCoordinateSystem> coordinateSystem;
+ TSM_ASSERT_THROWS_NOTHING("Should throw nothing as coordinate system is "
+ "mixed only with one Q type.",
+ coordinateSystem = converter(ws.get()));
+
+ TSM_ASSERT_EQUALS("Should be Qlab", *coordinateSystem,
+ Mantid::Kernel::SpecialCoordinateSystem::QLab);
+ }
+
+ void
+ test_that_returns_correct_equivalent_special_coordinate_system_for_QLab() {
+ // Arrange
+ Mantid::Geometry::QLab frame1;
+ Mantid::Geometry::QLab frame2;
+ Mantid::coord_t min = 0;
+ Mantid::coord_t max = 10;
+ size_t bins = 2;
+ auto dimension1 = boost::make_shared<MDHistoDimension>(
+ "QLabX", "QLabX", frame1, min, max, bins);
+ auto dimension2 = boost::make_shared<MDHistoDimension>(
+ "QLabY", "QLabY", frame2, min, max, bins);
+ auto ws = boost::make_shared<Mantid::DataObjects::MDHistoWorkspace>(
+ dimension1, dimension2);
+ Mantid::DataObjects::MDFramesToSpecialCoordinateSystem converter;
+
+ // Act + Assert
+ boost::optional<Mantid::Kernel::SpecialCoordinateSystem> coordinateSystem;
+ TS_ASSERT_THROWS_NOTHING(coordinateSystem = converter(ws.get()));
+ TSM_ASSERT_EQUALS("Should be Qlab", *coordinateSystem,
+ Mantid::Kernel::SpecialCoordinateSystem::QLab);
+ }
+
+ void
+ test_that_returns_correct_equivalent_special_coordinate_system_for_QSample() {
+ // Arrange
+ Mantid::Geometry::QSample frame1;
+ Mantid::Geometry::QSample frame2;
+ Mantid::coord_t min = 0;
+ Mantid::coord_t max = 10;
+ size_t bins = 2;
+ auto dimension1 = boost::make_shared<MDHistoDimension>(
+ "QSampleX", "QSampleX", frame1, min, max, bins);
+ auto dimension2 = boost::make_shared<MDHistoDimension>(
+ "QSampleY", "QSampleY", frame2, min, max, bins);
+ auto ws = boost::make_shared<Mantid::DataObjects::MDHistoWorkspace>(
+ dimension1, dimension2);
+ Mantid::DataObjects::MDFramesToSpecialCoordinateSystem converter;
+
+ // Act + Assert
+ boost::optional<Mantid::Kernel::SpecialCoordinateSystem> coordinateSystem;
+ TS_ASSERT_THROWS_NOTHING(coordinateSystem = converter(ws.get()));
+ TSM_ASSERT_EQUALS("Should be QSample", *coordinateSystem,
+ Mantid::Kernel::SpecialCoordinateSystem::QSample);
+ }
+
+ void
+ test_that_returns_correct_equivalent_special_coordinate_system_for_HKL() {
+ // Arrange
+ Mantid::Geometry::HKL frame1(new Mantid::Kernel::ReciprocalLatticeUnit);
+ Mantid::Geometry::HKL frame2(new Mantid::Kernel::ReciprocalLatticeUnit);
+ Mantid::coord_t min = 0;
+ Mantid::coord_t max = 10;
+ size_t bins = 2;
+ auto dimension1 =
+ boost::make_shared<MDHistoDimension>("H", "H", frame1, min, max, bins);
+ auto dimension2 =
+ boost::make_shared<MDHistoDimension>("K", "K", frame2, min, max, bins);
+ auto ws = boost::make_shared<Mantid::DataObjects::MDHistoWorkspace>(
+ dimension1, dimension2);
+ Mantid::DataObjects::MDFramesToSpecialCoordinateSystem converter;
+
+ // Act + Assert
+ boost::optional<Mantid::Kernel::SpecialCoordinateSystem> coordinateSystem;
+ TS_ASSERT_THROWS_NOTHING(coordinateSystem = converter(ws.get()));
+ TSM_ASSERT_EQUALS("Should be HKL", *coordinateSystem,
+ Mantid::Kernel::SpecialCoordinateSystem::HKL);
+ }
+
+ void
+ test_that_returns_correct_equivalent_special_coordinate_system_for_GeneralFrame() {
+ // Arrange
+ Mantid::Geometry::GeneralFrame frame1("a", "b");
+ Mantid::Geometry::GeneralFrame frame2("a", "b");
+ Mantid::coord_t min = 0;
+ Mantid::coord_t max = 10;
+ size_t bins = 2;
+ auto dimension1 =
+ boost::make_shared<MDHistoDimension>("H", "H", frame1, min, max, bins);
+ auto dimension2 =
+ boost::make_shared<MDHistoDimension>("K", "K", frame2, min, max, bins);
+ auto ws = boost::make_shared<Mantid::DataObjects::MDHistoWorkspace>(
+ dimension1, dimension2);
+ Mantid::DataObjects::MDFramesToSpecialCoordinateSystem converter;
+
+ // Act + Assert
+ boost::optional<Mantid::Kernel::SpecialCoordinateSystem> coordinateSystem;
+ TS_ASSERT_THROWS_NOTHING(coordinateSystem = converter(ws.get()));
+ TSM_ASSERT_EQUALS("Should be None", *coordinateSystem,
+ Mantid::Kernel::SpecialCoordinateSystem::None);
+ }
+
+ void test_that_returns_empty_optional_when_UnknownFrame_detected() {
+ // Arrange
+ Mantid::Geometry::UnknownFrame frame1("b");
+ Mantid::Geometry::UnknownFrame frame2("b");
+ Mantid::coord_t min = 0;
+ Mantid::coord_t max = 10;
+ size_t bins = 2;
+ auto dimension1 =
+ boost::make_shared<MDHistoDimension>("H", "H", frame1, min, max, bins);
+ auto dimension2 =
+ boost::make_shared<MDHistoDimension>("K", "K", frame2, min, max, bins);
+ auto ws = boost::make_shared<Mantid::DataObjects::MDHistoWorkspace>(
+ dimension1, dimension2);
+ Mantid::DataObjects::MDFramesToSpecialCoordinateSystem converter;
+
+ // Act + Assert
+ boost::optional<Mantid::Kernel::SpecialCoordinateSystem> coordinateSystem;
+ TS_ASSERT_THROWS_NOTHING(coordinateSystem = converter(ws.get()));
+ TSM_ASSERT("Should not be initialized", !coordinateSystem);
+ }
+};
+
+#endif
\ No newline at end of file
diff --git a/Framework/DataObjects/test/MDHistoWorkspaceIteratorTest.h b/Framework/DataObjects/test/MDHistoWorkspaceIteratorTest.h
index 5791b8fc0b7c6d5e21506a1128d2933c5244b261..3879e17d05a5b950b5cbc73c58f1a0e79b1c0812 100644
--- a/Framework/DataObjects/test/MDHistoWorkspaceIteratorTest.h
+++ b/Framework/DataObjects/test/MDHistoWorkspaceIteratorTest.h
@@ -244,9 +244,11 @@ public:
}
void test_skip_masked_detectors() {
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "m");
WritableHistoWorkspace *ws =
new WritableHistoWorkspace(MDHistoDimension_sptr(
- new MDHistoDimension("x", "x", "m", 0.0, 10, 100)));
+ new MDHistoDimension("x", "x", frame, 0.0, 10, 100)));
ws->setMaskValueAt(0, true); // Mask the first bin
ws->setMaskValueAt(1, true); // Mask the second bin
diff --git a/Framework/DataObjects/test/MDHistoWorkspaceTest.h b/Framework/DataObjects/test/MDHistoWorkspaceTest.h
index d289a06ffa2282df2b0ad7dd226cb9f36885f281..5d3b2fffe5ecd138d8a9722a2c974c3d6af279f3 100644
--- a/Framework/DataObjects/test/MDHistoWorkspaceTest.h
+++ b/Framework/DataObjects/test/MDHistoWorkspaceTest.h
@@ -6,6 +6,7 @@
#include "MantidDataObjects/WorkspaceSingleValue.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
#include "MantidGeometry/MDGeometry/MDBoxImplicitFunction.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
#include "MantidKernel/System.h"
#include "MantidKernel/Timer.h"
#include "MantidKernel/VMD.h"
@@ -76,10 +77,15 @@ public:
//--------------------------------------------------------------------------------------
void test_constructor() {
- MDHistoDimension_sptr dimX(new MDHistoDimension("X", "x", "m", -10, 10, 5));
- MDHistoDimension_sptr dimY(new MDHistoDimension("Y", "y", "m", -10, 10, 5));
- MDHistoDimension_sptr dimZ(new MDHistoDimension("Z", "z", "m", -10, 10, 5));
- MDHistoDimension_sptr dimT(new MDHistoDimension("T", "t", "m", -10, 10, 5));
+ Mantid::Geometry::GeneralFrame frame("m", "m");
+ MDHistoDimension_sptr dimX(
+ new MDHistoDimension("X", "x", frame, -10, 10, 5));
+ MDHistoDimension_sptr dimY(
+ new MDHistoDimension("Y", "y", frame, -10, 10, 5));
+ MDHistoDimension_sptr dimZ(
+ new MDHistoDimension("Z", "z", frame, -10, 10, 5));
+ MDHistoDimension_sptr dimT(
+ new MDHistoDimension("T", "t", frame, -10, 10, 5));
MDHistoWorkspace ws(dimX, dimY, dimZ, dimT);
@@ -152,8 +158,11 @@ public:
//---------------------------------------------------------------------------------------------------
/** Create a dense histogram with only 2 dimensions */
void test_constructor_fewerDimensions() {
- MDHistoDimension_sptr dimX(new MDHistoDimension("X", "x", "m", -10, 10, 5));
- MDHistoDimension_sptr dimY(new MDHistoDimension("Y", "y", "m", -10, 10, 5));
+ Mantid::Geometry::GeneralFrame frame("m", "m");
+ MDHistoDimension_sptr dimX(
+ new MDHistoDimension("X", "x", frame, -10, 10, 5));
+ MDHistoDimension_sptr dimY(
+ new MDHistoDimension("Y", "y", frame, -10, 10, 5));
MDHistoWorkspace ws(dimX, dimY);
@@ -181,9 +190,10 @@ public:
/** Create a dense histogram with 7 dimensions */
void test_constructor_MoreThanFourDimensions() {
std::vector<MDHistoDimension_sptr> dimensions;
+ Mantid::Geometry::GeneralFrame frame("m", "m");
for (size_t i = 0; i < 7; i++) {
dimensions.push_back(MDHistoDimension_sptr(
- new MDHistoDimension("Dim", "Dim", "m", -10, 10, 3)));
+ new MDHistoDimension("Dim", "Dim", frame, -10, 10, 3)));
}
MDHistoWorkspace ws(dimensions);
@@ -236,7 +246,9 @@ public:
//---------------------------------------------------------------------------------------------------
void test_getVertexesArray_1D() {
- MDHistoDimension_sptr dimX(new MDHistoDimension("X", "x", "m", -10, 10, 5));
+ Mantid::Geometry::GeneralFrame frame("m", "m");
+ MDHistoDimension_sptr dimX(
+ new MDHistoDimension("X", "x", frame, -10, 10, 5));
MDHistoWorkspace ws(dimX);
size_t numVertices;
coord_t *v1 = ws.getVertexesArray(0, numVertices);
@@ -253,8 +265,11 @@ public:
//---------------------------------------------------------------------------------------------------
void test_getVertexesArray_2D() {
- MDHistoDimension_sptr dimX(new MDHistoDimension("X", "x", "m", -10, 10, 5));
- MDHistoDimension_sptr dimY(new MDHistoDimension("Y", "y", "m", -10, 10, 5));
+ Mantid::Geometry::GeneralFrame frame("m", "m");
+ MDHistoDimension_sptr dimX(
+ new MDHistoDimension("X", "x", frame, -10, 10, 5));
+ MDHistoDimension_sptr dimY(
+ new MDHistoDimension("Y", "y", frame, -10, 10, 5));
MDHistoWorkspace ws(dimX, dimY);
size_t numVertices, i;
@@ -278,9 +293,13 @@ public:
//---------------------------------------------------------------------------------------------------
void test_getVertexesArray_3D() {
- MDHistoDimension_sptr dimX(new MDHistoDimension("X", "x", "m", -10, 10, 5));
- MDHistoDimension_sptr dimY(new MDHistoDimension("Y", "y", "m", -9, 10, 5));
- MDHistoDimension_sptr dimZ(new MDHistoDimension("Z", "z", "m", -8, 10, 5));
+ Mantid::Geometry::GeneralFrame frame("m", "m");
+ MDHistoDimension_sptr dimX(
+ new MDHistoDimension("X", "x", frame, -10, 10, 5));
+ MDHistoDimension_sptr dimY(
+ new MDHistoDimension("Y", "y", frame, -9, 10, 5));
+ MDHistoDimension_sptr dimZ(
+ new MDHistoDimension("Z", "z", frame, -8, 10, 5));
MDHistoWorkspace ws(dimX, dimY, dimZ);
size_t numVertices, i;
@@ -294,10 +313,13 @@ public:
//---------------------------------------------------------------------------------------------------
void test_getCenter_3D() {
+ Mantid::Geometry::GeneralFrame frame("m", "m");
MDHistoDimension_sptr dimX(
- new MDHistoDimension("X", "x", "m", -10, 10, 20));
- MDHistoDimension_sptr dimY(new MDHistoDimension("Y", "y", "m", -9, 10, 19));
- MDHistoDimension_sptr dimZ(new MDHistoDimension("Z", "z", "m", -8, 10, 18));
+ new MDHistoDimension("X", "x", frame, -10, 10, 20));
+ MDHistoDimension_sptr dimY(
+ new MDHistoDimension("Y", "y", frame, -9, 10, 19));
+ MDHistoDimension_sptr dimZ(
+ new MDHistoDimension("Z", "z", frame, -8, 10, 18));
MDHistoWorkspace ws(dimX, dimY, dimZ);
VMD v = ws.getCenter(0);
TS_ASSERT_DELTA(v[0], -9.5, 1e-5);
@@ -308,13 +330,15 @@ public:
//---------------------------------------------------------------------------------------------------
/** Test for a possible seg-fault if nx != ny etc. */
void test_uneven_numbers_of_bins() {
- MDHistoDimension_sptr dimX(new MDHistoDimension("X", "x", "m", -10, 10, 5));
+ Mantid::Geometry::GeneralFrame frame("m", "m");
+ MDHistoDimension_sptr dimX(
+ new MDHistoDimension("X", "x", frame, -10, 10, 5));
MDHistoDimension_sptr dimY(
- new MDHistoDimension("Y", "y", "m", -10, 10, 10));
+ new MDHistoDimension("Y", "y", frame, -10, 10, 10));
MDHistoDimension_sptr dimZ(
- new MDHistoDimension("Z", "z", "m", -10, 10, 20));
+ new MDHistoDimension("Z", "z", frame, -10, 10, 20));
MDHistoDimension_sptr dimT(
- new MDHistoDimension("T", "t", "m", -10, 10, 10));
+ new MDHistoDimension("T", "t", frame, -10, 10, 10));
MDHistoWorkspace ws(dimX, dimY, dimZ, dimT);
@@ -345,10 +369,13 @@ public:
//---------------------------------------------------------------------------------------------------
void test_createIterator() {
+ Mantid::Geometry::GeneralFrame frame("m", "m");
MDHistoDimension_sptr dimX(
- new MDHistoDimension("X", "x", "m", -10, 10, 10));
- MDHistoDimension_sptr dimY(new MDHistoDimension("Y", "y", "m", -9, 10, 10));
- MDHistoDimension_sptr dimZ(new MDHistoDimension("Z", "z", "m", -8, 10, 10));
+ new MDHistoDimension("X", "x", frame, -10, 10, 10));
+ MDHistoDimension_sptr dimY(
+ new MDHistoDimension("Y", "y", frame, -9, 10, 10));
+ MDHistoDimension_sptr dimZ(
+ new MDHistoDimension("Z", "z", frame, -8, 10, 10));
MDHistoWorkspace ws(dimX, dimY, dimZ);
IMDIterator *it = ws.createIterator();
TS_ASSERT(it);
@@ -366,14 +393,15 @@ public:
//---------------------------------------------------------------------------------------------------
// Test for the IMDWorkspace aspects of MDWorkspace.
void testGetNonIntegratedDimensions() {
+ Mantid::Geometry::GeneralFrame frame("m", "m");
MDHistoDimension_sptr dimX(
- new MDHistoDimension("X", "x", "m", -10, 10, 1)); // Integrated.
+ new MDHistoDimension("X", "x", frame, -10, 10, 1)); // Integrated.
MDHistoDimension_sptr dimY(
- new MDHistoDimension("Y", "y", "m", -10, 10, 10));
+ new MDHistoDimension("Y", "y", frame, -10, 10, 10));
MDHistoDimension_sptr dimZ(
- new MDHistoDimension("Z", "z", "m", -10, 10, 20));
+ new MDHistoDimension("Z", "z", frame, -10, 10, 20));
MDHistoDimension_sptr dimT(
- new MDHistoDimension("T", "t", "m", -10, 10, 10));
+ new MDHistoDimension("T", "t", frame, -10, 10, 10));
MDHistoWorkspace ws(dimX, dimY, dimZ, dimT);
Mantid::Geometry::VecIMDDimension_const_sptr vecNonIntegratedDims =
@@ -394,20 +422,24 @@ public:
// outputs like this.
std::string expectedXML =
std::string("<DimensionSet>") + "<Dimension ID=\"x\">" +
- "<Name>X</Name>" + "<Units>m</Units>" + "<Frame>Unknown frame</Frame>" +
+ "<Name>X</Name>" + "<Units>m</Units>" +
+ "<Frame>My General Frame</Frame>" +
"<UpperBounds>10.0000</UpperBounds>" +
"<LowerBounds>-10.0000</LowerBounds>" +
"<NumberOfBins>5</NumberOfBins>" + "</Dimension>" +
"<Dimension ID=\"y\">" + "<Name>Y</Name>" + "<Units>m</Units>" +
- "<Frame>Unknown frame</Frame>" + "<UpperBounds>10.0000</UpperBounds>" +
+ "<Frame>My General Frame</Frame>" +
+ "<UpperBounds>10.0000</UpperBounds>" +
"<LowerBounds>-10.0000</LowerBounds>" +
"<NumberOfBins>5</NumberOfBins>" + "</Dimension>" +
"<Dimension ID=\"z\">" + "<Name>Z</Name>" + "<Units>m</Units>" +
- "<Frame>Unknown frame</Frame>" + "<UpperBounds>10.0000</UpperBounds>" +
+ "<Frame>My General Frame</Frame>" +
+ "<UpperBounds>10.0000</UpperBounds>" +
"<LowerBounds>-10.0000</LowerBounds>" +
"<NumberOfBins>5</NumberOfBins>" + "</Dimension>" +
"<Dimension ID=\"t\">" + "<Name>T</Name>" + "<Units>m</Units>" +
- "<Frame>Unknown frame</Frame>" + "<UpperBounds>10.0000</UpperBounds>" +
+ "<Frame>My General Frame</Frame>" +
+ "<UpperBounds>10.0000</UpperBounds>" +
"<LowerBounds>-10.0000</LowerBounds>" +
"<NumberOfBins>5</NumberOfBins>" + "</Dimension>" + "<XDimension>" +
"<RefDimensionId>x</RefDimensionId>" + "</XDimension>" +
@@ -416,11 +448,15 @@ public:
"<RefDimensionId>z</RefDimensionId>" + "</ZDimension>" +
"<TDimension>" + "<RefDimensionId>t</RefDimensionId>" +
"</TDimension>" + "</DimensionSet>";
-
- MDHistoDimension_sptr dimX(new MDHistoDimension("X", "x", "m", -10, 10, 5));
- MDHistoDimension_sptr dimY(new MDHistoDimension("Y", "y", "m", -10, 10, 5));
- MDHistoDimension_sptr dimZ(new MDHistoDimension("Z", "z", "m", -10, 10, 5));
- MDHistoDimension_sptr dimT(new MDHistoDimension("T", "t", "m", -10, 10, 5));
+ Mantid::Geometry::GeneralFrame frame("My General Frame", "m");
+ MDHistoDimension_sptr dimX(
+ new MDHistoDimension("X", "x", frame, -10, 10, 5));
+ MDHistoDimension_sptr dimY(
+ new MDHistoDimension("Y", "y", frame, -10, 10, 5));
+ MDHistoDimension_sptr dimZ(
+ new MDHistoDimension("Z", "z", frame, -10, 10, 5));
+ MDHistoDimension_sptr dimT(
+ new MDHistoDimension("T", "t", frame, -10, 10, 5));
MDHistoWorkspace ws(dimX, dimY, dimZ, dimT);
@@ -965,17 +1001,33 @@ public:
Mantid::Kernel::None, ws->getSpecialCoordinateSystem());
}
- void test_setSpecialCoordinateSystem_default() {
- MDHistoWorkspace_sptr ws =
- MDEventsTestHelper::makeFakeMDHistoWorkspace(1, 1);
- TS_ASSERT_EQUALS(Mantid::Kernel::None, ws->getSpecialCoordinateSystem());
-
- ws->setCoordinateSystem(Mantid::Kernel::QLab);
- TS_ASSERT_EQUALS(Mantid::Kernel::QLab, ws->getSpecialCoordinateSystem());
+ void test_getSpecialCoordinateSystem_when_MDFrames_are_set() {
+ // Arrange
+ Mantid::Geometry::QSample frame1;
+ Mantid::Geometry::QSample frame2;
+ Mantid::coord_t min = 0;
+ Mantid::coord_t max = 10;
+ size_t bins = 2;
+ auto dimension1 = boost::make_shared<MDHistoDimension>(
+ "QSampleX", "QSampleX", frame1, min, max, bins);
+ auto dimension2 = boost::make_shared<MDHistoDimension>(
+ "QSampleY", "QSampleY", frame2, min, max, bins);
+ auto ws = boost::make_shared<Mantid::DataObjects::MDHistoWorkspace>(
+ dimension1, dimension2);
+
+ // Act
+ auto specialCoordinates = ws->getSpecialCoordinateSystem();
+
+ // Assert
+ TSM_ASSERT_EQUALS("Should detect QSample as the SpecialCoordinate",
+ specialCoordinates,
+ Mantid::Kernel::SpecialCoordinateSystem::QSample);
}
void test_displayNormalizationDefault() {
- MDHistoDimension_sptr dimX(new MDHistoDimension("X", "x", "m", -10, 10, 5));
+ Mantid::Geometry::GeneralFrame frame("m", "m");
+ MDHistoDimension_sptr dimX(
+ new MDHistoDimension("X", "x", frame, -10, 10, 5));
// Constructor variant 1.
MDHistoWorkspace ws1(dimX);
TS_ASSERT_EQUALS(Mantid::API::NoNormalization, ws1.displayNormalization());
@@ -992,10 +1044,10 @@ public:
}
void test_setDisplayNormalization() {
-
auto targetDisplayNormalization = Mantid::API::VolumeNormalization;
-
- MDHistoDimension_sptr dimX(new MDHistoDimension("X", "x", "m", -10, 10, 5));
+ Mantid::Geometry::GeneralFrame frame("m", "m");
+ MDHistoDimension_sptr dimX(
+ new MDHistoDimension("X", "x", frame, -10, 10, 5));
// Constructor variant 1.
MDHistoWorkspace ws1(dimX, dimX, dimX, dimX, targetDisplayNormalization);
TS_ASSERT_EQUALS(targetDisplayNormalization, ws1.displayNormalization());
diff --git a/Framework/Geometry/CMakeLists.txt b/Framework/Geometry/CMakeLists.txt
index 495488fdd9fa667ab9504906f20ab7c4bdcbc2ed..0cb007602f710c2c92fc3d9a18cfed9982054089 100644
--- a/Framework/Geometry/CMakeLists.txt
+++ b/Framework/Geometry/CMakeLists.txt
@@ -80,6 +80,7 @@ set ( SRC_FILES
src/MDGeometry/NullImplicitFunction.cpp
src/MDGeometry/QLab.cpp
src/MDGeometry/QSample.cpp
+ src/MDGeometry/UnknownFrame.cpp
src/Math/Acomp.cpp
src/Math/Algebra.cpp
src/Math/BnId.cpp
@@ -229,6 +230,7 @@ set ( INC_FILES
inc/MantidGeometry/MDGeometry/NullImplicitFunction.h
inc/MantidGeometry/MDGeometry/QLab.h
inc/MantidGeometry/MDGeometry/QSample.h
+ inc/MantidGeometry/MDGeometry/UnknownFrame.h
inc/MantidGeometry/Math/Acomp.h
inc/MantidGeometry/Math/Algebra.h
inc/MantidGeometry/Math/BnId.h
@@ -398,10 +400,8 @@ endif(UNITY_BUILD)
# ===================== Open Cascade ===================
if (ENABLE_OPENCASCADE)
- find_package ( OpenCascade REQUIRED )
include_directories ( system ${OPENCASCADE_INCLUDE_DIR} )
set (SRC_FILES ${SRC_FILES} ${OPENCASCADE_SRC} )
- add_definitions ( -DENABLE_OPENCASCADE )
endif ()
# A few defines needed for OpenCascade on the Mac
diff --git a/Framework/Geometry/inc/MantidGeometry/IObjComponent.h b/Framework/Geometry/inc/MantidGeometry/IObjComponent.h
index f99974527e8c937d6462396d2d590ad946509c99..ef10037da16e559a2a2963e0926b32b0874ee84e 100644
--- a/Framework/Geometry/inc/MantidGeometry/IObjComponent.h
+++ b/Framework/Geometry/inc/MantidGeometry/IObjComponent.h
@@ -107,7 +107,7 @@ public:
protected:
/// Protected copy constructor
IObjComponent(const IObjComponent &);
- /// Assignment operato
+ /// Assignment operator
IObjComponent &operator=(const IObjComponent &);
/// Reset the current geometry handler
diff --git a/Framework/Geometry/inc/MantidGeometry/Instrument/INearestNeighbours.h b/Framework/Geometry/inc/MantidGeometry/Instrument/INearestNeighbours.h
index 7cce58d7e4add601818f6c19a33309ea286c714e..710a875b0730537ce9103baf8258bd9a548daf8b 100644
--- a/Framework/Geometry/inc/MantidGeometry/Instrument/INearestNeighbours.h
+++ b/Framework/Geometry/inc/MantidGeometry/Instrument/INearestNeighbours.h
@@ -8,7 +8,7 @@
// Boost graphing
#ifndef Q_MOC_RUN
#include <boost/graph/adjacency_list.hpp>
-#include <boost/unordered_map.hpp>
+#include <unordered_map>
#include <boost/shared_ptr.hpp>
#include <boost/scoped_ptr.hpp>
#endif
@@ -21,7 +21,7 @@ namespace Geometry {
class Instrument;
class IComponent;
-typedef boost::unordered_map<specid_t, std::set<detid_t>>
+typedef std::unordered_map<specid_t, std::set<detid_t>>
ISpectrumDetectorMapping;
/**
diff --git a/Framework/Geometry/inc/MantidGeometry/Instrument/NearestNeighbours.h b/Framework/Geometry/inc/MantidGeometry/Instrument/NearestNeighbours.h
index 953ba110eebf4f6879020e6bbb1e413cb03ca620..aefd39961e03aa108360c4c2778b3d93a50d712e 100644
--- a/Framework/Geometry/inc/MantidGeometry/Instrument/NearestNeighbours.h
+++ b/Framework/Geometry/inc/MantidGeometry/Instrument/NearestNeighbours.h
@@ -93,7 +93,7 @@ private:
/// Vertex descriptor object for Graph
typedef boost::graph_traits<Graph>::vertex_descriptor Vertex;
/// map object of int to Graph Vertex descriptor
- typedef boost::unordered_map<specid_t, Vertex> MapIV;
+ typedef std::unordered_map<specid_t, Vertex> MapIV;
/// Construct the graph based on the given number of neighbours and the
/// current instument and spectra-detector mapping
diff --git a/Framework/Geometry/inc/MantidGeometry/MDGeometry/GeneralFrame.h b/Framework/Geometry/inc/MantidGeometry/MDGeometry/GeneralFrame.h
index 5d45c78bd813d9ca5cff0b49962dc25061fcf6ce..524988a3bf3a412786bb62c18c12edcd1cab17f5 100644
--- a/Framework/Geometry/inc/MantidGeometry/MDGeometry/GeneralFrame.h
+++ b/Framework/Geometry/inc/MantidGeometry/MDGeometry/GeneralFrame.h
@@ -4,6 +4,7 @@
#include "MantidGeometry/MDGeometry/MDFrame.h"
#include "MantidKernel/MDUnit.h"
#include "MantidKernel/System.h"
+#include "MantidGeometry/DllConfig.h"
#include "MantidKernel/UnitLabel.h"
#include <memory>
@@ -33,8 +34,11 @@ namespace Geometry {
File change history is stored at: <https://github.com/mantidproject/mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
-class DLLExport GeneralFrame : public MDFrame {
+class MANTID_GEOMETRY_DLL GeneralFrame : public MDFrame {
public:
+ static const std::string GeneralFrameDistance;
+ static const std::string GeneralFrameTOF;
+ static const std::string GeneralFrameName;
GeneralFrame(const std::string &frameName, const Kernel::UnitLabel &unit);
GeneralFrame(const std::string &frameName,
std::unique_ptr<Mantid::Kernel::MDUnit> unit);
@@ -42,8 +46,12 @@ public:
Kernel::UnitLabel getUnitLabel() const;
const Kernel::MDUnit &getMDUnit() const;
bool canConvertTo(const Kernel::MDUnit &otherUnit) const;
+ bool isQ() const;
+ bool isSameType(const MDFrame &frame) const;
std::string name() const;
virtual GeneralFrame *clone() const;
+ Mantid::Kernel::SpecialCoordinateSystem
+ equivalientSpecialCoordinateSystem() const;
private:
/// Label unit
@@ -51,6 +59,7 @@ private:
/// Frame name
const std::string m_frameName;
};
+
} // namespace Geometry
} // namespace Mantid
diff --git a/Framework/Geometry/inc/MantidGeometry/MDGeometry/HKL.h b/Framework/Geometry/inc/MantidGeometry/MDGeometry/HKL.h
index ae0a3864c471dd1512e1da1acfb0a5bd2c220f81..38eb4bf26c4c367bf4168d366017fd1dfa6ff2a3 100644
--- a/Framework/Geometry/inc/MantidGeometry/MDGeometry/HKL.h
+++ b/Framework/Geometry/inc/MantidGeometry/MDGeometry/HKL.h
@@ -47,8 +47,12 @@ public:
Kernel::UnitLabel getUnitLabel() const;
const Kernel::MDUnit &getMDUnit() const;
bool canConvertTo(const Kernel::MDUnit &otherUnit) const;
+ bool isQ() const;
+ bool isSameType(const MDFrame &frame) const;
std::string name() const;
HKL *clone() const;
+ Mantid::Kernel::SpecialCoordinateSystem
+ equivalientSpecialCoordinateSystem() const;
private:
std::unique_ptr<Kernel::MDUnit> m_unit;
diff --git a/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDFrame.h b/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDFrame.h
index f8d98869fafa647bb663fdb681f56e2c9827fb11..51b9daf745adc5f78a43dc9f862a5558201db019 100644
--- a/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDFrame.h
+++ b/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDFrame.h
@@ -5,6 +5,7 @@
#include "MantidKernel/MDUnit.h"
#include "MantidKernel/UnitLabel.h"
+#include "MantidKernel/SpecialCoordinateSystem.h"
#include <memory>
namespace Mantid {
@@ -39,13 +40,19 @@ public:
virtual Mantid::Kernel::UnitLabel getUnitLabel() const = 0;
virtual const Mantid::Kernel::MDUnit &getMDUnit() const = 0;
virtual bool canConvertTo(const Mantid::Kernel::MDUnit &otherUnit) const = 0;
+ virtual bool isQ() const = 0;
+ virtual bool isSameType(const MDFrame &frame) const = 0;
virtual std::string name() const = 0;
+ virtual Mantid::Kernel::SpecialCoordinateSystem
+ equivalientSpecialCoordinateSystem() const = 0;
virtual MDFrame *clone() const = 0;
virtual ~MDFrame() {}
};
typedef std::unique_ptr<MDFrame> MDFrame_uptr;
typedef std::unique_ptr<const MDFrame> MDFrame_const_uptr;
+typedef std::shared_ptr<MDFrame> MDFrame_sptr;
+typedef std::shared_ptr<const MDFrame> MDFrame_const_sptr;
} // namespace Geometry
} // namespace Mantid
diff --git a/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDFrameFactory.h b/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDFrameFactory.h
index b42e611109fd15e601d57405ce7b83dd883b3b5b..d39e786edbe6a90181c8f8014388e78dcdba2b6c 100644
--- a/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDFrameFactory.h
+++ b/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDFrameFactory.h
@@ -7,6 +7,7 @@
#include "MantidGeometry/MDGeometry/QLab.h"
#include "MantidGeometry/MDGeometry/QSample.h"
#include "MantidGeometry/MDGeometry/HKL.h"
+#include "MantidGeometry/MDGeometry/UnknownFrame.h"
#include "MantidGeometry/DllConfig.h"
#include <memory>
@@ -98,6 +99,15 @@ public:
bool canInterpret(const MDFrameArgument &argument) const;
};
+/// Unknown Frame derived MDFrameFactory type
+class MANTID_GEOMETRY_DLL UnknownFrameFactory : public MDFrameFactory {
+private:
+ UnknownFrame *createRaw(const MDFrameArgument &argument) const;
+
+public:
+ bool canInterpret(const MDFrameArgument &argument) const;
+};
+
/// Make a complete factory chain
MDFrameFactory_uptr MANTID_GEOMETRY_DLL makeMDFrameFactoryChain();
diff --git a/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDHistoDimension.h b/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDHistoDimension.h
index d51620b258acce3c22f88e866050cbbee209f742..a18089c33b6127271c9a9c2af0f25cf9d459328e 100644
--- a/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDHistoDimension.h
+++ b/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDHistoDimension.h
@@ -5,7 +5,7 @@
#include "MantidKernel/Exception.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidGeometry/MDGeometry/MDFrame.h"
-#include "MantidGeometry/MDGeometry/GeneralFrame.h"
+#include "MantidGeometry/MDGeometry/UnknownFrame.h"
#include "MantidKernel/MDUnit.h"
#include "MantidKernel/MDUnitFactory.h"
#include "MantidKernel/VMD.h"
@@ -23,27 +23,6 @@ namespace Geometry {
*/
class MANTID_GEOMETRY_DLL MDHistoDimension : public IMDDimension {
public:
- /** Constructor for simple MDHistoDimension
- * @param name :: full name of the axis
- * @param ID :: identifier string
- * @param units :: A plain-text string giving the units of this dimension
- * @param min :: minimum extent
- * @param max :: maximum extent
- * @param numBins :: number of bins (evenly spaced)
- */
- MDHistoDimension(std::string name, std::string ID,
- const Kernel::UnitLabel &units, coord_t min, coord_t max,
- size_t numBins)
- : m_name(name), m_dimensionId(ID),
- m_frame(new GeneralFrame("Unknown frame", units)), m_min(min),
- m_max(max), m_numBins(numBins),
- m_binWidth((max - min) / static_cast<coord_t>(numBins)) {
- if (max < min) {
- throw std::invalid_argument("Error making MDHistoDimension. Cannot have "
- "dimension with min > max");
- }
- }
-
/** Constructor for simple MDHistoDimension
* @param name :: full name of the axis
* @param ID :: identifier string
diff --git a/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDHistoDimensionBuilder.h b/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDHistoDimensionBuilder.h
index 26ffcbab3bf97425286249ef6505e983dbeeda72..cc7e302beae0a49987cb588b164b567bf0c05ce0 100644
--- a/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDHistoDimensionBuilder.h
+++ b/Framework/Geometry/inc/MantidGeometry/MDGeometry/MDHistoDimensionBuilder.h
@@ -28,6 +28,7 @@ public:
void setMin(double min);
void setMax(double max);
void setNumBins(size_t nbins);
+ void setFrameName(std::string frameName);
size_t getNumBins() const { return m_nbins; }
MDHistoDimension *createRaw();
@@ -52,6 +53,8 @@ private:
bool m_minSet;
/// Flag indicating that max has been set.
bool m_maxSet;
+ /// Frame name
+ std::string m_frameName;
};
/// Handy typedef for collection of builders.
diff --git a/Framework/Geometry/inc/MantidGeometry/MDGeometry/QLab.h b/Framework/Geometry/inc/MantidGeometry/MDGeometry/QLab.h
index 23d649e0597b4aa9a549a7dc420a433224b82e84..c21b349d84dfa9078ba8df85d80dca9d20e5f86e 100644
--- a/Framework/Geometry/inc/MantidGeometry/MDGeometry/QLab.h
+++ b/Framework/Geometry/inc/MantidGeometry/MDGeometry/QLab.h
@@ -41,8 +41,12 @@ public:
Mantid::Kernel::UnitLabel getUnitLabel() const;
const Mantid::Kernel::MDUnit &getMDUnit() const;
bool canConvertTo(const Mantid::Kernel::MDUnit &otherUnit) const;
+ bool isQ() const;
+ bool isSameType(const MDFrame &frame) const;
virtual std::string name() const;
QLab *clone() const;
+ Mantid::Kernel::SpecialCoordinateSystem
+ equivalientSpecialCoordinateSystem() const;
// Type name
static const std::string QLabName;
diff --git a/Framework/Geometry/inc/MantidGeometry/MDGeometry/QSample.h b/Framework/Geometry/inc/MantidGeometry/MDGeometry/QSample.h
index 1eb80a05172e40be4044c86275bf31663c05eda3..5f932b3eb2e98891669c01c88a8d4ff61fe3fc83 100644
--- a/Framework/Geometry/inc/MantidGeometry/MDGeometry/QSample.h
+++ b/Framework/Geometry/inc/MantidGeometry/MDGeometry/QSample.h
@@ -42,8 +42,12 @@ public:
Kernel::UnitLabel getUnitLabel() const;
const Kernel::MDUnit &getMDUnit() const;
bool canConvertTo(const Kernel::MDUnit &otherUnit) const;
+ bool isQ() const;
+ bool isSameType(const MDFrame &frame) const;
std::string name() const;
QSample *clone() const;
+ Mantid::Kernel::SpecialCoordinateSystem
+ equivalientSpecialCoordinateSystem() const;
private:
/// immutable unit for qlab.
diff --git a/Framework/Geometry/inc/MantidGeometry/MDGeometry/UnknownFrame.h b/Framework/Geometry/inc/MantidGeometry/MDGeometry/UnknownFrame.h
new file mode 100644
index 0000000000000000000000000000000000000000..691537e4f07e2bba6a4479895d0fad1596016a21
--- /dev/null
+++ b/Framework/Geometry/inc/MantidGeometry/MDGeometry/UnknownFrame.h
@@ -0,0 +1,62 @@
+#ifndef MANTID_GEOMETRY_UNKNOWN_H_
+#define MANTID_GEOMETRY_UNKNOWN_H_
+
+#include "MantidKernel/MDUnit.h"
+#include "MantidKernel/System.h"
+#include "MantidKernel/UnitLabel.h"
+#include "MantidGeometry/MDGeometry/GeneralFrame.h"
+#include "MantidGeometry/DllConfig.h"
+#include <memory>
+
+namespace Mantid {
+namespace Geometry {
+
+/** UnknownFrame : Unknown MDFrame
+
+ Copyright © 2015 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
+ National Laboratory & European Spallation Source
+
+ This file is part of Mantid.
+
+ Mantid is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ Mantid is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ File change history is stored at: <https://github.com/mantidproject/mantid>
+ Code Documentation is available at: <http://doxygen.mantidproject.org>
+*/
+class MANTID_GEOMETRY_DLL UnknownFrame : public MDFrame {
+public:
+ UnknownFrame(std::unique_ptr<Kernel::MDUnit> unit);
+ UnknownFrame(const Kernel::UnitLabel &unit);
+ virtual ~UnknownFrame();
+ std::string name() const;
+ bool canConvertTo(const Mantid::Kernel::MDUnit &otherUnit) const;
+ bool isQ() const;
+ bool isSameType(const MDFrame &frame) const;
+ Mantid::Kernel::UnitLabel getUnitLabel() const;
+ const Mantid::Kernel::MDUnit &getMDUnit() const;
+ Mantid::Kernel::SpecialCoordinateSystem
+ equivalientSpecialCoordinateSystem() const;
+ UnknownFrame *clone() const;
+ // Type name
+ static const std::string UnknownFrameName;
+
+private:
+ /// Label unit
+ const std::unique_ptr<Mantid::Kernel::MDUnit> m_unit;
+};
+
+} // namespace Geometry
+} // namespace Mantid
+
+#endif /* MANTID_GEOMETRY_QLAB_H_ */
diff --git a/Framework/Geometry/inc/MantidGeometry/Objects/Rules.h b/Framework/Geometry/inc/MantidGeometry/Objects/Rules.h
index 46c44f1f26df642e2d03dbc668e7b776f7d4b742..19b087753a6de29a79c71385c392fbe07d4671bc 100644
--- a/Framework/Geometry/inc/MantidGeometry/Objects/Rules.h
+++ b/Framework/Geometry/inc/MantidGeometry/Objects/Rules.h
@@ -3,6 +3,8 @@
#include <map>
+class TopoDS_Shape;
+
namespace Mantid {
namespace Geometry {
@@ -102,6 +104,9 @@ public:
/// Abstract getBoundingBox
virtual void getBoundingBox(double &xmax, double &ymax, double &zmax,
double &xmin, double &ymin, double &zmin) = 0;
+#ifdef ENABLE_OPENCASCADE
+ virtual TopoDS_Shape analyze() = 0;
+#endif
};
/**
@@ -151,6 +156,9 @@ public:
int simplify(); ///< apply general intersection simplification
void getBoundingBox(double &xmax, double &ymax, double &zmax, double &xmin,
double &ymin, double &zmin); /// bounding box
+#ifdef ENABLE_OPENCASCADE
+ virtual TopoDS_Shape analyze();
+#endif
};
/**
@@ -201,6 +209,9 @@ public:
int simplify(); ///< apply general intersection simplification
void getBoundingBox(double &xmax, double &ymax, double &zmax, double &xmin,
double &ymin, double &zmin); /// bounding box
+#ifdef ENABLE_OPENCASCADE
+ virtual TopoDS_Shape analyze();
+#endif
};
/**
@@ -220,7 +231,6 @@ private:
Surface *key; ///< Actual Surface Base Object
int keyN; ///< Key Number (identifer)
int sign; ///< +/- in Object unit
-
public:
SurfPoint();
SurfPoint(const SurfPoint &);
@@ -252,6 +262,9 @@ public:
std::string displayAddress() const;
void getBoundingBox(double &xmax, double &ymax, double &zmax, double &xmin,
double &ymin, double &zmin); /// bounding box
+#ifdef ENABLE_OPENCASCADE
+ virtual TopoDS_Shape analyze();
+#endif
};
/**
@@ -302,6 +315,9 @@ public:
std::string displayAddress() const;
void getBoundingBox(double &xmax, double &ymax, double &zmax, double &xmin,
double &ymin, double &zmin); /// bounding box
+#ifdef ENABLE_OPENCASCADE
+ virtual TopoDS_Shape analyze();
+#endif
};
/**
@@ -348,6 +364,9 @@ public:
std::string displayAddress() const;
void getBoundingBox(double &xmax, double &ymax, double &zmax, double &xmin,
double &ymin, double &zmin); /// bounding box
+#ifdef ENABLE_OPENCASCADE
+ virtual TopoDS_Shape analyze();
+#endif
};
/**
@@ -397,6 +416,9 @@ public:
std::string displayAddress() const;
void getBoundingBox(double &xmax, double &ymax, double &zmax, double &xmin,
double &ymin, double &zmin); /// bounding box
+#ifdef ENABLE_OPENCASCADE
+ TopoDS_Shape analyze();
+#endif
};
} // NAMESPACE Geometry
diff --git a/Framework/Geometry/inc/MantidGeometry/Rendering/OCGeometryGenerator.h b/Framework/Geometry/inc/MantidGeometry/Rendering/OCGeometryGenerator.h
index afff96a016f030a2061d4ad5a4e57e8bbd5d3916..25bef1348fab5081fcbdc0c87ebadc1a54d781c5 100644
--- a/Framework/Geometry/inc/MantidGeometry/Rendering/OCGeometryGenerator.h
+++ b/Framework/Geometry/inc/MantidGeometry/Rendering/OCGeometryGenerator.h
@@ -58,32 +58,6 @@ private:
TopoDS_Shape *ObjSurface; ///< Storage for the output surface
/// Analyze the object
void AnalyzeObject();
- /// Analyze a geometry rule for n object rule
- TopoDS_Shape AnalyzeRule(Rule *);
- /// Analyze a geometry rule for an intersection
- TopoDS_Shape AnalyzeRule(Intersection *);
- /// Analyze a geometry rule for a union
- TopoDS_Shape AnalyzeRule(Union *);
- /// Analyze a geometry rule for a surface rule
- TopoDS_Shape AnalyzeRule(SurfPoint *);
- /// Analyze a geometry rule for a Complement group
- TopoDS_Shape AnalyzeRule(CompGrp *);
- /// Analyze a geometry rule for a complement object
- TopoDS_Shape AnalyzeRule(CompObj *);
- /// Analyze a geometry rule for a boolean value
- TopoDS_Shape AnalyzeRule(BoolValue *);
- /// create an OpenCascade shape from a Mantid shape
- TopoDS_Shape CreateShape(Surface *surf, int orientation);
- /// create an OpenCascade sphere from a Mantid shape
- TopoDS_Shape CreateSphere(Sphere *);
- /// create an OpenCascade cylinder from a Mantid shape
- TopoDS_Shape CreateCylinder(Cylinder *);
- /// create an OpenCascade cone from a Mantid shape
- TopoDS_Shape CreateCone(Cone *);
- /// create an OpenCascade plane from a Mantid shape
- TopoDS_Shape CreatePlane(Plane *, int orientation);
- /// create an OpenCascade Torus from a Mantid shape
- TopoDS_Shape CreateTorus(Torus *);
public:
OCGeometryGenerator(const Object *obj);
diff --git a/Framework/Geometry/inc/MantidGeometry/Surfaces/Cone.h b/Framework/Geometry/inc/MantidGeometry/Surfaces/Cone.h
index 1393a5acfe009c57b7efe2405699771d3346b5c9..1bbb794ba2d7a992f0cf6afb99e4767b7b3a765f 100644
--- a/Framework/Geometry/inc/MantidGeometry/Surfaces/Cone.h
+++ b/Framework/Geometry/inc/MantidGeometry/Surfaces/Cone.h
@@ -53,7 +53,6 @@ private:
public:
/// Public identifer
virtual std::string className() const { return "Cone"; }
-
Cone();
Cone(const Cone &);
Cone *clone() const;
@@ -103,6 +102,9 @@ public:
static int g_nslices;
/// The number of stacks to approximate a cone
static int g_nstacks;
+#ifdef ENABLE_OPENCASCADE
+ virtual TopoDS_Shape createShape();
+#endif
};
} // NAMESPACE MonteCarlo
diff --git a/Framework/Geometry/inc/MantidGeometry/Surfaces/Cylinder.h b/Framework/Geometry/inc/MantidGeometry/Surfaces/Cylinder.h
index 61aafe353806d012c2d827edf3d721d8eed3778f..9184521f2e6c8e81a882991cdab2dde10510ac7a 100644
--- a/Framework/Geometry/inc/MantidGeometry/Surfaces/Cylinder.h
+++ b/Framework/Geometry/inc/MantidGeometry/Surfaces/Cylinder.h
@@ -50,7 +50,7 @@ private:
Kernel::V3D Centre; ///< Kernel::V3D for centre
Kernel::V3D Normal; ///< Direction of centre line
- int Nvec; ///< Normal vector is x,y or z :: (1-3) (0 if general)
+ std::size_t Nvec; ///< Normal vector is x,y or z :: (1-3) (0 if general)
double Radius; ///< Radius of cylinder
void rotate(const Kernel::Matrix<double> &);
@@ -98,6 +98,9 @@ public:
static int g_nslices;
/// The number of stacks to approximate a cylinder
static int g_nstacks;
+#ifdef ENABLE_OPENCASCADE
+ virtual TopoDS_Shape createShape();
+#endif
};
} // NAMESPACE Geometry
diff --git a/Framework/Geometry/inc/MantidGeometry/Surfaces/Plane.h b/Framework/Geometry/inc/MantidGeometry/Surfaces/Plane.h
index 1e894acad9e9c9719d728e188f7733d6599275d0..dabfe313367521e49d6e280feb4b1d149207eee4 100644
--- a/Framework/Geometry/inc/MantidGeometry/Surfaces/Plane.h
+++ b/Framework/Geometry/inc/MantidGeometry/Surfaces/Plane.h
@@ -52,7 +52,7 @@ private:
Kernel::V3D NormV; ///< Normal vector
double Dist; ///< Distance
- int planeType() const; ///< are we alined on an axis
+ std::size_t planeType() const; ///< are we alined on an axis
public:
/// Effective typename
@@ -93,6 +93,9 @@ public:
Kernel::V3D &output);
void getBoundingBox(double &xmax, double &ymax, double &zmax, double &xmin,
double &ymin, double &zmin);
+#ifdef ENABLE_OPENCASCADE
+ virtual TopoDS_Shape createShape();
+#endif
};
} // NAMESPACE Geometry
diff --git a/Framework/Geometry/inc/MantidGeometry/Surfaces/Sphere.h b/Framework/Geometry/inc/MantidGeometry/Surfaces/Sphere.h
index 429d14e287ec2d7e18269bd401e6cc7030160618..63dfe057f58db9821fcc717b3f95ea4886b4a516 100644
--- a/Framework/Geometry/inc/MantidGeometry/Surfaces/Sphere.h
+++ b/Framework/Geometry/inc/MantidGeometry/Surfaces/Sphere.h
@@ -6,6 +6,8 @@
#include "MantidKernel/V3D.h"
#include <string>
+class TopoDS_Shape;
+
namespace Mantid {
namespace Geometry {
@@ -89,6 +91,9 @@ public:
static int g_nslices;
/// The number of stacks to approximate a sphere
static int g_nstacks;
+#ifdef ENABLE_OPENCASCADE
+ virtual TopoDS_Shape createShape();
+#endif
};
} // NAMESPACE Geometry
diff --git a/Framework/Geometry/inc/MantidGeometry/Surfaces/Surface.h b/Framework/Geometry/inc/MantidGeometry/Surfaces/Surface.h
index 57f6cb40ddb64c2e9cea0f2335c1860920985151..7372435ca684fdd7d86d0f2b2d55770f3395c568 100644
--- a/Framework/Geometry/inc/MantidGeometry/Surfaces/Surface.h
+++ b/Framework/Geometry/inc/MantidGeometry/Surfaces/Surface.h
@@ -5,6 +5,8 @@
#include "BaseVisit.h"
#include <string>
+class TopoDS_Shape;
+
namespace Mantid {
namespace Kernel {
class V3D;
@@ -87,6 +89,9 @@ public:
/// bounding box for the surface
virtual void getBoundingBox(double &xmax, double &ymax, double &zmax,
double &xmin, double &ymin, double &zmin) = 0;
+#ifdef ENABLE_OPENCASCADE
+ virtual TopoDS_Shape createShape();
+#endif
};
} // NAMESPACE Geometry
diff --git a/Framework/Geometry/inc/MantidGeometry/Surfaces/Torus.h b/Framework/Geometry/inc/MantidGeometry/Surfaces/Torus.h
index f49a6e883f0152ad46f8936321634cef788a8eee..6737fa55e7384ed41a4baf331594a5cc63dce189 100644
--- a/Framework/Geometry/inc/MantidGeometry/Surfaces/Torus.h
+++ b/Framework/Geometry/inc/MantidGeometry/Surfaces/Torus.h
@@ -91,6 +91,9 @@ public:
void write(std::ostream &OX) const;
void getBoundingBox(double &xmax, double &ymax, double &zmax, double &xmin,
double &ymin, double &zmin);
+#ifdef ENABLE_OPENCASCADE
+ virtual TopoDS_Shape createShape();
+#endif
};
} // NAMESPACE
diff --git a/Framework/Geometry/src/MDGeometry/GeneralFrame.cpp b/Framework/Geometry/src/MDGeometry/GeneralFrame.cpp
index e1393b17ec31c08e9ae66ee18c5ab78f7f8f7b3d..534f4a4fec9d3af39b50bd23247f72cdee72e07a 100644
--- a/Framework/Geometry/src/MDGeometry/GeneralFrame.cpp
+++ b/Framework/Geometry/src/MDGeometry/GeneralFrame.cpp
@@ -3,6 +3,10 @@
namespace Mantid {
namespace Geometry {
+const std::string GeneralFrame::GeneralFrameDistance = "Distance";
+const std::string GeneralFrame::GeneralFrameTOF = "Time of Flight";
+const std::string GeneralFrame::GeneralFrameName = "General Frame";
+
GeneralFrame::GeneralFrame(const std::string &frameName,
std::unique_ptr<Kernel::MDUnit> unit)
: m_unit(unit.release()), m_frameName(frameName) {}
@@ -33,5 +37,23 @@ GeneralFrame *GeneralFrame::clone() const {
std::unique_ptr<Kernel::MDUnit>(m_unit->clone()));
}
+Mantid::Kernel::SpecialCoordinateSystem
+GeneralFrame::equivalientSpecialCoordinateSystem() const {
+ return Mantid::Kernel::SpecialCoordinateSystem::None;
+}
+
+bool GeneralFrame::isQ() const { return false; }
+
+bool GeneralFrame::isSameType(const MDFrame &frame) const {
+ auto isSameType = true;
+ try {
+ const auto &tmp = dynamic_cast<const GeneralFrame &>(frame);
+ UNUSED_ARG(tmp);
+ } catch (std::bad_cast &) {
+ isSameType = false;
+ }
+ return isSameType;
+}
+
} // namespace Geometry
} // namespace Mantid
diff --git a/Framework/Geometry/src/MDGeometry/HKL.cpp b/Framework/Geometry/src/MDGeometry/HKL.cpp
index 33ae8767d4430c89a7aad8aba1740a7076f587f4..3abb77264cc7fad323e3bdb5dfe3dfacea9b15cd 100644
--- a/Framework/Geometry/src/MDGeometry/HKL.cpp
+++ b/Framework/Geometry/src/MDGeometry/HKL.cpp
@@ -64,5 +64,22 @@ std::string HKL::name() const { return HKLName; }
HKL *HKL::clone() const { return new HKL(m_unit->clone()); }
+Mantid::Kernel::SpecialCoordinateSystem
+HKL::equivalientSpecialCoordinateSystem() const {
+ return Mantid::Kernel::SpecialCoordinateSystem::HKL;
+}
+
+bool HKL::isQ() const { return true; }
+
+bool HKL::isSameType(const MDFrame &frame) const {
+ auto isSameType = true;
+ try {
+ const auto &tmp = dynamic_cast<const HKL &>(frame);
+ UNUSED_ARG(tmp);
+ } catch (std::bad_cast &) {
+ isSameType = false;
+ }
+ return isSameType;
+}
} // namespace Geometry
} // namespace Mantid
diff --git a/Framework/Geometry/src/MDGeometry/MDFrameFactory.cpp b/Framework/Geometry/src/MDGeometry/MDFrameFactory.cpp
index d3f58ceb35d4ff9253bcffba932336982b01448d..bf558f0d064ea7dddb30f2fc6ba3a391b7f196ec 100644
--- a/Framework/Geometry/src/MDGeometry/MDFrameFactory.cpp
+++ b/Framework/Geometry/src/MDGeometry/MDFrameFactory.cpp
@@ -3,7 +3,7 @@
#include "MantidKernel/MDUnit.h"
#include "MantidKernel/UnitLabelTypes.h"
#include "MantidGeometry/MDGeometry/MDFrame.h"
-
+#include <boost/regex.hpp>
namespace Mantid {
namespace Geometry {
@@ -19,8 +19,12 @@ GeneralFrameFactory::createRaw(const MDFrameArgument &argument) const {
}
/// Indicate an ability to intepret the string
-bool GeneralFrameFactory::canInterpret(const MDFrameArgument &) const {
- return true; // This can interpret everything
+bool GeneralFrameFactory::canInterpret(const MDFrameArgument &argument) const {
+ auto canInterpret = true;
+ if (argument.frameString == UnknownFrame::UnknownFrameName) {
+ canInterpret = false;
+ }
+ return canInterpret;
}
QLab *QLabFrameFactory::createRaw(const MDFrameArgument &) const {
@@ -54,13 +58,33 @@ bool HKLFrameFactory::canInterpret(const MDFrameArgument &argument) const {
auto unitFactoryChain = Kernel::makeMDUnitFactoryChain();
auto mdUnit = unitFactoryChain->create(argument.unitString);
// We expect units to be RLU or A^-1
- const bool compatibleUnit =
- (mdUnit->getUnitLabel() == Units::Symbol::InverseAngstrom ||
- mdUnit->getUnitLabel() == Units::Symbol::RLU);
+ auto isInverseAngstrom =
+ mdUnit->getUnitLabel() == Units::Symbol::InverseAngstrom;
+ auto isRLU = mdUnit->getUnitLabel() == Units::Symbol::RLU;
+ boost::regex pattern("in.*A.*\\^-1");
+ auto isHoraceStyle =
+ boost::regex_match(mdUnit->getUnitLabel().ascii(), pattern);
+ const bool compatibleUnit = isInverseAngstrom || isRLU || isHoraceStyle;
// Check both the frame name and the unit name
return argument.frameString == HKL::HKLName && compatibleUnit;
}
+UnknownFrame *
+UnknownFrameFactory::createRaw(const MDFrameArgument &argument) const {
+ using namespace Mantid::Kernel;
+
+ // Try to generate a proper md unit, don't just assume a label unit.
+ auto unitFactoryChain = Kernel::makeMDUnitFactoryChain();
+ auto mdUnit = unitFactoryChain->create(argument.unitString);
+
+ return new UnknownFrame(MDUnit_uptr(mdUnit->clone()));
+}
+
+/// Indicate an ability to intepret the string
+bool UnknownFrameFactory::canInterpret(const MDFrameArgument &) const {
+ return true; // This can interpret everything
+}
+
MDFrameFactory_uptr makeMDFrameFactoryChain() {
typedef MDFrameFactory_uptr FactoryType;
auto first = FactoryType(new QLabFrameFactory);
@@ -68,7 +92,8 @@ MDFrameFactory_uptr makeMDFrameFactoryChain() {
.setSuccessor(FactoryType(new HKLFrameFactory))
// Make sure that GeneralFrameFactory is the last in the chain to give a
// fall-through option
- .setSuccessor(FactoryType(new GeneralFrameFactory));
+ .setSuccessor(FactoryType(new GeneralFrameFactory))
+ .setSuccessor(FactoryType(new UnknownFrameFactory));
return first;
}
diff --git a/Framework/Geometry/src/MDGeometry/MDHistoDimensionBuilder.cpp b/Framework/Geometry/src/MDGeometry/MDHistoDimensionBuilder.cpp
index ff3e0a285710cd4ca25e5e43814d0ee7e86b89dd..57d5fe5db8f4bbf28690ef6b86199a55044ab14c 100644
--- a/Framework/Geometry/src/MDGeometry/MDHistoDimensionBuilder.cpp
+++ b/Framework/Geometry/src/MDGeometry/MDHistoDimensionBuilder.cpp
@@ -1,6 +1,7 @@
#include "MantidGeometry/MDGeometry/MDHistoDimensionBuilder.h"
#include "MantidKernel/Strings.h"
#include "MantidKernel/UnitLabelTypes.h"
+#include "MantidGeometry/MDGeometry/MDFrameFactory.h"
namespace Mantid {
namespace Geometry {
@@ -8,7 +9,7 @@ namespace Geometry {
/// Constructor
MDHistoDimensionBuilder::MDHistoDimensionBuilder()
: m_units(Kernel::Units::Symbol::EmptyLabel), m_min(0), m_max(0),
- m_nbins(0), m_minSet(false), m_maxSet(false) {}
+ m_nbins(0), m_minSet(false), m_maxSet(false), m_frameName("") {}
/// Destructor
MDHistoDimensionBuilder::~MDHistoDimensionBuilder() {}
@@ -38,6 +39,7 @@ operator=(const MDHistoDimensionBuilder &other) {
m_nbins = other.m_nbins;
m_maxSet = other.m_maxSet;
m_minSet = other.m_minSet;
+ m_frameName = other.m_frameName;
}
return *this;
}
@@ -89,6 +91,14 @@ Setter for the dimension nbins
*/
void MDHistoDimensionBuilder::setNumBins(size_t nbins) { m_nbins = nbins; }
+/**
+ * Setter for the frame name
+ * @param frameName: the frame name
+ */
+void MDHistoDimensionBuilder::setFrameName(std::string frameName) {
+ m_frameName = frameName;
+}
+
/*
Creational method
@return fully constructed MDHistoDimension instance.
@@ -122,7 +132,14 @@ MDHistoDimension *MDHistoDimensionBuilder::createRaw() {
throw std::invalid_argument(
"Cannot create MDHistogramDimension without setting a n bins.");
}
- return new MDHistoDimension(m_name, m_id, m_units, coord_t(m_min),
+
+ // Select a Mantid Frame. Use FrameName if available else just use name.
+ auto frameFactory = Mantid::Geometry::makeMDFrameFactoryChain();
+ std::string frameNameForFactory = m_frameName.empty() ? m_name : m_frameName;
+ Mantid::Geometry::MDFrameArgument frameArgument(frameNameForFactory, m_units);
+ auto frame = frameFactory->create(frameArgument);
+
+ return new MDHistoDimension(m_name, m_id, *frame, coord_t(m_min),
coord_t(m_max), m_nbins);
}
diff --git a/Framework/Geometry/src/MDGeometry/QLab.cpp b/Framework/Geometry/src/MDGeometry/QLab.cpp
index 175e33be054046a9caf47f0ac8d0089f45f612c9..b70e6d860ac1baebba088e19ca610fb3e4673280 100644
--- a/Framework/Geometry/src/MDGeometry/QLab.cpp
+++ b/Framework/Geometry/src/MDGeometry/QLab.cpp
@@ -35,5 +35,23 @@ std::string QLab::name() const { return QLab::QLabName; }
QLab *QLab::clone() const { return new QLab; }
+Mantid::Kernel::SpecialCoordinateSystem
+QLab::equivalientSpecialCoordinateSystem() const {
+ return Mantid::Kernel::SpecialCoordinateSystem::QLab;
+}
+
+bool QLab::isQ() const { return true; }
+
+bool QLab::isSameType(const MDFrame &frame) const {
+ auto isSameType = true;
+ try {
+ const auto &tmp = dynamic_cast<const QLab &>(frame);
+ UNUSED_ARG(tmp);
+ } catch (std::bad_cast &) {
+ isSameType = false;
+ }
+ return isSameType;
+}
+
} // namespace Geometry
} // namespace Mantid
diff --git a/Framework/Geometry/src/MDGeometry/QSample.cpp b/Framework/Geometry/src/MDGeometry/QSample.cpp
index 6caae639b54768a82c3ddd6004101da9ef6a868f..877c93cd921ad9a8b40a8acc64c75515c12cd565 100644
--- a/Framework/Geometry/src/MDGeometry/QSample.cpp
+++ b/Framework/Geometry/src/MDGeometry/QSample.cpp
@@ -30,5 +30,23 @@ std::string QSample::name() const { return QSampleName; }
QSample *QSample::clone() const { return new QSample; }
+Mantid::Kernel::SpecialCoordinateSystem
+QSample::equivalientSpecialCoordinateSystem() const {
+ return Mantid::Kernel::SpecialCoordinateSystem::QSample;
+}
+
+bool QSample::isQ() const { return true; }
+
+bool QSample::isSameType(const MDFrame &frame) const {
+ auto isSameType = true;
+ try {
+ const auto &tmp = dynamic_cast<const QSample &>(frame);
+ UNUSED_ARG(tmp);
+ } catch (std::bad_cast &) {
+ isSameType = false;
+ }
+ return isSameType;
+}
+
} // namespace Geometry
} // namespace Mantid
diff --git a/Framework/Geometry/src/MDGeometry/UnknownFrame.cpp b/Framework/Geometry/src/MDGeometry/UnknownFrame.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..886232831a3ffd8462561737bf43619ea93e91e8
--- /dev/null
+++ b/Framework/Geometry/src/MDGeometry/UnknownFrame.cpp
@@ -0,0 +1,52 @@
+#include "MantidGeometry/MDGeometry/UnknownFrame.h"
+
+namespace Mantid {
+namespace Geometry {
+
+UnknownFrame::UnknownFrame(std::unique_ptr<Kernel::MDUnit> unit)
+ : m_unit(unit.release()) {}
+
+UnknownFrame::UnknownFrame(const Kernel::UnitLabel &unit)
+ : m_unit(new Mantid::Kernel::LabelUnit(unit)) {}
+
+UnknownFrame::~UnknownFrame() {}
+
+const std::string UnknownFrame::UnknownFrameName = "Unknown frame";
+
+bool UnknownFrame::canConvertTo(const Mantid::Kernel::MDUnit &) const {
+ return false; // Cannot convert since it is unknown
+}
+
+std::string UnknownFrame::name() const { return UnknownFrameName; }
+
+Mantid::Kernel::UnitLabel UnknownFrame::getUnitLabel() const {
+ return m_unit->getUnitLabel();
+}
+
+const Mantid::Kernel::MDUnit &UnknownFrame::getMDUnit() const {
+ return *m_unit;
+}
+
+Mantid::Kernel::SpecialCoordinateSystem
+UnknownFrame::equivalientSpecialCoordinateSystem() const {
+ return Mantid::Kernel::SpecialCoordinateSystem::None;
+}
+
+UnknownFrame *UnknownFrame::clone() const {
+ return new UnknownFrame(std::unique_ptr<Kernel::MDUnit>(m_unit->clone()));
+}
+
+bool UnknownFrame::isQ() const { return false; }
+
+bool UnknownFrame::isSameType(const MDFrame &frame) const {
+ auto isSameType = true;
+ try {
+ const auto &tmp = dynamic_cast<const UnknownFrame &>(frame);
+ UNUSED_ARG(tmp);
+ } catch (std::bad_cast &) {
+ isSameType = false;
+ }
+ return isSameType;
+}
+}
+}
diff --git a/Framework/Geometry/src/Objects/RuleItems.cpp b/Framework/Geometry/src/Objects/RuleItems.cpp
index 505fda685eefb8cb1668c676c0785172bb42886c..30e7042d782ebfe704a9215dd657cadcc6063579 100644
--- a/Framework/Geometry/src/Objects/RuleItems.cpp
+++ b/Framework/Geometry/src/Objects/RuleItems.cpp
@@ -22,6 +22,32 @@
#include "MantidGeometry/Objects/Rules.h"
#include "MantidGeometry/Objects/Object.h"
+#ifdef ENABLE_OPENCASCADE
+// Opencascade defines _USE_MATH_DEFINES without checking whether it is already
+// used.
+// Undefine it here before we include the headers to avoid a warning
+#ifdef _MSC_VER
+#undef _USE_MATH_DEFINES
+#ifdef M_SQRT1_2
+#undef M_SQRT1_2
+#endif
+#endif
+
+#include "MantidKernel/WarningSuppressions.h"
+GCC_DIAG_OFF(conversion)
+// clang-format off
+GCC_DIAG_OFF(cast-qual)
+// clang-format on
+#include <TopoDS_Shape.hxx>
+#include <BRepAlgoAPI_Common.hxx>
+#include <BRepAlgoAPI_Fuse.hxx>
+#include <BRepPrimAPI_MakeBox.hxx>
+GCC_DIAG_ON(conversion)
+// clang-format off
+GCC_DIAG_ON(cast-qual)
+// clang-format on
+#endif
+
namespace Mantid {
namespace Geometry {
@@ -334,6 +360,19 @@ void Intersection::getBoundingBox(double &xmax, double &ymax, double &zmax,
zmin = (Azmin > Bzmin) ? Azmin : Bzmin;
}
+#ifdef ENABLE_OPENCASCADE
+/**
+* Analyze intersection
+* @return the resulting TopoDS_Shape
+*/
+TopoDS_Shape Intersection::analyze() {
+ TopoDS_Shape left = A->analyze();
+ TopoDS_Shape right = B->analyze();
+ BRepAlgoAPI_Common comm(left, right);
+ return comm.Shape();
+}
+#endif
+
// -------------------------------------------------------------
// UNION
//---------------------------------------------------------------
@@ -643,12 +682,22 @@ void Union::getBoundingBox(double &xmax, double &ymax, double &zmax,
zmax = (Azmax > Bzmax) ? Azmax : Bzmax;
zmin = (Azmin < Bzmin) ? Azmin : Bzmin;
}
+
+#ifdef ENABLE_OPENCASCADE
+TopoDS_Shape Union::analyze() {
+ TopoDS_Shape left = A->analyze();
+ TopoDS_Shape right = B->analyze();
+ BRepAlgoAPI_Fuse fuse(left, right);
+ return fuse.Shape();
+}
+#endif
+
// -------------------------------------------------------------
// SURF KEYS
//---------------------------------------------------------------
SurfPoint::SurfPoint()
- : Rule(), key(0), keyN(0), sign(1)
+ : Rule(), key(NULL), keyN(0), sign(1)
/**
Constructor with null key/number
*/
@@ -937,6 +986,22 @@ void SurfPoint::getBoundingBox(double &xmax, double &ymax, double &zmax,
}
}
}
+
+#ifdef ENABLE_OPENCASCADE
+TopoDS_Shape SurfPoint::analyze() {
+ // Check for individual type of surfaces
+ TopoDS_Shape Result = key->createShape();
+ if (sign > 0)
+ Result.Complement();
+ if (key->className() == "Plane") {
+ // build a box
+ gp_Pnt p(-1000.0, -1000.0, -1000.0);
+ TopoDS_Shape world = BRepPrimAPI_MakeBox(p, 2000.0, 2000.0, 2000.0).Shape();
+ return BRepAlgoAPI_Common(world, Result);
+ }
+ return Result;
+}
+#endif
//----------------------------------------
// COMPOBJ
//----------------------------------------
@@ -1222,6 +1287,13 @@ void CompObj::getBoundingBox(double &xmax, double &ymax, double &zmax,
}
}
+#ifdef ENABLE_OPENCASCADE
+TopoDS_Shape CompObj::analyze() {
+ TopoDS_Shape Result = const_cast<Rule *>(key->topRule())->analyze();
+ Result.Complement();
+ return Result;
+}
+#endif
// -----------------------------------------------
// BOOLVALUE
// -----------------------------------------------
@@ -1681,6 +1753,15 @@ void CompGrp::getBoundingBox(double &xmax, double &ymax, double &zmax,
}
}
+#ifdef ENABLE_OPENCASCADE
+TopoDS_Shape CompGrp::analyze() {
+ TopoDS_Shape Result = A->analyze();
+ Result.Complement();
+ return Result;
+}
+
+TopoDS_Shape BoolValue::analyze() { return TopoDS_Shape(); }
+#endif
} // NAMESPACE Geometry
} // NAMESPACE Mantid
diff --git a/Framework/Geometry/src/Rendering/OCGeometryGenerator.cpp b/Framework/Geometry/src/Rendering/OCGeometryGenerator.cpp
index f9bf1df320cdb5e74449782f6284a90627a66fa4..f055b9505caaf016ca81c5bd9a69b28f030d3911 100644
--- a/Framework/Geometry/src/Rendering/OCGeometryGenerator.cpp
+++ b/Framework/Geometry/src/Rendering/OCGeometryGenerator.cpp
@@ -50,12 +50,7 @@ GCC_DIAG_OFF(cast-qual)
#include <BRepAlgoAPI_Fuse.hxx>
#include <BRepAlgoAPI_Common.hxx>
#include <BRepAlgoAPI_Cut.hxx>
-#include <BRepPrimAPI_MakeHalfSpace.hxx>
-#include <BRepPrimAPI_MakeSphere.hxx>
#include <BRepPrimAPI_MakeBox.hxx>
-#include <BRepPrimAPI_MakeCylinder.hxx>
-#include <BRepPrimAPI_MakeCone.hxx>
-#include <BRepBuilderAPI_MakeFace.hxx>
#include <BRepBuilderAPI_Transform.hxx>
#include <BRep_Tool.hxx>
#include <Poly_Triangulation.hxx>
@@ -104,11 +99,6 @@ OCGeometryGenerator::~OCGeometryGenerator() {
}
}
-/**
-* Returns the shape generated.
-*/
-TopoDS_Shape *OCGeometryGenerator::getObjectSurface() { return ObjSurface; }
-
/**
* Analyzes the rule tree in object and creates a Topology Shape
*/
@@ -122,7 +112,7 @@ void OCGeometryGenerator::AnalyzeObject() {
return;
}
// Traverse through Rule
- TopoDS_Shape Result = AnalyzeRule(const_cast<Rule *>(top));
+ TopoDS_Shape Result = const_cast<Rule *>(top)->analyze();
try {
ObjSurface = new TopoDS_Shape(Result);
BRepMesh_IncrementalMesh(Result, 0.001);
@@ -131,160 +121,11 @@ void OCGeometryGenerator::AnalyzeObject() {
}
}
}
+
/**
-* Analyze intersection
-* @return the resulting TopoDS_Shape
+* Returns the shape generated.
*/
-TopoDS_Shape OCGeometryGenerator::AnalyzeRule(Intersection *rule) {
- TopoDS_Shape left = AnalyzeRule(rule->leaf(0));
- TopoDS_Shape right = AnalyzeRule(rule->leaf(1));
- // TopoDS_Shape Result=BRepAlgoAPI_Common(left,right);
- BRepAlgoAPI_Common comm(left, right);
- TopoDS_Shape Result = comm.Shape();
- // std::cerr << "Intersection status " << comm.ErrorStatus() << std::endl;
- return Result;
-}
-TopoDS_Shape OCGeometryGenerator::AnalyzeRule(Union *rule) {
- TopoDS_Shape left = AnalyzeRule(rule->leaf(0));
- TopoDS_Shape right = AnalyzeRule(rule->leaf(1));
- // TopoDS_Shape Result=BRepAlgoAPI_Fuse(left,right);
- BRepAlgoAPI_Fuse fuse(left, right);
- TopoDS_Shape Result = fuse.Shape();
- return Result;
-}
-TopoDS_Shape OCGeometryGenerator::AnalyzeRule(SurfPoint *rule) {
- // Check for individual type of surfaces
- Surface *surf = rule->getKey();
- TopoDS_Shape Result = CreateShape(surf, rule->getSign());
- if (rule->getSign() > 0 && surf->className() != "Plane")
- Result.Complement();
- return Result;
-}
-TopoDS_Shape OCGeometryGenerator::AnalyzeRule(CompGrp *rule) {
- TopoDS_Shape Result = AnalyzeRule(rule->leaf(0));
- Result.Complement();
- return Result;
-}
-TopoDS_Shape OCGeometryGenerator::AnalyzeRule(CompObj *rule) {
- Object *obj = rule->getObj();
- TopoDS_Shape Result = AnalyzeRule(const_cast<Rule *>(obj->topRule()));
- Result.Complement();
- return Result;
-}
-TopoDS_Shape OCGeometryGenerator::AnalyzeRule(BoolValue *rule) {
- (void)rule; // Avoid compiler warning
- return TopoDS_Shape();
-}
-TopoDS_Shape OCGeometryGenerator::AnalyzeRule(Rule *rule) {
- if (rule == NULL)
- return TopoDS_Shape();
- if (rule->className() == "Intersection") {
- return AnalyzeRule((Intersection *)rule);
- } else if (rule->className() == "Union") {
- return AnalyzeRule((Union *)rule);
- } else if (rule->className() == "SurfPoint") {
- return AnalyzeRule((SurfPoint *)rule);
- } else if (rule->className() == "CompGrp") {
- return AnalyzeRule((CompGrp *)rule);
- } else if (rule->className() == "CompObj") {
- return AnalyzeRule((CompObj *)rule);
- } else if (rule->className() == "BoolValue") {
- return AnalyzeRule((BoolValue *)rule);
- }
- return TopoDS_Shape();
-}
-
-TopoDS_Shape OCGeometryGenerator::CreateShape(Surface *surf, int orientation) {
- // Check for the type of the surface object
- if (surf->className() == "Sphere") {
- return CreateSphere((Sphere *)surf);
- } else if (surf->className() == "Cone") {
- return CreateCone((Cone *)surf);
- } else if (surf->className() == "Cylinder") {
- return CreateCylinder((Cylinder *)surf);
- } else if (surf->className() == "Plane") {
- return CreatePlane((Plane *)surf, orientation);
- } else if (surf->className() == "Torus") {
- return CreateTorus((Torus *)surf);
- }
- return TopoDS_Shape();
-}
-TopoDS_Shape OCGeometryGenerator::CreateSphere(Sphere *sphere) {
- // Get the center to Sphere, Radius
- V3D center = sphere->getCentre();
- double radius = sphere->getRadius();
- TopoDS_Shape shape = BRepPrimAPI_MakeSphere(radius).Shape();
- gp_Trsf T;
- gp_Vec v(center[0], center[1], center[2]);
- T.SetTranslation(v);
- BRepBuilderAPI_Transform move(T);
- move.Perform(shape);
- return move.Shape();
-}
-TopoDS_Shape OCGeometryGenerator::CreateCylinder(Cylinder *cylinder) {
- // Get the Cylinder Centre,Normal,Radius
- V3D center = cylinder->getCentre();
- V3D axis = cylinder->getNormal();
- double radius = cylinder->getRadius();
- center[0] = center[0] - axis[0] * 500;
- center[1] = center[1] - axis[1] * 500;
- center[2] = center[2] - axis[2] * 500;
- gp_Ax2 gpA(gp_Pnt(center[0], center[1], center[2]),
- gp_Dir(axis[0], axis[1], axis[2]));
- TopoDS_Shape shape =
- BRepPrimAPI_MakeCylinder(gpA, radius, 1000, 2 * M_PI).Solid();
- return shape;
-}
-TopoDS_Shape OCGeometryGenerator::CreateCone(Cone *cone) {
- // Get the Cone Centre Normal Radius
- V3D center = cone->getCentre();
- V3D axis = cone->getNormal();
- double angle = cone->getCosAngle();
- gp_Ax2 gpA(gp_Pnt(center[0], center[1], center[2]),
- gp_Dir(axis[0], axis[1], axis[2]));
- TopoDS_Shape shape =
- BRepPrimAPI_MakeCone(gpA, 0, 1000 / tan(acos(angle * M_PI / 180.0)), 1000,
- 2 * M_PI).Shape();
- return shape;
-}
-TopoDS_Shape OCGeometryGenerator::CreatePlane(Plane *plane, int orientation) {
- // Get Plane normal and distance.
- V3D normal = plane->getNormal();
- double norm2 = normal.norm2();
- if (norm2 == 0.0) {
- throw std::runtime_error("Cannot create a plane with zero normal");
- }
- double distance = plane->getDistance();
- // Find point closest to origin
- double t = distance / norm2;
- // Create Half Space
- TopoDS_Shape Result;
- if (orientation > 0) {
- TopoDS_Face P =
- BRepBuilderAPI_MakeFace(
- gp_Pln(normal[0], normal[1], normal[2], -distance)).Face();
- Result = BRepPrimAPI_MakeHalfSpace(P, gp_Pnt(normal[0] * (1 + t),
- normal[1] * (1 + t),
- normal[2] * (1 + t))).Solid();
- } else {
- TopoDS_Face P =
- BRepBuilderAPI_MakeFace(
- gp_Pln(normal[0], normal[1], normal[2], -distance)).Face();
- P.Reverse();
- Result = BRepPrimAPI_MakeHalfSpace(P, gp_Pnt(normal[0] * (1 + t),
- normal[1] * (1 + t),
- normal[2] * (1 + t))).Solid();
- }
- // create a box
- gp_Pnt p(-1000.0, -1000.0, -1000.0);
- TopoDS_Shape world = BRepPrimAPI_MakeBox(p, 2000.0, 2000.0, 2000.0).Shape();
- Result = BRepAlgoAPI_Common(world, Result);
- return Result;
-}
-TopoDS_Shape OCGeometryGenerator::CreateTorus(Torus *) {
- // NOTE:: Not yet implemented
- return TopoDS_Shape();
-}
+TopoDS_Shape *OCGeometryGenerator::getObjectSurface() { return ObjSurface; }
int OCGeometryGenerator::getNumberOfTriangles() {
int countFace = 0;
diff --git a/Framework/Geometry/src/Surfaces/Cone.cpp b/Framework/Geometry/src/Surfaces/Cone.cpp
index c584fe7daf6219fe6c88706a00f36312d92aebb7..2109cb0c6c01ee0eb722d99c9bb75e439a6fc112 100644
--- a/Framework/Geometry/src/Surfaces/Cone.cpp
+++ b/Framework/Geometry/src/Surfaces/Cone.cpp
@@ -19,6 +19,29 @@
#include "MantidGeometry/Surfaces/Quadratic.h"
#include "MantidGeometry/Surfaces/Cone.h"
+#ifdef ENABLE_OPENCASCADE
+// Opencascade defines _USE_MATH_DEFINES without checking whether it is already
+// used.
+// Undefine it here before we include the headers to avoid a warning
+#ifdef _MSC_VER
+#undef _USE_MATH_DEFINES
+#ifdef M_SQRT1_2
+#undef M_SQRT1_2
+#endif
+#endif
+
+#include "MantidKernel/WarningSuppressions.h"
+GCC_DIAG_OFF(conversion)
+// clang-format off
+GCC_DIAG_OFF(cast-qual)
+// clang-format on
+#include <BRepPrimAPI_MakeCone.hxx>
+GCC_DIAG_ON(conversion)
+// clang-format off
+GCC_DIAG_ON(cast-qual)
+// clang-format on
+#endif
+
namespace Mantid {
namespace Geometry {
@@ -99,9 +122,10 @@ int Cone::setSurface(const std::string &Pstr)
return -1;
// Cones on X/Y/Z axis
- const int itemPt((item[1] == '/' && item.length() == 3) ? 2 : 1);
- const int ptype = static_cast<int>(tolower(item[itemPt]) - 'x');
- if (ptype < 0 || ptype >= 3)
+ const std::size_t itemPt((item[1] == '/' && item.length() == 3) ? 2 : 1);
+ const std::size_t ptype =
+ static_cast<std::size_t>(tolower(item[itemPt]) - 'x');
+ if (ptype >= 3)
return -2;
std::vector<double> norm(3, 0.0);
std::vector<double> cent(3, 0.0);
@@ -112,7 +136,7 @@ int Cone::setSurface(const std::string &Pstr)
if (!Mantid::Kernel::Strings::section(Line, cent[ptype]))
return -3;
} else {
- int index;
+ std::size_t index;
for (index = 0;
index < 3 && Mantid::Kernel::Strings::section(Line, cent[index]);
index++)
@@ -337,12 +361,13 @@ void Cone::write(std::ostream &OX) const
if (Cdir || Centre.nullVector(Tolerance)) {
cx << " k";
cx << Tailends[Ndir + 3] << " "; // set x,y,z based on Ndir
- cx << ((Cdir > 0) ? Centre[Cdir - 1] : Centre[-Cdir - 1]);
+ cx << ((Cdir > 0) ? Centre[static_cast<std::size_t>(Cdir - 1)]
+ : Centre[static_cast<std::size_t>(-Cdir - 1)]);
cx << " ";
} else {
cx << " k/";
cx << Tailends[Ndir + 3] << " "; // set x,y,z based on Ndir
- for (int i = 0; i < 3; i++)
+ for (std::size_t i = 0; i < 3; i++)
cx << Centre[i] << " ";
}
const double TA = tan((M_PI * alpha) / 180.0); // tan^2(angle)
@@ -404,6 +429,15 @@ void Cone::getBoundingBox(double &xmax, double &ymax, double &zmax,
}
}
+#ifdef ENABLE_OPENCASCADE
+TopoDS_Shape Cone::createShape() {
+ gp_Ax2 gpA(gp_Pnt(Centre[0], Centre[1], Centre[2]),
+ gp_Dir(Normal[0], Normal[1], Normal[2]));
+ return BRepPrimAPI_MakeCone(gpA, 0.0,
+ 1000.0 / tan(acos(cangle * M_PI / 180.0)), 1000.0,
+ 2.0 * M_PI).Shape();
+}
+#endif
} // NAMESPACE Geometry
} // NAMESPACE Mantid
diff --git a/Framework/Geometry/src/Surfaces/Cylinder.cpp b/Framework/Geometry/src/Surfaces/Cylinder.cpp
index 1499afecf17fb20cb0369e8cb29b7b09e1a76bf9..cec74b732efe23240d7126f9799fceaab6bb587d 100644
--- a/Framework/Geometry/src/Surfaces/Cylinder.cpp
+++ b/Framework/Geometry/src/Surfaces/Cylinder.cpp
@@ -5,6 +5,29 @@
#include <cfloat>
#include <iostream>
+#ifdef ENABLE_OPENCASCADE
+// Opencascade defines _USE_MATH_DEFINES without checking whether it is already
+// used.
+// Undefine it here before we include the headers to avoid a warning
+#ifdef _MSC_VER
+#undef _USE_MATH_DEFINES
+#ifdef M_SQRT1_2
+#undef M_SQRT1_2
+#endif
+#endif
+
+#include "MantidKernel/WarningSuppressions.h"
+GCC_DIAG_OFF(conversion)
+// clang-format off
+GCC_DIAG_OFF(cast-qual)
+// clang-format on
+#include <BRepPrimAPI_MakeCylinder.hxx>
+GCC_DIAG_ON(conversion)
+// clang-format off
+GCC_DIAG_ON(cast-qual)
+// clang-format on
+#endif
+
namespace Mantid {
namespace Geometry {
@@ -90,9 +113,10 @@ int Cylinder::setSurface(const std::string &Pstr)
return errDesc;
// Cylinders on X/Y/Z axis
- const int itemPt((item[1] == '/' && item.length() == 3) ? 2 : 1);
- const int ptype = static_cast<int>(tolower(item[itemPt]) - 'x');
- if (ptype < 0 || ptype >= 3)
+ const std::size_t itemPt((item[1] == '/' && item.length() == 3) ? 2 : 1);
+ const std::size_t ptype =
+ static_cast<std::size_t>(tolower(item[itemPt]) - 'x');
+ if (ptype >= 3)
return errAxis;
std::vector<double> norm(3, 0.0);
std::vector<double> cent(3, 0.0);
@@ -100,7 +124,7 @@ int Cylinder::setSurface(const std::string &Pstr)
if (itemPt != 1) {
// get the other two coordinates
- int index((!ptype) ? 1 : 0);
+ std::size_t index((!ptype) ? 1 : 0);
while (index < 3 && Mantid::Kernel::Strings::section(Line, cent[index])) {
index++;
if (index == ptype)
@@ -179,7 +203,7 @@ void Cylinder::setNvec()
*/
{
Nvec = 0;
- for (int i = 0; i < 3; i++) {
+ for (std::size_t i = 0; i < 3; i++) {
if (fabs(Normal[i]) > (1.0 - Tolerance)) {
Nvec = i + 1;
return;
@@ -445,6 +469,16 @@ void Cylinder::getBoundingBox(double &xmax, double &ymax, double &zmax,
}
}
+#ifdef ENABLE_OPENCASCADE
+TopoDS_Shape Cylinder::createShape() {
+ gp_Pnt center;
+ center.SetX(Centre[0] - Normal[0] * 500.0);
+ center.SetY(Centre[1] - Normal[1] * 500.0);
+ center.SetZ(Centre[2] - Normal[2] * 500.0);
+ gp_Ax2 gpA(center, gp_Dir(Normal[0], Normal[1], Normal[2]));
+ return BRepPrimAPI_MakeCylinder(gpA, Radius, 1000.0, 2.0 * M_PI).Solid();
+}
+#endif
} // NAMESPACE MonteCarlo
} // NAMESPACE Mantid
diff --git a/Framework/Geometry/src/Surfaces/Plane.cpp b/Framework/Geometry/src/Surfaces/Plane.cpp
index ab0865bd7fba1287a9f63cf5230eacf0f7c80c6a..8d00ff8f721214895c902804da9f18cfae669709 100644
--- a/Framework/Geometry/src/Surfaces/Plane.cpp
+++ b/Framework/Geometry/src/Surfaces/Plane.cpp
@@ -5,6 +5,33 @@
#include <cfloat>
#include <iostream>
+#ifdef ENABLE_OPENCASCADE
+// Opencascade defines _USE_MATH_DEFINES without checking whether it is already
+// used.
+// Undefine it here before we include the headers to avoid a warning
+#ifdef _MSC_VER
+#undef _USE_MATH_DEFINES
+#ifdef M_SQRT1_2
+#undef M_SQRT1_2
+#endif
+#endif
+
+#include "MantidKernel/WarningSuppressions.h"
+GCC_DIAG_OFF(conversion)
+// clang-format off
+GCC_DIAG_OFF(cast-qual)
+// clang-format on
+#include <BRepPrimAPI_MakeBox.hxx>
+#include <BRepBuilderAPI_MakeFace.hxx>
+#include <BRepPrimAPI_MakeHalfSpace.hxx>
+#include <BRepAlgoAPI_Common.hxx>
+#include <gp_Pln.hxx>
+GCC_DIAG_ON(conversion)
+// clang-format off
+GCC_DIAG_ON(cast-qual)
+// clang-format on
+#endif
+
namespace Mantid {
namespace Geometry {
@@ -233,7 +260,7 @@ void Plane::print() const
return;
}
-int Plane::planeType() const
+std::size_t Plane::planeType() const
/**
Find if the normal vector allows it to be a special
type of plane (x,y,z direction)
@@ -242,7 +269,7 @@ int Plane::planeType() const
@retval 0 :: general plane
*/
{
- for (int i = 0; i < 3; i++)
+ for (std::size_t i = 0; i < 3; i++)
if (fabs(NormV[i]) > (1.0 - Tolerance))
return i + 1;
return 0;
@@ -274,7 +301,7 @@ void Plane::write(std::ostream &OX) const {
std::ostringstream cx;
Surface::writeHeader(cx);
cx.precision(Surface::Nprecision);
- const int ptype = planeType();
+ const std::size_t ptype = planeType();
if (!ptype)
cx << "p " << NormV[0] << " " << NormV[1] << " " << NormV[2] << " " << Dist;
else if (NormV[ptype - 1] < 0)
@@ -413,6 +440,28 @@ void Plane::getBoundingBox(double &xmax, double &ymax, double &zmax,
}
}
+#ifdef ENABLE_OPENCASCADE
+TopoDS_Shape Plane::createShape() {
+ // Get Plane normal and distance.
+ V3D normal = this->getNormal();
+ double norm2 = normal.norm2();
+ if (norm2 == 0.0) {
+ throw std::runtime_error("Cannot create a plane with zero normal");
+ }
+ double distance = this->getDistance();
+ // Find point closest to origin
+ double t = distance / norm2;
+ // Create Half Space
+ TopoDS_Face P = BRepBuilderAPI_MakeFace(gp_Pln(normal[0], normal[1],
+ normal[2], -distance)).Face();
+
+ TopoDS_Shape Result = BRepPrimAPI_MakeHalfSpace(
+ P, gp_Pnt(normal[0] * (1 + t), normal[1] * (1 + t),
+ normal[2] * (1 + t))).Solid();
+ return Result.Complemented();
+}
+#endif
+
} // NAMESPACE MonteCarlo
} // NAMESPACE Mantid
diff --git a/Framework/Geometry/src/Surfaces/Sphere.cpp b/Framework/Geometry/src/Surfaces/Sphere.cpp
index 3d91184765508e3a902bb8952ddce86f03edcf48..ac66914e7c32fb31136f0c284310acf10ee222dc 100644
--- a/Framework/Geometry/src/Surfaces/Sphere.cpp
+++ b/Framework/Geometry/src/Surfaces/Sphere.cpp
@@ -2,6 +2,29 @@
#include "MantidKernel/Strings.h"
#include "MantidKernel/Tolerance.h"
+#ifdef ENABLE_OPENCASCADE
+// Opencascade defines _USE_MATH_DEFINES without checking whether it is already
+// used.
+// Undefine it here before we include the headers to avoid a warning
+#ifdef _MSC_VER
+#undef _USE_MATH_DEFINES
+#ifdef M_SQRT1_2
+#undef M_SQRT1_2
+#endif
+#endif
+
+#include "MantidKernel/WarningSuppressions.h"
+GCC_DIAG_OFF(conversion)
+// clang-format off
+GCC_DIAG_OFF(cast-qual)
+// clang-format on
+#include <BRepPrimAPI_MakeSphere.hxx>
+GCC_DIAG_ON(conversion)
+// clang-format off
+GCC_DIAG_ON(cast-qual)
+// clang-format on
+#endif
+
namespace Mantid {
namespace Geometry {
@@ -84,14 +107,15 @@ Valid input is:
if (item.length() == 2) // sx/sy/sz
{
if (tolower(item[1]) != 'o') {
- const int pType = static_cast<int>(tolower(item[1]) - 'x');
- if (pType < 0 || pType > 2)
+ const std::size_t pType =
+ static_cast<std::size_t>(tolower(item[1]) - 'x');
+ if (pType > 2)
return -3;
if (!Mantid::Kernel::Strings::section(Line, cent[pType]))
return -4;
}
} else if (item.length() == 1) {
- int index;
+ std::size_t index;
for (index = 0;
index < 3 && Mantid::Kernel::Strings::section(Line, cent[index]);
index++)
@@ -257,6 +281,13 @@ void Sphere::getBoundingBox(double &xmax, double &ymax, double &zmax,
zmin = Centre[2] - Radius;
}
+#ifdef ENABLE_OPENCASCADE
+TopoDS_Shape Sphere::createShape() {
+ return BRepPrimAPI_MakeSphere(gp_Pnt(Centre[0], Centre[1], Centre[2]), Radius)
+ .Shape();
+}
+#endif
+
} // NAMESPACE Geometry
} // NAMESPACE Mantid
diff --git a/Framework/Geometry/src/Surfaces/Surface.cpp b/Framework/Geometry/src/Surfaces/Surface.cpp
index 89fdaaec526fbd381f8391c206bbe4bcb68b08c4..adfb25b6e320b08642aa51a999e7a94a3930e5ee 100644
--- a/Framework/Geometry/src/Surfaces/Surface.cpp
+++ b/Framework/Geometry/src/Surfaces/Surface.cpp
@@ -20,6 +20,29 @@
#include "MantidGeometry/Surfaces/BaseVisit.h"
#include "MantidGeometry/Surfaces/Surface.h"
+#ifdef ENABLE_OPENCASCADE
+// Opencascade defines _USE_MATH_DEFINES without checking whether it is already
+// used.
+// Undefine it here before we include the headers to avoid a warning
+#ifdef _MSC_VER
+#undef _USE_MATH_DEFINES
+#ifdef M_SQRT1_2
+#undef M_SQRT1_2
+#endif
+#endif
+
+#include "MantidKernel/WarningSuppressions.h"
+GCC_DIAG_OFF(conversion)
+// clang-format off
+GCC_DIAG_OFF(cast-qual)
+// clang-format on
+#include <TopoDS_Shape.hxx>
+GCC_DIAG_ON(conversion)
+// clang-format off
+GCC_DIAG_ON(cast-qual)
+// clang-format on
+#endif
+
namespace Mantid {
namespace Geometry {
@@ -94,6 +117,9 @@ void Surface::write(std::ostream &out) const
throw Kernel::Exception::AbsObjMethod("Surface::write");
}
+#ifdef ENABLE_OPENCASCADE
+TopoDS_Shape Surface::createShape() { return TopoDS_Shape(); }
+#endif
} // NAMESPACE Geometry
} // NAMESPACE Mantid
diff --git a/Framework/Geometry/src/Surfaces/Torus.cpp b/Framework/Geometry/src/Surfaces/Torus.cpp
index 2f8ed1d860da8cd65e01d6f37e4e7664ff1aa4a8..d1e57c3d3dfcc00039f18ed091dc4769f63d2a15 100644
--- a/Framework/Geometry/src/Surfaces/Torus.cpp
+++ b/Framework/Geometry/src/Surfaces/Torus.cpp
@@ -18,6 +18,29 @@
#include "MantidGeometry/Surfaces/Surface.h"
#include "MantidGeometry/Surfaces/Torus.h"
+#ifdef ENABLE_OPENCASCADE
+// Opencascade defines _USE_MATH_DEFINES without checking whether it is already
+// used.
+// Undefine it here before we include the headers to avoid a warning
+#ifdef _MSC_VER
+#undef _USE_MATH_DEFINES
+#ifdef M_SQRT1_2
+#undef M_SQRT1_2
+#endif
+#endif
+
+#include "MantidKernel/WarningSuppressions.h"
+GCC_DIAG_OFF(conversion)
+// clang-format off
+GCC_DIAG_OFF(cast-qual)
+// clang-format on
+#include <TopoDS_Shape.hxx>
+GCC_DIAG_ON(conversion)
+// clang-format off
+GCC_DIAG_ON(cast-qual)
+// clang-format on
+#endif
+
namespace Mantid {
namespace Geometry {
@@ -148,8 +171,8 @@ int Torus::setSurface(const std::string &Pstr)
return errDesc;
// Torus on X/Y/Z axis
- const int ptype = static_cast<int>(tolower(item[2]) - 'x');
- if (ptype < 0 || ptype >= 3)
+ const std::size_t ptype = static_cast<std::size_t>(tolower(item[2]) - 'x');
+ if (ptype >= 3)
return errAxis;
Kernel::V3D Norm;
@@ -333,6 +356,13 @@ void Torus::setDistanceFromCentreToTube(double dist) { Iradius = dist; }
*/
void Torus::setTubeRadius(double dist) { Dradius = dist; }
+#ifdef ENABLE_OPENCASCADE
+TopoDS_Shape Torus::createShape() {
+ // NOTE:: Not yet implemented
+ return TopoDS_Shape();
+}
+#endif
+
} // NAMESPACE MonteCarlo
} // NAMESPACE Mantid
diff --git a/Framework/Geometry/test/GeneralFrameTest.h b/Framework/Geometry/test/GeneralFrameTest.h
index fbf4ee2d07624f8741ec02ebc8f51383698f4b59..32ed87bbe73e8ef9e266de26f1bbbe07786e3b44 100644
--- a/Framework/Geometry/test/GeneralFrameTest.h
+++ b/Framework/Geometry/test/GeneralFrameTest.h
@@ -21,6 +21,9 @@ public:
GeneralFrame frame("Temperature", "DegC");
TS_ASSERT_EQUALS("Temperature", frame.name());
TS_ASSERT_EQUALS(UnitLabel("DegC"), frame.getUnitLabel());
+ TSM_ASSERT_EQUALS("The equivalent special coordinate system should be None",
+ frame.equivalientSpecialCoordinateSystem(),
+ Mantid::Kernel::SpecialCoordinateSystem::None);
}
void test_string_unit_construction() {
diff --git a/Framework/Geometry/test/HKLTest.h b/Framework/Geometry/test/HKLTest.h
index 983632001603dca7cf29ffa4fd733ee4f856b68b..bb0c6dd6560a5b3dfbfd27aa79734b9d9af34162 100644
--- a/Framework/Geometry/test/HKLTest.h
+++ b/Framework/Geometry/test/HKLTest.h
@@ -37,6 +37,9 @@ public:
void test_name() {
HKL frame(new Mantid::Kernel::ReciprocalLatticeUnit);
TS_ASSERT_EQUALS(HKL::HKLName, frame.name());
+ TSM_ASSERT_EQUALS("The equivalent special coordinate system should be HKL",
+ frame.equivalientSpecialCoordinateSystem(),
+ Mantid::Kernel::SpecialCoordinateSystem::HKL);
}
};
diff --git a/Framework/Geometry/test/MDFrameFactoryTest.h b/Framework/Geometry/test/MDFrameFactoryTest.h
index 586309b4705a1250daa5ec255733c6beb660fa60..8032c178dd12009d7bb746ca43e6b3f58818285c 100644
--- a/Framework/Geometry/test/MDFrameFactoryTest.h
+++ b/Framework/Geometry/test/MDFrameFactoryTest.h
@@ -9,6 +9,7 @@
#include "MantidGeometry/MDGeometry/QLab.h"
#include "MantidGeometry/MDGeometry/QSample.h"
#include "MantidGeometry/MDGeometry/HKL.h"
+#include "MantidGeometry/MDGeometry/UnknownFrame.h"
#include "MantidKernel/UnitLabelTypes.h"
#include "MantidKernel/MDUnit.h"
@@ -65,7 +66,7 @@ public:
std::unique_ptr<MDFrame> product = factory.create(argument);
TSM_ASSERT("Should be creating a QLab frame",
- dynamic_cast<QLab *>(product.get()));
+ dynamic_cast<Mantid::Geometry::QLab *>(product.get()));
}
void test_QSampleFrameFactory() {
@@ -82,7 +83,7 @@ public:
std::unique_ptr<MDFrame> product = factory.create(argument);
TSM_ASSERT("Should be creating a QSample frame",
- dynamic_cast<QSample *>(product.get()));
+ dynamic_cast<Mantid::Geometry::QSample *>(product.get()));
}
void test_HKLFrameFactory_interpretation() {
@@ -103,6 +104,10 @@ public:
TSM_ASSERT("Should offer to produce HKL products",
factory.canInterpret(
MDFrameArgument(HKL::HKLName, Units::Symbol::RLU)));
+
+ TSM_ASSERT(
+ "Should offer to produce HKL products",
+ factory.canInterpret(MDFrameArgument(HKL::HKLName, "in 1.684 A^-1")));
}
void test_HKLFrameFactory_create_inverse_angstroms() {
@@ -112,7 +117,7 @@ public:
MDFrameArgument(HKL::HKLName, Units::Symbol::InverseAngstrom));
TSM_ASSERT("Should be creating a HKL frame, in inverse angstroms",
- dynamic_cast<HKL *>(product.get()));
+ dynamic_cast<Mantid::Geometry::HKL *>(product.get()));
TSM_ASSERT_EQUALS("Units carried across incorrectly",
Units::Symbol::InverseAngstrom, product->getUnitLabel());
@@ -124,7 +129,7 @@ public:
std::unique_ptr<MDFrame> product =
factory.create(MDFrameArgument(HKL::HKLName, Units::Symbol::RLU));
TSM_ASSERT("Should be creating a HKL frame, in rlu",
- dynamic_cast<HKL *>(product.get()));
+ dynamic_cast<Mantid::Geometry::HKL *>(product.get()));
TSM_ASSERT_EQUALS("Units carried across incorrectly", Units::Symbol::RLU,
product->getUnitLabel());
@@ -133,13 +138,15 @@ public:
void test_make_standard_chain() {
MDFrameFactory_uptr chain = makeMDFrameFactoryChain();
// Now lets try the chain of factories out
+ TS_ASSERT(dynamic_cast<UnknownFrame *>(
+ chain->create(MDFrameArgument(UnknownFrame::UnknownFrameName)).get()));
TS_ASSERT(dynamic_cast<GeneralFrame *>(
chain->create(MDFrameArgument("any_frame")).get()));
- TS_ASSERT(dynamic_cast<QLab *>(
+ TS_ASSERT(dynamic_cast<Mantid::Geometry::QLab *>(
chain->create(MDFrameArgument(QLab::QLabName)).get()));
- TS_ASSERT(dynamic_cast<QSample *>(
+ TS_ASSERT(dynamic_cast<Mantid::Geometry::QSample *>(
chain->create(MDFrameArgument(QSample::QSampleName)).get()));
- TS_ASSERT(dynamic_cast<HKL *>(
+ TS_ASSERT(dynamic_cast<Mantid::Geometry::HKL *>(
chain->create(MDFrameArgument(HKL::HKLName, Units::Symbol::RLU))
.get()));
}
diff --git a/Framework/Geometry/test/MDHistoDimensionBuilderTest.h b/Framework/Geometry/test/MDHistoDimensionBuilderTest.h
index 77fe43e78a57c170b9579349b51cdb0c3922c079..13c7af23a4dd91a575f58a079bfeb9459373e392 100644
--- a/Framework/Geometry/test/MDHistoDimensionBuilderTest.h
+++ b/Framework/Geometry/test/MDHistoDimensionBuilderTest.h
@@ -3,6 +3,8 @@
#include <cxxtest/TestSuite.h>
#include "MantidGeometry/MDGeometry/MDHistoDimensionBuilder.h"
+#include "MantidGeometry/MDGeometry/QLab.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
using Mantid::Geometry::MDHistoDimension;
using Mantid::Geometry::MDHistoDimensionBuilder;
@@ -18,15 +20,21 @@ public:
builder.setMin(0);
builder.setMax(2);
builder.setNumBins(1);
+ builder.setFrameName("QLab");
MDHistoDimension *product = builder.createRaw();
TS_ASSERT_EQUALS("testDimName", product->getName());
TS_ASSERT_EQUALS("testDimId", product->getDimensionId());
- TS_ASSERT_EQUALS("A^-1", product->getUnits().ascii());
+ Mantid::Kernel::InverseAngstromsUnit expectedUnit;
+ TS_ASSERT_EQUALS(expectedUnit.getUnitLabel(), product->getUnits().ascii());
TS_ASSERT_EQUALS(0, product->getMinimum());
TS_ASSERT_EQUALS(2, product->getMaximum());
TS_ASSERT_EQUALS(1, product->getNBins());
+ TSM_ASSERT_EQUALS("Should have selected QLab as the frame",
+ Mantid::Geometry::QLab::QLabName,
+ product->getMDFrame().name());
+
delete product;
}
@@ -38,15 +46,42 @@ public:
builder.setMin(0);
builder.setMax(2);
builder.setNumBins(1);
+ builder.setFrameName("QSample");
+
+ IMDDimension_sptr product;
+ TS_ASSERT_THROWS_NOTHING(product = builder.create());
+ TS_ASSERT_EQUALS("testDimName", product->getName());
+ TS_ASSERT_EQUALS("testDimId", product->getDimensionId());
+ Mantid::Kernel::InverseAngstromsUnit expectedUnit;
+ TS_ASSERT_EQUALS(expectedUnit.getUnitLabel(), product->getUnits().ascii());
+ TS_ASSERT_EQUALS(0, product->getMinimum());
+ TS_ASSERT_EQUALS(2, product->getMaximum());
+ TS_ASSERT_EQUALS(1, product->getNBins());
+ TSM_ASSERT_EQUALS("Should have selected QSample as the frame",
+ Mantid::Geometry::QSample::QSampleName,
+ product->getMDFrame().name());
+ }
+
+ void testConstruct_without_frame_name() {
+ MDHistoDimensionBuilder builder;
+ builder.setName("testDimName");
+ builder.setId("testDimId");
+ builder.setUnits("A^-1");
+ builder.setMin(0);
+ builder.setMax(2);
+ builder.setNumBins(1);
IMDDimension_sptr product;
TS_ASSERT_THROWS_NOTHING(product = builder.create());
TS_ASSERT_EQUALS("testDimName", product->getName());
TS_ASSERT_EQUALS("testDimId", product->getDimensionId());
- TS_ASSERT_EQUALS("A^-1", product->getUnits().ascii());
+ Mantid::Kernel::InverseAngstromsUnit expectedUnit;
+ TS_ASSERT_EQUALS(expectedUnit.getUnitLabel(), product->getUnits().ascii());
TS_ASSERT_EQUALS(0, product->getMinimum());
TS_ASSERT_EQUALS(2, product->getMaximum());
TS_ASSERT_EQUALS(1, product->getNBins());
+ TSM_ASSERT_EQUALS("Should have selected GeneralFrame as the frame",
+ "testDimName", product->getMDFrame().name());
}
void testCopy() {
diff --git a/Framework/Geometry/test/MDHistoDimensionTest.h b/Framework/Geometry/test/MDHistoDimensionTest.h
index f6dca8e74baeeebf6aeb7b03aec7c71b1cc1d11c..9b0a4220ce8b3297dd0b829350226660a021550f 100644
--- a/Framework/Geometry/test/MDHistoDimensionTest.h
+++ b/Framework/Geometry/test/MDHistoDimensionTest.h
@@ -16,13 +16,15 @@ public:
void test_constructor_throws() {
coord_t min = 10;
coord_t max = 1; // min > max !
+ Mantid::Geometry::GeneralFrame frame("My General Frame", "Furlongs");
TSM_ASSERT_THROWS("Should throw if min > max!",
- MDHistoDimension("name", "id", "Furlongs", min, max, 15),
+ MDHistoDimension("name", "id", frame, min, max, 15),
std::invalid_argument);
}
void test_constructor() {
- MDHistoDimension d("name", "id", "Furlongs", -10, 20.0, 15);
+ Mantid::Geometry::GeneralFrame frame("My General Frame", "Furlongs");
+ MDHistoDimension d("name", "id", frame, -10, 20.0, 15);
TS_ASSERT_EQUALS(d.getName(), "name");
TS_ASSERT_EQUALS(d.getDimensionId(), "id");
TS_ASSERT_EQUALS(d.getUnits(), "Furlongs");
@@ -35,14 +37,14 @@ public:
void test_toXMLStringIntegrated() {
std::string expectedXML =
std::string("<Dimension ID=\"id\">") + "<Name>name</Name>" +
- "<Units>Furlongs</Units>" + "<Frame>Unknown frame</Frame>" +
+ "<Units>Furlongs</Units>" + "<Frame>My General Frame</Frame>" +
"<UpperBounds>20.0000</UpperBounds>" +
"<LowerBounds>-10.0000</LowerBounds>" +
"<NumberOfBins>1</NumberOfBins>" + "<Integrated>" +
"<UpperLimit>20.0000</UpperLimit>" +
"<LowerLimit>-10.0000</LowerLimit>" + "</Integrated>" + "</Dimension>";
-
- MDHistoDimension dimension("name", "id", "Furlongs", -10, 20.0, 1);
+ Mantid::Geometry::GeneralFrame frame("My General Frame", "Furlongs");
+ MDHistoDimension dimension("name", "id", frame, -10, 20.0, 1);
std::string actualXML = dimension.toXMLString();
TS_ASSERT_EQUALS(expectedXML, actualXML);
}
@@ -50,20 +52,20 @@ public:
void test_toXMLStringNotIntegrated() {
std::string expectedXML =
std::string("<Dimension ID=\"id\">") + "<Name>name</Name>" +
- "<Units>Furlongs</Units>" + "<Frame>Unknown frame</Frame>" +
+ "<Units>Furlongs</Units>" + "<Frame>My General Frame</Frame>" +
"<UpperBounds>20.0000</UpperBounds>" +
"<LowerBounds>-10.0000</LowerBounds>" +
"<NumberOfBins>15</NumberOfBins>" + "</Dimension>";
-
- MDHistoDimension dimension("name", "id", "Furlongs", -10, 20.0, 15);
+ Mantid::Geometry::GeneralFrame frame("My General Frame", "Furlongs");
+ MDHistoDimension dimension("name", "id", frame, -10, 20.0, 15);
std::string actualXML = dimension.toXMLString();
TS_ASSERT_EQUALS(expectedXML, actualXML);
}
void test_getMDUnits_gives_label_unit() {
-
Kernel::UnitLabel unitLabel("Meters");
- MDHistoDimension dimension("Distance", "Dist", unitLabel, 0, 10, 1);
+ Mantid::Geometry::GeneralFrame frame("Length", unitLabel);
+ MDHistoDimension dimension("Distance", "Dist", frame, 0, 10, 1);
const Mantid::Kernel::MDUnit &unit = dimension.getMDUnits();
TS_ASSERT_EQUALS(unit.getUnitLabel(), unitLabel);
TS_ASSERT(dynamic_cast<const Mantid::Kernel::LabelUnit *>(&unit));
diff --git a/Framework/Geometry/test/NearestNeighboursTest.h b/Framework/Geometry/test/NearestNeighboursTest.h
index bc5edf2e2bfba979fade85e2c20e5a2ca1e212e0..e4d3ad1879a6690f9540100024563dea2a28ada5 100644
--- a/Framework/Geometry/test/NearestNeighboursTest.h
+++ b/Framework/Geometry/test/NearestNeighboursTest.h
@@ -27,7 +27,7 @@ class NearestNeighboursTest : public CxxTest::TestSuite {
public:
static ISpectrumDetectorMapping
buildSpectrumDetectorMapping(const specid_t start, const specid_t end) {
- boost::unordered_map<specid_t, std::set<detid_t>> map;
+ std::unordered_map<specid_t, std::set<detid_t>> map;
for (specid_t i = start; i <= end; ++i) {
map[i].insert(i);
}
diff --git a/Framework/Geometry/test/QLabTest.h b/Framework/Geometry/test/QLabTest.h
index 9064e2fe7547505116cece94470f5acf921418b5..818b837c9985f41ee619bc5f8086253454261ae4 100644
--- a/Framework/Geometry/test/QLabTest.h
+++ b/Framework/Geometry/test/QLabTest.h
@@ -17,21 +17,24 @@ public:
static void destroySuite(QLabTest *suite) { delete suite; }
void test_name() {
- QLab frame;
+ Mantid::Geometry::QLab frame;
TS_ASSERT_EQUALS(QLab::QLabName, frame.name());
}
void test_canConvertTo_unit() {
- QLab frame;
+ Mantid::Geometry::QLab frame;
InverseAngstromsUnit unit;
TSM_ASSERT("Same unit type as is used for QLab", frame.canConvertTo(unit));
}
void test_cannotConvertTo_unit() {
- QLab frame;
+ Mantid::Geometry::QLab frame;
ReciprocalLatticeUnit unit;
TSM_ASSERT("Not same unit type as is used for QLab",
!frame.canConvertTo(unit));
+ TSM_ASSERT_EQUALS("The equivalent special coordinate system should be QLab",
+ frame.equivalientSpecialCoordinateSystem(),
+ Mantid::Kernel::SpecialCoordinateSystem::QLab);
}
};
diff --git a/Framework/Geometry/test/QSampleTest.h b/Framework/Geometry/test/QSampleTest.h
index 1af8015d3afa10df303802ed273b31597bd79808..dd6b326c6ea92ad7f7bc8674e9a97b26f92a45dc 100644
--- a/Framework/Geometry/test/QSampleTest.h
+++ b/Framework/Geometry/test/QSampleTest.h
@@ -17,21 +17,25 @@ public:
static void destroySuite(QSampleTest *suite) { delete suite; }
void test_name() {
- QSample frame;
+ Mantid::Geometry::QSample frame;
TS_ASSERT_EQUALS(QSample::QSampleName, frame.name());
}
void test_canConvertTo_unit() {
- QSample frame;
+ Mantid::Geometry::QSample frame;
InverseAngstromsUnit unit;
TSM_ASSERT("Same unit type as is used for QLab", frame.canConvertTo(unit));
}
void test_cannotConvertTo_unit() {
- QSample frame;
+ Mantid::Geometry::QSample frame;
ReciprocalLatticeUnit unit;
TSM_ASSERT("Not same unit type as is used for QLab",
!frame.canConvertTo(unit));
+ TSM_ASSERT_EQUALS(
+ "The equivalent special coordinate system should be QSample",
+ frame.equivalientSpecialCoordinateSystem(),
+ Mantid::Kernel::SpecialCoordinateSystem::QSample);
}
};
diff --git a/Framework/ICat/CMakeLists.txt b/Framework/ICat/CMakeLists.txt
index 3d0a1da104b6adb77648393c20a0635134f963f0..c1f9016ca290e2a399d99b935d5c8955e0288869 100644
--- a/Framework/ICat/CMakeLists.txt
+++ b/Framework/ICat/CMakeLists.txt
@@ -98,7 +98,7 @@ set_property ( TARGET ICat PROPERTY FOLDER "MantidFramework" )
include_directories ( inc )
-target_link_libraries ( ICat LINK_PRIVATE ${TCMALLOC_LIBRARIES_LINKTIME} ${MANTIDLIBS} ${OPENSSL_LIBRARIES} )
+target_link_libraries ( ICat LINK_PRIVATE ${TCMALLOC_LIBRARIES_LINKTIME} ${MANTIDLIBS} ${OPENSSL_LIBRARIES} ${JSONCPP_LIBRARIES})
# Add the unit tests directory
add_subdirectory ( test )
diff --git a/Framework/ICat/src/CatalogAlgorithmHelper.cpp b/Framework/ICat/src/CatalogAlgorithmHelper.cpp
index 192c099f2b10e718bb65a9cf162cfae2dbb15f9b..33cde6e09ab2bafc4b169edab473d18bf132011e 100644
--- a/Framework/ICat/src/CatalogAlgorithmHelper.cpp
+++ b/Framework/ICat/src/CatalogAlgorithmHelper.cpp
@@ -1,8 +1,8 @@
#include "MantidICat/CatalogAlgorithmHelper.h"
-#include <boost/property_tree/ptree.hpp>
-#include <boost/property_tree/json_parser.hpp>
#include <boost/assign/list_of.hpp>
+#include <json/reader.h>
+#include <json/value.h>
namespace Mantid {
namespace ICat {
@@ -26,12 +26,13 @@ const std::string CatalogAlgorithmHelper::getIDSError(
// from the server is not in our successHTTPStatus set.
if (successHTTPStatus.find(HTTPStatus) == successHTTPStatus.end()) {
// Stores the contents of `jsonResponseData` as a json property tree.
- boost::property_tree::ptree json;
+ Json::Value json;
// Convert the stream to a JSON tree.
- boost::property_tree::read_json(responseStream, json);
+ Json::Reader json_reader;
+ json_reader.parse(responseStream, json);
// Return the message returned by the server.
- return json.get<std::string>("code") + ": " +
- json.get<std::string>("message");
+ return json.get("code", "UTF-8").asString() + ": " +
+ json.get("message", "UTF-8").asString();
}
// No error occurred, so return an empty string for verification.
return "";
diff --git a/Framework/Kernel/inc/MantidKernel/MDUnit.h b/Framework/Kernel/inc/MantidKernel/MDUnit.h
index 2d9df34609a00d5383a99e3c789154082df4e2ef..7d339496728af1362694c34683bd7bc16937fd16 100644
--- a/Framework/Kernel/inc/MantidKernel/MDUnit.h
+++ b/Framework/Kernel/inc/MantidKernel/MDUnit.h
@@ -54,10 +54,16 @@ public:
/// Dimensionless RLU
class DLLExport ReciprocalLatticeUnit : public QUnit {
public:
+ ReciprocalLatticeUnit();
+ ReciprocalLatticeUnit(const UnitLabel &unitLabel);
UnitLabel getUnitLabel() const;
bool canConvertTo(const MDUnit &other) const;
ReciprocalLatticeUnit *clone() const;
virtual ~ReciprocalLatticeUnit();
+
+private:
+ bool isSpecialRLUUnitLabel() const;
+ UnitLabel m_unitLabel;
};
/// Inverse Angstroms unit
diff --git a/Framework/Kernel/src/MDUnit.cpp b/Framework/Kernel/src/MDUnit.cpp
index 5dc249f5dbf94c3431f57da9fdbbb74949905cc9..e995ba5e0682baf319864c6d3c312616495aaa5c 100644
--- a/Framework/Kernel/src/MDUnit.cpp
+++ b/Framework/Kernel/src/MDUnit.cpp
@@ -33,8 +33,19 @@ bool QUnit::isQUnit() const { return true; }
//----------------------------------------------------------------------------------------------
// RLU
//----------------------------------------------------------------------------------------------
+ReciprocalLatticeUnit::ReciprocalLatticeUnit() : m_unitLabel(UnitLabel("")) {}
+
+ReciprocalLatticeUnit::ReciprocalLatticeUnit(const UnitLabel &unitLabel)
+ : m_unitLabel(unitLabel) {}
+
+ReciprocalLatticeUnit::~ReciprocalLatticeUnit() {}
+
UnitLabel ReciprocalLatticeUnit::getUnitLabel() const {
- return Units::Symbol::RLU;
+ if (isSpecialRLUUnitLabel()) {
+ return m_unitLabel;
+ } else {
+ return Units::Symbol::RLU;
+ }
}
bool ReciprocalLatticeUnit::canConvertTo(const MDUnit &other) const {
@@ -42,10 +53,18 @@ bool ReciprocalLatticeUnit::canConvertTo(const MDUnit &other) const {
}
ReciprocalLatticeUnit *ReciprocalLatticeUnit::clone() const {
- return new ReciprocalLatticeUnit;
+ if (isSpecialRLUUnitLabel()) {
+ return new ReciprocalLatticeUnit(m_unitLabel);
+ } else {
+ return new ReciprocalLatticeUnit;
+ }
+}
+
+bool ReciprocalLatticeUnit::isSpecialRLUUnitLabel() const {
+ boost::regex pattern("in.*A.*\\^-1");
+ return boost::regex_match(m_unitLabel.ascii(), pattern);
}
-ReciprocalLatticeUnit::~ReciprocalLatticeUnit() {}
//----------------------------------------------------------------------------------------------
// End RLU
//----------------------------------------------------------------------------------------------
diff --git a/Framework/Kernel/src/MDUnitFactory.cpp b/Framework/Kernel/src/MDUnitFactory.cpp
index 5ed54a57c5231d415620762c6d8a854a03374324..396cbd9ff2963c9b16a6ce41a0d43ef245e65537 100644
--- a/Framework/Kernel/src/MDUnitFactory.cpp
+++ b/Framework/Kernel/src/MDUnitFactory.cpp
@@ -24,24 +24,35 @@ InverseAngstromsUnitFactory::createRaw(const std::string &) const {
bool InverseAngstromsUnitFactory::canInterpret(
const std::string &unitString) const {
boost::regex pattern("(Angstrom\\^-1)");
+ boost::regex pattern2("A\\^-1");
boost::smatch match; // Unused.
- return boost::regex_search(unitString, match, pattern);
+
+ auto isFullAngstrom = boost::regex_search(unitString, match, pattern);
+ auto isPartialAngstrom = boost::regex_search(unitString, match, pattern2);
+
+ return isFullAngstrom || isPartialAngstrom;
}
ReciprocalLatticeUnit *
-ReciprocalLatticeUnitFactory::createRaw(const std::string &) const {
- return new ReciprocalLatticeUnit;
+ReciprocalLatticeUnitFactory::createRaw(const std::string &unitString) const {
+ return new ReciprocalLatticeUnit(UnitLabel(unitString));
}
bool ReciprocalLatticeUnitFactory::canInterpret(
const std::string &unitString) const {
- return unitString == Units::Symbol::RLU.ascii();
+ auto isRLU = unitString == Units::Symbol::RLU.ascii();
+
+ // In addition to having RLU we can encounter units of type "in 6.28 A^-1"
+ // We need to account for the latter here
+ boost::regex pattern("in.*A.*\\^-1");
+ auto isHoraceStyle = boost::regex_match(unitString, pattern);
+ return isRLU || isHoraceStyle;
}
MDUnitFactory_uptr makeMDUnitFactoryChain() {
typedef MDUnitFactory_uptr FactoryType;
- auto first = FactoryType(new InverseAngstromsUnitFactory);
- first->setSuccessor(FactoryType(new ReciprocalLatticeUnitFactory))
+ auto first = FactoryType(new ReciprocalLatticeUnitFactory);
+ first->setSuccessor(FactoryType(new InverseAngstromsUnitFactory))
// Add more factories here!
// Make sure that LabelUnitFactory is the last in the chain to give a fall
// through
diff --git a/Framework/Kernel/test/MDUnitTest.h b/Framework/Kernel/test/MDUnitTest.h
index 17718f5806b0fc0084be4a317c97fe3c7e04f325..5cdf680425eac7e519817381478a69fc45f0c347 100644
--- a/Framework/Kernel/test/MDUnitTest.h
+++ b/Framework/Kernel/test/MDUnitTest.h
@@ -15,6 +15,19 @@ public:
static MDUnitTest *createSuite() { return new MDUnitTest(); }
static void destroySuite(MDUnitTest *suite) { delete suite; }
+ void test_RLU_Constructor_with_valid_special_unit_label_accepts_the_label() {
+ auto unitLabel = UnitLabel("in 1.992 A^-1");
+ ReciprocalLatticeUnit unit(unitLabel);
+ TS_ASSERT_EQUALS(unitLabel.ascii(), unit.getUnitLabel().ascii());
+ }
+
+ void
+ test_RLU_Constructor_with_invalid_special_unit_label_does_not_accept_the_label() {
+ auto unitLabel = UnitLabel("in invalidLabel A-1");
+ ReciprocalLatticeUnit unit(unitLabel);
+ TS_ASSERT_EQUALS(Units::Symbol::RLU, unit.getUnitLabel());
+ }
+
void test_RLU_getUnitLabel() {
ReciprocalLatticeUnit unit;
TS_ASSERT_EQUALS(Units::Symbol::RLU, unit.getUnitLabel());
diff --git a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/CreateMDWorkspace.h b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/CreateMDWorkspace.h
index d5790370522d8237295d617e9582855ade2374cc..3dcd52e01b27fac63a3d43230a47e6285e54c4aa 100644
--- a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/CreateMDWorkspace.h
+++ b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/CreateMDWorkspace.h
@@ -5,6 +5,7 @@
#include "MantidMDAlgorithms/BoxControllerSettingsAlgorithm.h"
#include "MantidDataObjects/MDEventFactory.h"
#include "MantidDataObjects/MDEventWorkspace.h"
+#include "MantidGeometry/MDGeometry/MDFrame.h"
namespace Mantid {
namespace MDAlgorithms {
@@ -36,6 +37,7 @@ public:
virtual int version() const { return 1; }
/// Algorithm's category for identification
virtual const std::string category() const { return "MDAlgorithms"; }
+ virtual std::map<std::string, std::string> validateInputs();
private:
void init();
@@ -43,6 +45,10 @@ private:
template <typename MDE, size_t nd>
void finish(typename DataObjects::MDEventWorkspace<MDE, nd>::sptr ws);
+ Mantid::Geometry::MDFrame_uptr createMDFrame(std::string frame,
+ std::string unit);
+ bool checkIfFrameValid(const std::string &frame,
+ const std::vector<std::string> &targetFrames);
};
} // namespace Mantid
diff --git a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/ImportMDHistoWorkspaceBase.h b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/ImportMDHistoWorkspaceBase.h
index 81e9ec99362001611a5d6f3fd00b028642c66508..94455e0a1a7720102e8914f04bb96f8a17912857 100644
--- a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/ImportMDHistoWorkspaceBase.h
+++ b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/ImportMDHistoWorkspaceBase.h
@@ -39,6 +39,7 @@ class DLLExport ImportMDHistoWorkspaceBase : public API::Algorithm {
public:
ImportMDHistoWorkspaceBase();
virtual ~ImportMDHistoWorkspaceBase();
+ virtual std::map<std::string, std::string> validateInputs();
protected:
/// Vector containing the number of bins in each dimension.
@@ -54,6 +55,10 @@ protected:
private:
// Product of the bins across all dimensions.
size_t m_bin_product;
+ Mantid::Geometry::MDFrame_uptr createMDFrame(std::string frame,
+ std::string unit);
+ bool checkIfFrameValid(const std::string &frame,
+ const std::vector<std::string> &targetFrames);
};
} // namespace MDAlgorithms
diff --git a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/Integrate3DEvents.h b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/Integrate3DEvents.h
index d5a3c71fc66da3866275f0cd6a87bf0c4b5050e5..8230143778a7fcabd4081f429b3cf8ffb8fc2fe0 100644
--- a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/Integrate3DEvents.h
+++ b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/Integrate3DEvents.h
@@ -3,7 +3,7 @@
#include <vector>
#include <boost/shared_ptr.hpp>
-#include <boost/unordered_map.hpp>
+#include <unordered_map>
#include "MantidKernel/V3D.h"
#include "MantidKernel/Matrix.h"
@@ -53,9 +53,9 @@ namespace MDAlgorithms {
<http://doxygen.mantidproject.org>
*/
-typedef boost::unordered_map<
+typedef std::unordered_map<
int64_t, std::vector<std::pair<double, Mantid::Kernel::V3D>>> EventListMap;
-typedef boost::unordered_map<int64_t, Mantid::Kernel::V3D> PeakQMap;
+typedef std::unordered_map<int64_t, Mantid::Kernel::V3D> PeakQMap;
class DLLExport Integrate3DEvents {
public:
diff --git a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/SlicingAlgorithm.h b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/SlicingAlgorithm.h
index a92af395b656f645902fea48169c7dd1ac083003..0d6b86fd8fd9693ee51d9d8d7fd82dc8442e43e4 100644
--- a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/SlicingAlgorithm.h
+++ b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/SlicingAlgorithm.h
@@ -150,6 +150,20 @@ protected:
/// The NormalizeBasisVectors option
bool m_NormalizeBasisVectors;
+
+private:
+ Mantid::Geometry::MDFrame_uptr
+ createMDFrameForNonAxisAligned(std::string units,
+ Mantid::Kernel::VMD basisVector) const;
+ std::vector<Mantid::Kernel::VMD> getOldBasis(size_t dimension) const;
+ bool isProjectingOnFrame(const Mantid::Kernel::VMD &oldVector,
+ const Mantid::Kernel::VMD &basisVector) const;
+ std::vector<size_t> getIndicesWithProjection(
+ const Mantid::Kernel::VMD &basisVector,
+ const std::vector<Mantid::Kernel::VMD> &oldBasis) const;
+ Mantid::Geometry::MDFrame_uptr
+ extractMDFrameForNonAxisAligned(std::vector<size_t> indicesWithProjection,
+ std::string units) const;
};
} // namespace DataObjects
diff --git a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/TransposeMD.h b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/TransposeMD.h
index ac82cd7fde4f78c5d9e175e6bdba43a31c9a0df6..84d466869ddae66b62d8b5c17c8ea5038b127c06 100644
--- a/Framework/MDAlgorithms/inc/MantidMDAlgorithms/TransposeMD.h
+++ b/Framework/MDAlgorithms/inc/MantidMDAlgorithms/TransposeMD.h
@@ -40,6 +40,8 @@ public:
virtual const std::string category() const;
virtual const std::string summary() const;
+ virtual const std::string alias() const { return "PermuteMD"; }
+
private:
void init();
void exec();
diff --git a/Framework/MDAlgorithms/src/CalculateCoverageDGS.cpp b/Framework/MDAlgorithms/src/CalculateCoverageDGS.cpp
index 25ec63f4b040e5024a00d5b21905a1e0af241319..d9e2a957b1f7411b3848390a8cbe22415ea1609b 100644
--- a/Framework/MDAlgorithms/src/CalculateCoverageDGS.cpp
+++ b/Framework/MDAlgorithms/src/CalculateCoverageDGS.cpp
@@ -367,18 +367,25 @@ void CalculateCoverageDGS::exec() {
// create the output workspace
std::vector<Mantid::Geometry::MDHistoDimension_sptr> binDimensions;
+
+ // Define frames
+ Mantid::Geometry::GeneralFrame frame1("Q1", "");
+ Mantid::Geometry::GeneralFrame frame2("Q2", "");
+ Mantid::Geometry::GeneralFrame frame3("Q3", "");
+ Mantid::Geometry::GeneralFrame frame4("meV", "");
MDHistoDimension_sptr out1(
- new MDHistoDimension("Q1", "Q1", "", static_cast<coord_t>(q1min),
+ new MDHistoDimension("Q1", "Q1", frame1, static_cast<coord_t>(q1min),
static_cast<coord_t>(q1max), q1NumBins));
MDHistoDimension_sptr out2(
- new MDHistoDimension("Q2", "Q2", "", static_cast<coord_t>(q2min),
+ new MDHistoDimension("Q2", "Q2", frame2, static_cast<coord_t>(q2min),
static_cast<coord_t>(q2max), q2NumBins));
MDHistoDimension_sptr out3(
- new MDHistoDimension("Q3", "Q3", "", static_cast<coord_t>(q3min),
+ new MDHistoDimension("Q3", "Q3", frame3, static_cast<coord_t>(q3min),
static_cast<coord_t>(q3max), q3NumBins));
MDHistoDimension_sptr out4(new MDHistoDimension(
- "DeltaE", "DeltaE", "meV", static_cast<coord_t>(m_dEmin),
+ "DeltaE", "DeltaE", frame4, static_cast<coord_t>(m_dEmin),
static_cast<coord_t>(m_dEmax), dENumBins));
+
for (size_t row = 0; row <= 3; row++) {
if (affineMat[row][0] == 1.) {
binDimensions.push_back(out1);
diff --git a/Framework/MDAlgorithms/src/ConvertCWSDExpToMomentum.cpp b/Framework/MDAlgorithms/src/ConvertCWSDExpToMomentum.cpp
index 22507befa430a047f4f1cb757bc943df762b53df..746eb498bc4ad870cb81ff6452f4c2cce3ab69e5 100644
--- a/Framework/MDAlgorithms/src/ConvertCWSDExpToMomentum.cpp
+++ b/Framework/MDAlgorithms/src/ConvertCWSDExpToMomentum.cpp
@@ -2,6 +2,7 @@
#include "MantidAPI/WorkspaceProperty.h"
#include "MantidKernel/ArrayProperty.h"
#include "MantidGeometry/Instrument.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
#include "MantidDataObjects/MDEventFactory.h"
#include "MantidAPI/ExperimentInfo.h"
#include "MantidGeometry/Instrument/ComponentHelper.h"
@@ -174,13 +175,15 @@ ConvertCWSDExpToMomentum::createExperimentMDWorkspace() {
g_log.debug() << "Direction " << d << ", Range = " << m_extentMins[d]
<< ", " << m_extentMaxs[d] << "\n";
+ // Set Q Sample frame
+ Mantid::Geometry::QSample frame;
+
for (size_t i = 0; i < nDimension; ++i) {
std::string id = vec_ID[i];
std::string name = dimensionNames[i];
- std::string units = "A^-1";
mdws->addDimension(
Geometry::MDHistoDimension_sptr(new Geometry::MDHistoDimension(
- id, name, units, static_cast<coord_t>(m_extentMins[i]),
+ id, name, frame, static_cast<coord_t>(m_extentMins[i]),
static_cast<coord_t>(m_extentMaxs[i]), m_numBins[i])));
}
diff --git a/Framework/MDAlgorithms/src/ConvertCWSDMDtoHKL.cpp b/Framework/MDAlgorithms/src/ConvertCWSDMDtoHKL.cpp
index ebee9b77c9e84a78b80ef741ee177271aab55475..eb285d80da2c1089983d35fc65dc40b5ad9f5cc1 100644
--- a/Framework/MDAlgorithms/src/ConvertCWSDMDtoHKL.cpp
+++ b/Framework/MDAlgorithms/src/ConvertCWSDMDtoHKL.cpp
@@ -6,8 +6,10 @@
#include "MantidGeometry/Crystal/IndexingUtils.h"
#include "MantidGeometry/Crystal/OrientedLattice.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
#include "MantidKernel/BoundedValidator.h"
#include "MantidKernel/ArrayProperty.h"
+#include "MantidKernel/UnitLabelTypes.h"
#include "MantidDataObjects/MDEventFactory.h"
#include "MantidAPI/ExperimentInfo.h"
@@ -335,14 +337,18 @@ API::IMDEventWorkspace_sptr ConvertCWSDMDtoHKL::createHKLMDWorkspace(
std::vector<size_t> m_numBins(3, 100);
getRange(vec_hkl, m_extentMins, m_extentMaxs);
+ // Get MDFrame of HKL type with RLU
+ auto unitFactory = makeMDUnitFactoryChain();
+ auto unit = unitFactory->create(Units::Symbol::RLU.ascii());
+ Mantid::Geometry::HKL frame(unit);
+
for (size_t i = 0; i < nDimension; ++i) {
std::string id = vec_ID[i];
std::string name = dimensionNames[i];
// std::string units = "A^-1";
- std::string units = "";
mdws->addDimension(
Geometry::MDHistoDimension_sptr(new Geometry::MDHistoDimension(
- id, name, units, static_cast<coord_t>(m_extentMins[i]),
+ id, name, frame, static_cast<coord_t>(m_extentMins[i]),
static_cast<coord_t>(m_extentMaxs[i]), m_numBins[i])));
}
diff --git a/Framework/MDAlgorithms/src/ConvertSpiceDataToRealSpace.cpp b/Framework/MDAlgorithms/src/ConvertSpiceDataToRealSpace.cpp
index 92b82c75b6dcec98d6bc9c5eff3f5fb5227a4ace..aadb3d485030ce9c6b789845dc4185a19b3e1b14 100644
--- a/Framework/MDAlgorithms/src/ConvertSpiceDataToRealSpace.cpp
+++ b/Framework/MDAlgorithms/src/ConvertSpiceDataToRealSpace.cpp
@@ -11,6 +11,7 @@
#include "MantidDataObjects/MDEventInserter.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
+#include "MantidGeometry/MDGeometry/GeneralFrame.h"
#include "MantidDataObjects/MDEventWorkspace.h"
#include "MantidDataObjects/MDEvent.h"
#include "MantidDataObjects/TableWorkspace.h"
@@ -602,11 +603,14 @@ IMDEventWorkspace_sptr ConvertSpiceDataToRealSpace::createDataMDWorkspace(
vec_name[1] = "Y";
vec_name[2] = "Z";
+ // Create MDFrame of General Frame type
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "m");
+
// Add dimensions
for (size_t i = 0; i < m_nDimensions; ++i) {
std::string id = vec_ID[i];
std::string name = vec_name[i];
- std::string units = "m";
// int nbins = 100;
for (size_t d = 0; d < 3; ++d)
@@ -614,7 +618,7 @@ IMDEventWorkspace_sptr ConvertSpiceDataToRealSpace::createDataMDWorkspace(
<< ", " << m_extentMaxs[d] << "\n";
outWs->addDimension(
Geometry::MDHistoDimension_sptr(new Geometry::MDHistoDimension(
- id, name, units, static_cast<coord_t>(m_extentMins[i]),
+ id, name, frame, static_cast<coord_t>(m_extentMins[i]),
static_cast<coord_t>(m_extentMaxs[i]), m_numBins[i])));
}
@@ -684,15 +688,18 @@ IMDEventWorkspace_sptr ConvertSpiceDataToRealSpace::createMonitorMDWorkspace(
vec_name[1] = "Y";
vec_name[2] = "Z";
+ // Create MDFrame of General Frame type
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "m");
+
// Add dimensions
for (size_t i = 0; i < m_nDimensions; ++i) {
std::string id = vec_ID[i];
std::string name = vec_name[i];
- std::string units = "m";
outWs->addDimension(
Geometry::MDHistoDimension_sptr(new Geometry::MDHistoDimension(
- id, name, units, static_cast<coord_t>(m_extentMins[i]),
+ id, name, frame, static_cast<coord_t>(m_extentMins[i]),
static_cast<coord_t>(m_extentMaxs[i]), m_numBins[i])));
}
diff --git a/Framework/MDAlgorithms/src/ConvertToDetectorFaceMD.cpp b/Framework/MDAlgorithms/src/ConvertToDetectorFaceMD.cpp
index 2d58e4c5fba823c4f71e04ffd03375ab37a44a4f..7855923d98510626d9f51c444f684ec89c607906 100644
--- a/Framework/MDAlgorithms/src/ConvertToDetectorFaceMD.cpp
+++ b/Framework/MDAlgorithms/src/ConvertToDetectorFaceMD.cpp
@@ -212,18 +212,24 @@ void ConvertToDetectorFaceMD::exec() {
if (ax0->getValue(ax0->length() - 1) > tof_max)
tof_max = ax0->getValue(ax0->length() - 1);
+ // Get MDFrame of General Frame type
+ Mantid::Geometry::GeneralFrame framePixel(
+ Mantid::Geometry::GeneralFrame::GeneralFrameName, "pixel");
+ Mantid::Geometry::GeneralFrame frameTOF(
+ Mantid::Geometry::GeneralFrame::GeneralFrameName, ax0->unit()->label());
+
// ------------------ Build all the dimensions ----------------------------
MDHistoDimension_sptr dimX(
- new MDHistoDimension("x", "x", "pixel", static_cast<coord_t>(0),
+ new MDHistoDimension("x", "x", framePixel, static_cast<coord_t>(0),
static_cast<coord_t>(m_numXPixels), m_numXPixels));
MDHistoDimension_sptr dimY(
- new MDHistoDimension("y", "y", "pixel", static_cast<coord_t>(0),
+ new MDHistoDimension("y", "y", framePixel, static_cast<coord_t>(0),
static_cast<coord_t>(m_numYPixels), m_numYPixels));
std::string TOFname = ax0->title();
if (TOFname.empty())
TOFname = ax0->unit()->unitID();
MDHistoDimension_sptr dimTOF(new MDHistoDimension(
- TOFname, TOFname, ax0->unit()->label(), static_cast<coord_t>(tof_min),
+ TOFname, TOFname, frameTOF, static_cast<coord_t>(tof_min),
static_cast<coord_t>(tof_max), ax0->length()));
std::vector<IMDDimension_sptr> dims;
@@ -232,10 +238,12 @@ void ConvertToDetectorFaceMD::exec() {
dims.push_back(dimTOF);
if (banks.size() > 1) {
+ Mantid::Geometry::GeneralFrame frameNumber(
+ Mantid::Geometry::GeneralFrame::GeneralFrameName, "number");
int min = banks.begin()->first;
int max = banks.rbegin()->first + 1;
MDHistoDimension_sptr dimBanks(new MDHistoDimension(
- "bank", "bank", "number", static_cast<coord_t>(min),
+ "bank", "bank", frameNumber, static_cast<coord_t>(min),
static_cast<coord_t>(max), max - min));
dims.push_back(dimBanks);
}
diff --git a/Framework/MDAlgorithms/src/ConvertToDiffractionMDWorkspace.cpp b/Framework/MDAlgorithms/src/ConvertToDiffractionMDWorkspace.cpp
index 1b3d3cd3321c4e924fa07175a9d59de48460f7f3..4f6bf32e23452dd2ec1d8b6ba2a0ed9ec04cddb4 100644
--- a/Framework/MDAlgorithms/src/ConvertToDiffractionMDWorkspace.cpp
+++ b/Framework/MDAlgorithms/src/ConvertToDiffractionMDWorkspace.cpp
@@ -5,6 +5,7 @@
#include "MantidDataObjects/Workspace2D.h"
#include "MantidGeometry/Crystal/OrientedLattice.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
+#include "MantidGeometry/MDGeometry/MDFrameFactory.h"
#include "MantidKernel/ArrayProperty.h"
#include "MantidKernel/CPUTimer.h"
#include "MantidKernel/FunctionTask.h"
@@ -12,6 +13,7 @@
#include "MantidKernel/ProgressText.h"
#include "MantidKernel/System.h"
#include "MantidKernel/Timer.h"
+#include "MantidKernel/UnitLabelTypes.h"
#include "MantidMDAlgorithms/ConvertToDiffractionMDWorkspace.h"
#include "MantidDataObjects/MDEventFactory.h"
#include "MantidDataObjects/MDEventWorkspace.h"
@@ -363,9 +365,13 @@ void ConvertToDiffractionMDWorkspace::exec() {
// -------------------------------------
std::string dimensionNames[3] = {"Q_lab_x", "Q_lab_y", "Q_lab_z"};
- std::string dimensionUnits = "Angstroms^-1";
Mantid::Kernel::SpecialCoordinateSystem coordinateSystem =
Mantid::Kernel::QLab;
+
+ // Setup the MDFrame
+ auto frameFactory = makeMDFrameFactoryChain();
+ Mantid::Geometry::MDFrame_uptr frame;
+
if (OutputDimensions == "Q (sample frame)") {
// Set the matrix based on goniometer angles
mat = m_inWS->mutableRun().getGoniometerMatrix();
@@ -376,6 +382,10 @@ void ConvertToDiffractionMDWorkspace::exec() {
dimensionNames[1] = "Q_sample_y";
dimensionNames[2] = "Q_sample_z";
coordinateSystem = Mantid::Kernel::QSample;
+ // Frame
+ MDFrameArgument frameArgQSample(QSample::QSampleName, "");
+ frame = frameFactory->create(frameArgQSample);
+
} else if (OutputDimensions == "HKL") {
// Set the matrix based on UB etc.
Kernel::Matrix<double> ub =
@@ -391,8 +401,12 @@ void ConvertToDiffractionMDWorkspace::exec() {
dimensionNames[0] = "H";
dimensionNames[1] = "K";
dimensionNames[2] = "L";
- dimensionUnits = "lattice";
coordinateSystem = Mantid::Kernel::HKL;
+ MDFrameArgument frameArgQLab(HKL::HKLName, Units::Symbol::RLU.ascii());
+ frame = frameFactory->create(frameArgQLab);
+ } else {
+ MDFrameArgument frameArgQLab(QLab::QLabName, "");
+ frame = frameFactory->create(frameArgQLab);
}
// Q in the lab frame is the default, so nothing special to do.
@@ -429,10 +443,10 @@ void ConvertToDiffractionMDWorkspace::exec() {
// Give all the dimensions
for (size_t d = 0; d < nd; d++) {
- MDHistoDimension *dim = new MDHistoDimension(
- dimensionNames[d], dimensionNames[d], dimensionUnits,
- static_cast<coord_t>(extents[d * 2]),
- static_cast<coord_t>(extents[d * 2 + 1]), 10);
+ MDHistoDimension *dim =
+ new MDHistoDimension(dimensionNames[d], dimensionNames[d], *frame,
+ static_cast<coord_t>(extents[d * 2]),
+ static_cast<coord_t>(extents[d * 2 + 1]), 10);
ws->addDimension(MDHistoDimension_sptr(dim));
}
ws->initialize();
diff --git a/Framework/MDAlgorithms/src/ConvertToReflectometryQ.cpp b/Framework/MDAlgorithms/src/ConvertToReflectometryQ.cpp
index f4d2a5950f734099c4f7be6438608d5c95030a0e..399b1c3e426f90ed072a1c1ff80c4dc0d94a1ced 100644
--- a/Framework/MDAlgorithms/src/ConvertToReflectometryQ.cpp
+++ b/Framework/MDAlgorithms/src/ConvertToReflectometryQ.cpp
@@ -23,6 +23,9 @@
#include "MantidMDAlgorithms/ReflectometryTransformQxQz.h"
#include "MantidMDAlgorithms/ReflectometryTransformP.h"
+#include "MantidGeometry/MDGeometry/QLab.h"
+#include "MantidGeometry/MDGeometry/GeneralFrame.h"
+
#include <boost/optional.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/make_shared.hpp>
@@ -334,21 +337,26 @@ void ConvertToReflectometryQ::exec() {
BoxController_sptr bc = boost::make_shared<BoxController>(2);
this->setBoxController(bc);
- // Select the transform strategy.
+ // Select the transform strategy and an appropriate MDFrame
ReflectometryTransform_sptr transform;
-
+ Mantid::Geometry::MDFrame_uptr frame;
if (outputDimensions == qSpaceTransform()) {
transform = boost::make_shared<ReflectometryTransformQxQz>(
dim0min, dim0max, dim1min, dim1max, incidentTheta, numberOfBinsQx,
numberOfBinsQz);
+ frame.reset(new Mantid::Geometry::QLab);
} else if (outputDimensions == pSpaceTransform()) {
transform = boost::make_shared<ReflectometryTransformP>(
dim0min, dim0max, dim1min, dim1max, incidentTheta, numberOfBinsQx,
numberOfBinsQz);
+ frame.reset(new Mantid::Geometry::GeneralFrame(
+ "P", Mantid::Kernel::InverseAngstromsUnit().getUnitLabel()));
} else {
transform = boost::make_shared<ReflectometryTransformKiKf>(
dim0min, dim0max, dim1min, dim1max, incidentTheta, numberOfBinsQx,
numberOfBinsQz);
+ frame.reset(new Mantid::Geometry::GeneralFrame(
+ "KiKf", Mantid::Kernel::InverseAngstromsUnit().getUnitLabel()));
}
IMDWorkspace_sptr outputWS;
@@ -359,7 +367,7 @@ void ConvertToReflectometryQ::exec() {
if (outputAsMDWorkspace) {
transSelectionProg.report("Choosing Transformation");
if (transMethod == centerTransform()) {
- auto outputMDWS = transform->executeMD(inputWs, bc);
+ auto outputMDWS = transform->executeMD(inputWs, bc, std::move(frame));
Progress transPerformProg(this, 0.1, 0.7, 5);
transPerformProg.report("Performed transformation");
// Copy ExperimentInfo (instrument, run, sample) to the output WS
diff --git a/Framework/MDAlgorithms/src/CreateMDWorkspace.cpp b/Framework/MDAlgorithms/src/CreateMDWorkspace.cpp
index 96204512e009bead9a7ecfa64d57d983d0fa16e2..78f8b23defaa34cd230a22ff2c78fc87a5caba2a 100644
--- a/Framework/MDAlgorithms/src/CreateMDWorkspace.cpp
+++ b/Framework/MDAlgorithms/src/CreateMDWorkspace.cpp
@@ -1,6 +1,12 @@
#include "MantidAPI/FileProperty.h"
#include "MantidAPI/IMDEventWorkspace.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
+#include "MantidGeometry/MDGeometry/MDFrame.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
+#include "MantidGeometry/MDGeometry/QLab.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
+#include "MantidGeometry/MDGeometry/GeneralFrame.h"
+#include "MantidGeometry/MDGeometry/MDFrameFactory.h"
#include "MantidKernel/ArrayProperty.h"
#include "MantidKernel/System.h"
#include "MantidMDAlgorithms/CreateMDWorkspace.h"
@@ -53,7 +59,17 @@ void CreateMDWorkspace::init() {
declareProperty(new ArrayProperty<std::string>("Units"),
"A comma separated list of the units of each dimension.");
-
+ declareProperty(
+ new ArrayProperty<std::string>("Frames"),
+ " A comma separated list of the frames of each dimension. "
+ " The frames can be"
+ " **General Frame**: Any frame which is not a Q-based frame."
+ " **QLab**: Wave-vector converted into the lab frame."
+ " **QSample**: Wave-vector converted into the frame of the sample."
+ " **HKL**: Wave-vector converted into the crystal's HKL indices."
+ " Note if nothing is specified then the **General Frame** is being "
+ "selected. Also note that if you select a frame then this might override "
+ "your unit selection if it is not compatible with the frame.");
// Set the box controller properties
this->initBoxControllerProps("5", 1000, 5);
@@ -130,6 +146,7 @@ void CreateMDWorkspace::exec() {
std::vector<double> extents = getProperty("Extents");
std::vector<std::string> names = getProperty("Names");
std::vector<std::string> units = getProperty("Units");
+ std::vector<std::string> frames = getProperty("Frames");
if (extents.size() != ndims * 2)
throw std::invalid_argument("You must specify twice as many extents "
@@ -140,6 +157,19 @@ void CreateMDWorkspace::exec() {
if (units.size() != ndims)
throw std::invalid_argument(
"You must specify as many units as there are dimensions.");
+ // If no frames are specified we want to default to the General Frame,
+ // to ensure backward compatibility. But if they are only partly specified,
+ // then we want to throw an error. It should be either used correctly or not
+ // at all
+ if (!frames.empty() && frames.size() != ndims) {
+ throw std::invalid_argument(
+ "You must specify as many frames as there are dimensions.");
+ }
+
+ if (frames.empty()) {
+ frames.resize(ndims);
+ std::fill(frames.begin(), frames.end(), GeneralFrame::GeneralFrameName);
+ }
// Have the factory create it
IMDEventWorkspace_sptr out =
@@ -147,8 +177,9 @@ void CreateMDWorkspace::exec() {
// Give all the dimensions
for (size_t d = 0; d < ndims; d++) {
+ auto frame = createMDFrame(frames[d], units[d]);
MDHistoDimension *dim = new MDHistoDimension(
- names[d], names[d], units[d], static_cast<coord_t>(extents[d * 2]),
+ names[d], names[d], *frame, static_cast<coord_t>(extents[d * 2]),
static_cast<coord_t>(extents[d * 2 + 1]), 1);
out->addDimension(MDHistoDimension_sptr(dim));
}
@@ -186,5 +217,64 @@ void CreateMDWorkspace::exec() {
setProperty("OutputWorkspace", boost::dynamic_pointer_cast<Workspace>(out));
}
+MDFrame_uptr CreateMDWorkspace::createMDFrame(std::string frame,
+ std::string unit) {
+ auto frameFactory = makeMDFrameFactoryChain();
+ MDFrameArgument frameArg(frame, unit);
+ return frameFactory->create(frameArg);
+}
+
+std::map<std::string, std::string> CreateMDWorkspace::validateInputs() {
+ // Check Frame names
+ std::map<std::string, std::string> errors;
+ std::string framePropertyName = "Frames";
+ std::vector<std::string> frames = getProperty(framePropertyName);
+ int ndims_prop = getProperty("Dimensions");
+ auto ndims = static_cast<size_t>(ndims_prop);
+
+ std::vector<std::string> targetFrames;
+ targetFrames.push_back(Mantid::Geometry::GeneralFrame::GeneralFrameName);
+ targetFrames.push_back(Mantid::Geometry::HKL::HKLName);
+ targetFrames.push_back(Mantid::Geometry::QLab::QLabName);
+ targetFrames.push_back(Mantid::Geometry::QSample::QSampleName);
+
+ auto isValidFrame = true;
+ for (auto it = frames.begin(); it != frames.end(); ++it) {
+ auto result = checkIfFrameValid(*it, targetFrames);
+ if (!result) {
+ isValidFrame = result;
+ }
+ }
+
+ if (!frames.empty() && frames.size() != ndims) {
+ isValidFrame = false;
+ }
+
+ if (!isValidFrame) {
+ std::string message = "The selected frames can be 'HKL', 'QSample', 'QLab' "
+ "or 'General Frame'. You must specify as many frames "
+ "as there are dimensions.";
+ errors.insert(std::make_pair(framePropertyName, message));
+ }
+ return errors;
+}
+
+/**
+ * Check if the specified frame matches a target frame
+ * @param frame: the frame name under investigation
+ * @param targetFrames: the allowed frame names
+ * @returns true if the frame name is valid else false
+ */
+bool CreateMDWorkspace::checkIfFrameValid(
+ const std::string &frame, const std::vector<std::string> &targetFrames) {
+ for (auto targetFrame = targetFrames.begin();
+ targetFrame != targetFrames.end(); ++targetFrame) {
+ if (*targetFrame == frame) {
+ return true;
+ }
+ }
+ return false;
+}
+
} // namespace Mantid
} // namespace DataObjects
diff --git a/Framework/MDAlgorithms/src/FitMD.cpp b/Framework/MDAlgorithms/src/FitMD.cpp
index c326e268381cd21e2f7e0a18231c99c15ab5a5c3..3f411bbc0d63d5fb3c36ec8f6b5b9133549f5485 100644
--- a/Framework/MDAlgorithms/src/FitMD.cpp
+++ b/Framework/MDAlgorithms/src/FitMD.cpp
@@ -206,6 +206,7 @@ boost::shared_ptr<API::Workspace> FitMD::createEventOutputWorkspace(
builder.setNumBins(inputDim->getNBins());
builder.setMin(inputDim->getMinimum());
builder.setMax(inputDim->getMaximum());
+ builder.setFrameName(inputDim->getMDFrame().name());
outputWS->addDimension(builder.create());
}
diff --git a/Framework/MDAlgorithms/src/ImportMDEventWorkspace.cpp b/Framework/MDAlgorithms/src/ImportMDEventWorkspace.cpp
index 8aab04ee8dbf02e05f695e30c90b2100fb472a3a..be346034e853bc84f9d5f876de9920c646de6713 100644
--- a/Framework/MDAlgorithms/src/ImportMDEventWorkspace.cpp
+++ b/Framework/MDAlgorithms/src/ImportMDEventWorkspace.cpp
@@ -6,6 +6,7 @@
#include "MantidDataObjects/MDEventFactory.h"
#include "MantidDataObjects/MDEventInserter.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
+#include "MantidKernel/MDUnit.h"
#include <boost/algorithm/string.hpp>
#include <boost/algorithm/string/split.hpp>
@@ -296,14 +297,18 @@ void ImportMDEventWorkspace::exec() {
// Extract Dimensions and add to the output workspace.
DataCollectionType::iterator dimEntriesIterator = m_posDimStart;
+ auto unitFactory = makeMDUnitFactoryChain();
for (size_t i = 0; i < m_nDimensions; ++i) {
std::string id = convert<std::string>(*(++dimEntriesIterator));
std::string name = convert<std::string>(*(++dimEntriesIterator));
std::string units = convert<std::string>(*(++dimEntriesIterator));
int nbins = convert<int>(*(++dimEntriesIterator));
+ auto mdUnit = unitFactory->create(units);
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameName, std::move(mdUnit));
outWs->addDimension(MDHistoDimension_sptr(new MDHistoDimension(
- id, name, units, static_cast<coord_t>(extentMins[i]),
+ id, name, frame, static_cast<coord_t>(extentMins[i]),
static_cast<coord_t>(extentMaxs[i]), nbins)));
}
diff --git a/Framework/MDAlgorithms/src/ImportMDHistoWorkspaceBase.cpp b/Framework/MDAlgorithms/src/ImportMDHistoWorkspaceBase.cpp
index 59bbfbca7879ebcd7863fc487ac210dda23b771e..84b71925e96cf0248b92685893a9841d741fc10f 100644
--- a/Framework/MDAlgorithms/src/ImportMDHistoWorkspaceBase.cpp
+++ b/Framework/MDAlgorithms/src/ImportMDHistoWorkspaceBase.cpp
@@ -5,7 +5,11 @@
#include "MantidKernel/BoundedValidator.h"
#include "MantidKernel/CompositeValidator.h"
#include "MantidKernel/MandatoryValidator.h"
-
+#include "MantidGeometry/MDGeometry/QSample.h"
+#include "MantidGeometry/MDGeometry/QLab.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
+#include "MantidGeometry/MDGeometry/GeneralFrame.h"
+#include "MantidGeometry/MDGeometry/MDFrameFactory.h"
#include <algorithm>
using namespace Mantid::API;
@@ -63,6 +67,17 @@ void ImportMDHistoWorkspaceBase::initGenericImportProps() {
declareProperty(new WorkspaceProperty<IMDHistoWorkspace>(
"OutputWorkspace", "", Direction::Output),
"MDHistoWorkspace reflecting the input text file.");
+ declareProperty(
+ new ArrayProperty<std::string>("Frames"),
+ " A comma separated list of the frames of each dimension. "
+ " The frames can be"
+ " **General Frame**: Any frame which is not a Q-based frame."
+ " **QLab**: Wave-vector converted into the lab frame."
+ " **QSample**: Wave-vector converted into the frame of the sample."
+ " **HKL**: Wave-vector converted into the crystal's HKL indices."
+ " Note if nothing is specified then the **General Frame** is being "
+ "selected. Also note that if you select a frame then this might override "
+ "your unit selection if it is not compatible with the frame.");
}
//----------------------------------------------------------------------------------------------
@@ -81,6 +96,7 @@ MDHistoWorkspace_sptr ImportMDHistoWorkspaceBase::createEmptyOutputWorkspace() {
std::vector<int> nbins = getProperty("NumberOfBins");
std::vector<std::string> names = getProperty("Names");
std::vector<std::string> units = getProperty("Units");
+ std::vector<std::string> frames = getProperty("Frames");
// Perform all validation on inputs
if (extents.size() != ndims * 2)
@@ -96,11 +112,26 @@ MDHistoWorkspace_sptr ImportMDHistoWorkspaceBase::createEmptyOutputWorkspace() {
throw std::invalid_argument(
"You must specify as many units as there are dimensions.");
+ // If no frames are specified we want to default to the General Frame,
+ // to ensure backward compatibility. But if they are only partly specified,
+ // then we want to throw an error. It should be either used correctly or not
+ // at all
+ if (!frames.empty() && frames.size() != ndims) {
+ throw std::invalid_argument(
+ "You must specify as many frames as there are dimensions.");
+ }
+
+ if (frames.empty()) {
+ frames.resize(ndims);
+ std::fill(frames.begin(), frames.end(), GeneralFrame::GeneralFrameName);
+ }
+
// Fabricate new dimensions from inputs
std::vector<MDHistoDimension_sptr> dimensions;
for (size_t k = 0; k < ndims; ++k) {
+ auto frame = createMDFrame(frames[k], units[k]);
dimensions.push_back(MDHistoDimension_sptr(new MDHistoDimension(
- names[k], names[k], units[k], static_cast<coord_t>(extents[k * 2]),
+ names[k], names[k], *frame, static_cast<coord_t>(extents[k * 2]),
static_cast<coord_t>(extents[(k * 2) + 1]), nbins[k])));
}
@@ -112,5 +143,71 @@ MDHistoWorkspace_sptr ImportMDHistoWorkspaceBase::createEmptyOutputWorkspace() {
return ws;
}
+/**
+ * Create an MDFrame
+ * @param frame: the selected frame
+ * @param unit: the selected unit
+ * @returns a unique pointer to an MDFrame
+ */
+MDFrame_uptr ImportMDHistoWorkspaceBase::createMDFrame(std::string frame,
+ std::string unit) {
+ auto frameFactory = makeMDFrameFactoryChain();
+ MDFrameArgument frameArg(frame, unit);
+ return frameFactory->create(frameArg);
+}
+
+std::map<std::string, std::string>
+ImportMDHistoWorkspaceBase::validateInputs() {
+ // Check Frame names
+ std::map<std::string, std::string> errors;
+ std::string framePropertyName = "Frames";
+ std::vector<std::string> frames = getProperty(framePropertyName);
+ int ndims_prop = getProperty("Dimensionality");
+ auto ndims = static_cast<size_t>(ndims_prop);
+
+ std::vector<std::string> targetFrames;
+ targetFrames.push_back(Mantid::Geometry::GeneralFrame::GeneralFrameName);
+ targetFrames.push_back(Mantid::Geometry::HKL::HKLName);
+ targetFrames.push_back(Mantid::Geometry::QLab::QLabName);
+ targetFrames.push_back(Mantid::Geometry::QSample::QSampleName);
+
+ auto isValidFrame = true;
+ for (auto it = frames.begin(); it != frames.end(); ++it) {
+ auto result = checkIfFrameValid(*it, targetFrames);
+ if (!result) {
+ isValidFrame = result;
+ }
+ }
+
+ if (!frames.empty() && frames.size() != ndims) {
+ isValidFrame = false;
+ }
+
+ if (!isValidFrame) {
+ std::string message = "The selected frames can be 'HKL', 'QSample', 'QLab' "
+ "or 'General Frame'. You must specify as many frames "
+ "as there are dimensions.";
+ errors.insert(std::make_pair(framePropertyName, message));
+ }
+ return errors;
+}
+
+/**
+ * Check if the specified frame matches a target frame
+ * @param frame: the frame name under investigation
+ * @param targetFrames: the allowed frame names
+ * @returns true if the frame name is valid else false
+ */
+bool ImportMDHistoWorkspaceBase::checkIfFrameValid(
+ const std::string &frame, const std::vector<std::string> &targetFrames) {
+ for (auto targetFrame = targetFrames.begin();
+ targetFrame != targetFrames.end(); ++targetFrame) {
+ if (*targetFrame == frame) {
+ return true;
+ }
+ }
+ return false;
+}
+
} // namespace Mantid
} // namespace MDAlgorithms
diff --git a/Framework/MDAlgorithms/src/LoadMD.cpp b/Framework/MDAlgorithms/src/LoadMD.cpp
index 876e8a6bb5dc3e6a124cd2d86e913c4ad00d08ee..c2f6e181f3aaed8ec4bb34c2ac8804a2d5ae1671 100644
--- a/Framework/MDAlgorithms/src/LoadMD.cpp
+++ b/Framework/MDAlgorithms/src/LoadMD.cpp
@@ -7,6 +7,7 @@
#include "MantidGeometry/MDGeometry/MDDimensionExtents.h"
#include "MantidGeometry/MDGeometry/MDFrameFactory.h"
#include "MantidGeometry/MDGeometry/MDFrame.h"
+#include "MantidGeometry/MDGeometry/UnknownFrame.h"
#include "MantidKernel/CPUTimer.h"
#include "MantidKernel/EnabledWhenProperty.h"
#include "MantidKernel/Memory.h"
@@ -353,7 +354,7 @@ void LoadMD::loadDimensions2() {
try {
m_file->getAttr("frame", frame);
} catch (std::exception &) {
- frame = "Unknown frame";
+ frame = Mantid::Geometry::UnknownFrame::UnknownFrameName;
}
Geometry::MDFrame_const_uptr mdFrame =
Geometry::makeMDFrameFactoryChain()->create(
diff --git a/Framework/MDAlgorithms/src/LoadSQW.cpp b/Framework/MDAlgorithms/src/LoadSQW.cpp
index b3bc63d11e5ade978e0c4abcdba21b605c8c4abc..04bc0d1d72f7de3de7b8704fb53b88dcc8528f9a 100644
--- a/Framework/MDAlgorithms/src/LoadSQW.cpp
+++ b/Framework/MDAlgorithms/src/LoadSQW.cpp
@@ -408,15 +408,18 @@ void LoadSQW::buildMDDimsBase(
std::vector<Mantid::Geometry::MDHistoDimensionBuilder> &DimVector) {
std::vector<std::string> dimID(4, "qx");
std::vector<std::string> dimUnit(4, "A^-1");
+ std::vector<std::string> dimFrameName(4, "HKL");
dimID[1] = "qy";
dimID[2] = "qz";
dimID[3] = "en";
dimUnit[3] = "meV";
+ dimFrameName[3] = "meV";
DimVector.resize(4);
for (size_t i = 0; i < 4; i++) {
DimVector[i].setId(dimID[i]);
DimVector[i].setUnits(dimUnit[i]);
DimVector[i].setName(dimID[i]);
+ DimVector[i].setFrameName(dimFrameName[i]);
}
}
diff --git a/Framework/MDAlgorithms/src/MDEventWSWrapper.cpp b/Framework/MDAlgorithms/src/MDEventWSWrapper.cpp
index a7586ccdb57fda588dfee283bad4f658a9022050..f288262e3067891cc48ba147582667dd4a901318 100644
--- a/Framework/MDAlgorithms/src/MDEventWSWrapper.cpp
+++ b/Framework/MDAlgorithms/src/MDEventWSWrapper.cpp
@@ -39,9 +39,10 @@ void MDEventWSWrapper::createEmptyEventWS(const MDWSDescription &description) {
Mantid::coord_t(description.getDimMax()[d]), nBins);
} else {
+ Mantid::Geometry::GeneralFrame frame(description.getDimNames()[d],
+ description.getDimUnits()[d]);
dim = new Geometry::MDHistoDimension(
- description.getDimNames()[d], description.getDimIDs()[d],
- description.getDimUnits()[d],
+ description.getDimNames()[d], description.getDimIDs()[d], frame,
Mantid::coord_t(description.getDimMin()[d]),
Mantid::coord_t(description.getDimMax()[d]), nBins);
}
diff --git a/Framework/MDAlgorithms/src/MergeMD.cpp b/Framework/MDAlgorithms/src/MergeMD.cpp
index 0c441665f31aa3dac30d220e6b4d973dca69d2b5..edd7d43cc1ca3434c1766f4cf62272e5ebb505a5 100644
--- a/Framework/MDAlgorithms/src/MergeMD.cpp
+++ b/Framework/MDAlgorithms/src/MergeMD.cpp
@@ -133,7 +133,7 @@ void MergeMD::createOutputWorkspace(std::vector<std::string> &inputs) {
for (size_t d = 0; d < numDims; d++) {
IMDDimension_const_sptr dim0 = ws0->getDimension(d);
MDHistoDimension *dim = new MDHistoDimension(
- dim0->getName(), dim0->getDimensionId(), dim0->getUnits(), dimMin[d],
+ dim0->getName(), dim0->getDimensionId(), dim0->getMDFrame(), dimMin[d],
dimMax[d], dim0->getNBins());
out->addDimension(MDHistoDimension_sptr(dim));
}
diff --git a/Framework/MDAlgorithms/src/Quantification/SimulateResolutionConvolvedModel.cpp b/Framework/MDAlgorithms/src/Quantification/SimulateResolutionConvolvedModel.cpp
index f26b4faa128941f25567ee0e83fd27e99bcf339f..842e8edf4ef4778baf1bfee0e8a371228a5e2b96 100644
--- a/Framework/MDAlgorithms/src/Quantification/SimulateResolutionConvolvedModel.cpp
+++ b/Framework/MDAlgorithms/src/Quantification/SimulateResolutionConvolvedModel.cpp
@@ -168,6 +168,7 @@ void SimulateResolutionConvolvedModel::createOutputWorkspace() {
bc->setSplitInto(i, inputDim->getNBins());
builder.setMin(inputDim->getMinimum());
builder.setMax(inputDim->getMaximum());
+ builder.setFrameName(inputDim->getMDFrame().name());
m_outputWS->addDimension(builder.create());
}
diff --git a/Framework/MDAlgorithms/src/SlicingAlgorithm.cpp b/Framework/MDAlgorithms/src/SlicingAlgorithm.cpp
index 14522f6fce6d44e071b9d6823c4a04a96560ea01..828bcc13d2e68e5f25d1fe55f39bff453abe58a0 100644
--- a/Framework/MDAlgorithms/src/SlicingAlgorithm.cpp
+++ b/Framework/MDAlgorithms/src/SlicingAlgorithm.cpp
@@ -186,10 +186,6 @@ void SlicingAlgorithm::makeBasisVectorFromString(const std::string &str) {
"input dimensions) in the dimensions string: " +
str);
- // Extract the arguments
- std::string id = name;
- std::string units = Strings::strip(strs[0]);
-
// Get the number of bins from
int numBins = m_numBins[dim];
if (numBins < 1)
@@ -250,9 +246,16 @@ void SlicingAlgorithm::makeBasisVectorFromString(const std::string &str) {
// BIN number
double binningScaling = double(numBins) / (lengthInInput);
+ // Extract the arguments
+ std::string id = name;
+ std::string units = Strings::strip(strs[0]);
+
+ // Create the appropriate frame
+ auto frame = createMDFrameForNonAxisAligned(units, basis);
+
// Create the output dimension
MDHistoDimension_sptr out(
- new MDHistoDimension(name, id, units, static_cast<coord_t>(min),
+ new MDHistoDimension(name, id, *frame, static_cast<coord_t>(min),
static_cast<coord_t>(max), numBins));
// Put both in the algo for future use
@@ -510,9 +513,10 @@ void SlicingAlgorithm::makeAlignedDimensionFromString(const std::string &str) {
// Copy the dimension name, ID and units
IMDDimension_const_sptr inputDim = m_inWS->getDimension(dim_index);
+ const auto &frame = inputDim->getMDFrame();
m_binDimensions.push_back(MDHistoDimension_sptr(
new MDHistoDimension(inputDim->getName(), inputDim->getDimensionId(),
- inputDim->getUnits(), min, max, numBins)));
+ frame, min, max, numBins)));
// Add the index from which we're binning to the vector
this->m_dimensionToBinFrom.push_back(dim_index);
@@ -1002,5 +1006,97 @@ SlicingAlgorithm::getImplicitFunctionForChunk(const size_t *const chunkMin,
}
}
+/**
+ * Create an MDFrame for the Non-Axis-Aligned case. Make sure that
+ * MDFrames onto which the basis vector projects are not mixed, e.g. no mixing
+ * of HKL and GenerFrame
+ * @param units: the units
+ * @param basisVector: the basis vector
+ * @returns the unique pointer
+ */
+Mantid::Geometry::MDFrame_uptr SlicingAlgorithm::createMDFrameForNonAxisAligned(
+ std::string units, Mantid::Kernel::VMD basisVector) const {
+ // Get set of basis vectors
+ auto oldBasis = getOldBasis(m_inWS->getNumDims());
+
+ // Get indices onto which the vector projects
+ auto indicesWithProjection = getIndicesWithProjection(basisVector, oldBasis);
+
+ // Extract MDFrame
+ return extractMDFrameForNonAxisAligned(indicesWithProjection, units);
+}
+
+std::vector<Mantid::Kernel::VMD>
+SlicingAlgorithm::getOldBasis(size_t dimension) const {
+ std::vector<Mantid::Kernel::VMD> oldBasis;
+ for (size_t i = 0; i < dimension; ++i) {
+ Mantid::Kernel::VMD basisVector(dimension);
+ basisVector[i] = 1.0;
+ oldBasis.push_back(basisVector);
+ }
+ return oldBasis;
+}
+
+/**
+ * Check if the two vectors are orthogonal or not
+ * @param oldVector: the old vector
+ * @param basisVector: the vector under investigation
+ * @returns true if there is a projection else false
+ */
+bool SlicingAlgorithm::isProjectingOnFrame(
+ const Mantid::Kernel::VMD &oldVector,
+ const Mantid::Kernel::VMD &basisVector) const {
+ return std::fabs(oldVector.scalar_prod(basisVector)) > 0.0;
+}
+
+/**
+ * Get indices which have a projection contribution
+ * @param basisVector: the vector under investigation
+ * @param oldBasis: the old basis vectors
+ * @returns the indices of vectors onto which the basisVector projects
+ */
+std::vector<size_t> SlicingAlgorithm::getIndicesWithProjection(
+ const Mantid::Kernel::VMD &basisVector,
+ const std::vector<Mantid::Kernel::VMD> &oldBasis) const {
+ std::vector<size_t> indexWithProjection;
+ for (size_t index = 0; index < oldBasis.size(); ++index) {
+ if (isProjectingOnFrame(oldBasis[index], basisVector)) {
+ indexWithProjection.push_back(index);
+ }
+ }
+ return indexWithProjection;
+}
+
+/**
+ * Extract the MDFrame. Make sure that all MDFrames are compatible -- if not
+ * throw
+ * @param indicesWithProjection: list of indices of dimensions which have a
+ * projection
+ * @param units: the units
+ */
+Mantid::Geometry::MDFrame_uptr
+SlicingAlgorithm::extractMDFrameForNonAxisAligned(
+ std::vector<size_t> indicesWithProjection, std::string) const {
+ if (indicesWithProjection.empty()) {
+ g_log.warning() << "Slicing Algorithm: Chosen vector does not "
+ "project on any vector of the old basis.";
+ }
+ // Get a reference frame to perform pairwise comparison
+ const auto &referenceMDFrame =
+ m_inWS->getDimension(indicesWithProjection[0])->getMDFrame();
+
+ for (auto it = indicesWithProjection.begin();
+ it != indicesWithProjection.end(); ++it) {
+ const auto &toCheckMDFrame = m_inWS->getDimension(*it)->getMDFrame();
+ if (!referenceMDFrame.isSameType(toCheckMDFrame)) {
+ g_log.warning() << "Slicing Algorithm: New basis vector tries to "
+ "mix un-mixable MDFrame types.";
+ }
+ }
+
+ Mantid::Geometry::MDFrame_uptr mdFrame(referenceMDFrame.clone());
+ return mdFrame;
+}
+
} // namespace Mantid
} // namespace DataObjects
diff --git a/Framework/MDAlgorithms/test/BinMDTest.h b/Framework/MDAlgorithms/test/BinMDTest.h
index 71dabc2c7a619c5ee241bdc79df54ac04d6e2244..24f1e3228012744fd1725a16afacc3044e742d90 100644
--- a/Framework/MDAlgorithms/test/BinMDTest.h
+++ b/Framework/MDAlgorithms/test/BinMDTest.h
@@ -10,6 +10,7 @@
#include "MantidAPI/ImplicitFunctionParameterParserFactory.h"
#include "MantidGeometry/MDGeometry/MDImplicitFunction.h"
#include "MantidGeometry/MDGeometry/MDTypes.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
#include "MantidMDAlgorithms/BinMD.h"
#include "MantidMDAlgorithms/CreateMDWorkspace.h"
#include "MantidMDAlgorithms/FakeMDEventData.h"
@@ -114,11 +115,13 @@ public:
TS_ASSERT_THROWS_NOTHING(alg.initialize())
TS_ASSERT(alg.isInitialized())
+ Mantid::Geometry::QSample frame;
IMDEventWorkspace_sptr in_ws =
- MDEventsTestHelper::makeMDEW<3>(10, 0.0, 10.0, numEventsPerBox);
+ MDEventsTestHelper::makeAnyMDEWWithFrames<MDLeanEvent<3>, 3>(
+ 10, 0.0, 10.0, frame, numEventsPerBox);
Mantid::Kernel::SpecialCoordinateSystem appliedCoord =
Mantid::Kernel::QSample;
- in_ws->setCoordinateSystem(appliedCoord);
+
auto eventNorm = Mantid::API::MDNormalization::VolumeNormalization;
auto histoNorm = Mantid::API::MDNormalization::NumEventsNormalization;
in_ws->setDisplayNormalization(eventNorm);
diff --git a/Framework/MDAlgorithms/test/CentroidPeaksMD2Test.h b/Framework/MDAlgorithms/test/CentroidPeaksMD2Test.h
index 540525613396ddbf556def05edf754c682dc2f78..e5861ffbcb053100f3e0800a8068a919dfc9c7e1 100644
--- a/Framework/MDAlgorithms/test/CentroidPeaksMD2Test.h
+++ b/Framework/MDAlgorithms/test/CentroidPeaksMD2Test.h
@@ -6,10 +6,14 @@
#include "MantidDataObjects/PeaksWorkspace.h"
#include "MantidDataObjects/MDEventFactory.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
+#include "MantidGeometry/MDGeometry/QLab.h"
#include "MantidTestHelpers/ComponentCreationHelper.h"
#include "MantidMDAlgorithms/CentroidPeaksMD2.h"
#include "MantidMDAlgorithms/CreateMDWorkspace.h"
#include "MantidMDAlgorithms/FakeMDEventData.h"
+#include "MantidKernel/UnitLabelTypes.h"
#include <boost/math/distributions/normal.hpp>
#include <boost/math/special_functions/fpclassify.hpp>
@@ -40,8 +44,22 @@ public:
//-------------------------------------------------------------------------------
/** Create the (blank) MDEW */
- static void createMDEW() {
+ static void createMDEW(std::string CoordinatesToUse) {
// ---- Start with empty MDEW ----
+ std::string frames;
+ if (CoordinatesToUse == "Q (lab frame)") {
+ frames = Mantid::Geometry::QLab::QLabName + "," +
+ Mantid::Geometry::QLab::QLabName + "," +
+ Mantid::Geometry::QLab::QLabName;
+ } else if (CoordinatesToUse == "Q (sample frame)") {
+ frames = Mantid::Geometry::QSample::QSampleName + "," +
+ Mantid::Geometry::QSample::QSampleName + "," +
+ Mantid::Geometry::QSample::QSampleName;
+ } else if (CoordinatesToUse == "HKL") {
+ frames = Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName;
+ }
CreateMDWorkspace algC;
TS_ASSERT_THROWS_NOTHING(algC.initialize())
TS_ASSERT(algC.isInitialized())
@@ -49,7 +67,11 @@ public:
TS_ASSERT_THROWS_NOTHING(
algC.setProperty("Extents", "-10,10,-10,10,-10,10"));
TS_ASSERT_THROWS_NOTHING(algC.setProperty("Names", "h,k,l"));
- TS_ASSERT_THROWS_NOTHING(algC.setProperty("Units", "-,-,-"));
+ std::string units = Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii();
+ TS_ASSERT_THROWS_NOTHING(algC.setProperty("Units", units));
+ TS_ASSERT_THROWS_NOTHING(algC.setProperty("Frames", frames));
TS_ASSERT_THROWS_NOTHING(algC.setProperty("SplitInto", "5"));
TS_ASSERT_THROWS_NOTHING(algC.setProperty("MaxRecursionDepth", "2"));
TS_ASSERT_THROWS_NOTHING(
@@ -140,7 +162,7 @@ public:
/** Full test using faked-out peak data */
void do_test_exec() {
// --- Fake workspace with 3 peaks ------
- createMDEW();
+ createMDEW(CoordinatesToUse);
addPeak(1000, 0, 0., 0., 1.0);
addPeak(1000, 2., 3., 4., 0.5);
addPeak(1000, 6., 6., 6., 2.0);
@@ -196,7 +218,7 @@ public:
void test_exec_HKL_NotInPlace() {
CoordinatesToUse = "HKL";
- createMDEW();
+ createMDEW(CoordinatesToUse);
addPeak(1000, 0, 0., 0., 1.0);
doRun(V3D(0., 0., 0.), 1.0, V3D(0., 0., 0.),
"Start at the center, get the center",
diff --git a/Framework/MDAlgorithms/test/CentroidPeaksMDTest.h b/Framework/MDAlgorithms/test/CentroidPeaksMDTest.h
index 13d1cf96811d487bdf6221f3abb1d0869a1cd2f8..119083d11793659dd66878b3aa9c2c0a08618637 100644
--- a/Framework/MDAlgorithms/test/CentroidPeaksMDTest.h
+++ b/Framework/MDAlgorithms/test/CentroidPeaksMDTest.h
@@ -6,10 +6,14 @@
#include "MantidDataObjects/PeaksWorkspace.h"
#include "MantidDataObjects/MDEventFactory.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
+#include "MantidGeometry/MDGeometry/QLab.h"
#include "MantidMDAlgorithms/CentroidPeaksMD.h"
#include "MantidMDAlgorithms/CreateMDWorkspace.h"
#include "MantidMDAlgorithms/FakeMDEventData.h"
#include "MantidTestHelpers/ComponentCreationHelper.h"
+#include "MantidKernel/UnitLabelTypes.h"
#include <boost/math/distributions/normal.hpp>
#include <boost/math/special_functions/fpclassify.hpp>
@@ -40,8 +44,23 @@ public:
//-------------------------------------------------------------------------------
/** Create the (blank) MDEW */
- static void createMDEW() {
+ static void createMDEW(std::string CoordinatesToUse) {
// ---- Start with empty MDEW ----
+ std::string frames;
+ if (CoordinatesToUse == "Q (lab frame)") {
+ frames = Mantid::Geometry::QLab::QLabName + "," +
+ Mantid::Geometry::QLab::QLabName + "," +
+ Mantid::Geometry::QLab::QLabName;
+ } else if (CoordinatesToUse == "Q (sample frame)") {
+ frames = Mantid::Geometry::QSample::QSampleName + "," +
+ Mantid::Geometry::QSample::QSampleName + "," +
+ Mantid::Geometry::QSample::QSampleName;
+ } else if (CoordinatesToUse == "HKL") {
+ frames = Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName;
+ }
+
CreateMDWorkspace algC;
TS_ASSERT_THROWS_NOTHING(algC.initialize())
TS_ASSERT(algC.isInitialized())
@@ -49,7 +68,11 @@ public:
TS_ASSERT_THROWS_NOTHING(
algC.setProperty("Extents", "-10,10,-10,10,-10,10"));
TS_ASSERT_THROWS_NOTHING(algC.setProperty("Names", "h,k,l"));
- TS_ASSERT_THROWS_NOTHING(algC.setProperty("Units", "-,-,-"));
+ std::string units = Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii();
+ TS_ASSERT_THROWS_NOTHING(algC.setProperty("Units", units));
+ TS_ASSERT_THROWS_NOTHING(algC.setProperty("Frames", frames));
TS_ASSERT_THROWS_NOTHING(algC.setProperty("SplitInto", "5"));
TS_ASSERT_THROWS_NOTHING(algC.setProperty("MaxRecursionDepth", "2"));
TS_ASSERT_THROWS_NOTHING(
@@ -140,7 +163,7 @@ public:
/** Full test using faked-out peak data */
void do_test_exec() {
// --- Fake workspace with 3 peaks ------
- createMDEW();
+ createMDEW(CoordinatesToUse);
addPeak(1000, 0, 0., 0., 1.0);
addPeak(1000, 2., 3., 4., 0.5);
addPeak(1000, 6., 6., 6., 2.0);
@@ -196,7 +219,7 @@ public:
void test_exec_HKL_NotInPlace() {
CoordinatesToUse = "HKL";
- createMDEW();
+ createMDEW(CoordinatesToUse);
addPeak(1000, 0, 0., 0., 1.0);
doRun(V3D(0., 0., 0.), 1.0, V3D(0., 0., 0.),
"Start at the center, get the center",
diff --git a/Framework/MDAlgorithms/test/CloneMDWorkspaceTest.h b/Framework/MDAlgorithms/test/CloneMDWorkspaceTest.h
index 9bebcf04fc71e0c4ae9de75ef74f818adc70a2d3..5e0527d39be4348a15247bdb804311d7483bc543 100644
--- a/Framework/MDAlgorithms/test/CloneMDWorkspaceTest.h
+++ b/Framework/MDAlgorithms/test/CloneMDWorkspaceTest.h
@@ -190,11 +190,12 @@ public:
void test_MDHistoWorkspace_2D_uneven_bins() {
// Make the number of bins uneven in both dimensions
Mantid::DataObjects::MDHistoWorkspace *ws = NULL;
+ Mantid::Geometry::GeneralFrame frame("General Frame", "m");
ws = new Mantid::DataObjects::MDHistoWorkspace(
MDHistoDimension_sptr(
- new MDHistoDimension("x", "x", "m", 0.0, 10.0, 50)),
+ new MDHistoDimension("x", "x", frame, 0.0, 10.0, 50)),
MDHistoDimension_sptr(
- new MDHistoDimension("y", "y", "m", 0.0, 10.0, 100)));
+ new MDHistoDimension("y", "y", frame, 0.0, 10.0, 100)));
Mantid::DataObjects::MDHistoWorkspace_sptr ws1(ws);
ws1->setTo(1.234, 5.678, 1.0);
do_test_MDHisto(ws1);
diff --git a/Framework/MDAlgorithms/test/ConvertCWSDExpToMomentumTest.h b/Framework/MDAlgorithms/test/ConvertCWSDExpToMomentumTest.h
index 729b9eecd591625d85b7cbbe3dca4d3e7d38ff79..89ae4e78de0f414f8738834e7d2ad05ff7c78e7a 100644
--- a/Framework/MDAlgorithms/test/ConvertCWSDExpToMomentumTest.h
+++ b/Framework/MDAlgorithms/test/ConvertCWSDExpToMomentumTest.h
@@ -9,6 +9,7 @@
#include "MantidDataObjects/TableWorkspace.h"
#include "MantidAPI/IMDIterator.h"
#include "MantidGeometry/Instrument/ComponentHelper.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
using Mantid::MDAlgorithms::ConvertCWSDExpToMomentum;
using namespace Mantid;
@@ -69,6 +70,13 @@ public:
Geometry::Instrument_const_sptr instrument = expinfo0->getInstrument();
TS_ASSERT_EQUALS(instrument->getNumberDetectors(), 256);
+ // Test the frame type
+ for (size_t dim = 0; dim < outws->getNumDims(); ++dim) {
+ const auto &frame = outws->getDimension(dim)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be convertible to a QSample frame",
+ Mantid::Geometry::QSample::QSampleName, frame.name());
+ }
+
return;
}
diff --git a/Framework/MDAlgorithms/test/ConvertCWSDMDtoHKLTest.h b/Framework/MDAlgorithms/test/ConvertCWSDMDtoHKLTest.h
index d4044fec95e162a24b7145d0c042364eebd9943a..f9dc99cd849e4db52ff349c735ddd68ae68ef18b 100644
--- a/Framework/MDAlgorithms/test/ConvertCWSDMDtoHKLTest.h
+++ b/Framework/MDAlgorithms/test/ConvertCWSDMDtoHKLTest.h
@@ -9,6 +9,7 @@
#include "MantidAPI/IMDEventWorkspace.h"
#include "MantidAPI/FrameworkManager.h"
#include "MantidGeometry/Instrument.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
using Mantid::MDAlgorithms::ConvertCWSDMDtoHKL;
@@ -60,6 +61,12 @@ public:
TS_ASSERT_EQUALS(hklws->getSpecialCoordinateSystem(),
Mantid::Kernel::SpecialCoordinateSystem::HKL);
+ // Test the frame type
+ for (size_t dim = 0; dim < hklws->getNumDims(); ++dim) {
+ const auto &frame = hklws->getDimension(dim)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be convertible to a HKL frame",
+ Mantid::Geometry::HKL::HKLName, frame.name());
+ }
}
private:
@@ -68,11 +75,12 @@ private:
void createMDEW() {
// ---- Start with empty MDEW ----
FrameworkManager::Instance().exec(
- "CreateMDWorkspace", 18, "Dimensions", "3", "EventType", "MDEvent",
+ "CreateMDWorkspace", 20, "Dimensions", "3", "EventType", "MDEvent",
"Extents", "-10,10,-10,10,-10,10", "Names",
"Q_sample_x,Q_sample_y,Q_sample_z", "Units",
- "Q_Sample_X,Q_Sample_Y,Q_Sample_Z", "SplitInto", "5", "SplitThreshold",
- "20", "MaxRecursionDepth", "15", "OutputWorkspace", "MDEWS");
+ "Q_Sample_X,Q_Sample_Y,Q_Sample_Z", "Frames", "QSample,QSample,QSample",
+ "SplitInto", "5", "SplitThreshold", "20", "MaxRecursionDepth", "15",
+ "OutputWorkspace", "MDEWS");
// Give it an instrument
Instrument_sptr inst =
diff --git a/Framework/MDAlgorithms/test/ConvertSpiceDataToRealSpaceTest.h b/Framework/MDAlgorithms/test/ConvertSpiceDataToRealSpaceTest.h
index 3c3d8ca250fa6e174b077ab3dc4dc8a505f75a90..25d09c08f36be36d0b12e25a01c2df4006548ab0 100644
--- a/Framework/MDAlgorithms/test/ConvertSpiceDataToRealSpaceTest.h
+++ b/Framework/MDAlgorithms/test/ConvertSpiceDataToRealSpaceTest.h
@@ -221,6 +221,14 @@ public:
DateAndTime time1 = times[1];
TS_ASSERT_EQUALS(time1.toFormattedString(), "2012-Aug-13 11:58:03");
+ // Test the frame type
+ for (size_t dim = 0; dim < mdws->getNumDims(); ++dim) {
+ const auto &frame = mdws->getDimension(dim)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be convertible to a General frame",
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance,
+ frame.name());
+ }
+
// Examine Monitor MDWorkspace
IMDWorkspace_const_sptr monmdws = boost::dynamic_pointer_cast<IMDWorkspace>(
AnalysisDataService::Instance().retrieve("MonitorMDW"));
@@ -237,6 +245,14 @@ public:
yl = mditer->getInnerSignal(44 * 61 - 1);
TS_ASSERT_DELTA(yl, 31968.0, 0.1);
+ // Test the frame type
+ for (size_t dim = 0; dim < monmdws->getNumDims(); ++dim) {
+ const auto &frame = monmdws->getDimension(dim)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be convertible to a General frame",
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance,
+ frame.name());
+ }
+
// Remove workspaces
AnalysisDataService::Instance().remove("DataTable");
AnalysisDataService::Instance().remove("LogParentWS");
diff --git a/Framework/MDAlgorithms/test/ConvertToDetectorFaceMDTest.h b/Framework/MDAlgorithms/test/ConvertToDetectorFaceMDTest.h
index daddc451b76972efebc21fb5dc04f69b6dc0dbba..9b23889c4e0c851099a9a6f8cc50f9b7b83455dd 100644
--- a/Framework/MDAlgorithms/test/ConvertToDetectorFaceMDTest.h
+++ b/Framework/MDAlgorithms/test/ConvertToDetectorFaceMDTest.h
@@ -81,6 +81,9 @@ public:
TS_ASSERT_DELTA(dim->getMinimum(), 0, 1e-5);
TS_ASSERT_DELTA(dim->getMaximum(), 10, 1e-5);
TS_ASSERT_EQUALS(dim->getUnits(), "pixel");
+ TSM_ASSERT_EQUALS("Should be convertible to a General frame",
+ Mantid::Geometry::GeneralFrame::GeneralFrameName,
+ dim->getMDFrame().name());
}
IMDDimension_const_sptr dim = ws->getDimension(2);
TS_ASSERT_EQUALS(dim->getName(), "dSpacing");
@@ -88,6 +91,9 @@ public:
TS_ASSERT_DELTA(dim->getMinimum(), 0, 1e-5);
TS_ASSERT_DELTA(dim->getMaximum(), 100, 1e-5);
TS_ASSERT_EQUALS(dim->getUnits(), "Angstrom");
+ TSM_ASSERT_EQUALS("Should be convertible to a General frame",
+ Mantid::Geometry::GeneralFrame::GeneralFrameName,
+ dim->getMDFrame().name());
return ws;
}
diff --git a/Framework/MDAlgorithms/test/ConvertToDiffractionMDWorkspaceTest.h b/Framework/MDAlgorithms/test/ConvertToDiffractionMDWorkspaceTest.h
index c194b578597a99afa05c40b26d739645a7324f54..a56dd8014a1d0126337ecf4b6161855211650ef2 100644
--- a/Framework/MDAlgorithms/test/ConvertToDiffractionMDWorkspaceTest.h
+++ b/Framework/MDAlgorithms/test/ConvertToDiffractionMDWorkspaceTest.h
@@ -8,7 +8,9 @@
#include "MantidTestHelpers/ComponentCreationHelper.h"
#include "MantidTestHelpers/MDEventsTestHelper.h"
#include "MantidTestHelpers/WorkspaceCreationHelper.h"
-
+#include "MantidGeometry/MDGeometry/QSample.h"
+#include "MantidGeometry/MDGeometry/QLab.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
#include <cxxtest/TestSuite.h>
using namespace Mantid;
@@ -48,6 +50,12 @@ public:
return;
TS_ASSERT_EQUALS(ws->getDimension(0)->getName(), "Q_lab_x");
TS_ASSERT_EQUALS(ws->getSpecialCoordinateSystem(), Mantid::Kernel::QLab);
+ // Test the frame type
+ for (size_t dim = 0; dim < ws->getNumDims(); ++dim) {
+ const auto &frame = ws->getDimension(dim)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be convertible to a QSample frame",
+ Mantid::Geometry::QLab::QLabName, frame.name());
+ }
// But you can't add to an existing one of the wrong dimensions type, if you
// choose Append
@@ -86,6 +94,12 @@ public:
return;
TS_ASSERT_EQUALS(ws->getDimension(0)->getName(), "H");
TS_ASSERT_EQUALS(ws->getSpecialCoordinateSystem(), Mantid::Kernel::HKL);
+ // Test the frame type
+ for (size_t dim = 0; dim < ws->getNumDims(); ++dim) {
+ const auto &frame = ws->getDimension(dim)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be convertible to a HKL frame",
+ Mantid::Geometry::HKL::HKLName, frame.name());
+ }
AnalysisDataService::Instance().remove("testOutMD");
alg = FrameworkManager::Instance().exec("ConvertToDiffractionMDWorkspace",
@@ -103,6 +117,12 @@ public:
return;
TS_ASSERT_EQUALS(ws->getDimension(0)->getName(), "Q_sample_x");
TS_ASSERT_EQUALS(ws->getSpecialCoordinateSystem(), Mantid::Kernel::QSample);
+ // Test the frame type
+ for (size_t dim = 0; dim < ws->getNumDims(); ++dim) {
+ const auto &frame = ws->getDimension(dim)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be convertible to a QSample frame",
+ Mantid::Geometry::QSample::QSampleName, frame.name());
+ }
}
void do_test_MINITOPAZ(EventType type, size_t numTimesToAdd = 1,
diff --git a/Framework/MDAlgorithms/test/ConvertToReflectometryQTest.h b/Framework/MDAlgorithms/test/ConvertToReflectometryQTest.h
index ac63a1421a01be939bb6ae788d6f9c9729107e9e..2804987b76ddcb4959bc4d720b36597272997fb3 100644
--- a/Framework/MDAlgorithms/test/ConvertToReflectometryQTest.h
+++ b/Framework/MDAlgorithms/test/ConvertToReflectometryQTest.h
@@ -13,6 +13,9 @@
#include "MantidTestHelpers/WorkspaceCreationHelper.h"
#include "MantidDataObjects/Workspace2D.h"
+#include "MantidGeometry/MDGeometry/GeneralFrame.h"
+#include "MantidGeometry/MDGeometry/QLab.h"
+
#include <boost/assign.hpp>
#include <cxxtest/TestSuite.h>
@@ -153,6 +156,13 @@ public:
"OutputTransformedWorkspace"));
TS_ASSERT(ws != NULL);
TS_ASSERT_EQUALS(2, ws->getExperimentInfo(0)->run().getLogData().size());
+ // Assert that dimensions should be a general frame
+ const auto &frame0 = ws->getDimension(0)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be a QLab frame",
+ Mantid::Geometry::QLab::QLabName, frame0.name());
+ TSM_ASSERT_EQUALS(
+ "Should have a special coordinate system selection of QLab",
+ ws->getSpecialCoordinateSystem(), Mantid::Kernel::QLab);
}
void test_execute_kikf_md() {
@@ -162,6 +172,12 @@ public:
Mantid::API::AnalysisDataService::Instance().retrieve(
"OutputTransformedWorkspace"));
TS_ASSERT(ws != NULL);
+ // Assert that dimensions should be a general frame
+ const auto &frame0 = ws->getDimension(0)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be a general frame", "KiKf", frame0.name());
+ TSM_ASSERT_EQUALS(
+ "Should have a special coordinate system selection of None",
+ ws->getSpecialCoordinateSystem(), Mantid::Kernel::None);
}
void test_execute_pipf_md() {
@@ -171,6 +187,12 @@ public:
Mantid::API::AnalysisDataService::Instance().retrieve(
"OutputTransformedWorkspace"));
TS_ASSERT(ws != NULL);
+ // Assert that dimensions should be a general frame
+ const auto &frame0 = ws->getDimension(0)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be a general frame", "P", frame0.name());
+ TSM_ASSERT_EQUALS(
+ "Should have a special coordinate system selection of None",
+ ws->getSpecialCoordinateSystem(), Mantid::Kernel::None);
}
void test_execute_qxqz_2D() {
diff --git a/Framework/MDAlgorithms/test/CreateMDHistoWorkspaceTest.h b/Framework/MDAlgorithms/test/CreateMDHistoWorkspaceTest.h
index 534d7b00cde935fba25e9f0769a7a1da88c3c7e7..c575738d9c2124b188f9e15dd93ddb1e982928a8 100644
--- a/Framework/MDAlgorithms/test/CreateMDHistoWorkspaceTest.h
+++ b/Framework/MDAlgorithms/test/CreateMDHistoWorkspaceTest.h
@@ -4,7 +4,8 @@
#include <cxxtest/TestSuite.h>
#include "MantidKernel/Timer.h"
#include "MantidKernel/System.h"
-
+#include "MantidGeometry/MDGeometry/QSample.h"
+#include "MantidGeometry/MDGeometry/GeneralFrame.h"
#include "MantidMDAlgorithms/CreateMDHistoWorkspace.h"
using namespace Mantid;
@@ -103,6 +104,7 @@ public:
TS_ASSERT_THROWS_NOTHING(alg.setPropertyValue("Extents", "-1,1"));
TS_ASSERT_THROWS_NOTHING(alg.setPropertyValue("Names", "A"));
TS_ASSERT_THROWS_NOTHING(alg.setPropertyValue("Units", "U"));
+ TS_ASSERT_THROWS_NOTHING(alg.setPropertyValue("Frames", "QSample"));
TS_ASSERT_THROWS_NOTHING(
alg.setPropertyValue("OutputWorkspace", outWSName));
TS_ASSERT_THROWS_NOTHING(alg.execute(););
@@ -122,7 +124,12 @@ public:
TS_ASSERT_EQUALS("A", dim1->getName());
TS_ASSERT_EQUALS("A", dim1->getDimensionId());
- TS_ASSERT_EQUALS("U", dim1->getUnits().ascii());
+ TSM_ASSERT("Should not be set to U any longer",
+ "U" != dim1->getUnits().ascii());
+ TSM_ASSERT_EQUALS("Should be a QSample frame",
+ Mantid::Geometry::QSample::QSampleName,
+ dim1->getMDFrame().name());
+
TS_ASSERT_EQUALS(1, dim1->getMaximum());
TS_ASSERT_EQUALS(-1, dim1->getMinimum());
TS_ASSERT_EQUALS(5, dim1->getNBins());
@@ -177,6 +184,15 @@ public:
TS_ASSERT_EQUALS(2, dim1->getNBins());
TS_ASSERT_EQUALS(3, dim2->getNBins());
+ // Check frame and label
+ TSM_ASSERT("Should be set to U", "U" == dim1->getUnits().ascii());
+ TSM_ASSERT_EQUALS("Should be convertible to a General Frame",
+ Mantid::Geometry::GeneralFrame::GeneralFrameName,
+ dim1->getMDFrame().name());
+ TSM_ASSERT_EQUALS("Should be convertible to a General Frame",
+ Mantid::Geometry::GeneralFrame::GeneralFrameName,
+ dim2->getMDFrame().name());
+
// Check the data
double *signals = outWs->getSignalArray();
TS_ASSERT_DELTA(1, signals[0], 0.0001); // Check the first signal value
diff --git a/Framework/MDAlgorithms/test/CreateMDWorkspaceTest.h b/Framework/MDAlgorithms/test/CreateMDWorkspaceTest.h
index d6bdcd9666be6581bd396bfeb19e3230547ba75c..dd62747610b416300b829c11c1c2da73eb3c25be 100644
--- a/Framework/MDAlgorithms/test/CreateMDWorkspaceTest.h
+++ b/Framework/MDAlgorithms/test/CreateMDWorkspaceTest.h
@@ -3,6 +3,8 @@
#include "MantidAPI/FrameworkManager.h"
#include "MantidMDAlgorithms/CreateMDWorkspace.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
+#include "MantidGeometry/MDGeometry/GeneralFrame.h"
#include <cxxtest/TestSuite.h>
@@ -62,6 +64,23 @@ public:
"-1,1,-2,2,3,3", "Names", "One,Two,Three",
"MinRecursionDepth", "5", "MaxRecursionDepth", "4")
->isExecuted());
+
+ // Wrong Frame-type input
+ TS_ASSERT_THROWS(FrameworkManager::Instance().exec(
+ "CreateMDWorkspace", 12, "OutputWorkspace",
+ "simple_md", "Dimensions", "3", "Extents",
+ "-1,1,-2,2,3,3", "Names", "One,Two,Three", "Units",
+ "One,Two,Three", "Frames", "QSample, QTest, QSample"),
+ std::runtime_error);
+
+ // Wrong number of frames
+ TS_ASSERT_THROWS(!FrameworkManager::Instance().exec(
+ "CreateMDWorkspace", 12, "OutputWorkspace",
+ "simple_md", "Dimensions", "3", "Extents",
+ "-1,1,-2,2,3,3", "Names", "One,Two,Three", "Units",
+ "One,Two,Three", "Frames", "QSample, QSample"),
+ std::runtime_error);
+
// Uses too much memory
TS_ASSERT(!FrameworkManager::Instance()
.exec("CreateMDWorkspace", 14, "OutputWorkspace",
@@ -73,7 +92,7 @@ public:
}
void do_test_exec(std::string Filename, bool lean, int MinRecursionDepth = 0,
- int expectedNumMDBoxes = 216) {
+ int expectedNumMDBoxes = 216, bool withFrames = false) {
std::string wsName = "CreateMDWorkspaceTest_out";
CreateMDWorkspace alg;
@@ -91,6 +110,9 @@ public:
alg.setPropertyValue("OutputWorkspace", wsName);
alg.setPropertyValue("Filename", Filename);
alg.setPropertyValue("Memory", "1");
+ if (withFrames) {
+ alg.setPropertyValue("Frames", "QSample, QSample, QSample");
+ }
std::string fullName = alg.getPropertyValue("Filename");
if (fullName != "")
@@ -162,6 +184,22 @@ public:
if (Poco::File(s).exists())
Poco::File(s).remove();
}
+
+ // Test the frame type
+ if (withFrames) {
+ for (size_t dim = 0; dim < ws->getNumDims(); ++dim) {
+ const auto &frame = ws->getDimension(dim)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be convertible to a QSample frame",
+ Mantid::Geometry::QSample::QSampleName, frame.name());
+ }
+ } else {
+ for (size_t dim = 0; dim < ws->getNumDims(); ++dim) {
+ const auto &frame = ws->getDimension(dim)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be convertible to a General frame",
+ Mantid::Geometry::GeneralFrame::GeneralFrameName,
+ frame.name());
+ }
+ }
}
void test_exec_MDEvent() { do_test_exec("", false); }
diff --git a/Framework/MDAlgorithms/test/ImportMDEventWorkspaceTest.h b/Framework/MDAlgorithms/test/ImportMDEventWorkspaceTest.h
index a32ae2f59a70eaa7254227fdb248451eceba260b..170c489ddc9c4402296cd62feb84b35d037320ba 100644
--- a/Framework/MDAlgorithms/test/ImportMDEventWorkspaceTest.h
+++ b/Framework/MDAlgorithms/test/ImportMDEventWorkspaceTest.h
@@ -3,6 +3,7 @@
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidMDAlgorithms/ImportMDEventWorkspace.h"
+#include "MantidGeometry/MDGeometry/GeneralFrame.h"
#include "MantidKernel/ConfigService.h"
#include <cxxtest/TestSuite.h>
@@ -318,7 +319,9 @@ public:
AnalysisDataService::Instance().retrieveWS<IMDEventWorkspace>(
"test_out");
TS_ASSERT_EQUALS(3, outWS->getNumDims());
-
+ TSM_ASSERT_EQUALS("Should be a general frame",
+ outWS->getDimension(0)->getMDFrame().name(),
+ Mantid::Geometry::GeneralFrame::GeneralFrameName);
TS_ASSERT_EQUALS(3, outWS->getNPoints());
TS_ASSERT_EQUALS("MDEvent", outWS->getEventTypeName());
}
diff --git a/Framework/MDAlgorithms/test/ImportMDHistoWorkspaceTest.h b/Framework/MDAlgorithms/test/ImportMDHistoWorkspaceTest.h
index cd09e88274deb742a0e2c20fe71b8ea21dadb019..bad5b97cb80aa96fa97c09ca5c99fd22c1954db3 100644
--- a/Framework/MDAlgorithms/test/ImportMDHistoWorkspaceTest.h
+++ b/Framework/MDAlgorithms/test/ImportMDHistoWorkspaceTest.h
@@ -4,7 +4,7 @@
#include "MantidAPI/IMDHistoWorkspace.h"
#include "MantidKernel/ConfigService.h"
#include "MantidMDAlgorithms/ImportMDHistoWorkspace.h"
-
+#include "MantidGeometry/MDGeometry/QSample.h"
#include <cxxtest/TestSuite.h>
#include <Poco/Path.h>
@@ -277,7 +277,9 @@ public:
alg->setPropertyValue("Extents", "-1,1,-1,1,-1,1");
alg->setPropertyValue("NumberOfBins", "2,2,2");
alg->setPropertyValue("Names", "A,B,C");
- alg->setPropertyValue("Units", "U1,U2,U3");
+ alg->setPropertyValue("Units", "U,U,U");
+ TS_ASSERT_THROWS_NOTHING(
+ alg->setPropertyValue("Frames", "QSample, QSample, QSample"));
alg->setPropertyValue("OutputWorkspace", "test_workspace");
alg->setRethrows(true);
alg->execute();
@@ -296,6 +298,16 @@ public:
// Check the dimensionality
TS_ASSERT_EQUALS(3, outWs->getNumDims());
+ // Check frame
+ for (size_t dim = 0; dim < outWs->getNumDims(); ++dim) {
+ auto dimension = outWs->getDimension(dim);
+ const auto &frame = dimension->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be convertible to a QSample frame",
+ Mantid::Geometry::QSample::QSampleName, frame.name());
+ TSM_ASSERT("Should not be set to U any longer",
+ "U" != dimension->getUnits().ascii());
+ }
+
ADS.remove("test_workspace");
}
};
diff --git a/Framework/MDAlgorithms/test/IntegratePeaksMD2Test.h b/Framework/MDAlgorithms/test/IntegratePeaksMD2Test.h
index 9ae687145f3c08fa7d9dbd83c7ebd76019a55463..dc5870cc71992f515132734ec0ad6133883b18f9 100644
--- a/Framework/MDAlgorithms/test/IntegratePeaksMD2Test.h
+++ b/Framework/MDAlgorithms/test/IntegratePeaksMD2Test.h
@@ -8,10 +8,13 @@
#include "MantidDataObjects/PeaksWorkspace.h"
#include "MantidDataObjects/PeakShapeSpherical.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
+
#include "MantidMDAlgorithms/CreateMDWorkspace.h"
#include "MantidMDAlgorithms/FakeMDEventData.h"
#include "MantidMDAlgorithms/IntegratePeaksMD2.h"
#include "MantidTestHelpers/ComponentCreationHelper.h"
+#include "MantidKernel/UnitLabelTypes.h"
#include <boost/math/distributions/normal.hpp>
#include <boost/math/special_functions/fpclassify.hpp>
@@ -91,7 +94,14 @@ public:
TS_ASSERT_THROWS_NOTHING(
algC.setProperty("Extents", "-10,10,-10,10,-10,10"));
TS_ASSERT_THROWS_NOTHING(algC.setProperty("Names", "h,k,l"));
- TS_ASSERT_THROWS_NOTHING(algC.setProperty("Units", "-,-,-"));
+ std::string units = Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii();
+ TS_ASSERT_THROWS_NOTHING(algC.setProperty("Units", units));
+ std::string frames = Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName;
+ TS_ASSERT_THROWS_NOTHING(algC.setProperty("Frames", frames));
TS_ASSERT_THROWS_NOTHING(algC.setProperty("SplitInto", "5"));
TS_ASSERT_THROWS_NOTHING(algC.setProperty("MaxRecursionDepth", "2"));
TS_ASSERT_THROWS_NOTHING(algC.setPropertyValue(
diff --git a/Framework/MDAlgorithms/test/IntegratePeaksMDTest.h b/Framework/MDAlgorithms/test/IntegratePeaksMDTest.h
index b992ac7198cf4501ec5ecbe1ee6861c072d7e22d..279e98997fd7a70f7207e39620e05d26519da748 100644
--- a/Framework/MDAlgorithms/test/IntegratePeaksMDTest.h
+++ b/Framework/MDAlgorithms/test/IntegratePeaksMDTest.h
@@ -8,10 +8,12 @@
#include "MantidDataObjects/PeaksWorkspace.h"
#include "MantidDataObjects/PeakShapeSpherical.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
#include "MantidMDAlgorithms/IntegratePeaksMD.h"
#include "MantidMDAlgorithms/CreateMDWorkspace.h"
#include "MantidMDAlgorithms/FakeMDEventData.h"
#include "MantidTestHelpers/ComponentCreationHelper.h"
+#include "MantidKernel/UnitLabelTypes.h"
#include <boost/math/distributions/normal.hpp>
#include <boost/math/special_functions/fpclassify.hpp>
@@ -86,9 +88,16 @@ public:
TS_ASSERT_THROWS_NOTHING(
algC.setProperty("Extents", "-10,10,-10,10,-10,10"));
TS_ASSERT_THROWS_NOTHING(algC.setProperty("Names", "h,k,l"));
- TS_ASSERT_THROWS_NOTHING(algC.setProperty("Units", "-,-,-"));
+ std::string units = Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii() + "," +
+ Mantid::Kernel::Units::Symbol::RLU.ascii();
+ TS_ASSERT_THROWS_NOTHING(algC.setProperty("Units", units));
TS_ASSERT_THROWS_NOTHING(algC.setProperty("SplitInto", "5"));
TS_ASSERT_THROWS_NOTHING(algC.setProperty("MaxRecursionDepth", "2"));
+ std::string frames = Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName + "," +
+ Mantid::Geometry::HKL::HKLName;
+ TS_ASSERT_THROWS_NOTHING(algC.setProperty("Frames", frames));
TS_ASSERT_THROWS_NOTHING(
algC.setPropertyValue("OutputWorkspace", "IntegratePeaksMDTest_MDEWS"));
TS_ASSERT_THROWS_NOTHING(algC.execute());
@@ -123,7 +132,9 @@ public:
MDEventWorkspace3Lean::sptr mdews =
AnalysisDataService::Instance().retrieveWS<MDEventWorkspace3Lean>(
"IntegratePeaksMDTest_MDEWS");
- mdews->setCoordinateSystem(Mantid::Kernel::HKL);
+ auto &frame = mdews->getDimension(0)->getMDFrame();
+ TSM_ASSERT_EQUALS("Should be HKL", Mantid::Geometry::HKL::HKLName,
+ frame.name());
TS_ASSERT_EQUALS(mdews->getNPoints(), 3000);
TS_ASSERT_DELTA(mdews->getBox()->getSignal(), 3000.0, 1e-2);
diff --git a/Framework/MDAlgorithms/test/LoadMDTest.h b/Framework/MDAlgorithms/test/LoadMDTest.h
index 4ff9b2548cb8be67a0a65056d3fb9bb3b1b7e138..744d40d6a2e7c53471ab45ef5454969929d730d2 100644
--- a/Framework/MDAlgorithms/test/LoadMDTest.h
+++ b/Framework/MDAlgorithms/test/LoadMDTest.h
@@ -11,6 +11,7 @@
#include "MantidDataObjects/MDEventFactory.h"
#include "MantidDataObjects/MDEventWorkspace.h"
#include "MantidDataObjects/BoxControllerNeXusIO.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
#include "MantidMDAlgorithms/LoadMD.h"
#include <cxxtest/TestSuite.h>
@@ -565,8 +566,10 @@ public:
void test_histo1D() {
Mantid::coord_t min(-10.0);
Mantid::coord_t max(10.0);
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "m");
std::vector<Geometry::IMDDimension_sptr> dims(
- 1, boost::make_shared<Geometry::MDHistoDimension>("X", "x", "m", min,
+ 1, boost::make_shared<Geometry::MDHistoDimension>("X", "x", frame, min,
max, 5));
MDHistoWorkspace_sptr ws =
boost::make_shared<MDHistoWorkspace>(dims, API::VolumeNormalization);
@@ -591,9 +594,11 @@ public:
/// More of an integration test as it uses both load and save.
void test_save_and_load_special_coordinates_MDEventWorkspace() {
+ Mantid::Geometry::QSample frame;
MDEventWorkspace1Lean::sptr mdeventWS =
- MDEventsTestHelper::makeMDEW<1>(10, 0.0, 10.0, 2);
- const SpecialCoordinateSystem appliedCoordinateSystem = QSample;
+ MDEventsTestHelper::makeMDEWWithFrames<1>(10, 0.0, 10.0, frame, 2);
+ const Mantid::Kernel::SpecialCoordinateSystem appliedCoordinateSystem =
+ Mantid::Kernel::SpecialCoordinateSystem::QSample;
mdeventWS->setCoordinateSystem(appliedCoordinateSystem);
auto loadedWS = testSaveAndLoadWorkspace(mdeventWS, "MDEventWorkspace");
@@ -605,9 +610,11 @@ public:
// backwards-compatability check for coordinate in log
void test_load_coordinate_system_MDEventWorkspace_from_experiment_info() {
+ Mantid::Geometry::QSample frame;
MDEventWorkspace1Lean::sptr mdeventWS =
- MDEventsTestHelper::makeMDEW<1>(10, 0.0, 10.0, 2);
- const SpecialCoordinateSystem appliedCoordinateSystem = QSample;
+ MDEventsTestHelper::makeMDEWWithFrames<1>(10, 0.0, 10.0, frame, 2);
+ const Mantid::Kernel::SpecialCoordinateSystem appliedCoordinateSystem =
+ Mantid::Kernel::SpecialCoordinateSystem::QSample;
mdeventWS->setCoordinateSystem(appliedCoordinateSystem);
// Create a log in the first experiment info to simulated an old version of
@@ -626,9 +633,11 @@ public:
}
void test_save_and_load_special_coordinates_MDHistoWorkspace() {
- auto mdhistoWS = MDEventsTestHelper::makeFakeMDHistoWorkspace(
- 2.5, 2, 10, 10.0, 3.5, "", 4.5);
- const SpecialCoordinateSystem appliedCoordinateSystem = QSample;
+ Mantid::Geometry::QSample frame;
+ auto mdhistoWS = MDEventsTestHelper::makeFakeMDHistoWorkspaceWithMDFrame(
+ 2.5, 2, frame, 10, 10.0, 3.5, "", 4.5);
+ const Mantid::Kernel::SpecialCoordinateSystem appliedCoordinateSystem =
+ Mantid::Kernel::SpecialCoordinateSystem::QSample;
mdhistoWS->setCoordinateSystem(appliedCoordinateSystem);
auto loadedWS = testSaveAndLoadWorkspace(mdhistoWS, "MDHistoWorkspace");
@@ -640,9 +649,11 @@ public:
// backwards-compatability check for coordinate in log
void test_load_coordinate_system_MDHistoWorkspace_from_experiment_info() {
- auto mdhistoWS = MDEventsTestHelper::makeFakeMDHistoWorkspace(
- 2.5, 2, 10, 10.0, 3.5, "", 4.5);
- const SpecialCoordinateSystem appliedCoordinateSystem = QSample;
+ Mantid::Geometry::QSample frame;
+ auto mdhistoWS = MDEventsTestHelper::makeFakeMDHistoWorkspaceWithMDFrame(
+ 2.5, 2, frame, 10, 10.0, 3.5, "", 4.5);
+ const Mantid::Kernel::SpecialCoordinateSystem appliedCoordinateSystem =
+ Mantid::Kernel::SpecialCoordinateSystem::QSample;
mdhistoWS->setCoordinateSystem(appliedCoordinateSystem);
// Create a log in the first experiment info to simulated an old version of
diff --git a/Framework/MDAlgorithms/test/LoadSQWTest.h b/Framework/MDAlgorithms/test/LoadSQWTest.h
index bd5c9668a223b5337851b5243f05398787b902bf..a192b4001cf9a716950981349d8b0601d019343f 100644
--- a/Framework/MDAlgorithms/test/LoadSQWTest.h
+++ b/Framework/MDAlgorithms/test/LoadSQWTest.h
@@ -159,9 +159,11 @@ public:
TS_ASSERT_EQUALS("en", d->getDimensionId());
// Check Units
- TS_ASSERT_EQUALS("A^-1", a->getUnits().ascii());
- TS_ASSERT_EQUALS("A^-1", b->getUnits().ascii());
- TS_ASSERT_EQUALS("A^-1", c->getUnits().ascii());
+ auto expectedUnit =
+ Mantid::Kernel::InverseAngstromsUnit().getUnitLabel().ascii();
+ TS_ASSERT_EQUALS(expectedUnit, a->getUnits().ascii());
+ TS_ASSERT_EQUALS(expectedUnit, b->getUnits().ascii());
+ TS_ASSERT_EQUALS(expectedUnit, c->getUnits().ascii());
TS_ASSERT_EQUALS("meV", d->getUnits().ascii());
// Check Nbins
diff --git a/Framework/MDAlgorithms/test/MergeMDFilesTest.h b/Framework/MDAlgorithms/test/MergeMDFilesTest.h
index 5951f35b6f93131fd258282c7084442575c65b62..e7fb5c6f6b319e451a43bd890e744a6608ec2999 100644
--- a/Framework/MDAlgorithms/test/MergeMDFilesTest.h
+++ b/Framework/MDAlgorithms/test/MergeMDFilesTest.h
@@ -4,6 +4,7 @@
#include "MantidMDAlgorithms/MergeMDFiles.h"
#include "MantidDataObjects/MDEventFactory.h"
#include "MantidTestHelpers/MDAlgorithmsTestHelper.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
#include <cxxtest/TestSuite.h>
@@ -35,6 +36,7 @@ public:
std::vector<std::vector<std::string>> filenames;
Mantid::Kernel::SpecialCoordinateSystem appliedCoord =
Mantid::Kernel::QSample;
+ Mantid::Geometry::QSample frame;
std::vector<MDEventWorkspace3Lean::sptr> inWorkspaces;
// how many events put into each file.
long nFileEvents(1000);
@@ -42,8 +44,8 @@ public:
std::ostringstream mess;
mess << "MergeMDFilesTestInput" << i;
MDEventWorkspace3Lean::sptr ws =
- MDAlgorithmsTestHelper::makeFileBackedMDEW(
- mess.str(), true, -nFileEvents, appliedCoord);
+ MDAlgorithmsTestHelper::makeFileBackedMDEWwithMDFrame(
+ mess.str(), true, frame, -nFileEvents, appliedCoord);
inWorkspaces.push_back(ws);
filenames.push_back(
std::vector<std::string>(1, ws->getBoxController()->getFilename()));
diff --git a/Framework/MDAlgorithms/test/SliceMDTest.h b/Framework/MDAlgorithms/test/SliceMDTest.h
index 3bda00f80a88a441e782bf54115094bc308e7d2e..f6089251263c1663f682592baede22b87fac88cd 100644
--- a/Framework/MDAlgorithms/test/SliceMDTest.h
+++ b/Framework/MDAlgorithms/test/SliceMDTest.h
@@ -5,6 +5,7 @@
#include "MantidMDAlgorithms/SliceMD.h"
#include "MantidDataObjects/CoordTransformAffine.h"
#include "MantidTestHelpers/MDEventsTestHelper.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
#include <cxxtest/TestSuite.h>
@@ -145,9 +146,10 @@ public:
SliceMD alg;
TS_ASSERT_THROWS_NOTHING(alg.initialize())
TS_ASSERT(alg.isInitialized())
-
+ Mantid::Geometry::QSample frame;
IMDEventWorkspace_sptr in_ws =
- MDEventsTestHelper::makeAnyMDEW<MDE, nd>(10, 0.0, 10.0, 1);
+ MDEventsTestHelper::makeAnyMDEWWithFrames<MDE, nd>(10, 0.0, 10.0, frame,
+ 1);
Mantid::Kernel::SpecialCoordinateSystem appliedCoord =
Mantid::Kernel::QSample;
in_ws->setCoordinateSystem(appliedCoord);
diff --git a/Framework/MDAlgorithms/test/SlicingAlgorithmTest.h b/Framework/MDAlgorithms/test/SlicingAlgorithmTest.h
index 762ffd5f2d12c660586fb3b8f01095fac3a46d4d..2b2b42de8a0c7ab451006a0c95509155b0d23c94 100644
--- a/Framework/MDAlgorithms/test/SlicingAlgorithmTest.h
+++ b/Framework/MDAlgorithms/test/SlicingAlgorithmTest.h
@@ -4,9 +4,11 @@
#include "MantidKernel/VMD.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidGeometry/MDGeometry/MDImplicitFunction.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
#include "MantidMDAlgorithms/SlicingAlgorithm.h"
#include "MantidTestHelpers/MDEventsTestHelper.h"
-
+#include "MantidKernel/MDUnit.h"
+#include "MantidKernel/UnitLabel.h"
#include <cxxtest/TestSuite.h>
using namespace Mantid::API;
@@ -48,6 +50,8 @@ public:
IMDEventWorkspace_sptr ws3;
IMDEventWorkspace_sptr ws4;
IMDEventWorkspace_sptr ws5;
+ IMDEventWorkspace_sptr wsQSample;
+ IMDEventWorkspace_sptr wsMixedFrames;
IMDEventWorkspace_sptr ws_names;
SlicingAlgorithmTest() {
@@ -57,6 +61,19 @@ public:
ws3 = MDEventsTestHelper::makeMDEW<3>(5, 0.0, 10.0, 1);
ws4 = MDEventsTestHelper::makeMDEW<4>(5, 0.0, 10.0, 1);
ws5 = MDEventsTestHelper::makeMDEW<5>(5, 0.0, 10.0, 1);
+ // Workspace with QSample frames
+ Mantid::Geometry::QSample qSampleFrame;
+ wsQSample = MDEventsTestHelper::makeMDEWWithFrames<3>(5, 0.0, 10.0,
+ qSampleFrame, 1);
+ // Workspace with mixed frames
+ std::vector<Mantid::Geometry::MDFrame_sptr> frames;
+ frames.push_back(std::make_shared<Mantid::Geometry::QSample>());
+ frames.push_back(std::make_shared<Mantid::Geometry::QSample>());
+ frames.push_back(std::make_shared<Mantid::Geometry::QSample>());
+ frames.push_back(std::make_shared<Mantid::Geometry::GeneralFrame>(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "m"));
+ wsMixedFrames = MDEventsTestHelper::makeMDEWWithIndividualFrames<4>(
+ 5, 0.0, 10.0, frames, 1);
/// Workspace with custom names
ws_names = MDEventsTestHelper::makeAnyMDEW<MDEvent<3>, 3>(
3, 0.0, 10.0, 1, "", "[%dh,k,l]", "Q%d");
@@ -112,6 +129,28 @@ public:
TS_ASSERT_EQUALS(dim->getX(10), 9.0);
}
+ void test_makeAlignedDimensionFromStringWithMDFrameSetToQSample() {
+ SlicingAlgorithmImpl alg;
+ alg.m_inWS = wsQSample;
+ TSM_ASSERT_THROWS_NOTHING(
+ "", alg.makeAlignedDimensionFromString("Axis2, 1.0, 9.0, 10"));
+ TS_ASSERT_EQUALS(alg.m_dimensionToBinFrom.size(), 1);
+ TS_ASSERT_EQUALS(alg.m_binDimensions.size(), 1);
+
+ TS_ASSERT_EQUALS(alg.m_dimensionToBinFrom[0], 2);
+
+ IMDDimension_sptr dim = alg.m_binDimensions[0];
+ TS_ASSERT_EQUALS(dim->getName(), "Axis2");
+ TS_ASSERT_EQUALS(
+ dim->getUnits(),
+ Mantid::Kernel::InverseAngstromsUnit().getUnitLabel().ascii());
+ TSM_ASSERT_EQUALS("Should be a QSample",
+ Mantid::Geometry::QSample::QSampleName,
+ dim->getMDFrame().name());
+ TS_ASSERT_EQUALS(dim->getNBins(), 10);
+ TS_ASSERT_EQUALS(dim->getX(10), 9.0);
+ }
+
/// Dimension name is of style "[x,y,z]". Handle this.
void test_makeAlignedDimensionFromString_NameWithCommas() {
SlicingAlgorithmImpl alg;
@@ -373,7 +412,126 @@ public:
TS_ASSERT_EQUALS(alg.m_bases[0], basis);
IMDDimension_sptr dim = alg.m_binDimensions[0];
TS_ASSERT_EQUALS(dim->getName(), "name");
- TS_ASSERT_EQUALS(dim->getUnits(), "units");
+ TSM_ASSERT("The units selection is ignored", dim->getUnits() != "units");
+ TSM_ASSERT("The unit is in m", dim->getUnits() == "m");
+ TS_ASSERT_EQUALS(dim->getNBins(), 20);
+ TS_ASSERT_EQUALS(dim->getMinimum(), -5);
+ TS_ASSERT_EQUALS(dim->getMaximum(), +5);
+ TS_ASSERT_DELTA(dim->getX(5), -2.5, 1e-5);
+
+ if (alg.m_NormalizeBasisVectors) {
+ TSM_ASSERT_DELTA("Unit transformation scaling if normalizing",
+ alg.m_transformScaling[0], 1.0, 1e-5);
+ TSM_ASSERT_DELTA("A bin ranges from 0-0.5 in OUTPUT, which is 0.5 long "
+ "in the INPUT, "
+ "so the binningScaling is 2.",
+ alg.m_binningScaling[0], 2., 1e-5);
+ } else {
+ TSM_ASSERT_DELTA("Length sqrt(14) in INPUT = 1.0 in output",
+ alg.m_transformScaling[0], sqrt(1.0 / 14.0), 1e-5);
+ TSM_ASSERT_DELTA("A bin ranges from 0-0.5 in OUTPUT, which is "
+ "0.5/sqrt(14) long in the INPUT, "
+ "so the binningScaling is 2/sqrt(14)",
+ alg.m_binningScaling[0], 2. / sqrt(14.0), 1e-5);
+ }
+ }
+ }
+
+ void test_makeBasisVectorFromString_WithPureQSampleInput() {
+ // Test WITH and WITHOUT basis vector normalization
+ for (int normalize = 0; normalize < 2; normalize++) {
+ SlicingAlgorithmImpl alg;
+ alg.m_inWS = wsQSample; // All dimensions are QSample
+ // Set up data that comes from other properties
+ alg.m_minExtents.push_back(-5.0);
+ alg.m_maxExtents.push_back(+5.0);
+ alg.m_numBins.push_back(20);
+ alg.m_NormalizeBasisVectors = (normalize > 0);
+
+ TS_ASSERT_EQUALS(alg.m_bases.size(), 0);
+ TSM_ASSERT_THROWS_NOTHING(
+ "", alg.makeBasisVectorFromString(" name, units , 1,2,3"));
+ TS_ASSERT_EQUALS(alg.m_bases.size(), 1);
+ TS_ASSERT_EQUALS(alg.m_binDimensions.size(), 1);
+ TS_ASSERT_EQUALS(alg.m_binningScaling.size(), 1);
+ TS_ASSERT_EQUALS(alg.m_transformScaling.size(), 1);
+
+ VMD basis(1., 2., 3.);
+ if (alg.m_NormalizeBasisVectors)
+ basis.normalize();
+
+ TS_ASSERT_EQUALS(alg.m_bases[0], basis);
+ IMDDimension_sptr dim = alg.m_binDimensions[0];
+ TS_ASSERT_EQUALS(dim->getName(), "name");
+ TSM_ASSERT("The units selection is ignored", dim->getUnits() != "units");
+ TS_ASSERT_EQUALS(
+ dim->getUnits(),
+ Mantid::Kernel::InverseAngstromsUnit().getUnitLabel().ascii());
+ TSM_ASSERT_EQUALS("Should be a QSample",
+ Mantid::Geometry::QSample::QSampleName,
+ dim->getMDFrame().name());
+
+ TS_ASSERT_EQUALS(dim->getNBins(), 20);
+ TS_ASSERT_EQUALS(dim->getMinimum(), -5);
+ TS_ASSERT_EQUALS(dim->getMaximum(), +5);
+ TS_ASSERT_DELTA(dim->getX(5), -2.5, 1e-5);
+
+ if (alg.m_NormalizeBasisVectors) {
+ TSM_ASSERT_DELTA("Unit transformation scaling if normalizing",
+ alg.m_transformScaling[0], 1.0, 1e-5);
+ TSM_ASSERT_DELTA("A bin ranges from 0-0.5 in OUTPUT, which is 0.5 long "
+ "in the INPUT, "
+ "so the binningScaling is 2.",
+ alg.m_binningScaling[0], 2., 1e-5);
+ } else {
+ TSM_ASSERT_DELTA("Length sqrt(14) in INPUT = 1.0 in output",
+ alg.m_transformScaling[0], sqrt(1.0 / 14.0), 1e-5);
+ TSM_ASSERT_DELTA("A bin ranges from 0-0.5 in OUTPUT, which is "
+ "0.5/sqrt(14) long in the INPUT, "
+ "so the binningScaling is 2/sqrt(14)",
+ alg.m_binningScaling[0], 2. / sqrt(14.0), 1e-5);
+ }
+ }
+ }
+
+ void
+ test_makeBasisVectorFromString_WithMixedMDFrames_AndBasisVectorNotMixed() {
+ // Test WITH and WITHOUT basis vector normalization
+ for (int normalize = 0; normalize < 2; normalize++) {
+ SlicingAlgorithmImpl alg;
+ alg.m_inWS = wsMixedFrames; // First three dimensions are Q Sample
+ // the last is General Frame
+ // Set up data that comes from other properties
+ alg.m_minExtents.push_back(-5.0);
+ alg.m_maxExtents.push_back(+5.0);
+ alg.m_numBins.push_back(20);
+ alg.m_NormalizeBasisVectors = (normalize > 0);
+
+ TS_ASSERT_EQUALS(alg.m_bases.size(), 0);
+ TSM_ASSERT_THROWS_NOTHING(
+ "", alg.makeBasisVectorFromString(
+ " name, units , 1,2,3,0")); // Basis vector is in QSample
+ // sub-space
+ TS_ASSERT_EQUALS(alg.m_bases.size(), 1);
+ TS_ASSERT_EQUALS(alg.m_binDimensions.size(), 1);
+ TS_ASSERT_EQUALS(alg.m_binningScaling.size(), 1);
+ TS_ASSERT_EQUALS(alg.m_transformScaling.size(), 1);
+
+ VMD basis(1., 2., 3., 0.);
+ if (alg.m_NormalizeBasisVectors)
+ basis.normalize();
+
+ TS_ASSERT_EQUALS(alg.m_bases[0], basis);
+ IMDDimension_sptr dim = alg.m_binDimensions[0];
+ TS_ASSERT_EQUALS(dim->getName(), "name");
+ TSM_ASSERT("The units selection is ignored", dim->getUnits() != "units");
+ TS_ASSERT_EQUALS(
+ dim->getUnits(),
+ Mantid::Kernel::InverseAngstromsUnit().getUnitLabel().ascii());
+ TSM_ASSERT_EQUALS("Should be a QSample",
+ Mantid::Geometry::QSample::QSampleName,
+ dim->getMDFrame().name());
+
TS_ASSERT_EQUALS(dim->getNBins(), 20);
TS_ASSERT_EQUALS(dim->getMinimum(), -5);
TS_ASSERT_EQUALS(dim->getMaximum(), +5);
@@ -424,7 +582,8 @@ public:
IMDDimension_sptr dim = alg.m_binDimensions[0];
TS_ASSERT_EQUALS(dim->getName(), "[Dumb,Name]");
TS_ASSERT_EQUALS(dim->getDimensionId(), "[Dumb,Name]");
- TS_ASSERT_EQUALS(dim->getUnits(), "units");
+ TSM_ASSERT("The units selection is ignored", dim->getUnits() != "units");
+ TSM_ASSERT("The unit is in m", dim->getUnits() == "m");
TS_ASSERT_EQUALS(dim->getNBins(), 20);
TS_ASSERT_EQUALS(dim->getMinimum(), -5);
TS_ASSERT_EQUALS(dim->getMaximum(), +5);
diff --git a/Framework/MDAlgorithms/test/ThresholdMDTest.h b/Framework/MDAlgorithms/test/ThresholdMDTest.h
index 831759a1e3fb060e53379096a7403f0ba163a899..794e5d1d12a2af54619c30e14c90fa8e35ae4a39 100644
--- a/Framework/MDAlgorithms/test/ThresholdMDTest.h
+++ b/Framework/MDAlgorithms/test/ThresholdMDTest.h
@@ -5,7 +5,7 @@
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
#include "MantidGeometry/MDGeometry/MDTypes.h"
#include "MantidMDAlgorithms/ThresholdMD.h"
-
+#include "MantidGeometry/MDGeometry/QLab.h"
#include <cxxtest/TestSuite.h>
using namespace Mantid::API;
@@ -22,12 +22,12 @@ public:
// This means the constructor isn't called when running other tests
static ThresholdMDTest *createSuite() { return new ThresholdMDTest(); }
static void destroySuite(ThresholdMDTest *suite) { delete suite; }
-
+ Mantid::Geometry::QLab frame;
MDHistoWorkspace_sptr createInputWorkspace(signal_t signal,
signal_t errorSQ = 0,
const int nBins = 1) {
MDHistoDimension_sptr dim = boost::make_shared<MDHistoDimension>(
- "X", "X", "", static_cast<coord_t>(0), static_cast<coord_t>(10),
+ "X", "X", frame, static_cast<coord_t>(0), static_cast<coord_t>(10),
static_cast<size_t>(nBins));
MDHistoWorkspace_sptr histo = boost::make_shared<MDHistoWorkspace>(dim);
signal_t *signals = histo->getSignalArray();
diff --git a/Framework/PythonInterface/mantid/api/src/Exports/Sample.cpp b/Framework/PythonInterface/mantid/api/src/Exports/Sample.cpp
index baa9826478dbad9a4c9ee7b2065d468a7cfedf01..5d9583f6dff1bd917d4e890c9ad00d2c209b508c 100644
--- a/Framework/PythonInterface/mantid/api/src/Exports/Sample.cpp
+++ b/Framework/PythonInterface/mantid/api/src/Exports/Sample.cpp
@@ -1,5 +1,6 @@
#include "MantidAPI/Sample.h"
#include "MantidGeometry/Crystal/OrientedLattice.h"
+#include "MantidGeometry/Crystal/CrystalStructure.h"
#include "MantidKernel/Material.h"
#include <boost/python/class.hpp>
#include <boost/python/copy_const_reference.hpp>
@@ -25,6 +26,17 @@ void export_Sample() {
.def("hasOrientedLattice", &Sample::hasOrientedLattice, arg("self"),
"Returns True if this sample has an oriented lattice, false "
"otherwise")
+ .def("getCrystalStructure", &Sample::getCrystalStructure, arg("self"),
+ return_value_policy<reference_existing_object>(),
+ "Get the crystal structure for this sample")
+ .def("hasCrystalStructure", &Sample::hasCrystalStructure, arg("self"),
+ "Returns True if this sample has a crystal structure, false "
+ "otherwise")
+ .def("setCrystalStructure", &Sample::setCrystalStructure, arg("self"),
+ arg("crystalStructure"),
+ "Assign a crystal structure object to the sample.")
+ .def("clearCrystalStructure", &Sample::clearCrystalStructure, arg("self"),
+ "Removes the internally stored crystal structure.")
.def("size", &Sample::size, arg("self"),
"Return the number of samples contained within this sample")
// Required for ISIS SANS reduction until the full sample geometry is
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ApplyPaalmanPingsCorrection.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ApplyPaalmanPingsCorrection.py
index 525db109bfc34a1bfc05a30e1cce7d45388c2892..be6133556b7449eef5cbf90cc4d650221c6a8663 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ApplyPaalmanPingsCorrection.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ApplyPaalmanPingsCorrection.py
@@ -247,6 +247,12 @@ class ApplyPaalmanPingsCorrection(PythonAlgorithm):
Do a simple container subtraction (when no corrections are given).
"""
+
+ logger.information('Rebining container to ensure Minus')
+ RebinToWorkspace(WorkspaceToRebin=self._can_ws_name,
+ WorkspaceToMatch=self._sample_ws_name,
+ OutputWorkspace=self._can_ws_name)
+
logger.information('Using simple container subtraction')
Minus(LHSWorkspace=self._sample_ws_name,
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ISISIndirectEnergyTransfer.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ISISIndirectEnergyTransfer.py
index 4b3a005b7c4f9beaceb239f4ae6c20c0ce741957..fa83c92cf98338544ae381a386f21a458da96d7d 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ISISIndirectEnergyTransfer.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ISISIndirectEnergyTransfer.py
@@ -138,14 +138,19 @@ class ISISIndirectEnergyTransfer(DataProcessorAlgorithm):
plot_reduction)
self._setup()
+ load_prog = Progress(self, start=0.0, end=0.10, nreports=2)
+ load_prog.report('loading files')
self._workspace_names, self._chopped_data = load_files(self._data_files,
self._ipf_filename,
self._spectra_range[0],
self._spectra_range[1],
self._sum_files,
self._load_logs)
+ load_prog.report('files loaded')
+ process_prog = Progress(self, start=0.1, end=0.9, nreports=len(self._workspace_names))
for c_ws_name in self._workspace_names:
+ process_prog.report('processing workspace' + c_ws_name)
is_multi_frame = isinstance(mtd[c_ws_name], WorkspaceGroup)
# Get list of workspaces
@@ -263,22 +268,28 @@ class ISISIndirectEnergyTransfer(DataProcessorAlgorithm):
# Rename output workspaces
output_workspace_names = [rename_reduction(ws_name, self._sum_files) for ws_name in self._workspace_names]
+ summary_prog = Progress(self, start=0.9, end=1.0, nreports=4)
+
# Save result workspaces
if self._save_formats is not None:
+ summary_prog.report('saving')
save_reduction(output_workspace_names,
self._save_formats,
self._output_x_units)
# Group result workspaces
+ summary_prog.report('grouping workspaces')
GroupWorkspaces(InputWorkspaces=output_workspace_names,
OutputWorkspace=self._output_ws)
- self.setProperty('OutputWorkspace', self._output_ws)
+ self.setProperty('OutputWorkspace', mtd[self._output_ws])
# Plot result workspaces
if self._plot_type != 'None':
+ summary_prog.report('Plotting')
for ws_name in mtd[self._output_ws].getNames():
plot_reduction(ws_name, self._plot_type)
+ summary_prog.report('Algorithm complete')
def validateInputs(self):
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectCalibration.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectCalibration.py
index 4e1ea169dba4c6a38c4321235a889715c81b9c97..ac91de07fc00ca8d77a8ac3608f2474fb54e925d 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectCalibration.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectCalibration.py
@@ -87,9 +87,10 @@ class IndirectCalibration(DataProcessorAlgorithm):
from IndirectCommon import get_run_number
self._setup()
-
runs = []
self._run_numbers = []
+ load_prog = Progress(self, start=0.0, end=0.30, nreports=len(self._input_files))
+ i = 0
for in_file in self._input_files:
(_, filename) = os.path.split(in_file)
(root, _) = os.path.splitext(filename)
@@ -104,34 +105,45 @@ class IndirectCalibration(DataProcessorAlgorithm):
self._run_numbers.append(get_run_number(root))
except (RuntimeError,ValueError) as exc:
logger.error('Could not load raw file "%s": %s' % (in_file, str(exc)))
+ load_prog.report('Loading file: ' + str(i))
+ i += 1
calib_ws_name = 'calibration'
+ merge_prog = Progress(self, start=0.30, end=0.40, nreports=2)
if len(runs) > 1:
MergeRuns(InputWorkspaces=",".join(runs),
OutputWorkspace=calib_ws_name)
+ merge_prog.report('Workspaces merged')
factor = 1.0 / len(runs)
Scale(InputWorkspace=calib_ws_name,
OutputWorkspace=calib_ws_name,
Factor=factor)
+ merge_prog.report('Scaling complete')
else:
calib_ws_name = runs[0]
+ merge_prog.report()
+ workflow_prog = Progress(self, start=0.40, end=0.90, nreports=10)
+ workflow_prog.report('Calculating flat background')
CalculateFlatBackground(InputWorkspace=calib_ws_name,
OutputWorkspace=calib_ws_name,
StartX=self._back_range[0],
EndX=self._back_range[1],
Mode='Mean')
+ workflow_prog.report('Masking detectors')
number_historgrams = mtd[calib_ws_name].getNumberHistograms()
ws_mask, num_zero_spectra = FindDetectorsOutsideLimits(InputWorkspace=calib_ws_name,
OutputWorkspace='__temp_ws_mask')
DeleteWorkspace(ws_mask)
+ workflow_prog.report('Integrating calibration file')
Integration(InputWorkspace=calib_ws_name,
OutputWorkspace=calib_ws_name,
RangeLower=self._peak_range[0],
RangeUpper=self._peak_range[1])
+ workflow_prog.report('Summing Spectra')
temp_sum = SumSpectra(InputWorkspace=calib_ws_name,
OutputWorkspace='__temp_sum')
total = temp_sum.readY(0)[0]
@@ -140,6 +152,7 @@ class IndirectCalibration(DataProcessorAlgorithm):
if self._intensity_scale is None:
self._intensity_scale = 1 / (total / (number_historgrams - num_zero_spectra))
+ workflow_prog.report('Scaling calibration')
Scale(InputWorkspace=calib_ws_name,
OutputWorkspace=self._out_ws,
Factor=self._intensity_scale,
@@ -149,6 +162,7 @@ class IndirectCalibration(DataProcessorAlgorithm):
if len(runs) > 1:
for run in runs:
DeleteWorkspace(Workspace=run)
+ workflow_prog.report('Deleting workspaces')
self._add_logs()
self.setProperty('OutputWorkspace', self._out_ws)
@@ -186,9 +200,11 @@ class IndirectCalibration(DataProcessorAlgorithm):
if self._intensity_scale is not None:
sample_logs.append(('calib_scale_factor', self._intensity_scale))
- AddSampleLogMultiple(Workspace=self._out_ws,
- LogNames=[log[0] for log in sample_logs],
- LogValues=[log[1] for log in sample_logs])
+ log_alg = self.createChildAlgorithm(name='AddSampleLogMultiple', startProgress=0.9,
+ endProgress=1.0, enableLogging=True)
+ log_alg.setProperty('Workspace', self._out_ws)
+ log_alg.setProperty('LogNames', [log[0] for log in sample_logs])
+ log_alg.setProperty('LogValues', [log[1] for log in sample_logs])
# Register algorithm with Mantid
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectResolution.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectResolution.py
index b4abec0897d753f1e8492267b0d7844bef8b2860..a88ea9986fe34518ff87fa6def56c65499984feb 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectResolution.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectResolution.py
@@ -59,22 +59,29 @@ class IndirectResolution(DataProcessorAlgorithm):
def PyExec(self):
self._setup()
- ISISIndirectEnergyTransfer(Instrument=self._instrument,
- Analyser=self._analyser,
- Reflection=self._reflection,
- GroupingMethod='All',
- SumFiles=True,
- InputFiles=self._input_files,
- SpectraRange=self._detector_range,
- OutputWorkspace='__et_ws_group')
-
- icon_ws = mtd['__et_ws_group'].getItem(0).getName()
+ iet_alg = self.createChildAlgorithm(name='ISISIndirectEnergyTransfer', startProgress=0.0,
+ endProgress=0.7, enableLogging=True)
+ iet_alg.setProperty('Instrument', self._instrument)
+ iet_alg.setProperty('Analyser', self._analyser)
+ iet_alg.setProperty('Reflection', self._reflection)
+ iet_alg.setProperty('GroupingMethod', 'All')
+ iet_alg.setProperty('SumFiles', True)
+ iet_alg.setProperty('InputFiles', self._input_files)
+ iet_alg.setProperty('SpectraRange', self._detector_range)
+ iet_alg.execute()
+
+ group_ws = iet_alg.getProperty('OutputWorkspace').value
+ icon_ws = group_ws.getItem(0).getName()
+
+ workflow_prog = Progress(self, start=0.7, end=0.9, nreports=4)
if self._scale_factor != 1.0:
+ workflow_prog.report('Scaling Workspace')
Scale(InputWorkspace=icon_ws,
OutputWorkspace=icon_ws,
Factor=self._scale_factor)
+ workflow_prog.report('Calculating flat background')
CalculateFlatBackground(InputWorkspace=icon_ws,
OutputWorkspace=self._out_ws,
StartX=self._background[0],
@@ -82,10 +89,12 @@ class IndirectResolution(DataProcessorAlgorithm):
Mode='Mean',
OutputMode='Subtract Background')
+ workflow_prog.report('Rebinning Workspace')
Rebin(InputWorkspace=self._out_ws,
OutputWorkspace=self._out_ws,
Params=self._rebin_string)
+ workflow_prog.report('Completing Post Processing')
self._post_process()
self.setProperty('OutputWorkspace', self._out_ws)
@@ -125,9 +134,11 @@ class IndirectResolution(DataProcessorAlgorithm):
sample_logs.append(('rebin_width', rebin_params[1]))
sample_logs.append(('rebin_high', rebin_params[2]))
- AddSampleLogMultiple(Workspace=self._out_ws,
- LogNames=[log[0] for log in sample_logs],
- LogValues=[log[1] for log in sample_logs])
+ log_alg = self.createChildAlgorithm(name='AddSampleLogMultiple', startProgress=0.9,
+ endProgress=1.0, enableLogging=True)
+ log_alg.setProperty('Workspace', self._out_ws)
+ log_alg.setProperty('LogNames', [log[0] for log in sample_logs])
+ log_alg.setProperty('LogValues',[log[1] for log in sample_logs])
self.setProperty('OutputWorkspace', self._out_ws)
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/TimeSlice.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/TimeSlice.py
index cfb86873a3a1330d3f5c882ee82239cf868cb600..716d94de695b195d1bd66c5be932acf94dbdc4ed 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/TimeSlice.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/TimeSlice.py
@@ -126,24 +126,31 @@ class TimeSlice(PythonAlgorithm):
# CheckXrange(xRange, 'Time')
out_ws_list = []
-
+ i = 0
+ workflow_prog = Progress(self, start=0.0, end=0.96, nreports=len(self._raw_files)*3)
for index, filename in enumerate(self._raw_files):
+ workflow_prog.report('Reading file: ' + str(i))
raw_file = self._read_raw_file(filename)
# Only need to process the calib file once
if index == 0 and self._calib_ws is not None:
self._process_calib(raw_file)
+ workflow_prog.report('Transposing Workspace: ' + str(i))
slice_file = self._process_raw_file(raw_file)
Transpose(InputWorkspace=slice_file, OutputWorkspace=slice_file)
unit = mtd[slice_file].getAxis(0).setUnit("Label")
unit.setLabel("Spectrum Number", "")
+ workflow_prog.report('Deleting Workspace')
out_ws_list.append(slice_file)
DeleteWorkspace(raw_file)
all_workspaces = ','.join(out_ws_list)
+ final_prog = Progress(self, start=0.96, end=1.0, nreports=2)
+ final_prog.report('Grouping result')
GroupWorkspaces(InputWorkspaces=all_workspaces, OutputWorkspace=self._out_ws_group)
+ final_prog.report('setting result')
self.setProperty('OutputWorkspace', self._out_ws_group)
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/TransformToIqt.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/TransformToIqt.py
index 0b397290d3ef939e8927f16eee6dd9a091ae5ceb..0f7907e7e4cc59741e4f4e68d5d702a505ea6375 100644
--- a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/TransformToIqt.py
+++ b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/TransformToIqt.py
@@ -1,6 +1,6 @@
#pylint: disable=no-init,too-many-instance-attributes
from mantid.simpleapi import *
-from mantid.api import PythonAlgorithm, AlgorithmFactory, MatrixWorkspaceProperty, PropertyMode
+from mantid.api import PythonAlgorithm, AlgorithmFactory, MatrixWorkspaceProperty, PropertyMode, Progress
from mantid.kernel import Direction, logger
from mantid import config
import math
@@ -72,6 +72,9 @@ class TransformToIqt(PythonAlgorithm):
self._add_logs()
else:
+ skip_prog = Progress(self, start=0.3, end=1.0, nreports=2)
+ skip_prog.report('skipping transform')
+ skip_prog.report('skipping add logs')
logger.information('Dry run, will not run TransformToIqt')
self.setProperty('ParameterWorkspace', self._parameter_table)
@@ -125,16 +128,21 @@ class TransformToIqt(PythonAlgorithm):
"""
Calculates the TransformToIqt parameters and saves in a table workspace.
"""
+ workflow_prog = Progress(self, start=0.0, end=0.3, nreports=8)
+ workflow_prog.report('Croping Workspace')
CropWorkspace(InputWorkspace=self._sample,
OutputWorkspace='__TransformToIqt_sample_cropped',
Xmin=self._e_min,
Xmax=self._e_max)
+ workflow_prog.report('Calculating table properties')
x_data = mtd['__TransformToIqt_sample_cropped'].readX(0)
number_input_points = len(x_data) - 1
num_bins = int(number_input_points / self._number_points_per_bin)
self._e_width = (abs(self._e_min) + abs(self._e_max)) / num_bins
+ workflow_prog.report('Attemping to Access IPF')
try:
+ workflow_prog.report('Access IPF')
instrument = mtd[self._sample].getInstrument()
analyserName = instrument.getStringParameter('analyser')[0]
@@ -150,8 +158,9 @@ class TransformToIqt(PythonAlgorithm):
resolution = instrument.getNumberParameter('resolution')[0]
logger.information('Got resolution from IPF: %f' % resolution)
-
+ workflow_prog.report('IPF resolution obtained')
except (AttributeError, IndexError):
+ workflow_prog.report('Resorting to Default')
resolution = 0.0175
logger.warning('Could not get resolution from IPF, using default value: %f' % (resolution))
@@ -160,8 +169,10 @@ class TransformToIqt(PythonAlgorithm):
if resolution_bins < 5:
logger.warning('Resolution curve has <5 points. Results may be unreliable.')
+ workflow_prog.report('Creating Parameter table')
param_table = CreateEmptyTableWorkspace(OutputWorkspace=self._parameter_table)
+ workflow_prog.report('Populating Parameter table')
param_table.addColumn('int', 'SampleInputBins')
param_table.addColumn('float', 'BinReductionFactor')
param_table.addColumn('int', 'SampleOutputBins')
@@ -175,6 +186,7 @@ class TransformToIqt(PythonAlgorithm):
self._e_min, self._e_max, self._e_width,
resolution, resolution_bins])
+ workflow_prog.report('Deleting temp Workspace')
DeleteWorkspace('__TransformToIqt_sample_cropped')
self.setProperty('ParameterWorkspace', param_table)
@@ -187,9 +199,12 @@ class TransformToIqt(PythonAlgorithm):
('iqt_binning', '%f,%f,%f' % (self._e_min, self._e_width, self._e_max))
]
- AddSampleLogMultiple(Workspace=self._output_workspace,
- LogNames=[item[0] for item in sample_logs],
- LogValues=[item[1] for item in sample_logs])
+ log_alg = self.createChildAlgorithm(name='AddSampleLogMultiple', startProgress=0.8,
+ endProgress=1.0, enableLogging=True)
+ log_alg.setProperty('Workspace', self._output_workspace)
+ log_alg.setProperty('LogNames',[item[0] for item in sample_logs])
+ log_alg.setProperty('LogValues', [item[1] for item in sample_logs])
+ log_alg.execute()
def _transform(self):
@@ -197,7 +212,7 @@ class TransformToIqt(PythonAlgorithm):
Run TransformToIqt.
"""
from IndirectCommon import CheckHistZero, CheckHistSame, CheckAnalysers
-
+ trans_prog = Progress(self, start=0.3, end=0.8, nreports=15)
try:
CheckAnalysers(self._sample, self._resolution)
except ValueError:
@@ -213,47 +228,59 @@ class TransformToIqt(PythonAlgorithm):
CheckHistSame(self._sample, 'Sample', self._resolution, 'Resolution')
rebin_param = str(self._e_min) + ',' + str(self._e_width) + ',' + str(self._e_max)
-
+ trans_prog.report('Rebinning Workspace')
Rebin(InputWorkspace=self._sample,
OutputWorkspace='__sam_data',
Params=rebin_param,
FullBinsOnly=True)
# Sample
+ trans_prog.report('Rebinning sample')
Rebin(InputWorkspace='__sam_data',
OutputWorkspace='__sam_data',
Params=rebin_param)
+ trans_prog.report('Integrating Sample')
Integration(InputWorkspace='__sam_data',
OutputWorkspace='__sam_int')
+ trans_prog.report('Converting Sample to data points')
ConvertToPointData(InputWorkspace='__sam_data',
OutputWorkspace='__sam_data')
+ trans_prog.report('Extracting FFT spectrum for Sample')
ExtractFFTSpectrum(InputWorkspace='__sam_data',
OutputWorkspace='__sam_fft',
FFTPart=2)
+ trans_prog.report('Dividing Sample')
Divide(LHSWorkspace='__sam_fft',
RHSWorkspace='__sam_int',
OutputWorkspace='__sam')
# Resolution
+ trans_prog.report('Rebinnig Resolution')
Rebin(InputWorkspace=self._resolution,
OutputWorkspace='__res_data',
Params=rebin_param)
+ trans_prog.report('Integrating Resolution')
Integration(InputWorkspace='__res_data',
OutputWorkspace='__res_int')
+ trans_prog.report('Converting Resolution to data points')
ConvertToPointData(InputWorkspace='__res_data',
OutputWorkspace='__res_data')
+ trans_prog.report('Extractig FFT Resolution spectrum')
ExtractFFTSpectrum(InputWorkspace='__res_data',
OutputWorkspace='__res_fft',
FFTPart=2)
+ trans_prog.report('Dividing Resolution')
Divide(LHSWorkspace='__res_fft',
RHSWorkspace='__res_int',
OutputWorkspace='__res')
+ trans_prog.report('Diving Workspaces')
Divide(LHSWorkspace='__sam',
RHSWorkspace='__res',
OutputWorkspace=self._output_workspace)
# Cleanup sample workspaces
+ trans_prog.report('Deleting Sample temp')
DeleteWorkspace('__sam_data')
DeleteWorkspace('__sam_int')
DeleteWorkspace('__sam_fft')
@@ -262,6 +289,7 @@ class TransformToIqt(PythonAlgorithm):
# Crop nonsense values off workspace
binning = int(math.ceil(mtd[self._output_workspace].blocksize() / 2.0))
bin_v = mtd[self._output_workspace].dataX(0)[binning]
+ trans_prog.report('Cropping output')
CropWorkspace(InputWorkspace=self._output_workspace,
OutputWorkspace=self._output_workspace,
XMax=bin_v)
@@ -270,6 +298,7 @@ class TransformToIqt(PythonAlgorithm):
mtd[self._output_workspace].setYUnit('')
mtd[self._output_workspace].setYUnitLabel('Intensity')
+ trans_prog.report('Deleting Resolution temp')
# Clean up resolution workspaces
DeleteWorkspace('__res_data')
DeleteWorkspace('__res_int')
diff --git a/Framework/PythonInterface/test/python/mantid/api/SampleTest.py b/Framework/PythonInterface/test/python/mantid/api/SampleTest.py
index 798795fdf039f6042b692e098b0c6641d572c71b..e1ddf8ea7c41bb0fbaaae89e85357e16b7381bef 100644
--- a/Framework/PythonInterface/test/python/mantid/api/SampleTest.py
+++ b/Framework/PythonInterface/test/python/mantid/api/SampleTest.py
@@ -1,6 +1,7 @@
import unittest
from mantid.api import Sample
from mantid.simpleapi import CreateWorkspace
+from mantid.geometry import CrystalStructure
class SampleTest(unittest.TestCase):
@@ -17,5 +18,35 @@ class SampleTest(unittest.TestCase):
sample.setWidth(5.9)
self.assertEquals(sample.getWidth(), 5.9)
+ def test_crystal_structure_handling(self):
+ sample = self._ws.sample()
+
+ self.assertEquals(sample.hasCrystalStructure(), False)
+ self.assertRaises(RuntimeError, sample.getCrystalStructure)
+
+ cs = CrystalStructure('5.43 5.43 5.43',
+ 'F d -3 m',
+ 'Si 0 0 0 1.0 0.01')
+
+ sample.setCrystalStructure(cs)
+
+ self.assertEquals(sample.hasCrystalStructure(), True)
+
+ cs_from_sample = sample.getCrystalStructure()
+
+ self.assertEquals(cs.getSpaceGroup().getHMSymbol(), cs_from_sample.getSpaceGroup().getHMSymbol())
+ self.assertEquals(cs.getUnitCell().a(), cs_from_sample.getUnitCell().a())
+ self.assertEquals(len(cs.getScatterers()), len(cs_from_sample.getScatterers()))
+ self.assertEquals(cs.getScatterers()[0], cs_from_sample.getScatterers()[0])
+
+
+ sample.clearCrystalStructure()
+
+ self.assertEquals(sample.hasCrystalStructure(), False)
+ self.assertRaises(RuntimeError, sample.getCrystalStructure)
+
+
+
+
if __name__ == '__main__':
unittest.main()
diff --git a/Framework/PythonInterface/test/python/plugins/algorithms/ApplyPaalmanPingsCorrectionTest.py b/Framework/PythonInterface/test/python/plugins/algorithms/ApplyPaalmanPingsCorrectionTest.py
index 581f3c7e413c935893d8e79bcba6f42cb0f58a52..c3ebe75b86287c76ade0acba92495237588a2080 100644
--- a/Framework/PythonInterface/test/python/plugins/algorithms/ApplyPaalmanPingsCorrectionTest.py
+++ b/Framework/PythonInterface/test/python/plugins/algorithms/ApplyPaalmanPingsCorrectionTest.py
@@ -49,7 +49,7 @@ class ApplyPaalmanPingsCorrectionTest(unittest.TestCase):
"""
DeleteWorkspace(self._sample_ws)
- DeleteWorkspace(self._can_ws)
+ DeleteWorkspace(mtd['can_ws'])
DeleteWorkspace(self._corrections_ws)
diff --git a/Framework/SINQ/src/LoadFlexiNexus.cpp b/Framework/SINQ/src/LoadFlexiNexus.cpp
index d589ce89c86d6df3055e64532ff7ba7071916091..644c05118e1e465dfc1b12ba359349b97d17997c 100644
--- a/Framework/SINQ/src/LoadFlexiNexus.cpp
+++ b/Framework/SINQ/src/LoadFlexiNexus.cpp
@@ -297,8 +297,9 @@ MDHistoDimension_sptr LoadFlexiNexus::makeDimension(NeXus::File *fin, int index,
min = tmp;
g_log.notice("WARNING: swapped axis values on " + name);
}
+ Mantid::Geometry::GeneralFrame frame(name, "");
return MDHistoDimension_sptr(
- new MDHistoDimension(name, name, "", min, max, length));
+ new MDHistoDimension(name, name, frame, min, max, length));
}
void LoadFlexiNexus::addMetaData(NeXus::File *fin, Workspace_sptr ws,
ExperimentInfo_sptr info) {
diff --git a/Framework/SINQ/src/SINQHMListener.cpp b/Framework/SINQ/src/SINQHMListener.cpp
index fd449cb9648dd54cadb67cea330d91aa46ed5fcd..408cb99013cbea6f21fdd3eaf3cf0325cdf8615e 100644
--- a/Framework/SINQ/src/SINQHMListener.cpp
+++ b/Framework/SINQ/src/SINQHMListener.cpp
@@ -102,8 +102,9 @@ boost::shared_ptr<Workspace> SINQHMListener::extractData() {
std::vector<MDHistoDimension_sptr> dimensions;
for (int i = 0; i < rank; i++) {
+ Mantid::Geometry::GeneralFrame frame(dimNames[i], "");
dimensions.push_back(MDHistoDimension_sptr(new MDHistoDimension(
- dimNames[i], dimNames[i], "", .0, coord_t(dim[i]), dim[i])));
+ dimNames[i], dimNames[i], frame, .0, coord_t(dim[i]), dim[i])));
}
MDHistoWorkspace_sptr ws(new MDHistoWorkspace(dimensions));
ws->setTo(.0, .0, .0);
diff --git a/Framework/SINQ/src/SliceMDHisto.cpp b/Framework/SINQ/src/SliceMDHisto.cpp
index 60e4bb154c917b94fa11204d3c37b3a4b40eb158..433918f5ffa8c0dca4b6ca0e6e7c3ba150fe26d1 100644
--- a/Framework/SINQ/src/SliceMDHisto.cpp
+++ b/Framework/SINQ/src/SliceMDHisto.cpp
@@ -75,7 +75,7 @@ void SliceMDHisto::exec() {
for (unsigned int k = 0; k < m_rank; ++k) {
boost::shared_ptr<const IMDDimension> arDim = inWS->getDimension(k);
dimensions.push_back(MDHistoDimension_sptr(new MDHistoDimension(
- arDim->getName(), arDim->getName(), arDim->getUnits(),
+ arDim->getName(), arDim->getName(), arDim->getMDFrame(),
arDim->getX(start[k]), arDim->getX(end[k]), end[k] - start[k])));
}
MDHistoWorkspace_sptr outWS(new MDHistoWorkspace(dimensions));
diff --git a/Framework/SINQ/test/InvertMDDimTest.h b/Framework/SINQ/test/InvertMDDimTest.h
index 860eb191a9799612973b8e3dbf16279fa92b90e3..504205679292a848409db797ae391143e71c676d 100644
--- a/Framework/SINQ/test/InvertMDDimTest.h
+++ b/Framework/SINQ/test/InvertMDDimTest.h
@@ -110,18 +110,20 @@ public:
private:
MDHistoWorkspace_sptr makeTestMD() {
IMDDimension_sptr dim;
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "mm");
std::vector<IMDDimension_sptr> dimensions;
- dim = MDHistoDimension_sptr(new MDHistoDimension(
- std::string("x"), std::string("ID0"), std::string("mm"), coord_t(-5),
- coord_t(5), size_t(10)));
+ dim = MDHistoDimension_sptr(
+ new MDHistoDimension(std::string("x"), std::string("ID0"), frame,
+ coord_t(-5), coord_t(5), size_t(10)));
dimensions.push_back(boost::const_pointer_cast<IMDDimension>(dim));
- dim = MDHistoDimension_sptr(new MDHistoDimension(
- std::string("y"), std::string("ID1"), std::string("mm"), coord_t(-6),
- coord_t(6), size_t(12)));
+ dim = MDHistoDimension_sptr(
+ new MDHistoDimension(std::string("y"), std::string("ID1"), frame,
+ coord_t(-6), coord_t(6), size_t(12)));
dimensions.push_back(boost::const_pointer_cast<IMDDimension>(dim));
- dim = MDHistoDimension_sptr(new MDHistoDimension(
- std::string("z"), std::string("ID2"), std::string("mm"), coord_t(-10),
- coord_t(10), size_t(20)));
+ dim = MDHistoDimension_sptr(
+ new MDHistoDimension(std::string("z"), std::string("ID2"), frame,
+ coord_t(-10), coord_t(10), size_t(20)));
dimensions.push_back(boost::const_pointer_cast<IMDDimension>(dim));
MDHistoWorkspace_sptr outWS(new MDHistoWorkspace(dimensions));
diff --git a/Framework/SINQ/test/MDHistoToWorkspace2DTest.h b/Framework/SINQ/test/MDHistoToWorkspace2DTest.h
index cdd08b0122c9f084011b4872bbfd415e32c32814..f20d7f8c14710682d69d7a7b7b6c76255edd56bf 100644
--- a/Framework/SINQ/test/MDHistoToWorkspace2DTest.h
+++ b/Framework/SINQ/test/MDHistoToWorkspace2DTest.h
@@ -74,18 +74,20 @@ public:
private:
MDHistoWorkspace_sptr makeTestMD() {
IMDDimension_sptr dim;
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "mm");
std::vector<IMDDimension_sptr> dimensions;
- dim = MDHistoDimension_sptr(new MDHistoDimension(
- std::string("x"), std::string("ID0"), std::string("mm"), coord_t(-50),
- coord_t(50), size_t(100)));
+ dim = MDHistoDimension_sptr(
+ new MDHistoDimension(std::string("x"), std::string("ID0"), frame,
+ coord_t(-50), coord_t(50), size_t(100)));
dimensions.push_back(boost::const_pointer_cast<IMDDimension>(dim));
- dim = MDHistoDimension_sptr(new MDHistoDimension(
- std::string("y"), std::string("ID1"), std::string("mm"), coord_t(-60),
- coord_t(60), size_t(120)));
+ dim = MDHistoDimension_sptr(
+ new MDHistoDimension(std::string("y"), std::string("ID1"), frame,
+ coord_t(-60), coord_t(60), size_t(120)));
dimensions.push_back(boost::const_pointer_cast<IMDDimension>(dim));
- dim = MDHistoDimension_sptr(new MDHistoDimension(
- std::string("z"), std::string("ID2"), std::string("mm"), coord_t(-100),
- coord_t(100), size_t(200)));
+ dim = MDHistoDimension_sptr(
+ new MDHistoDimension(std::string("z"), std::string("ID2"), frame,
+ coord_t(-100), coord_t(100), size_t(200)));
dimensions.push_back(boost::const_pointer_cast<IMDDimension>(dim));
MDHistoWorkspace_sptr outWS(new MDHistoWorkspace(dimensions));
diff --git a/Framework/SINQ/test/ProjectMDTest.h b/Framework/SINQ/test/ProjectMDTest.h
index 5f34e3acb3b2542523290d293722d95fc076b41f..f3fd48f35b7b657d559b74e47dfc6e43bd02ef9d 100644
--- a/Framework/SINQ/test/ProjectMDTest.h
+++ b/Framework/SINQ/test/ProjectMDTest.h
@@ -228,18 +228,20 @@ public:
private:
MDHistoWorkspace_sptr makeTestMD() {
IMDDimension_sptr dim;
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "mm");
std::vector<IMDDimension_sptr> dimensions;
- dim = MDHistoDimension_sptr(new MDHistoDimension(
- std::string("x"), std::string("ID0"), std::string("mm"), coord_t(-5),
- coord_t(5), size_t(10)));
+ dim = MDHistoDimension_sptr(
+ new MDHistoDimension(std::string("x"), std::string("ID0"), frame,
+ coord_t(-5), coord_t(5), size_t(10)));
dimensions.push_back(boost::const_pointer_cast<IMDDimension>(dim));
- dim = MDHistoDimension_sptr(new MDHistoDimension(
- std::string("y"), std::string("ID1"), std::string("mm"), coord_t(-6),
- coord_t(6), size_t(12)));
+ dim = MDHistoDimension_sptr(
+ new MDHistoDimension(std::string("y"), std::string("ID1"), frame,
+ coord_t(-6), coord_t(6), size_t(12)));
dimensions.push_back(boost::const_pointer_cast<IMDDimension>(dim));
- dim = MDHistoDimension_sptr(new MDHistoDimension(
- std::string("z"), std::string("ID2"), std::string("mm"), coord_t(-10),
- coord_t(10), size_t(20)));
+ dim = MDHistoDimension_sptr(
+ new MDHistoDimension(std::string("z"), std::string("ID2"), frame,
+ coord_t(-10), coord_t(10), size_t(20)));
dimensions.push_back(boost::const_pointer_cast<IMDDimension>(dim));
MDHistoWorkspace_sptr outWS(new MDHistoWorkspace(dimensions));
diff --git a/Framework/SINQ/test/SliceMDHistoTest.h b/Framework/SINQ/test/SliceMDHistoTest.h
index 140ef301df70049384bfce91d457ad33c1028d82..cb5e44d7b04b2fe29ae15f053bcdfc2dfda505a3 100644
--- a/Framework/SINQ/test/SliceMDHistoTest.h
+++ b/Framework/SINQ/test/SliceMDHistoTest.h
@@ -90,17 +90,19 @@ private:
MDHistoWorkspace_sptr makeTestMD() {
IMDDimension_sptr dim;
std::vector<IMDDimension_sptr> dimensions;
- dim = MDHistoDimension_sptr(new MDHistoDimension(
- std::string("x"), std::string("ID0"), std::string("mm"), coord_t(-50),
- coord_t(50), size_t(100)));
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "mm");
+ dim = MDHistoDimension_sptr(
+ new MDHistoDimension(std::string("x"), std::string("ID0"), frame,
+ coord_t(-50), coord_t(50), size_t(100)));
dimensions.push_back(boost::const_pointer_cast<IMDDimension>(dim));
- dim = MDHistoDimension_sptr(new MDHistoDimension(
- std::string("y"), std::string("ID1"), std::string("mm"), coord_t(-60),
- coord_t(60), size_t(120)));
+ dim = MDHistoDimension_sptr(
+ new MDHistoDimension(std::string("y"), std::string("ID1"), frame,
+ coord_t(-60), coord_t(60), size_t(120)));
dimensions.push_back(boost::const_pointer_cast<IMDDimension>(dim));
- dim = MDHistoDimension_sptr(new MDHistoDimension(
- std::string("z"), std::string("ID2"), std::string("mm"), coord_t(-100),
- coord_t(100), size_t(200)));
+ dim = MDHistoDimension_sptr(
+ new MDHistoDimension(std::string("z"), std::string("ID2"), frame,
+ coord_t(-100), coord_t(100), size_t(200)));
dimensions.push_back(boost::const_pointer_cast<IMDDimension>(dim));
MDHistoWorkspace_sptr outWS(new MDHistoWorkspace(dimensions));
diff --git a/Framework/ScriptRepository/CMakeLists.txt b/Framework/ScriptRepository/CMakeLists.txt
index 97573e8f64f5dfb0958ffc0b84ffc02fb2fccf6e..f16cbbf784a460ac614c7e9cf6287e89c29cb6b4 100644
--- a/Framework/ScriptRepository/CMakeLists.txt
+++ b/Framework/ScriptRepository/CMakeLists.txt
@@ -35,6 +35,6 @@ set ( LIBS ${MANTIDLIBS} )
include_directories(inc)
-target_link_libraries(ScriptRepository LINK_PRIVATE ${TCMALLOC_LIBRARIES_LINKTIME} ${LIBS})
+target_link_libraries(ScriptRepository LINK_PRIVATE ${TCMALLOC_LIBRARIES_LINKTIME} ${LIBS} ${JSONCPP_LIBRARIES})
install (TARGETS ScriptRepository ${SYSTEM_PACKAGE_TARGET} DESTINATION ${PLUGINS_DIR} )
diff --git a/Framework/ScriptRepository/inc/MantidScriptRepository/ScriptRepositoryImpl.h b/Framework/ScriptRepository/inc/MantidScriptRepository/ScriptRepositoryImpl.h
index bd92ecea6d773504365096cec17bad669c07c4b1..6c9678c0477c33b62e3d62914f1503adcdd284f5 100644
--- a/Framework/ScriptRepository/inc/MantidScriptRepository/ScriptRepositoryImpl.h
+++ b/Framework/ScriptRepository/inc/MantidScriptRepository/ScriptRepositoryImpl.h
@@ -4,6 +4,7 @@
#include "MantidAPI/ScriptRepository.h"
#include "MantidKernel/DateAndTime.h"
#include <map>
+#include <json/value.h>
#ifdef _WIN32
#if (IN_MANTID_SCRIPTREPO)
@@ -18,6 +19,17 @@
namespace Mantid {
namespace API {
+void writeJsonFile(const std::string &filename, Json::Value json,
+ const std::string &error);
+
+Json::Value readJsonFile(const std::string &filename, const std::string &error);
+
+void writeStringFile(const std::string &filename,
+ const std::string &stringToWrite,
+ const std::string &error);
+
+bool fileExists(const std::string &filename);
+
/** Implementation of Mantid::API::ScriptRepository
This implementation relies on the definition of the Script Repository
diff --git a/Framework/ScriptRepository/src/ScriptRepositoryImpl.cpp b/Framework/ScriptRepository/src/ScriptRepositoryImpl.cpp
index 25ecd1465d490443588dbf7fbadbc083b41130b8..9051a68e93e039b39cf0c8b7ca69a973e6bba80c 100644
--- a/Framework/ScriptRepository/src/ScriptRepositoryImpl.cpp
+++ b/Framework/ScriptRepository/src/ScriptRepositoryImpl.cpp
@@ -49,13 +49,11 @@ using Mantid::Kernel::NetworkProxy;
#include <Poco/DateTimeFormatter.h>
// from boost
-#include <boost/property_tree/ptree.hpp>
-#include <boost/property_tree/json_parser.hpp>
#include <boost/foreach.hpp>
#include <boost/algorithm/string.hpp>
#include <boost/regex.hpp>
-using boost::property_tree::ptree;
+#include <json/json.h>
namespace Mantid {
namespace API {
@@ -72,6 +70,60 @@ const char *emptyURL =
"properties file, "
"at ScriptRepository";
+/**
+Write json object to file
+*/
+void writeJsonFile(const std::string &filename, Json::Value json,
+ const std::string &error) {
+ Poco::FileOutputStream filestream(filename);
+ if (!filestream.good()) {
+ g_log.error() << error << std::endl;
+ }
+ Json::StyledWriter writer;
+ filestream << writer.write(json);
+ filestream.close();
+}
+
+/**
+Read json object from file
+*/
+Json::Value readJsonFile(const std::string &filename,
+ const std::string &error) {
+ Poco::FileInputStream filestream(filename);
+ if (!filestream.good()) {
+ g_log.error() << error << std::endl;
+ }
+ Json::Reader json_reader;
+ Json::Value read;
+ json_reader.parse(filestream, read);
+ return read;
+}
+
+/**
+Write string to file
+*/
+void writeStringFile(const std::string &filename,
+ const std::string &stringToWrite,
+ const std::string &error) {
+ Poco::FileStream filestream(filename);
+ if (!filestream.good()) {
+ g_log.error() << error << std::endl;
+ }
+ filestream << stringToWrite;
+ filestream.close();
+}
+
+/**
+Test if a file with this filename already exists
+*/
+bool fileExists(const std::string &filename) {
+ Poco::File test_file(filename);
+ if (test_file.exists()) {
+ return true;
+ }
+ return false;
+}
+
DECLARE_SCRIPTREPOSITORY(ScriptRepositoryImpl)
/**
The main information that ScriptrepositoryImpl needs to be able
@@ -272,10 +324,9 @@ void ScriptRepositoryImpl::install(const std::string &path) {
g_log.debug() << "ScriptRepository downloaded repository information"
<< std::endl;
// creation of the instance of local_json file
- Poco::File local(local_json_file);
- if (!local.exists()) {
- ptree pt;
- write_json(local_json_file, pt);
+ if (!fileExists(local_json_file)) {
+ writeStringFile(local_json_file, "{\n}",
+ "ScriptRepository failed to create local repository");
g_log.debug() << "ScriptRepository created the local repository information"
<< std::endl;
}
@@ -608,7 +659,7 @@ void ScriptRepositoryImpl::download_directory(
it->second.downloaded_pubdate = it->second.pub_date;
updateLocalJson(it->first, it->second);
- } // end donwloading directory
+ } // end downloading directory
// update the status
it->second.status = BOTH_UNCHANGED; // update this entry
} // end interaction with all entries
@@ -822,19 +873,17 @@ void ScriptRepositoryImpl::upload(const std::string &file_path,
std::string detail;
std::string published_date;
- ptree pt;
- try {
- read_json(answer, pt);
- info = pt.get<std::string>("message", "");
- detail = pt.get<std::string>("detail", "");
- published_date = pt.get<std::string>("pub_date", "");
- std::string cmd = pt.get<std::string>("shell", "");
- if (!cmd.empty())
- detail.append("\nFrom Command: ").append(cmd);
-
- } catch (boost::property_tree::json_parser_error &ex) {
- throw ScriptRepoException("Bad answer from the Server", ex.what());
+ Json::Value pt;
+ Json::Reader json_reader;
+ if (!json_reader.parse(answer, pt)) {
+ throw ScriptRepoException("Bad answer from the Server");
}
+ info = pt.get("message", "").asString();
+ detail = pt.get("detail", "").asString();
+ published_date = pt.get("pub_date", "").asString();
+ std::string cmd = pt.get("shell", "").asString();
+ if (!cmd.empty())
+ detail.append("\nFrom Command: ").append(cmd);
if (info == "success") {
g_log.notice() << "ScriptRepository:" << file_path << " uploaded!"
@@ -890,24 +939,22 @@ void ScriptRepositoryImpl::upload(const std::string &file_path,
void ScriptRepositoryImpl::updateRepositoryJson(const std::string &path,
const RepositoryEntry &entry) {
- ptree repository_json;
+ Json::Value repository_json;
std::string filename =
std::string(local_repository).append(".repository.json");
- read_json(filename, repository_json);
-
- ptree::const_assoc_iterator it = repository_json.find(path);
- if (it == repository_json.not_found()) {
- boost::property_tree::ptree array;
- array.put(std::string("author"), entry.author);
- array.put(std::string("description"), entry.description);
- std::string directory =
- (const char *)((entry.directory) ? "true" : "false");
- array.put(std::string("directory"), directory);
- array.put(std::string("pub_date"), entry.pub_date.toFormattedString());
- repository_json.push_back(
- std::pair<std::string,
- boost::property_tree::basic_ptree<std::string, std::string>>(
- path, array));
+ repository_json =
+ readJsonFile(filename, "Error reading .repository.json file");
+
+ if (!repository_json.isMember(path)) {
+ // Create Json value for entry
+ Json::Value entry_json;
+ entry_json["author"] = entry.author;
+ entry_json["description"] = entry.description;
+ entry_json["directory"] = (entry.directory ? "true" : "false");
+ entry_json["pub_date"] = entry.pub_date.toFormattedString();
+
+ // Add Json value for entry to repository Json value
+ repository_json[path] = entry_json;
}
g_log.debug() << "Update LOCAL JSON FILE" << std::endl;
@@ -915,7 +962,8 @@ void ScriptRepositoryImpl::updateRepositoryJson(const std::string &path,
// set the .repository.json and .local.json not hidden to be able to edit it
SetFileAttributes(filename.c_str(), FILE_ATTRIBUTE_NORMAL);
#endif
- write_json(filename, repository_json);
+ writeJsonFile(filename, repository_json,
+ "Error writing .repository.json file");
#if defined(_WIN32) || defined(_WIN64)
// set the .repository.json and .local.json hidden
SetFileAttributes(filename.c_str(), FILE_ATTRIBUTE_HIDDEN);
@@ -1016,21 +1064,18 @@ void ScriptRepositoryImpl::remove(const std::string &file_path,
// not.
std::string info;
std::string detail;
- ptree pt;
- try {
- read_json(answer, pt);
- info = pt.get<std::string>("message", "");
- detail = pt.get<std::string>("detail", "");
- std::string cmd = pt.get<std::string>("shell", "");
- if (!cmd.empty())
- detail.append("\nFrom Command: ").append(cmd);
-
- } catch (boost::property_tree::json_parser_error &ex) {
- // this should not occurr in production. The answer from the
- // server should always be a valid json file
- g_log.debug() << "Bad answer: " << ex.what() << std::endl;
- throw ScriptRepoException("Bad answer from the Server", ex.what());
+ Json::Value answer_json;
+
+ Json::Reader json_reader;
+ if (!json_reader.parse(answer, answer_json)) {
+ throw ScriptRepoException("Bad answer from the Server");
}
+ info = answer_json.get("message", "").asString();
+ detail = answer_json.get("detail", "").asString();
+ std::string cmd = answer_json.get("shell", "").asString();
+
+ if (!cmd.empty())
+ detail.append("\nFrom Command: ").append(cmd);
g_log.debug() << "Checking if success info=" << info << std::endl;
// check if the server removed the file from the central repository
@@ -1048,31 +1093,22 @@ void ScriptRepositoryImpl::remove(const std::string &file_path,
// dealt with locally.
//
{
- ptree pt;
std::string filename =
std::string(local_repository).append(".repository.json");
- try {
- read_json(filename, pt);
- pt.erase(relative_path); // remove the entry
+
+ Json::Value pt =
+ readJsonFile(filename, "Error reading .repository.json file");
+ pt.removeMember(relative_path); // remove the entry
#if defined(_WIN32) || defined(_WIN64)
- // set the .repository.json and .local.json not hidden (to be able to
- // edit it)
- SetFileAttributes(filename.c_str(), FILE_ATTRIBUTE_NORMAL);
+ // set the .repository.json and .local.json not hidden (to be able to
+ // edit it)
+ SetFileAttributes(filename.c_str(), FILE_ATTRIBUTE_NORMAL);
#endif
- write_json(filename, pt);
+ writeJsonFile(filename, pt, "Error writing .repository.json file");
#if defined(_WIN32) || defined(_WIN64)
- // set the .repository.json and .local.json hidden
- SetFileAttributes(filename.c_str(), FILE_ATTRIBUTE_HIDDEN);
+ // set the .repository.json and .local.json hidden
+ SetFileAttributes(filename.c_str(), FILE_ATTRIBUTE_HIDDEN);
#endif
- } catch (boost::property_tree::json_parser_error &ex) {
- std::stringstream ss;
- ss << "corrupted central copy of database : " << filename;
-
- g_log.error() << "ScriptRepository: " << ss.str()
- << "\nDetails: deleting entries - json_parser_error: "
- << ex.what() << std::endl;
- throw ScriptRepoException(ss.str(), ex.what());
- }
}
// update the repository list variable
@@ -1385,32 +1421,31 @@ void ScriptRepositoryImpl::doDownloadFile(const std::string &url_file,
@todo describe
*/
void ScriptRepositoryImpl::parseCentralRepository(Repository &repo) {
- ptree pt;
std::string filename =
std::string(local_repository).append(".repository.json");
try {
- read_json(filename, pt);
-
- BOOST_FOREACH (ptree::value_type &file, pt) {
- if (!isEntryValid(file.first))
+ Json::Value pt =
+ readJsonFile(filename, "Error reading .repository.json file");
+
+ // This is looping through the member name list rather than using
+ // Json::ValueIterator
+ // as a workaround for a bug in the JsonCpp library (Json::ValueIterator is
+ // not exported)
+ Json::Value::Members member_names = pt.getMemberNames();
+ for (unsigned int i = 0; i < member_names.size(); ++i) {
+ std::string filepath = member_names[i];
+ if (!isEntryValid(filepath))
continue;
- // g_log.debug() << "Inserting : file.first " << file.first << std::endl;
- RepositoryEntry &entry = repo[file.first];
+ Json::Value entry_json = pt.get(filepath, "");
+ RepositoryEntry &entry = repo[filepath];
entry.remote = true;
- entry.directory = file.second.get("directory", false);
- entry.pub_date = DateAndTime(file.second.get<std::string>("pub_date"));
- entry.description = file.second.get("description", "");
- entry.author = file.second.get("author", "");
+ entry.directory = entry_json.get("directory", false).asBool();
+ entry.pub_date = DateAndTime(entry_json.get("pub_date", "").asString());
+ entry.description = entry_json.get("description", "").asString();
+ entry.author = entry_json.get("author", "").asString();
entry.status = BOTH_UNCHANGED;
}
- } catch (boost::property_tree::json_parser_error &ex) {
- std::stringstream ss;
- ss << "Corrupted database : " << filename;
-
- g_log.error() << "ScriptRepository: " << ss.str()
- << "\nDetails: json_parser_error: " << ex.what() << std::endl;
- throw ScriptRepoException(ss.str(), ex.what());
} catch (std::exception &ex) {
std::stringstream ss;
ss << "RuntimeError: checking database >> " << ex.what();
@@ -1450,15 +1485,24 @@ void ScriptRepositoryImpl::parseLocalRepository(Repository &repo) {
*/
void ScriptRepositoryImpl::parseDownloadedEntries(Repository &repo) {
- ptree pt;
std::string filename = std::string(local_repository).append(".local.json");
std::vector<std::string> entries_to_delete;
Repository::iterator entry_it;
std::set<std::string> folders_of_deleted;
+
try {
- read_json(filename, pt);
- BOOST_FOREACH (ptree::value_type &file, pt) {
- entry_it = repo.find(file.first);
+ Json::Value pt = readJsonFile(filename, "Error reading .local.json file");
+
+ // This is looping through the member name list rather than using
+ // Json::ValueIterator
+ // as a workaround for a bug in the JsonCpp library (Json::ValueIterator is
+ // not exported)
+ Json::Value::Members member_names = pt.getMemberNames();
+ for (unsigned int i = 0; i < member_names.size(); ++i) {
+ std::string filepath = member_names[i];
+ Json::Value entry_json = pt.get(filepath, "");
+
+ entry_it = repo.find(filepath);
if (entry_it != repo.end()) {
// entry found, so, lets update the entry
if (entry_it->second.local && entry_it->second.remote) {
@@ -1466,24 +1510,25 @@ void ScriptRepositoryImpl::parseDownloadedEntries(Repository &repo) {
// was found at the local file system and at the remote repository
entry_it->second.downloaded_pubdate =
- DateAndTime(file.second.get<std::string>("downloaded_pubdate"));
+ DateAndTime(entry_json.get("downloaded_pubdate", "").asString());
entry_it->second.downloaded_date =
- DateAndTime(file.second.get<std::string>("downloaded_date"));
+ DateAndTime(entry_json.get("downloaded_date", "").asString());
+ std::string auto_update =
+ entry_json.get("auto_update", "false").asString();
entry_it->second.auto_update =
- (file.second.get<std::string>("auto_update", std::string()) ==
- "true");
+ (auto_update == "true"); // get().asBool() fails here on OS X
} else {
- // if the entry was not found locally or remotelly, this means
- // that this entry was deleted (remotelly or locally),
+ // if the entry was not found locally or remotely, this means
+ // that this entry was deleted (remotely or locally),
// so it should not appear at local_repository json any more
- entries_to_delete.push_back(file.first);
- folders_of_deleted.insert(getParentFolder(file.first));
+ entries_to_delete.push_back(filepath);
+ folders_of_deleted.insert(getParentFolder(filepath));
}
} else {
// this entry was never created before, so it should not
// exist in local repository json
- entries_to_delete.push_back(file.first);
+ entries_to_delete.push_back(filepath);
}
} // end loop FOREACH entry in local json
@@ -1493,8 +1538,7 @@ void ScriptRepositoryImpl::parseDownloadedEntries(Repository &repo) {
// clear the auto_update flag from the folders if the user deleted files
BOOST_FOREACH (const std::string &folder, folders_of_deleted) {
- ptree::assoc_iterator pt_entry = pt.find(folder);
- if (pt_entry == pt.not_found())
+ if (!pt.isMember(folder))
continue;
entry_it = repo.find(folder);
@@ -1510,27 +1554,19 @@ void ScriptRepositoryImpl::parseDownloadedEntries(Repository &repo) {
for (std::vector<std::string>::iterator it = entries_to_delete.begin();
it != entries_to_delete.end(); ++it) {
// remove this entry
- pt.erase(*it);
+ pt.removeMember(*it);
}
#if defined(_WIN32) || defined(_WIN64)
// set the .repository.json and .local.json not hidden (to be able to edit
// it)
SetFileAttributes(filename.c_str(), FILE_ATTRIBUTE_NORMAL);
#endif
- write_json(filename, pt);
+ writeJsonFile(filename, pt, "Error writing .local.json file");
#if defined(_WIN32) || defined(_WIN64)
// set the .repository.json and .local.json hidden
SetFileAttributes(filename.c_str(), FILE_ATTRIBUTE_HIDDEN);
#endif
}
- } catch (boost::property_tree::json_parser_error &ex) {
- std::stringstream ss;
- ss << "Corrupted local database : " << filename;
-
- g_log.error() << "ScriptRepository: " << ss.str()
- << "\nDetails: downloaded entries - json_parser_error: "
- << ex.what() << std::endl;
- throw ScriptRepoException(ss.str(), ex.what());
} catch (std::exception &ex) {
std::stringstream ss;
ss << "RuntimeError: checking downloaded entries >> " << ex.what();
@@ -1546,41 +1582,41 @@ void ScriptRepositoryImpl::parseDownloadedEntries(Repository &repo) {
void ScriptRepositoryImpl::updateLocalJson(const std::string &path,
const RepositoryEntry &entry) {
- ptree local_json;
+
std::string filename = std::string(local_repository).append(".local.json");
- read_json(filename, local_json);
-
- ptree::const_assoc_iterator it = local_json.find(path);
- if (it == local_json.not_found()) {
- boost::property_tree::ptree array;
- array.put(std::string("downloaded_date"),
- entry.downloaded_date.toFormattedString());
- array.put(std::string("downloaded_pubdate"),
- entry.downloaded_pubdate.toFormattedString());
- // array.push_back(std::make_pair("auto_update",entry.auto_update)));
- local_json.push_back(
- std::pair<std::string,
- boost::property_tree::basic_ptree<std::string, std::string>>(
- path, array));
+ Json::Value local_json =
+ readJsonFile(filename, "Error reading .local.json file");
+
+ if (!local_json.isMember(path)) {
+
+ // Create new entry
+ Json::Value new_entry;
+ new_entry["downloaded_date"] = entry.downloaded_date.toFormattedString();
+ new_entry["downloaded_pubdate"] =
+ entry.downloaded_pubdate.toFormattedString();
+
+ // Add new entry to repository json value
+ local_json[path] = new_entry;
+
} else {
- local_json.put(boost::property_tree::ptree::path_type(
- std::string(path).append("!downloaded_pubdate"), '!'),
- entry.downloaded_pubdate.toFormattedString().c_str());
- local_json.put(boost::property_tree::ptree::path_type(
- std::string(path).append("!downloaded_date"), '!'),
- entry.downloaded_date.toFormattedString().c_str());
- std::string auto_update_op =
- (const char *)((entry.auto_update) ? "true" : "false");
- std::string key = std::string(path).append("!auto_update");
- local_json.put(boost::property_tree::ptree::path_type(key, '!'),
- auto_update_op);
+
+ Json::Value replace_entry;
+ replace_entry["downloaded_date"] =
+ entry.downloaded_date.toFormattedString();
+ replace_entry["downloaded_pubdate"] =
+ entry.downloaded_pubdate.toFormattedString();
+ replace_entry["auto_update"] = ((entry.auto_update) ? "true" : "false");
+
+ // Replace existing entry for this file
+ local_json.removeMember(path);
+ local_json[path] = replace_entry;
}
-// g_log.debug() << "Update LOCAL JSON FILE" << std::endl;
+
#if defined(_WIN32) || defined(_WIN64)
// set the .repository.json and .local.json not hidden to be able to edit it
SetFileAttributes(filename.c_str(), FILE_ATTRIBUTE_NORMAL);
#endif
- write_json(filename, local_json);
+ writeJsonFile(filename, local_json, "Error writing .local.json file");
#if defined(_WIN32) || defined(_WIN64)
// set the .repository.json and .local.json hidden
SetFileAttributes(filename.c_str(), FILE_ATTRIBUTE_HIDDEN);
diff --git a/Framework/TestHelpers/inc/MantidTestHelpers/MDAlgorithmsTestHelper.h b/Framework/TestHelpers/inc/MantidTestHelpers/MDAlgorithmsTestHelper.h
index d75d83317bc762cbbb02fa5a34ae24e6b856939f..80bbd1cb96caccfad070b771b008b2c6c1c1437c 100644
--- a/Framework/TestHelpers/inc/MantidTestHelpers/MDAlgorithmsTestHelper.h
+++ b/Framework/TestHelpers/inc/MantidTestHelpers/MDAlgorithmsTestHelper.h
@@ -18,6 +18,11 @@ makeFileBackedMDEW(const std::string &wsName, bool fileBacked,
long numEvents = 10000,
Kernel::SpecialCoordinateSystem coord = Kernel::None);
+DataObjects::MDEventWorkspace3Lean::sptr makeFileBackedMDEWwithMDFrame(
+ const std::string &wsName, bool fileBacked,
+ const Mantid::Geometry::MDFrame &frame, long numEvents = 10000,
+ Kernel::SpecialCoordinateSystem coord = Kernel::None);
+
} // namespace
}
}
diff --git a/Framework/TestHelpers/inc/MantidTestHelpers/MDEventsTestHelper.h b/Framework/TestHelpers/inc/MantidTestHelpers/MDEventsTestHelper.h
index e00c37dd2c922c9aaa35b5595b11947586c53ff1..d4c1a04d915d3a769a77635c1243564c95bcbdc4 100644
--- a/Framework/TestHelpers/inc/MantidTestHelpers/MDEventsTestHelper.h
+++ b/Framework/TestHelpers/inc/MantidTestHelpers/MDEventsTestHelper.h
@@ -18,6 +18,117 @@
#include "MantidKernel/DateAndTime.h"
#include "MantidKernel/Utils.h"
+namespace {
+template <typename MDE, size_t nd>
+boost::shared_ptr<Mantid::DataObjects::MDEventWorkspace<MDE, nd>>
+createOutputWorkspace(size_t splitInto) {
+ boost::shared_ptr<Mantid::DataObjects::MDEventWorkspace<MDE, nd>> out(
+ new Mantid::DataObjects::MDEventWorkspace<MDE, nd>());
+ Mantid::API::BoxController_sptr bc = out->getBoxController();
+ bc->setSplitThreshold(100);
+ bc->setSplitInto(splitInto);
+ return out;
+}
+
+template <typename MDE, size_t nd>
+void addMDDimensions(
+ boost::shared_ptr<Mantid::DataObjects::MDEventWorkspace<MDE, nd>> out,
+ Mantid::coord_t min, Mantid::coord_t max, std::string axisNameFormat,
+ std::string axisIdFormat) {
+
+ // Create MDFrame of General Frame type
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "m");
+
+ // Create dimensions
+ for (size_t d = 0; d < nd; d++) {
+ char name[200];
+ sprintf(name, axisNameFormat.c_str(), d);
+ char id[200];
+ sprintf(id, axisIdFormat.c_str(), d);
+
+ Mantid::Geometry::MDHistoDimension_sptr dim(
+ new Mantid::Geometry::MDHistoDimension(
+ std::string(name), std::string(id), frame, min, max, 10));
+ out->addDimension(dim);
+ }
+ out->initialize();
+}
+
+template <typename MDE, size_t nd>
+void addMDDimensionsWithFrames(
+ boost::shared_ptr<Mantid::DataObjects::MDEventWorkspace<MDE, nd>> out,
+ Mantid::coord_t min, Mantid::coord_t max,
+ const Mantid::Geometry::MDFrame &frame, std::string axisNameFormat,
+ std::string axisIdFormat) {
+ for (size_t d = 0; d < nd; d++) {
+ char name[200];
+ sprintf(name, axisNameFormat.c_str(), d);
+ char id[200];
+ sprintf(id, axisIdFormat.c_str(), d);
+
+ // Use the same frame for all dimensions
+ auto dim = boost::make_shared<Mantid::Geometry::MDHistoDimension>(
+ std::string(name), std::string(id), frame, min, max, 10);
+ out->addDimension(dim);
+ }
+ out->initialize();
+}
+
+template <typename MDE, size_t nd>
+void addMDDimensionsWithIndividualFrames(
+ boost::shared_ptr<Mantid::DataObjects::MDEventWorkspace<MDE, nd>> out,
+ Mantid::coord_t min, Mantid::coord_t max,
+ const std::vector<Mantid::Geometry::MDFrame_sptr> &frame,
+ std::string axisNameFormat, std::string axisIdFormat) {
+ for (size_t d = 0; d < nd; d++) {
+ char name[200];
+ sprintf(name, axisNameFormat.c_str(), d);
+ char id[200];
+ sprintf(id, axisIdFormat.c_str(), d);
+
+ // Use the same frame for all dimensions
+ auto dim = boost::make_shared<Mantid::Geometry::MDHistoDimension>(
+ std::string(name), std::string(id), *frame[d], min, max, 10);
+ out->addDimension(dim);
+ }
+ out->initialize();
+}
+
+template <typename MDE, size_t nd>
+void addData(
+ boost::shared_ptr<Mantid::DataObjects::MDEventWorkspace<MDE, nd>> out,
+ size_t splitInto, Mantid::coord_t min, Mantid::coord_t max,
+ size_t numEventsPerBox) {
+ if (numEventsPerBox > 0) {
+ out->splitBox();
+ size_t index[nd];
+ Mantid::Kernel::Utils::NestedForLoop::SetUp(nd, index);
+ size_t index_max[nd];
+ Mantid::Kernel::Utils::NestedForLoop::SetUp(nd, index_max, splitInto);
+ bool allDone = false;
+ while (!allDone) {
+ for (size_t i = 0; i < numEventsPerBox; i++) {
+ // Put an event in the middle of each box
+ Mantid::coord_t centers[nd];
+ for (size_t d = 0; d < nd; d++)
+ centers[d] = min +
+ (static_cast<Mantid::coord_t>(index[d]) + 0.5f) *
+ (max - min) /
+ static_cast<Mantid::coord_t>(splitInto);
+ out->addEvent(MDE(1.0, 1.0, centers));
+ }
+
+ allDone =
+ Mantid::Kernel::Utils::NestedForLoop::Increment(nd, index, index_max);
+ }
+ out->refreshCache();
+ }
+ auto ei = Mantid::API::ExperimentInfo_sptr(new Mantid::API::ExperimentInfo());
+ out->addExperimentInfo(ei);
+}
+}
+
namespace Mantid {
namespace DataObjects {
@@ -54,6 +165,11 @@ makeFakeMDHistoWorkspace(double signal, size_t numDims, size_t numBins = 10,
coord_t max = 10.0, double errorSquared = 1.0,
std::string name = "", double numEvents = 1.0);
+Mantid::DataObjects::MDHistoWorkspace_sptr makeFakeMDHistoWorkspaceWithMDFrame(
+ double signal, size_t numDims, const Mantid::Geometry::MDFrame &frame,
+ size_t numBins = 10, coord_t max = 10.0, double errorSquared = 1.0,
+ std::string name = "", double numEvents = 1.0);
+
/// More general fake n-dimensionsal MDHistoWorkspace
Mantid::DataObjects::MDHistoWorkspace_sptr makeFakeMDHistoWorkspaceGeneral(
size_t numDims, double signal, double errorSquared, size_t *numBins,
@@ -85,49 +201,96 @@ makeAnyMDEW(size_t splitInto, coord_t min, coord_t max,
size_t numEventsPerBox = 0, std::string wsName = "",
std::string axisNameFormat = "Axis%d",
std::string axisIdFormat = "Axis%d") {
- boost::shared_ptr<Mantid::DataObjects::MDEventWorkspace<MDE, nd>> out(
- new Mantid::DataObjects::MDEventWorkspace<MDE, nd>());
- Mantid::API::BoxController_sptr bc = out->getBoxController();
- bc->setSplitThreshold(100);
- bc->setSplitInto(splitInto);
+ // Create bare workspace
+ auto out = createOutputWorkspace<MDE, nd>(splitInto);
- for (size_t d = 0; d < nd; d++) {
- char name[200];
- sprintf(name, axisNameFormat.c_str(), d);
- char id[200];
- sprintf(id, axisIdFormat.c_str(), d);
- Mantid::Geometry::MDHistoDimension_sptr dim(
- new Mantid::Geometry::MDHistoDimension(
- std::string(name), std::string(id), "m", min, max, 10));
- out->addDimension(dim);
- }
- out->initialize();
+ // Add standard dimensions
+ addMDDimensions<MDE, nd>(out, min, max, axisNameFormat, axisIdFormat);
- if (numEventsPerBox > 0) {
- out->splitBox();
- size_t index[nd];
- Mantid::Kernel::Utils::NestedForLoop::SetUp(nd, index);
- size_t index_max[nd];
- Mantid::Kernel::Utils::NestedForLoop::SetUp(nd, index_max, splitInto);
- bool allDone = false;
- while (!allDone) {
- for (size_t i = 0; i < numEventsPerBox; i++) {
- // Put an event in the middle of each box
- Mantid::coord_t centers[nd];
- for (size_t d = 0; d < nd; d++)
- centers[d] = min +
- (static_cast<coord_t>(index[d]) + 0.5f) * (max - min) /
- static_cast<coord_t>(splitInto);
- out->addEvent(MDE(1.0, 1.0, centers));
- }
+ // Add data
+ addData<MDE, nd>(out, splitInto, min, max, numEventsPerBox);
- allDone =
- Mantid::Kernel::Utils::NestedForLoop::Increment(nd, index, index_max);
- }
- out->refreshCache();
- }
- auto ei = API::ExperimentInfo_sptr(new API::ExperimentInfo());
- out->addExperimentInfo(ei);
+ // Add to ADS on option
+ if (!wsName.empty())
+ Mantid::API::AnalysisDataService::Instance().addOrReplace(wsName, out);
+
+ return out;
+}
+
+/** Create a test MDEventWorkspace<nd> . Dimensions are names Axis0, Axis1, etc.
+ * But you can set an MDFrame. The frames can be set individually.
+ *
+ * @param splitInto :: each dimension will split into this many subgrids
+ * @param min :: extent of each dimension (min)
+ * @param max :: extent of each dimension (max)
+ * @param frames:: the chosen frame
+ * @param numEventsPerBox :: will create one MDLeanEvent in the center of each
+ *sub-box.
+ * 0 = don't split box, don't add events
+ * @param wsName :: if specified, then add the workspace to the analysis data
+ *service
+ * @param axisNameFormat :: string for the axis name, processed via sprintf()
+ * @param axisIdFormat :: string for the axis ID, processed via sprintf()
+ * @return shared ptr to the created workspace
+ */
+template <typename MDE, size_t nd>
+boost::shared_ptr<Mantid::DataObjects::MDEventWorkspace<MDE, nd>>
+makeAnyMDEWWithIndividualFrames(
+ size_t splitInto, coord_t min, coord_t max,
+ std::vector<Mantid::Geometry::MDFrame_sptr> frames,
+ size_t numEventsPerBox = 0, std::string wsName = "",
+ std::string axisNameFormat = "Axis%d",
+ std::string axisIdFormat = "Axis%d") {
+ // Create bare workspace
+ auto out = createOutputWorkspace<MDE, nd>(splitInto);
+
+ // Add standard dimensions
+ addMDDimensionsWithIndividualFrames<MDE, nd>(out, min, max, frames,
+ axisNameFormat, axisIdFormat);
+
+ // Add data
+ addData<MDE, nd>(out, splitInto, min, max, numEventsPerBox);
+
+ // Add to ADS on option
+ if (!wsName.empty())
+ Mantid::API::AnalysisDataService::Instance().addOrReplace(wsName, out);
+
+ return out;
+}
+
+/** Create a test MDEventWorkspace<nd> . Dimensions are names Axis0, Axis1, etc.
+ * But you can set an MDFrame. For now the same frame for all dimensions
+ * is used.
+ *
+ * @param splitInto :: each dimension will split into this many subgrids
+ * @param min :: extent of each dimension (min)
+ * @param max :: extent of each dimension (max)
+ * @param frame:: the chosen frame
+ * @param numEventsPerBox :: will create one MDLeanEvent in the center of each
+ *sub-box.
+ * 0 = don't split box, don't add events
+ * @param wsName :: if specified, then add the workspace to the analysis data
+ *service
+ * @param axisNameFormat :: string for the axis name, processed via sprintf()
+ * @param axisIdFormat :: string for the axis ID, processed via sprintf()
+ * @return shared ptr to the created workspace
+ */
+template <typename MDE, size_t nd>
+boost::shared_ptr<Mantid::DataObjects::MDEventWorkspace<MDE, nd>>
+makeAnyMDEWWithFrames(size_t splitInto, coord_t min, coord_t max,
+ const Mantid::Geometry::MDFrame &frame,
+ size_t numEventsPerBox = 0, std::string wsName = "",
+ std::string axisNameFormat = "Axis%d",
+ std::string axisIdFormat = "Axis%d") {
+ // Create bare workspace
+ auto out = createOutputWorkspace<MDE, nd>(splitInto);
+
+ // Add standard dimensions
+ addMDDimensionsWithFrames<MDE, nd>(out, min, max, frame, axisNameFormat,
+ axisIdFormat);
+
+ // Add data
+ addData<MDE, nd>(out, splitInto, min, max, numEventsPerBox);
// Add to ADS on option
if (!wsName.empty())
@@ -144,6 +307,27 @@ makeMDEW(size_t splitInto, coord_t min, coord_t max,
return makeAnyMDEW<MDLeanEvent<nd>, nd>(splitInto, min, max, numEventsPerBox);
}
+/** Make a MDEventWorkspace with MDLeanEvents nad MDFrames*/
+template <size_t nd>
+boost::shared_ptr<MDEventWorkspace<MDLeanEvent<nd>, nd>>
+makeMDEWWithFrames(size_t splitInto, coord_t min, coord_t max,
+ const Mantid::Geometry::MDFrame &frame,
+ size_t numEventsPerBox = 0) {
+ return makeAnyMDEWWithFrames<MDLeanEvent<nd>, nd>(splitInto, min, max, frame,
+ numEventsPerBox);
+}
+
+/** Make a MDEventWorkspace with MDLeanEvents and individual MDFrames*/
+template <size_t nd>
+boost::shared_ptr<MDEventWorkspace<MDLeanEvent<nd>, nd>>
+makeMDEWWithIndividualFrames(
+ size_t splitInto, coord_t min, coord_t max,
+ const std::vector<Mantid::Geometry::MDFrame_sptr> &frame,
+ size_t numEventsPerBox = 0) {
+ return makeAnyMDEWWithIndividualFrames<MDLeanEvent<nd>, nd>(
+ splitInto, min, max, frame, numEventsPerBox);
+}
+
/** Make a MDEventWorkspace with MDEvents - updated to split dims by splitInto,
* not 10 */
template <size_t nd>
diff --git a/Framework/TestHelpers/src/MDAlgorithmsTestHelper.cpp b/Framework/TestHelpers/src/MDAlgorithmsTestHelper.cpp
index 024b3e7287f27ff122ebd72bdd3e8a8b0544c870..aff763280f6fee35ba72ac1409b19a657bcc4536 100644
--- a/Framework/TestHelpers/src/MDAlgorithmsTestHelper.cpp
+++ b/Framework/TestHelpers/src/MDAlgorithmsTestHelper.cpp
@@ -60,6 +60,50 @@ makeFileBackedMDEW(const std::string &wsName, bool fileBacked, long numEvents,
Mantid::API::AnalysisDataService::Instance().retrieve(wsName));
}
+/** Make a (optionally) file backed MDEventWorkspace with nEvents fake data
+ *points
+ * the points are randomly distributed within the box (nEvents>0) or
+ *homoheneously and regularly spread through the box (nEvents<0)
+ *
+ * @param wsName :: name of the workspace in ADS
+ * @param fileBacked :: true for file-backed
+ * @param frame:: the required frame
+ * @param numEvents :: number of events in the target workspace distributed
+ *randomly if numEvents>0 or regularly & homogeneously if numEvents<0
+ * @param coord :: Required coordinate system
+ * @return MDEW sptr
+ */
+DataObjects::MDEventWorkspace3Lean::sptr
+makeFileBackedMDEWwithMDFrame(const std::string &wsName, bool fileBacked,
+ const Mantid::Geometry::MDFrame &frame,
+ long numEvents,
+ Kernel::SpecialCoordinateSystem coord) {
+ // ---------- Make a file-backed MDEventWorkspace -----------------------
+ std::string snEvents = boost::lexical_cast<std::string>(numEvents);
+ MDEventWorkspace3Lean::sptr ws1 =
+ MDEventsTestHelper::makeAnyMDEWWithFrames<MDLeanEvent<3>, 3>(
+ 10, 0.0, 10.0, frame, 0);
+ ws1->getBoxController()->setSplitThreshold(100);
+ ws1->setCoordinateSystem(coord);
+ Mantid::API::AnalysisDataService::Instance().addOrReplace(
+ wsName, boost::dynamic_pointer_cast<Mantid::API::IMDEventWorkspace>(ws1));
+ FrameworkManager::Instance().exec("FakeMDEventData", 6, "InputWorkspace",
+ wsName.c_str(), "UniformParams",
+ snEvents.c_str(), "RandomizeSignal", "1");
+ if (fileBacked) {
+ std::string filename = wsName + ".nxs";
+ auto saver = FrameworkManager::Instance().exec(
+ "SaveMD", 4, "InputWorkspace", wsName.c_str(), "Filename",
+ filename.c_str());
+ FrameworkManager::Instance().exec(
+ "LoadMD", 8, "OutputWorkspace", wsName.c_str(), "Filename",
+ saver->getPropertyValue("Filename").c_str(), "FileBackEnd", "1",
+ "Memory", "0");
+ }
+ return boost::dynamic_pointer_cast<MDEventWorkspace3Lean>(
+ Mantid::API::AnalysisDataService::Instance().retrieve(wsName));
+}
+
} // namespace
}
}
diff --git a/Framework/TestHelpers/src/MDEventsTestHelper.cpp b/Framework/TestHelpers/src/MDEventsTestHelper.cpp
index fdea9049d1e6fb49c5eaac08339d95abb5d3630a..5bf97f422fe47229086380e6d18cb39513e06d56 100644
--- a/Framework/TestHelpers/src/MDEventsTestHelper.cpp
+++ b/Framework/TestHelpers/src/MDEventsTestHelper.cpp
@@ -19,6 +19,7 @@
#include "MantidGeometry/Instrument/InstrumentDefinitionParser.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
#include "MantidGeometry/MDGeometry/MDTypes.h"
+#include "MantidGeometry/MDGeometry/GeneralFrame.h"
#include "MantidKernel/cow_ptr.h"
#include "MantidKernel/DateAndTime.h"
@@ -217,44 +218,11 @@ Mantid::DataObjects::MDHistoWorkspace_sptr
makeFakeMDHistoWorkspace(double signal, size_t numDims, size_t numBins,
coord_t max, double errorSquared, std::string name,
double numEvents) {
- MDHistoWorkspace *ws = NULL;
- if (numDims == 1) {
- ws = new MDHistoWorkspace(MDHistoDimension_sptr(
- new MDHistoDimension("x", "x", "m", 0.0, max, numBins)));
- } else if (numDims == 2) {
- ws = new MDHistoWorkspace(MDHistoDimension_sptr(new MDHistoDimension(
- "x", "x", "m", 0.0, max, numBins)),
- MDHistoDimension_sptr(new MDHistoDimension(
- "y", "y", "m", 0.0, max, numBins)));
- } else if (numDims == 3) {
- ws = new MDHistoWorkspace(MDHistoDimension_sptr(new MDHistoDimension(
- "x", "x", "m", 0.0, max, numBins)),
- MDHistoDimension_sptr(new MDHistoDimension(
- "y", "y", "m", 0.0, max, numBins)),
- MDHistoDimension_sptr(new MDHistoDimension(
- "z", "z", "m", 0.0, max, numBins)));
- } else if (numDims == 4) {
- ws = new MDHistoWorkspace(
- MDHistoDimension_sptr(
- new MDHistoDimension("x", "x", "m", 0.0, max, numBins)),
- MDHistoDimension_sptr(
- new MDHistoDimension("y", "y", "m", 0.0, max, numBins)),
- MDHistoDimension_sptr(
- new MDHistoDimension("z", "z", "m", 0.0, max, numBins)),
- MDHistoDimension_sptr(
- new MDHistoDimension("t", "t", "m", 0.0, max, numBins)));
- }
-
- if (!ws)
- throw std::runtime_error(
- " invalid or unsupported number of dimensions given");
-
- MDHistoWorkspace_sptr ws_sptr(ws);
- ws_sptr->setTo(signal, errorSquared, numEvents);
- ws_sptr->addExperimentInfo(ExperimentInfo_sptr(new ExperimentInfo()));
- if (!name.empty())
- AnalysisDataService::Instance().addOrReplace(name, ws_sptr);
- return ws_sptr;
+ // Create MDFrame of General Frame type
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "m");
+ return makeFakeMDHistoWorkspaceWithMDFrame(
+ signal, numDims, frame, numBins, max, errorSquared, name, numEvents);
}
//-------------------------------------------------------------------------------------
@@ -280,10 +248,14 @@ makeFakeMDHistoWorkspaceGeneral(size_t numDims, double signal,
names.push_back("z");
names.push_back("t");
+ // Create MDFrame of General Frame type
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "m");
+
std::vector<Mantid::Geometry::MDHistoDimension_sptr> dimensions;
for (size_t d = 0; d < numDims; d++)
dimensions.push_back(MDHistoDimension_sptr(new MDHistoDimension(
- names[d], names[d], "m", min[d], max[d], numBins[d])));
+ names[d], names[d], frame, min[d], max[d], numBins[d])));
MDHistoWorkspace *ws = NULL;
ws = new MDHistoWorkspace(dimensions);
@@ -313,9 +285,12 @@ MDHistoWorkspace_sptr makeFakeMDHistoWorkspaceGeneral(
coord_t *min, coord_t *max, std::vector<std::string> names,
std::string name) {
std::vector<Mantid::Geometry::MDHistoDimension_sptr> dimensions;
+ // Create MDFrame of General Frame type
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameDistance, "m");
for (size_t d = 0; d < numDims; d++)
dimensions.push_back(MDHistoDimension_sptr(new MDHistoDimension(
- names[d], names[d], "m", min[d], max[d], numBins[d])));
+ names[d], names[d], frame, min[d], max[d], numBins[d])));
MDHistoWorkspace *ws = NULL;
ws = new MDHistoWorkspace(dimensions);
@@ -326,6 +301,64 @@ MDHistoWorkspace_sptr makeFakeMDHistoWorkspaceGeneral(
return ws_sptr;
}
+//-------------------------------------------------------------------------------------
+/** Creates a fake MDHistoWorkspace with MDFrame selection
+ *
+ * @param signal :: signal in every point
+ * @param numDims :: number of dimensions to create. They will range from 0 to
+ *max
+ * @param frame :: the selected frame
+ * @param numBins :: bins in each dimensions
+ * @param max :: max position in each dimension
+ * @param errorSquared :: error squared in every point
+ * @param name :: optional name
+ * @param numEvents :: optional number of events in each bin. Default 1.0
+ * @return the MDHisto
+ */
+Mantid::DataObjects::MDHistoWorkspace_sptr makeFakeMDHistoWorkspaceWithMDFrame(
+ double signal, size_t numDims, const Mantid::Geometry::MDFrame &frame,
+ size_t numBins, coord_t max, double errorSquared, std::string name,
+ double numEvents) {
+ MDHistoWorkspace *ws = NULL;
+ if (numDims == 1) {
+ ws = new MDHistoWorkspace(MDHistoDimension_sptr(
+ new MDHistoDimension("x", "x", frame, 0.0, max, numBins)));
+ } else if (numDims == 2) {
+ ws = new MDHistoWorkspace(MDHistoDimension_sptr(new MDHistoDimension(
+ "x", "x", frame, 0.0, max, numBins)),
+ MDHistoDimension_sptr(new MDHistoDimension(
+ "y", "y", frame, 0.0, max, numBins)));
+ } else if (numDims == 3) {
+ ws = new MDHistoWorkspace(MDHistoDimension_sptr(new MDHistoDimension(
+ "x", "x", frame, 0.0, max, numBins)),
+ MDHistoDimension_sptr(new MDHistoDimension(
+ "y", "y", frame, 0.0, max, numBins)),
+ MDHistoDimension_sptr(new MDHistoDimension(
+ "z", "z", frame, 0.0, max, numBins)));
+ } else if (numDims == 4) {
+ ws = new MDHistoWorkspace(
+ MDHistoDimension_sptr(
+ new MDHistoDimension("x", "x", frame, 0.0, max, numBins)),
+ MDHistoDimension_sptr(
+ new MDHistoDimension("y", "y", frame, 0.0, max, numBins)),
+ MDHistoDimension_sptr(
+ new MDHistoDimension("z", "z", frame, 0.0, max, numBins)),
+ MDHistoDimension_sptr(
+ new MDHistoDimension("t", "t", frame, 0.0, max, numBins)));
+ }
+
+ if (!ws)
+ throw std::runtime_error(
+ " invalid or unsupported number of dimensions given");
+
+ MDHistoWorkspace_sptr ws_sptr(ws);
+ ws_sptr->setTo(signal, errorSquared, numEvents);
+ ws_sptr->addExperimentInfo(ExperimentInfo_sptr(new ExperimentInfo()));
+ if (!name.empty())
+ AnalysisDataService::Instance().addOrReplace(name, ws_sptr);
+ return ws_sptr;
+}
+
/**
* Delete a file from disk
* @param filename : File name to check and delete
diff --git a/Framework/WorkflowAlgorithms/src/ConvolutionFitSequential.cpp b/Framework/WorkflowAlgorithms/src/ConvolutionFitSequential.cpp
index 2b3048339fbc816e9889258add38d93b37fb796b..c55f675fa3c18a317f73e121a07d9ac1224bfdbf 100644
--- a/Framework/WorkflowAlgorithms/src/ConvolutionFitSequential.cpp
+++ b/Framework/WorkflowAlgorithms/src/ConvolutionFitSequential.cpp
@@ -194,7 +194,7 @@ void ConvolutionFitSequential::exec() {
std::string nextWs = tempFitWsName + ",i";
nextWs += boost::lexical_cast<std::string>(i);
plotPeakInput += nextWs + ";";
- plotPeakStringProg.report();
+ plotPeakStringProg.report("Constructing PlotPeak name");
}
// passWSIndex
@@ -227,12 +227,12 @@ void ConvolutionFitSequential::exec() {
deleter->setProperty("WorkSpace",
outputWsName + "_NormalisedCovarianceMatrices");
deleter->executeAsChildAlg();
- deleteProgress.report();
+ deleteProgress.report("Deleting PlotPeak Output");
deleter = createChildAlgorithm("DeleteWorkspace");
deleter->setProperty("WorkSpace", outputWsName + "_Parameters");
deleter->executeAsChildAlg();
- deleteProgress.report();
+ deleteProgress.report("Deleting PlotPeak Output");
std::string paramTableName = outputWsName + "_Parameters";
AnalysisDataService::Instance().add(paramTableName, outputWs);
@@ -251,7 +251,7 @@ void ConvolutionFitSequential::exec() {
}
for (size_t i = 0; i < func->nParams(); i++) {
paramNames.push_back(func->parameterName(i));
- workflowProg.report();
+ workflowProg.report("Finding parameters to process");
}
if (funcName.compare("Lorentzian") == 0) {
// remove peak centre
@@ -268,7 +268,7 @@ void ConvolutionFitSequential::exec() {
calculateEISF(outputWs);
}
- // Construct comma separated list for ProcessIndirectFirParameters
+ // Construct comma separated list for ProcessIndirectFitParameters
std::string paramNamesList = "";
const size_t maxNames = paramNames.size();
for (size_t i = 0; i < maxNames; i++) {
@@ -276,7 +276,7 @@ void ConvolutionFitSequential::exec() {
if (i != (maxNames - 1)) {
paramNamesList += ",";
}
- workflowProg.report();
+ workflowProg.report("Constructing indirectFitParams input");
}
// Run ProcessIndirectFitParameters
@@ -319,7 +319,7 @@ void ConvolutionFitSequential::exec() {
logAdder->setProperty("LogText", it->second);
logAdder->setProperty("LogType", "String");
logAdder->executeAsChildAlg();
- logAdderProg.report();
+ logAdderProg.report("Add text logs");
}
// Add Numeric Logs
@@ -329,7 +329,7 @@ void ConvolutionFitSequential::exec() {
logAdder->setProperty("LogText", it->second);
logAdder->setProperty("LogType", "Number");
logAdder->executeAsChildAlg();
- logAdderProg.report();
+ logAdderProg.report("Adding Numerical logs");
}
// Copy Logs to GroupWorkspace
logCopier = createChildAlgorithm("CopyLogs", 0.97, 0.98, true);
@@ -352,7 +352,7 @@ void ConvolutionFitSequential::exec() {
outName += "_Workspace";
renamer->setProperty("OutputWorkspace", outName);
renamer->executeAsChildAlg();
- renamerProg.report();
+ renamerProg.report("Renaming group workspaces");
}
AnalysisDataService::Instance().addOrReplace(resultWsName, resultWs);
diff --git a/Framework/WorkflowAlgorithms/src/ProcessIndirectFitParameters.cpp b/Framework/WorkflowAlgorithms/src/ProcessIndirectFitParameters.cpp
index e87590afa918dcda5bd6744af7fd31084bae3369..730fca4ed8f0478fac8dca4993d18e43bffd6662 100644
--- a/Framework/WorkflowAlgorithms/src/ProcessIndirectFitParameters.cpp
+++ b/Framework/WorkflowAlgorithms/src/ProcessIndirectFitParameters.cpp
@@ -93,7 +93,9 @@ void ProcessIndirectFitParameters::exec() {
// ignoring their function index and output them to a workspace
auto workspaceNames = std::vector<std::vector<std::string>>();
const size_t totalNames = parameterNames.size();
+ Progress tblSearchProg = Progress(this, 0.0, 0.5, totalNames * 2);
for (size_t i = 0; i < totalNames; i++) {
+ tblSearchProg.report("Splitting table into relevant columns");
auto const allColumnNames = inputWs->getColumnNames();
auto columns = searchForFitParams(parameterNames.at(i), allColumnNames);
auto errColumns =
@@ -107,7 +109,7 @@ void ProcessIndirectFitParameters::exec() {
auto convertToMatrix =
createChildAlgorithm("ConvertTableToMatrixWorkspace", -1, -1, true);
convertToMatrix->setAlwaysStoreInADS(true);
-
+ tblSearchProg.report("Converting Column to Matrix");
for (size_t j = 0; j < min; j++) {
convertToMatrix->setProperty("InputWorkspace", inputWs);
convertToMatrix->setProperty("ColumnX", xColumn);
@@ -120,9 +122,11 @@ void ProcessIndirectFitParameters::exec() {
workspaceNames.push_back(paramWorkspaces);
}
+ Progress workflowProg = Progress(this, 0.5, 1.0, 10);
// Transpose list of workspaces, ignoring unequal length of lists
// this handles the case where a parameter occurs only once in the whole
// workspace
+ workflowProg.report("Reordering workspace vector");
workspaceNames = reorder2DVector(workspaceNames);
// Join all the parameters for each peak into a single workspace per peak
@@ -134,6 +138,7 @@ void ProcessIndirectFitParameters::exec() {
for (size_t j = 0; j < wsMax; j++) {
std::string tempPeakWs = workspaceNames.at(j).at(0);
const size_t paramMax = workspaceNames.at(j).size();
+ workflowProg.report("Conjoining matrix workspaces");
for (size_t k = 1; k < paramMax; k++) {
auto paramWs = workspaceNames.at(j).at(k);
conjoin->setProperty("InputWorkspace1", tempPeakWs);
@@ -147,6 +152,7 @@ void ProcessIndirectFitParameters::exec() {
// Join all peaks into a single workspace
std::string tempWorkspace = tempWorkspaces.at(0);
for (auto it = tempWorkspaces.begin() + 1; it != tempWorkspaces.end(); ++it) {
+ workflowProg.report("Joining peak workspaces");
conjoin->setProperty("InputWorkspace1", tempWorkspace);
conjoin->setProperty("InputWorkspace2", *it);
conjoin->executeAsChildAlg();
@@ -154,6 +160,7 @@ void ProcessIndirectFitParameters::exec() {
}
// Rename the workspace to the specified outputName
+ workflowProg.report("Renaming Workspace");
auto renamer = createChildAlgorithm("RenameWorkspace", -1, -1, true);
renamer->setProperty("InputWorkspace", tempWorkspace);
renamer->setProperty("OutputWorkspace", outputWsName);
@@ -162,6 +169,7 @@ void ProcessIndirectFitParameters::exec() {
auto outputWs = boost::dynamic_pointer_cast<MatrixWorkspace>(renameWs);
// Replace axis on workspaces with text axis
+ workflowProg.report("Converting text axis");
auto axis = new TextAxis(outputWs->getNumberHistograms());
size_t offset = 0;
for (size_t j = 0; j < workspaceNames.size(); j++) {
@@ -173,6 +181,7 @@ void ProcessIndirectFitParameters::exec() {
}
outputWs->replaceAxis(1, axis);
+ workflowProg.report("Setting unit");
// Set units for the xAxis
if (xUnit.compare("") != 0) {
outputWs->getAxis(0)->setUnit(xUnit);
diff --git a/MantidPlot/src/origin/OPJFile.cpp b/MantidPlot/src/origin/OPJFile.cpp
index 73c397f65f2b0677228b8845a3ee1219b7708505..af88aa5ed1d21f9c46510c0c1126031a38fbe138 100644
--- a/MantidPlot/src/origin/OPJFile.cpp
+++ b/MantidPlot/src/origin/OPJFile.cpp
@@ -27,27 +27,12 @@
* *
***************************************************************************/
-// Disable various warnings as this is not our code
-#if defined(__GNUC__) && !(defined(__INTEL_COMPILER))
-#define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
-#pragma GCC diagnostic ignored "-Wreorder"
-#pragma GCC diagnostic ignored "-Wformat"
-// This option seems to have disappeared in 4.4.4, but came back in 4.5.x?!?!?
-#if GCC_VERSION < 40404 || GCC_VERSION > 40500
- #pragma GCC diagnostic ignored "-Wunused-result"
-#endif
-#pragma GCC diagnostic ignored "-Wunused"
-#pragma GCC diagnostic ignored "-Wunused-parameter"
-#pragma GCC diagnostic ignored "-Wconversion"
-#pragma GCC diagnostic ignored "-Wtype-limits"
-#endif
-
#ifdef _WIN32
- #pragma warning( disable: 4800 )
+#pragma warning(disable : 4800)
#endif
#ifdef __INTEL_COMPILER
- #pragma warning disable 181
+#pragma warning disable 181
#endif
#include <stdio.h>
@@ -61,108 +46,134 @@
using std::vector;
using std::string;
-const char* colTypeNames[] = {"X", "Y", "Z", "XErr", "YErr", "Label", "None"};
+const char *colTypeNames[] = {"X", "Y", "Z", "XErr", "YErr", "Label", "None"};
#define MAX_LEVEL 20
-#define ERROR_MSG "Please send the OPJ file and the opjfile.log to the author of liborigin!\n"
+#define ERROR_MSG \
+ "Please send the OPJ file and the opjfile.log to the author of liborigin!\n"
-#define SwapBytes(x) ByteSwap((unsigned char *) &x,sizeof(x))
+#define SwapBytes(x) ByteSwap((unsigned char *)&x, sizeof(x))
-int strcmp_i(const char *s1, const char *s2) { //compare two strings ignoring case
+int strcmp_i(const char *s1,
+ const char *s2) { // compare two strings ignoring case
#ifdef _WINDOWS
- return _stricmp(s1,s2);
+ return _stricmp(s1, s2);
#else
- return strcasecmp(s1,s2);
+ return strcasecmp(s1, s2);
#endif
}
-void OPJFile::ByteSwap(unsigned char * b, int n) {
+// for standard calls like 'int retval = fseek(f, 0x7, SEEK_SET);'
+#define CHECKED_FSEEK(debug, fd, offset, whence) \
+ { \
+ int retval = fseek(fd, offset, whence); \
+ if (retval < 0) { \
+ std::string posStr = ""; \
+ if (SEEK_SET == whence) \
+ posStr = "beginning of the file"; \
+ else if (SEEK_CUR == whence) \
+ posStr = "current position of the file"; \
+ else if (SEEK_END == whence) \
+ posStr = "end of the file"; \
+ \
+ fprintf(debug, " WARNING : could not move to position %d from the %s\n", \
+ offset, posStr.c_str()); \
+ } \
+ }
+
+// for standard calls like 'size_t retval = fread(&objectcount, 4, 1, f);'
+#define CHECKED_FREAD(debug, ptr, size, nmemb, stream) \
+ { \
+ size_t retval = fread(ptr, size, nmemb, stream); \
+ if (static_cast<size_t>(size * nmemb) != retval) { \
+ fprintf(debug, " WARNING : could not read %llu bytes from file, read: " \
+ "%llu bytes\n", \
+ static_cast<unsigned long long>(size) * nmemb, \
+ static_cast<unsigned long long>(retval)); \
+ } \
+ }
+
+void OPJFile::ByteSwap(unsigned char *b, int n) {
int i = 0;
- int j = n-1;
- while (i<j) {
+ int j = n - 1;
+ while (i < j) {
std::swap(b[i], b[j]);
i++, j--;
}
}
-OPJFile::OPJFile(const char *filename)
- : filename(filename)
-{
- version=0;
- dataIndex=0;
- objectIndex=0;
+OPJFile::OPJFile(const char *filename) : filename(filename) {
+ version = 0;
+ dataIndex = 0;
+ objectIndex = 0;
}
int OPJFile::compareSpreadnames(char *sname) const {
- for(unsigned int i=0;i<SPREADSHEET.size();i++)
- if (0==strcmp_i(SPREADSHEET[i].name.c_str(),sname))
+ for (unsigned int i = 0; i < SPREADSHEET.size(); i++)
+ if (0 == strcmp_i(SPREADSHEET[i].name.c_str(), sname))
return i;
return -1;
}
int OPJFile::compareExcelnames(char *sname) const {
- for(unsigned int i=0;i<EXCEL.size();i++)
- if (0==strcmp_i(EXCEL[i].name.c_str(),sname))
+ for (unsigned int i = 0; i < EXCEL.size(); i++)
+ if (0 == strcmp_i(EXCEL[i].name.c_str(), sname))
return i;
return -1;
}
-
int OPJFile::compareColumnnames(int spread, char *sname) const {
- for(unsigned int i=0;i<SPREADSHEET[spread].column.size();i++)
+ for (unsigned int i = 0; i < SPREADSHEET[spread].column.size(); i++)
if (SPREADSHEET[spread].column[i].name == sname)
return i;
return -1;
}
-int OPJFile::compareExcelColumnnames(int iexcel, int isheet, char *sname) const {
- for(unsigned int i=0;i<EXCEL[iexcel].sheet[isheet].column.size();i++)
+int OPJFile::compareExcelColumnnames(int iexcel, int isheet,
+ char *sname) const {
+ for (unsigned int i = 0; i < EXCEL[iexcel].sheet[isheet].column.size(); i++)
if (EXCEL[iexcel].sheet[isheet].column[i].name == sname)
return i;
return -1;
}
int OPJFile::compareMatrixnames(char *sname) const {
- for(unsigned int i=0;i<MATRIX.size();i++)
- if (0==strcmp_i(MATRIX[i].name.c_str(),sname))
+ for (unsigned int i = 0; i < MATRIX.size(); i++)
+ if (0 == strcmp_i(MATRIX[i].name.c_str(), sname))
return i;
return -1;
}
int OPJFile::compareFunctionnames(const char *sname) const {
- for(unsigned int i=0;i<FUNCTION.size();i++)
- if (0==strcmp_i(FUNCTION[i].name.c_str(),sname))
+ for (unsigned int i = 0; i < FUNCTION.size(); i++)
+ if (0 == strcmp_i(FUNCTION[i].name.c_str(), sname))
return i;
return -1;
}
vector<string> OPJFile::findDataByIndex(int index) const {
vector<string> str;
- for(unsigned int spread=0;spread<SPREADSHEET.size();spread++)
- for(unsigned int i=0;i<SPREADSHEET[spread].column.size();i++)
- if (SPREADSHEET[spread].column[i].index == index)
- {
+ for (unsigned int spread = 0; spread < SPREADSHEET.size(); spread++)
+ for (unsigned int i = 0; i < SPREADSHEET[spread].column.size(); i++)
+ if (SPREADSHEET[spread].column[i].index == index) {
str.push_back(SPREADSHEET[spread].column[i].name);
str.push_back("T_" + SPREADSHEET[spread].name);
return str;
}
- for(unsigned int i=0;i<MATRIX.size();i++)
- if (MATRIX[i].index == index)
- {
+ for (unsigned int i = 0; i < MATRIX.size(); i++)
+ if (MATRIX[i].index == index) {
str.push_back(MATRIX[i].name);
str.push_back("M_" + MATRIX[i].name);
return str;
}
- for(unsigned int i=0;i<EXCEL.size();i++)
- for(unsigned int j=0;j<EXCEL[i].sheet.size();j++)
- for(unsigned int k=0;k<EXCEL[i].sheet[j].column.size();k++)
- if (EXCEL[i].sheet[j].column[k].index == index)
- {
+ for (unsigned int i = 0; i < EXCEL.size(); i++)
+ for (unsigned int j = 0; j < EXCEL[i].sheet.size(); j++)
+ for (unsigned int k = 0; k < EXCEL[i].sheet[j].column.size(); k++)
+ if (EXCEL[i].sheet[j].column[k].index == index) {
str.push_back(EXCEL[i].sheet[j].column[k].name);
str.push_back("E_" + EXCEL[i].name);
return str;
}
- for(unsigned int i=0;i<FUNCTION.size();i++)
- if (FUNCTION[i].index == index)
- {
+ for (unsigned int i = 0; i < FUNCTION.size(); i++)
+ if (FUNCTION[i].index == index) {
str.push_back(FUNCTION[i].name);
str.push_back("F_" + FUNCTION[i].name);
return str;
@@ -171,62 +182,58 @@ vector<string> OPJFile::findDataByIndex(int index) const {
}
string OPJFile::findObjectByIndex(int index) {
- for(unsigned int i=0;i<SPREADSHEET.size();i++)
- if (SPREADSHEET[i].objectID == index)
- {
+ for (unsigned int i = 0; i < SPREADSHEET.size(); i++)
+ if (SPREADSHEET[i].objectID == index) {
return SPREADSHEET[i].name;
}
- for(unsigned int i=0;i<MATRIX.size();i++)
- if (MATRIX[i].objectID == index)
- {
+ for (unsigned int i = 0; i < MATRIX.size(); i++)
+ if (MATRIX[i].objectID == index) {
return MATRIX[i].name;
}
- for(unsigned int i=0;i<EXCEL.size();i++)
- if (EXCEL[i].objectID == index)
- {
+ for (unsigned int i = 0; i < EXCEL.size(); i++)
+ if (EXCEL[i].objectID == index) {
return EXCEL[i].name;
}
- for(unsigned int i=0;i<GRAPH.size();i++)
- if (GRAPH[i].objectID == index)
- {
+ for (unsigned int i = 0; i < GRAPH.size(); i++)
+ if (GRAPH[i].objectID == index) {
return GRAPH[i].name;
}
return "";
}
-void OPJFile::convertSpreadToExcel(int spread)
-{
- //add new Excel sheet
- EXCEL.push_back(excel(SPREADSHEET[spread].name, SPREADSHEET[spread].label, SPREADSHEET[spread].maxRows, SPREADSHEET[spread].bHidden, SPREADSHEET[spread].bLoose));
- for (unsigned int i=0; i<SPREADSHEET[spread].column.size(); ++i)
- {
- string name=SPREADSHEET[spread].column[i].name;
- int pos=static_cast<int>(name.find_last_of("@"));
- string col=name;
- unsigned int index=0;
- if(pos!=-1)
- {
- col=name.substr(0, pos);
- index=atoi(name.substr(pos+1).c_str())-1;
+void OPJFile::convertSpreadToExcel(int spread) {
+ // add new Excel sheet
+ EXCEL.push_back(excel(SPREADSHEET[spread].name, SPREADSHEET[spread].label,
+ SPREADSHEET[spread].maxRows,
+ SPREADSHEET[spread].bHidden,
+ SPREADSHEET[spread].bLoose));
+ for (unsigned int i = 0; i < SPREADSHEET[spread].column.size(); ++i) {
+ string name = SPREADSHEET[spread].column[i].name;
+ int pos = static_cast<int>(name.find_last_of("@"));
+ string col = name;
+ unsigned int index = 0;
+ if (pos != -1) {
+ col = name.substr(0, pos);
+ index = atoi(name.substr(pos + 1).c_str()) - 1;
}
- if(EXCEL.back().sheet.size()<=index)
- EXCEL.back().sheet.resize(index+1);
- SPREADSHEET[spread].column[i].name=col;
+ if (EXCEL.back().sheet.size() <= index)
+ EXCEL.back().sheet.resize(index + 1);
+ SPREADSHEET[spread].column[i].name = col;
EXCEL.back().sheet[index].column.push_back(SPREADSHEET[spread].column[i]);
}
- SPREADSHEET.erase(SPREADSHEET.begin()+spread);
+ SPREADSHEET.erase(SPREADSHEET.begin() + spread);
}
// set default name for columns starting from spreadsheet spread
void OPJFile::setColName(int spread) {
- for(unsigned int j=spread;j<SPREADSHEET.size();j++) {
- SPREADSHEET[j].column[0].type=X;
- for (unsigned int k=1;k<SPREADSHEET[j].column.size();k++)
- SPREADSHEET[j].column[k].type=Y;
+ for (unsigned int j = spread; j < SPREADSHEET.size(); j++) {
+ SPREADSHEET[j].column[0].type = X;
+ for (unsigned int k = 1; k < SPREADSHEET[j].column.size(); k++)
+ SPREADSHEET[j].column[k].type = Y;
}
}
@@ -239,401 +246,443 @@ filepre +
/* parse file "filename" completely and save values */
int OPJFile::Parse() {
FILE *f;
- if((f=fopen(filename,"rb")) == NULL ) {
- printf("Could not open %s!\n",filename);
+ if ((f = fopen(filename, "rb")) == NULL) {
+ printf("Could not open %s!\n", filename);
return -1;
}
char vers[5];
- vers[4]=0;
+ vers[4] = 0;
// get version
- fseek(f,0x7,SEEK_SET);
- fread(&vers,4,1,f);
+ int retval = fseek(f, 0x7, SEEK_SET);
+ if (retval < 0) {
+ printf(" WARNING : could not move to position %d from the beginning of the "
+ "file\n",
+ 0x7);
+ return -1;
+ }
+
+ size_t readval = fread(&vers, 4, 1, f);
+ if (4 != readval) {
+ printf(" WARNING : could not read four bytes with the version information, "
+ "read: %d bytes\n",
+ retval);
+ return -1;
+ }
+
fclose(f);
version = atoi(vers);
- if(version >= 2766 && version <= 2769) // 7.5
+ if (version >= 2766 && version <= 2769) // 7.5
return ParseFormatNew();
else
return ParseFormatOld();
}
-
int OPJFile::ParseFormatOld() {
int i;
FILE *f, *debug;
- if((f=fopen(filename,"rb")) == NULL ) {
- printf("Could not open %s!\n",filename);
+ if ((f = fopen(filename, "rb")) == NULL) {
+ printf("Could not open %s!\n", filename);
return -1;
}
- if((debug=fopen("opjfile.log","w")) == NULL ) {
+ if ((debug = fopen("opjfile.log", "w")) == NULL) {
printf("Could not open log file!\n");
- fclose(f); //f is still open, so close it before returning
+ fclose(f); // f is still open, so close it before returning
return -1;
}
- ////////////////////////////// check version from header ///////////////////////////////
+ ////////////////////////////// check version from header
+ //////////////////////////////////
char vers[5];
- vers[4]=0;
+ vers[4] = 0;
// get version
- fseek(f,0x7,SEEK_SET);
- fread(&vers,4,1,f);
+ // fseek(f,0x7,SEEK_SET);
+ CHECKED_FSEEK(debug, f, 0x7, SEEK_SET);
+ CHECKED_FREAD(debug, &vers, 4, 1, f);
version = atoi(vers);
- fprintf(debug," [version = %d]\n",version);
+ fprintf(debug, " [version = %d]\n", version);
// translate version
- if(version >= 130 && version <= 140) // 4.1
- version=410;
- else if(version == 210) // 5.0
- version=500;
- else if(version == 2625) // 6.0
- version=600;
- else if(version == 2627) // 6.0 SR1
- version=601;
- else if(version == 2630 ) // 6.0 SR4
- version=604;
- else if(version == 2635 ) // 6.1
- version=610;
- else if(version == 2656) // 7.0
- version=700;
- else if(version == 2672) // 7.0 SR3
- version=703;
+ if (version >= 130 && version <= 140) // 4.1
+ version = 410;
+ else if (version == 210) // 5.0
+ version = 500;
+ else if (version == 2625) // 6.0
+ version = 600;
+ else if (version == 2627) // 6.0 SR1
+ version = 601;
+ else if (version == 2630) // 6.0 SR4
+ version = 604;
+ else if (version == 2635) // 6.1
+ version = 610;
+ else if (version == 2656) // 7.0
+ version = 700;
+ else if (version == 2672) // 7.0 SR3
+ version = 703;
else {
- fprintf(debug,"Found unknown project version %d\n",version);
- fprintf(debug,"Please contact the author of opj2dat\n");
+ fprintf(debug, "Found unknown project version %d\n", version);
+ fprintf(debug, "Please contact the author of opj2dat\n");
}
- fprintf(debug,"Found project version %.2f\n",version/100.0);
+ fprintf(debug, "Found project version %.2f\n", version / 100.0);
- unsigned char c=0; // tmp char
+ unsigned char c = 0; // tmp char
- fprintf(debug,"HEADER :\n");
- for(i=0;i<0x16;i++) { // skip header + 5 Bytes ("27")
- fread(&c,1,1,f);
- fprintf(debug,"%.2X ",c);
- if(!((i+1)%16)) fprintf(debug,"\n");
+ fprintf(debug, "HEADER :\n");
+ for (i = 0; i < 0x16; i++) { // skip header + 5 Bytes ("27")
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ fprintf(debug, "%.2X ", c);
+ if (!((i + 1) % 16))
+ fprintf(debug, "\n");
}
- fprintf(debug,"\n");
+ fprintf(debug, "\n");
- do{
- fread(&c,1,1,f);
+ do {
+ CHECKED_FREAD(debug, &c, 1, 1, f);
} while (c != '\n');
- fprintf(debug," [file header @ 0x%X]\n", (unsigned int) ftell(f));
+ fprintf(debug, " [file header @ 0x%X]\n", (unsigned int)ftell(f));
- /////////////////// find column ///////////////////////////////////////////////////////////
- if(version>410)
- for(i=0;i<5;i++) // skip "0"
- fread(&c,1,1,f);
+ /////////////////// find column
+ //////////////////////////////////////////////////////////////
+ if (version > 410)
+ for (i = 0; i < 5; i++) // skip "0"
+ CHECKED_FREAD(debug, &c, 1, 1, f);
int col_found;
- fread(&col_found,4,1,f);
- if(IsBigEndian()) SwapBytes(col_found);
+ CHECKED_FREAD(debug, &col_found, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(col_found);
- fread(&c,1,1,f); // skip '\n'
- fprintf(debug," [column found = %d/0x%X @ 0x%X]\n",col_found,col_found,(unsigned int) ftell(f));
+ CHECKED_FREAD(debug, &c, 1, 1, f); // skip '\n'
+ fprintf(debug, " [column found = %d/0x%X @ 0x%X]\n", col_found, col_found,
+ (unsigned int)ftell(f));
- int current_col=1, nr=0, nbytes=0;
+ int current_col = 1, nr = 0, nbytes = 0;
double a;
char name[25], valuesize;
- while(col_found > 0 && col_found < 0x84) { // should be 0x72, 0x73 or 0x83
- //////////////////////////////// COLUMN HEADER /////////////////////////////////////////////
- fprintf(debug,"COLUMN HEADER :\n");
- for(i=0;i < 0x3D;i++) { // skip 0x3C chars to value size
- fread(&c,1,1,f);
- //if(i>21 && i<27) {
- fprintf(debug,"%.2X ",c);
- if(!((i+1)%16)) fprintf(debug,"\n");
+ while (col_found > 0 && col_found < 0x84) { // should be 0x72, 0x73 or 0x83
+ //////////////////////////////// COLUMN HEADER
+ ////////////////////////////////////////////////
+ fprintf(debug, "COLUMN HEADER :\n");
+ for (i = 0; i < 0x3D; i++) { // skip 0x3C chars to value size
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ // if(i>21 && i<27) {
+ fprintf(debug, "%.2X ", c);
+ if (!((i + 1) % 16))
+ fprintf(debug, "\n");
//}
}
- fprintf(debug,"\n");
-
- fread(&valuesize,1,1,f);
- fprintf(debug," [valuesize = %d @ 0x%X]\n",valuesize,(unsigned int) ftell(f)-1);
- if(valuesize <= 0) {
- fprintf(debug," WARNING : found strange valuesize of %d\n",valuesize);
- valuesize=10;
+ fprintf(debug, "\n");
+
+ CHECKED_FREAD(debug, &valuesize, 1, 1, f);
+ fprintf(debug, " [valuesize = %d @ 0x%X]\n", valuesize,
+ (unsigned int)ftell(f) - 1);
+ if (valuesize <= 0) {
+ fprintf(debug, " WARNING : found strange valuesize of %d\n", valuesize);
+ valuesize = 10;
}
- fprintf(debug,"SKIP :\n");
- for(i=0;i<0x1A;i++) { // skip to name
- fread(&c,1,1,f);
- fprintf(debug,"%.2X ",c);
- if(!((i+1)%16)) fprintf(debug,"\n");
+ fprintf(debug, "SKIP :\n");
+ for (i = 0; i < 0x1A; i++) { // skip to name
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ fprintf(debug, "%.2X ", c);
+ if (!((i + 1) % 16))
+ fprintf(debug, "\n");
}
- fprintf(debug,"\n");
+ fprintf(debug, "\n");
// read name
- fprintf(debug," [Spreadsheet @ 0x%X]\n",(unsigned int) ftell(f));
+ fprintf(debug, " [Spreadsheet @ 0x%X]\n", (unsigned int)ftell(f));
fflush(debug);
- fread(&name,25,1,f);
- //char* sname = new char[26];
+ CHECKED_FREAD(debug, &name, 25, 1, f);
+ // char* sname = new char[26];
char sname[26];
- sprintf(sname,"%s",strtok(name,"_")); // spreadsheet name
- char* cname = strtok(NULL,"_"); // column name
- while(char* tmpstr = strtok(NULL,"_")) { // get multiple-"_" title correct
- strcat(sname,"_");
- strcat(sname,cname);
- strcpy(cname,tmpstr);
+ sprintf(sname, "%s", strtok(name, "_")); // spreadsheet name
+ char *cname = strtok(NULL, "_"); // column name
+ while (char *tmpstr = strtok(NULL, "_")) { // get multiple-"_" title correct
+ strcat(sname, "_");
+ strcat(sname, cname);
+ strcpy(cname, tmpstr);
}
- int spread=0;
- if(SPREADSHEET.size() == 0 || compareSpreadnames(sname) == -1) {
- fprintf(debug,"NEW SPREADSHEET\n");
- current_col=1;
+ int spread = 0;
+ if (SPREADSHEET.size() == 0 || compareSpreadnames(sname) == -1) {
+ fprintf(debug, "NEW SPREADSHEET\n");
+ current_col = 1;
SPREADSHEET.push_back(spreadSheet(sname));
- spread=static_cast<int>(SPREADSHEET.size())-1;
- SPREADSHEET.back().maxRows=0;
- }
- else {
+ spread = static_cast<int>(SPREADSHEET.size()) - 1;
+ SPREADSHEET.back().maxRows = 0;
+ } else {
- spread=compareSpreadnames(sname);
+ spread = compareSpreadnames(sname);
- current_col=static_cast<int>(SPREADSHEET[spread].column.size());
+ current_col = static_cast<int>(SPREADSHEET[spread].column.size());
- if(!current_col)
- current_col=1;
+ if (!current_col)
+ current_col = 1;
current_col++;
}
- fprintf(debug,"SPREADSHEET = %s COLUMN %d NAME = %s (@0x%X)\n",
- sname, current_col, cname, (unsigned int) ftell(f));
+ fprintf(debug, "SPREADSHEET = %s COLUMN %d NAME = %s (@0x%X)\n", sname,
+ current_col, cname, (unsigned int)ftell(f));
fflush(debug);
- if(cname == 0) {
- fprintf(debug,"NO COLUMN NAME FOUND! Must be a matrix or function.\n");
- ////////////////////////////// READ MATRIX or FUNCTION ////////////////////////////////////
- fprintf(debug,"Reading MATRIX.\n");
+ if (cname == 0) {
+ fprintf(debug, "NO COLUMN NAME FOUND! Must be a matrix or function.\n");
+ ////////////////////////////// READ MATRIX or FUNCTION
+ ///////////////////////////////////////
+ fprintf(debug, "Reading MATRIX.\n");
fflush(debug);
- fprintf(debug," [position @ 0x%X]\n",(unsigned int) ftell(f));
+ fprintf(debug, " [position @ 0x%X]\n", (unsigned int)ftell(f));
// TODO
- fprintf(debug," SIGNATURE : ");
- for(i=0;i<2;i++) { // skip header
- fread(&c,1,1,f);
- fprintf(debug,"%.2X ",c);
+ fprintf(debug, " SIGNATURE : ");
+ for (i = 0; i < 2; i++) { // skip header
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ fprintf(debug, "%.2X ", c);
}
fflush(debug);
- do{ // skip until '\n'
- fread(&c,1,1,f);
+ do { // skip until '\n'
+ CHECKED_FREAD(debug, &c, 1, 1, f);
// fprintf(debug,"%.2X ",c);
} while (c != '\n');
- fprintf(debug,"\n");
+ fprintf(debug, "\n");
fflush(debug);
// read size
int size;
- fread(&size,4,1,f);
- fread(&c,1,1,f); // skip '\n'
+ CHECKED_FREAD(debug, &size, 4, 1, f);
+ CHECKED_FREAD(debug, &c, 1, 1, f); // skip '\n'
// TODO : use entry size : double, float, ...
size /= 8;
- fprintf(debug," SIZE = %d\n",size);
+ fprintf(debug, " SIZE = %d\n", size);
fflush(debug);
// catch exception
- if(size>10000)
- size=1000;
+ if (size > 10000)
+ size = 1000;
- fprintf(debug,"VALUES :\n");
- SPREADSHEET[SPREADSHEET.size()-1].maxRows=1;
+ fprintf(debug, "VALUES :\n");
+ SPREADSHEET[SPREADSHEET.size() - 1].maxRows = 1;
- double value=0;
- for(i=0;i<size;i++) { // read data
+ double value = 0;
+ for (i = 0; i < size; i++) { // read data
string stmp;
- if(i<26)
- stmp=char(i+0x41);
- else if(i<26*26) {
- stmp = char(0x40+i/26);
- stmp[1] = i%26+0x41;
+ if (i < 26)
+ stmp = char(i + 0x41);
+ else if (i < 26 * 26) {
+ stmp = char(0x40 + i / 26);
+ stmp[1] = char(i % 26 + 0x41);
+ } else {
+ stmp = char(0x40 + i / 26 / 26);
+ stmp[1] = char(i / 26 % 26 + 0x41);
+ stmp[2] = char(i % 26 + 0x41);
}
- else {
- stmp = char(0x40+i/26/26);
- stmp[1] = char(i/26%26+0x41);
- stmp[2] = char(i%26+0x41);
- }
- SPREADSHEET[SPREADSHEET.size()-1].column.push_back(stmp);
- fread(&value,8,1,f);
- SPREADSHEET[SPREADSHEET.size()-1].column[i].odata.push_back(originData(value));
+ SPREADSHEET[SPREADSHEET.size() - 1].column.push_back(stmp);
+ CHECKED_FREAD(debug, &value, 8, 1, f);
+ SPREADSHEET[SPREADSHEET.size() - 1].column[i].odata.push_back(
+ originData(value));
- fprintf(debug,"%g ",value);
+ fprintf(debug, "%g ", value);
}
- fprintf(debug,"\n");
+ fprintf(debug, "\n");
fflush(debug);
- }
- else { // worksheet
+ } else { // worksheet
SPREADSHEET[spread].column.push_back(spreadColumn(cname));
- ////////////////////////////// SIZE of column /////////////////////////////////////////////
- do{ // skip until '\n'
- fread(&c,1,1,f);
+ ////////////////////////////// SIZE of column
+ ////////////////////////////////////////////////
+ do { // skip until '\n'
+ CHECKED_FREAD(debug, &c, 1, 1, f);
} while (c != '\n');
- fread(&nbytes,4,1,f);
- if(IsBigEndian()) SwapBytes(nbytes);
- if(fmod(nbytes,(double)valuesize)>0)
- fprintf(debug,"WARNING: data section could not be read correct\n");
+ CHECKED_FREAD(debug, &nbytes, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(nbytes);
+ if (fmod(nbytes, (double)valuesize) > 0)
+ fprintf(debug, "WARNING: data section could not be read correct\n");
nr = nbytes / valuesize;
- fprintf(debug," [number of rows = %d (%d Bytes) @ 0x%X]\n",nr,nbytes,(unsigned int) ftell(f));
+ fprintf(debug, " [number of rows = %d (%d Bytes) @ 0x%X]\n", nr, nbytes,
+ (unsigned int)ftell(f));
fflush(debug);
- SPREADSHEET[spread].maxRows<nr?SPREADSHEET[spread].maxRows=nr:0;
+ SPREADSHEET[spread].maxRows < nr ? SPREADSHEET[spread].maxRows = nr : 0;
- ////////////////////////////////////// DATA ////////////////////////////////////////////////
- fread(&c,1,1,f); // skip '\n'
- if(valuesize != 8 && valuesize <= 16) { // skip 0 0
- fread(&c,1,1,f);
- fread(&c,1,1,f);
+ ////////////////////////////////////// DATA
+ ///////////////////////////////////////////////////
+ CHECKED_FREAD(debug, &c, 1, 1, f); // skip '\n'
+ if (valuesize != 8 && valuesize <= 16) { // skip 0 0
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ CHECKED_FREAD(debug, &c, 1, 1, f);
}
- fprintf(debug," [data @ 0x%X]\n",(unsigned int) ftell(f));
+ fprintf(debug, " [data @ 0x%X]\n", (unsigned int)ftell(f));
fflush(debug);
- for (i=0;i<nr;i++) {
- if(valuesize <= 16) { // value
- fread(&a,valuesize,1,f);
- if(IsBigEndian()) SwapBytes(a);
- fprintf(debug,"%g ",a);
- SPREADSHEET[spread].column[(current_col-1)].odata.push_back(originData(a));
- }
- else { // label
- char *stmp = new char[valuesize+1];
- fread(stmp,valuesize,1,f);
- fprintf(debug,"%s ",stmp);
- SPREADSHEET[spread].column[(current_col-1)].odata.push_back(originData(stmp));
- delete [] stmp;
+ for (i = 0; i < nr; i++) {
+ if (valuesize <= 16) { // value
+ CHECKED_FREAD(debug, &a, valuesize, 1, f);
+ if (IsBigEndian())
+ SwapBytes(a);
+ fprintf(debug, "%g ", a);
+ SPREADSHEET[spread].column[(current_col - 1)].odata.push_back(
+ originData(a));
+ } else { // label
+ char *stmp = new char[valuesize + 1];
+ CHECKED_FREAD(debug, stmp, valuesize, 1, f);
+ fprintf(debug, "%s ", stmp);
+ SPREADSHEET[spread].column[(current_col - 1)].odata.push_back(
+ originData(stmp));
+ delete[] stmp;
}
}
} // else
// fprintf(debug," [now @ 0x%X]\n",ftell(f));
- fprintf(debug,"\n");
+ fprintf(debug, "\n");
fflush(debug);
- for(i=0;i<4;i++) // skip "0"
- fread(&c,1,1,f);
- if(valuesize == 8 || valuesize > 16) { // skip 0 0
- fread(&c,1,1,f);
- fread(&c,1,1,f);
+ for (i = 0; i < 4; i++) // skip "0"
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ if (valuesize == 8 || valuesize > 16) { // skip 0 0
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ CHECKED_FREAD(debug, &c, 1, 1, f);
}
- fread(&col_found,4,1,f);
- if(IsBigEndian()) SwapBytes(col_found);
- fread(&c,1,1,f); // skip '\n'
- fprintf(debug," [column found = %d/0x%X (@ 0x%X)]\n",col_found,col_found,(unsigned int) ftell(f)-5);
+ CHECKED_FREAD(debug, &col_found, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(col_found);
+ CHECKED_FREAD(debug, &c, 1, 1, f); // skip '\n'
+ fprintf(debug, " [column found = %d/0x%X (@ 0x%X)]\n", col_found, col_found,
+ (unsigned int)ftell(f) - 5);
fflush(debug);
}
////////////////////// HEADER SECTION //////////////////////////////////////
// TODO : use new method ('\n')
- int POS = int(ftell(f)-11);
- fprintf(debug,"\nHEADER SECTION\n");
- fprintf(debug," nr_spreads = %zu\n",SPREADSHEET.size());
- fprintf(debug," [position @ 0x%X]\n",POS);
+ int POS = int(ftell(f) - 11);
+ fprintf(debug, "\nHEADER SECTION\n");
+ fprintf(debug, " nr_spreads = %zu\n", SPREADSHEET.size());
+ fprintf(debug, " [position @ 0x%X]\n", POS);
fflush(debug);
-///////////////////// SPREADSHEET INFOS ////////////////////////////////////
- int LAYER=0;
+ ///////////////////// SPREADSHEET INFOS ////////////////////////////////////
+ int LAYER = 0;
int COL_JUMP = 0x1ED;
- for(unsigned int i=0; i < SPREADSHEET.size(); i++) {
- fprintf(debug," reading Spreadsheet %d/%zd properties\n",i+1,SPREADSHEET.size());
- fflush(debug);
- if(i > 0) {
- if (version == 700 )
- POS += 0x2530 + static_cast<int>(SPREADSHEET[i-1].column.size())*COL_JUMP;
- else if (version == 610 )
- POS += 0x25A4 + static_cast<int>(SPREADSHEET[i-1].column.size())*COL_JUMP;
- else if (version == 604 )
- POS += 0x25A0 + static_cast<int>(SPREADSHEET[i-1].column.size())*COL_JUMP;
- else if (version == 601 )
- POS += 0x2560 + static_cast<int>(SPREADSHEET[i-1].column.size())*COL_JUMP; // ?
- else if (version == 600 )
- POS += 0x2560 + static_cast<int>(SPREADSHEET[i-1].column.size())*COL_JUMP;
- else if (version == 500 )
- POS += 0x92C + static_cast<int>(SPREADSHEET[i-1].column.size())*COL_JUMP;
- else if (version == 410 )
- POS += 0x7FB + static_cast<int>(SPREADSHEET[i-1].column.size())*COL_JUMP;
- }
-
- fprintf(debug," reading Header\n");
- fflush(debug);
- // HEADER
- // check header
- int ORIGIN = 0x55;
- if(version == 500)
- ORIGIN = 0x58;
- fseek(f,POS + ORIGIN,SEEK_SET); // check for 'O'RIGIN
- char c;
- fread(&c,1,1,f);
- int jump=0;
- if( c == 'O')
- fprintf(debug," \"ORIGIN\" found ! (@ 0x%X)\n",POS+ORIGIN);
- while( c != 'O' && jump < MAX_LEVEL) { // no inf loop
- fprintf(debug," TRY %d \"O\"RIGIN not found ! : %c (@ 0x%X)",jump+1,c,POS+ORIGIN);
- fprintf(debug," POS=0x%X | ORIGIN = 0x%X\n",POS,ORIGIN);
+ for (unsigned int i = 0; i < SPREADSHEET.size(); i++) {
+ fprintf(debug, " reading Spreadsheet %d/%zd properties\n", i + 1,
+ SPREADSHEET.size());
fflush(debug);
- POS+=0x1F2;
- fseek(f,POS + ORIGIN,SEEK_SET);
- fread(&c,1,1,f);
- jump++;
- }
+ if (i > 0) {
+ if (version == 700)
+ POS += 0x2530 +
+ static_cast<int>(SPREADSHEET[i - 1].column.size()) * COL_JUMP;
+ else if (version == 610)
+ POS += 0x25A4 +
+ static_cast<int>(SPREADSHEET[i - 1].column.size()) * COL_JUMP;
+ else if (version == 604)
+ POS += 0x25A0 +
+ static_cast<int>(SPREADSHEET[i - 1].column.size()) * COL_JUMP;
+ else if (version == 601)
+ POS +=
+ 0x2560 +
+ static_cast<int>(SPREADSHEET[i - 1].column.size()) * COL_JUMP; // ?
+ else if (version == 600)
+ POS += 0x2560 +
+ static_cast<int>(SPREADSHEET[i - 1].column.size()) * COL_JUMP;
+ else if (version == 500)
+ POS += 0x92C +
+ static_cast<int>(SPREADSHEET[i - 1].column.size()) * COL_JUMP;
+ else if (version == 410)
+ POS += 0x7FB +
+ static_cast<int>(SPREADSHEET[i - 1].column.size()) * COL_JUMP;
+ }
- int spread=i;
- if(jump == MAX_LEVEL){
- fprintf(debug," Spreadsheet SECTION not found ! (@ 0x%X)\n",POS-10*0x1F2+0x55);
- // setColName(spread);
- fclose(f);
- fclose(debug);
- return -5;
- }
+ fprintf(debug, " reading Header\n");
+ fflush(debug);
+ // HEADER
+ // check header
+ int ORIGIN = 0x55;
+ if (version == 500)
+ ORIGIN = 0x58;
+ CHECKED_FSEEK(debug, f, POS + ORIGIN, SEEK_SET); // check for 'O'RIGIN
+ char c;
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ int jump = 0;
+ if (c == 'O')
+ fprintf(debug, " \"ORIGIN\" found ! (@ 0x%X)\n", POS + ORIGIN);
+ while (c != 'O' && jump < MAX_LEVEL) { // no inf loop
+ fprintf(debug, " TRY %d \"O\"RIGIN not found ! : %c (@ 0x%X)",
+ jump + 1, c, POS + ORIGIN);
+ fprintf(debug, " POS=0x%X | ORIGIN = 0x%X\n", POS, ORIGIN);
+ fflush(debug);
+ POS += 0x1F2;
+ CHECKED_FSEEK(debug, f, POS + ORIGIN, SEEK_SET);
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ jump++;
+ }
- fprintf(debug," [Spreadsheet SECTION (@ 0x%X)]\n",POS);
- fflush(debug);
+ int spread = i;
+ if (jump == MAX_LEVEL) {
+ fprintf(debug, " Spreadsheet SECTION not found ! (@ 0x%X)\n",
+ POS - 10 * 0x1F2 + 0x55);
+ // setColName(spread);
+ fclose(f);
+ fclose(debug);
+ return -5;
+ }
- // check spreadsheet name
- fseek(f,POS + 0x12,SEEK_SET);
- fread(&name,25,1,f);
+ fprintf(debug, " [Spreadsheet SECTION (@ 0x%X)]\n", POS);
+ fflush(debug);
- spread=compareSpreadnames(name);
- if(spread == -1)
- spread=i;
+ // check spreadsheet name
+ CHECKED_FSEEK(debug, f, POS + 0x12, SEEK_SET);
+ CHECKED_FREAD(debug, &name, 25, 1, f);
- fprintf(debug," SPREADSHEET %d NAME : %s (@ 0x%X) has %zu columns\n",
- spread+1,name,POS + 0x12,SPREADSHEET[spread].column.size());
- fflush(debug);
+ spread = compareSpreadnames(name);
+ if (spread == -1)
+ spread = i;
- int ATYPE=0;
- LAYER = POS;
- if (version == 700)
- ATYPE = 0x2E4;
- else if (version == 610)
- ATYPE = 0x358;
- else if (version == 604)
- ATYPE = 0x354;
- else if (version == 601)
- ATYPE = 0x500; // ?
- else if (version == 600)
- ATYPE = 0x314;
- else if (version == 500) {
- COL_JUMP=0x5D;
- ATYPE = 0x300;
- }
- else if (version == 410) {
- COL_JUMP = 0x58;
- ATYPE = 0x229;
- }
- fflush(debug);
+ fprintf(debug, " SPREADSHEET %d NAME : %s (@ 0x%X) has %zu columns\n",
+ spread + 1, name, POS + 0x12, SPREADSHEET[spread].column.size());
+ fflush(debug);
- /////////////// COLUMN Types ///////////////////////////////////////////
- fprintf(debug," Spreadsheet has %zu columns\n",SPREADSHEET[spread].column.size());
- for (unsigned int j=0;j<SPREADSHEET[spread].column.size();j++) {
- fprintf(debug," reading COLUMN %d/%zd type\n",j+1,SPREADSHEET[spread].column.size());
+ int ATYPE = 0;
+ LAYER = POS;
+ if (version == 700)
+ ATYPE = 0x2E4;
+ else if (version == 610)
+ ATYPE = 0x358;
+ else if (version == 604)
+ ATYPE = 0x354;
+ else if (version == 601)
+ ATYPE = 0x500; // ?
+ else if (version == 600)
+ ATYPE = 0x314;
+ else if (version == 500) {
+ COL_JUMP = 0x5D;
+ ATYPE = 0x300;
+ } else if (version == 410) {
+ COL_JUMP = 0x58;
+ ATYPE = 0x229;
+ }
fflush(debug);
- fseek(f,LAYER+ATYPE+j*COL_JUMP, SEEK_SET);
- fread(&name,25,1,f);
- fseek(f,LAYER+ATYPE+j*COL_JUMP-1, SEEK_SET);
- fread(&c,1,1,f);
- ColumnType type;
- switch(c) {
+ /////////////// COLUMN Types ///////////////////////////////////////////
+ fprintf(debug, " Spreadsheet has %zu columns\n",
+ SPREADSHEET[spread].column.size());
+ for (unsigned int j = 0; j < SPREADSHEET[spread].column.size(); j++) {
+ fprintf(debug, " reading COLUMN %d/%zd type\n", j + 1,
+ SPREADSHEET[spread].column.size());
+ fflush(debug);
+ CHECKED_FSEEK(debug, f, LAYER + ATYPE + j * COL_JUMP, SEEK_SET);
+ CHECKED_FREAD(debug, &name, 25, 1, f);
+
+ CHECKED_FSEEK(debug, f, LAYER + ATYPE + j * COL_JUMP - 1, SEEK_SET);
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ ColumnType type;
+ switch (c) {
case 3:
type = X;
break;
@@ -655,777 +704,840 @@ int OPJFile::ParseFormatOld() {
default:
type = NONE;
break;
- }
+ }
- SPREADSHEET[spread].column[j].type=type;
+ SPREADSHEET[spread].column[j].type = type;
- fprintf(debug," COLUMN \"%s\" type = %s (@ 0x%X)\n",
- SPREADSHEET[spread].column[j].name.c_str(),colTypeNames[type],LAYER+ATYPE+j*COL_JUMP);
- fflush(debug);
-
- // check column name
- int max_length=11; // only first 11 chars are saved here !
- int name_length = static_cast<int>(SPREADSHEET[spread].column[j].name.length());
- int length = (name_length < max_length) ? name_length : max_length;
+ fprintf(debug, " COLUMN \"%s\" type = %s (@ 0x%X)\n",
+ SPREADSHEET[spread].column[j].name.c_str(), colTypeNames[type],
+ LAYER + ATYPE + j * COL_JUMP);
+ fflush(debug);
- if(SPREADSHEET[spread].column[j].name.substr(0,length) == name) {
- fprintf(debug," TEST : column name = \"%s\". OK!\n",
- SPREADSHEET[spread].column[j].name.c_str());
- }
- else {
- fprintf(debug," TEST : COLUMN %d name mismatch (\"%s\" != \"%s\")\n",
- j+1,name,SPREADSHEET[spread].column[j].name.c_str());
- //fprintf(debug,"ERROR : column name mismatch! Continue anyway.\n"ERROR_MSG);
+ // check column name
+ int max_length = 11; // only first 11 chars are saved here !
+ int name_length =
+ static_cast<int>(SPREADSHEET[spread].column[j].name.length());
+ int length = (name_length < max_length) ? name_length : max_length;
+
+ if (SPREADSHEET[spread].column[j].name.substr(0, length) == name) {
+ fprintf(debug, " TEST : column name = \"%s\". OK!\n",
+ SPREADSHEET[spread].column[j].name.c_str());
+ } else {
+ fprintf(debug,
+ " TEST : COLUMN %d name mismatch (\"%s\" != \"%s\")\n",
+ j + 1, name, SPREADSHEET[spread].column[j].name.c_str());
+ // fprintf(debug,"ERROR : column name mismatch! Continue
+ // anyway.\n"ERROR_MSG);
+ }
+ fflush(debug);
}
- fflush(debug);
- }
- fprintf(debug," Done with spreadsheet %d\n",spread);
+ fprintf(debug, " Done with spreadsheet %d\n", spread);
fflush(debug);
}
-///////////////////////////////////////////////////////////////////////////////////////////////////////////
+ ///////////////////////////////////////////////////////////////////////////////////////////////////////////
// TODO : GRAPHS
- fprintf(debug,"Done parsing\n");
+ fprintf(debug, "Done parsing\n");
fclose(debug);
fclose(f);
return 0;
}
-
int OPJFile::ParseFormatNew() {
int i;
FILE *f, *debug;
- if((f=fopen(filename,"rb")) == NULL ) {
- printf("Could not open %s!\n",filename);
+ if ((f = fopen(filename, "rb")) == NULL) {
+ printf("Could not open %s!\n", filename);
return -1;
}
- if((debug=fopen("opjfile.log","w")) == NULL ) {
+ if ((debug = fopen("opjfile.log", "w")) == NULL) {
printf("Could not open log file!\n");
fclose(f);
return -1;
}
-////////////////////////////// check version from header ///////////////////////////////
+ ////////////////////////////// check version from header
+ //////////////////////////////////
char vers[5];
- vers[4]=0;
+ vers[4] = 0;
+
+ // get file size
+ int file_size = 0;
+ {
+ CHECKED_FSEEK(debug, f, 0, SEEK_END);
+ file_size = static_cast<int>(ftell(f));
+ CHECKED_FSEEK(debug, f, 0, SEEK_SET);
+ }
// get version
- fseek(f,0x7,SEEK_SET);
- fread(&vers,4,1,f);
+ CHECKED_FSEEK(debug, f, 0x7, SEEK_SET);
+ CHECKED_FREAD(debug, &vers, 4, 1, f);
version = atoi(vers);
- fprintf(debug," [version = %d]\n",version);
+ fprintf(debug, " [version = %d]\n", version);
// translate version
- if(version >= 130 && version <= 140) // 4.1
- version=410;
- else if(version == 210) // 5.0
- version=500;
- else if(version == 2625) // 6.0
- version=600;
- else if(version == 2627) // 6.0 SR1
- version=601;
- else if(version == 2630 ) // 6.0 SR4
- version=604;
- else if(version == 2635 ) // 6.1
- version=610;
- else if(version == 2656) // 7.0
- version=700;
- else if(version == 2672) // 7.0 SR3
- version=703;
- else if(version >= 2766 && version <= 2769) // 7.5
- version=750;
+ if (version >= 130 && version <= 140) // 4.1
+ version = 410;
+ else if (version == 210) // 5.0
+ version = 500;
+ else if (version == 2625) // 6.0
+ version = 600;
+ else if (version == 2627) // 6.0 SR1
+ version = 601;
+ else if (version == 2630) // 6.0 SR4
+ version = 604;
+ else if (version == 2635) // 6.1
+ version = 610;
+ else if (version == 2656) // 7.0
+ version = 700;
+ else if (version == 2672) // 7.0 SR3
+ version = 703;
+ else if (version >= 2766 && version <= 2769) // 7.5
+ version = 750;
else {
- fprintf(debug,"Found unknown project version %d\n",version);
- fprintf(debug,"Please contact the author of opj2dat\n");
+ fprintf(debug, "Found unknown project version %d\n", version);
+ fprintf(debug, "Please contact the author of opj2dat\n");
}
- fprintf(debug,"Found project version %.2f\n",version/100.0);
+ fprintf(debug, "Found project version %.2f\n", version / 100.0);
- unsigned char c=0; // tmp char
+ unsigned char c = 0; // tmp char
- fprintf(debug,"HEADER :\n");
- for(i=0;i<0x16;i++) { // skip header + 5 Bytes ("27")
- fread(&c,1,1,f);
- fprintf(debug,"%.2X ",c);
- if(!((i+1)%16)) fprintf(debug,"\n");
+ fprintf(debug, "HEADER :\n");
+ for (i = 0; i < 0x16; i++) { // skip header + 5 Bytes ("27")
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ fprintf(debug, "%.2X ", c);
+ if (!((i + 1) % 16))
+ fprintf(debug, "\n");
}
- fprintf(debug,"\n");
+ fprintf(debug, "\n");
- do{
- fread(&c,1,1,f);
+ do {
+ CHECKED_FREAD(debug, &c, 1, 1, f);
} while (c != '\n');
- fprintf(debug," [file header @ 0x%X]\n", (unsigned int) ftell(f));
+ fprintf(debug, " [file header @ 0x%X]\n", (unsigned int)ftell(f));
-/////////////////// find column ///////////////////////////////////////////////////////////
- if(version>410)
- for(i=0;i<5;i++) // skip "0"
- fread(&c,1,1,f);
+ /////////////////// find column
+ //////////////////////////////////////////////////////////////
+ if (version > 410)
+ for (i = 0; i < 5; i++) // skip "0"
+ CHECKED_FREAD(debug, &c, 1, 1, f);
int col_found;
- fread(&col_found,4,1,f);
- if(IsBigEndian()) SwapBytes(col_found);
+ CHECKED_FREAD(debug, &col_found, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(col_found);
- fread(&c,1,1,f); // skip '\n'
- fprintf(debug," [column found = %d/0x%X @ 0x%X]\n",col_found,col_found,(unsigned int) ftell(f));
- int colpos=int(ftell(f));
+ CHECKED_FREAD(debug, &c, 1, 1, f); // skip '\n'
+ fprintf(debug, " [column found = %d/0x%X @ 0x%X]\n", col_found, col_found,
+ (unsigned int)ftell(f));
+ int colpos = int(ftell(f));
- int current_col=1, nr=0, nbytes=0;
+ int current_col = 1, nr = 0, nbytes = 0;
double a;
char name[25], valuesize;
- while(col_found > 0 && col_found < 0x84) { // should be 0x72, 0x73 or 0x83
-//////////////////////////////// COLUMN HEADER /////////////////////////////////////////////
+ while (col_found > 0 && col_found < 0x84) { // should be 0x72, 0x73 or 0x83
+ //////////////////////////////// COLUMN HEADER
+ ////////////////////////////////////////////////
short data_type;
char data_type_u;
- int oldpos=int(ftell(f));
- fseek(f,oldpos+0x16,SEEK_SET);
- fread(&data_type,2,1,f);
- if(IsBigEndian()) SwapBytes(data_type);
- fseek(f,oldpos+0x3F,SEEK_SET);
- fread(&data_type_u,1,1,f);
- fseek(f,oldpos,SEEK_SET);
-
- fprintf(debug,"COLUMN HEADER :\n");
- for(i=0;i < 0x3D;i++) { // skip 0x3C chars to value size
- fread(&c,1,1,f);
- //if(i>21 && i<27) {
- fprintf(debug,"%.2X ",c);
- if(!((i+1)%16)) fprintf(debug,"\n");
+ int oldpos = int(ftell(f));
+ CHECKED_FSEEK(debug, f, oldpos + 0x16, SEEK_SET);
+ CHECKED_FREAD(debug, &data_type, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(data_type);
+ CHECKED_FSEEK(debug, f, oldpos + 0x3F, SEEK_SET);
+ CHECKED_FREAD(debug, &data_type_u, 1, 1, f);
+ CHECKED_FSEEK(debug, f, oldpos, SEEK_SET);
+
+ fprintf(debug, "COLUMN HEADER :\n");
+ for (i = 0; i < 0x3D; i++) { // skip 0x3C chars to value size
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ // if(i>21 && i<27) {
+ fprintf(debug, "%.2X ", c);
+ if (!((i + 1) % 16))
+ fprintf(debug, "\n");
//}
}
- fprintf(debug,"\n");
-
- fread(&valuesize,1,1,f);
- fprintf(debug," [valuesize = %d @ 0x%X]\n",valuesize,(unsigned int) ftell(f)-1);
- if(valuesize <= 0) {
- fprintf(debug," WARNING : found strange valuesize of %d\n",valuesize);
- valuesize=10;
+ fprintf(debug, "\n");
+
+ CHECKED_FREAD(debug, &valuesize, 1, 1, f);
+ fprintf(debug, " [valuesize = %d @ 0x%X]\n", valuesize,
+ (unsigned int)ftell(f) - 1);
+ if (valuesize <= 0) {
+ fprintf(debug, " WARNING : found strange valuesize of %d\n", valuesize);
+ valuesize = 10;
}
- fprintf(debug,"SKIP :\n");
- for(i=0;i<0x1A;i++) { // skip to name
- fread(&c,1,1,f);
- fprintf(debug,"%.2X ",c);
- if(!((i+1)%16)) fprintf(debug,"\n");
+ fprintf(debug, "SKIP :\n");
+ for (i = 0; i < 0x1A; i++) { // skip to name
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ fprintf(debug, "%.2X ", c);
+ if (!((i + 1) % 16))
+ fprintf(debug, "\n");
}
- fprintf(debug,"\n");
+ fprintf(debug, "\n");
// read name
- fprintf(debug," [Spreadsheet @ 0x%X]\n",(unsigned int) ftell(f));
+ fprintf(debug, " [Spreadsheet @ 0x%X]\n", (unsigned int)ftell(f));
fflush(debug);
- fread(&name,25,1,f);
- //char* sname = new char[26];
+ CHECKED_FREAD(debug, &name, 25, 1, f);
+ // char* sname = new char[26];
char sname[26];
- sprintf(sname,"%s",strtok(name,"_")); // spreadsheet name
- char* cname = strtok(NULL,"_"); // column name
- while(char* tmpstr = strtok(NULL,"_")) { // get multiple-"_" title correct
- strcat(sname,"_");
- strcat(sname,cname);
- strcpy(cname,tmpstr);
+ sprintf(sname, "%s", strtok(name, "_")); // spreadsheet name
+ char *cname = strtok(NULL, "_"); // column name
+ while (char *tmpstr = strtok(NULL, "_")) { // get multiple-"_" title correct
+ strcat(sname, "_");
+ strcat(sname, cname);
+ strcpy(cname, tmpstr);
}
- int spread=0;
- if(cname == 0) {
- fprintf(debug,"NO COLUMN NAME FOUND! Must be a matrix or function.\n");
-////////////////////////////// READ MATRIX or FUNCTION ////////////////////////////////////
+ int spread = 0;
+ if (cname == 0) {
+ fprintf(debug, "NO COLUMN NAME FOUND! Must be a matrix or function.\n");
+ ////////////////////////////// READ MATRIX or FUNCTION
+ ///////////////////////////////////////
- fprintf(debug," [position @ 0x%X]\n",(unsigned int) ftell(f));
+ fprintf(debug, " [position @ 0x%X]\n", (unsigned int)ftell(f));
// TODO
short signature;
- fread(&signature,2,1,f);
- if(IsBigEndian()) SwapBytes(signature);
- fprintf(debug," SIGNATURE : ");
- fprintf(debug,"%.2X ",signature);
+ CHECKED_FREAD(debug, &signature, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(signature);
+ fprintf(debug, " SIGNATURE : ");
+ fprintf(debug, "%.2X ", signature);
fflush(debug);
- do{ // skip until '\n'
- fread(&c,1,1,f);
+ do { // skip until '\n'
+ CHECKED_FREAD(debug, &c, 1, 1, f);
// fprintf(debug,"%.2X ",c);
} while (c != '\n');
- fprintf(debug,"\n");
+ fprintf(debug, "\n");
fflush(debug);
// read size
int size;
- fread(&size,4,1,f);
- if(IsBigEndian()) SwapBytes(size);
- fread(&c,1,1,f); // skip '\n'
+ CHECKED_FREAD(debug, &size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(size);
+ CHECKED_FREAD(debug, &c, 1, 1, f); // skip '\n'
// TODO : use entry size : double, float, ...
size /= valuesize;
- fprintf(debug," SIZE = %d\n",size);
+ fprintf(debug, " SIZE = %d\n", size);
fflush(debug);
// catch exception
/*if(size>10000)
size=1000;*/
- switch(signature)
- {
+ switch (signature) {
case 0x50CA:
case 0x70CA:
case 0x50F2:
case 0x50E2:
- fprintf(debug,"NEW MATRIX\n");
+ fprintf(debug, "NEW MATRIX\n");
MATRIX.push_back(matrix(sname, dataIndex));
dataIndex++;
- fprintf(debug,"VALUES :\n");
+ fprintf(debug, "VALUES :\n");
- switch(data_type)
- {
- case 0x6001://double
- for(i=0;i<size;i++) {
+ switch (data_type) {
+ case 0x6001: // double
+ for (i = 0; i < size; i++) {
double value;
- fread(&value,valuesize,1,f);
- if(IsBigEndian()) SwapBytes(value);
+ CHECKED_FREAD(debug, &value, valuesize, 1, f);
+ if (IsBigEndian())
+ SwapBytes(value);
MATRIX.back().data.push_back((double)value);
- fprintf(debug,"%g ",MATRIX.back().data.back());
+ fprintf(debug, "%g ", MATRIX.back().data.back());
}
break;
- case 0x6003://float
- for(i=0;i<size;i++) {
+ case 0x6003: // float
+ for (i = 0; i < size; i++) {
float value;
- fread(&value,valuesize,1,f);
- if(IsBigEndian()) SwapBytes(value);
+ CHECKED_FREAD(debug, &value, valuesize, 1, f);
+ if (IsBigEndian())
+ SwapBytes(value);
MATRIX.back().data.push_back((double)value);
- fprintf(debug,"%g ",MATRIX.back().data.back());
+ fprintf(debug, "%g ", MATRIX.back().data.back());
}
break;
- case 0x6801://int
- if(data_type_u==8)//unsigned
- for(i=0;i<size;i++) {
+ case 0x6801: // int
+ if (data_type_u == 8) // unsigned
+ for (i = 0; i < size; i++) {
unsigned int value;
- fread(&value,valuesize,1,f);
- if(IsBigEndian()) SwapBytes(value);
+ CHECKED_FREAD(debug, &value, valuesize, 1, f);
+ if (IsBigEndian())
+ SwapBytes(value);
MATRIX.back().data.push_back((double)value);
- fprintf(debug,"%g ",MATRIX.back().data.back());
+ fprintf(debug, "%g ", MATRIX.back().data.back());
}
else
- for(i=0;i<size;i++) {
+ for (i = 0; i < size; i++) {
int value;
- fread(&value,valuesize,1,f);
- if(IsBigEndian()) SwapBytes(value);
+ CHECKED_FREAD(debug, &value, valuesize, 1, f);
+ if (IsBigEndian())
+ SwapBytes(value);
MATRIX.back().data.push_back((double)value);
- fprintf(debug,"%g ",MATRIX.back().data.back());
+ fprintf(debug, "%g ", MATRIX.back().data.back());
}
break;
- case 0x6803://short
- if(data_type_u==8)//unsigned
- for(i=0;i<size;i++) {
+ case 0x6803: // short
+ if (data_type_u == 8) // unsigned
+ for (i = 0; i < size; i++) {
unsigned short value;
- fread(&value,valuesize,1,f);
- if(IsBigEndian()) SwapBytes(value);
+ CHECKED_FREAD(debug, &value, valuesize, 1, f);
+ if (IsBigEndian())
+ SwapBytes(value);
MATRIX.back().data.push_back((double)value);
- fprintf(debug,"%g ",MATRIX.back().data.back());
+ fprintf(debug, "%g ", MATRIX.back().data.back());
}
else
- for(i=0;i<size;i++) {
+ for (i = 0; i < size; i++) {
short value;
- fread(&value,valuesize,1,f);
- if(IsBigEndian()) SwapBytes(value);
+ CHECKED_FREAD(debug, &value, valuesize, 1, f);
+ if (IsBigEndian())
+ SwapBytes(value);
MATRIX.back().data.push_back((double)value);
- fprintf(debug,"%g ",MATRIX.back().data.back());
+ fprintf(debug, "%g ", MATRIX.back().data.back());
}
break;
- case 0x6821://char
- if(data_type_u==8)//unsigned
- for(i=0;i<size;i++) {
+ case 0x6821: // char
+ if (data_type_u == 8) // unsigned
+ for (i = 0; i < size; i++) {
unsigned char value;
- fread(&value,valuesize,1,f);
- if(IsBigEndian()) SwapBytes(value);
+ CHECKED_FREAD(debug, &value, valuesize, 1, f);
+ if (IsBigEndian())
+ SwapBytes(value);
MATRIX.back().data.push_back((double)value);
- fprintf(debug,"%g ",MATRIX.back().data.back());
+ fprintf(debug, "%g ", MATRIX.back().data.back());
}
else
- for(i=0;i<size;i++) {
+ for (i = 0; i < size; i++) {
char value;
- fread(&value,valuesize,1,f);
- if(IsBigEndian()) SwapBytes(value);
+ CHECKED_FREAD(debug, &value, valuesize, 1, f);
+ if (IsBigEndian())
+ SwapBytes(value);
MATRIX.back().data.push_back((double)value);
- fprintf(debug,"%g ",MATRIX.back().data.back());
+ fprintf(debug, "%g ", MATRIX.back().data.back());
}
break;
default:
- fprintf(debug,"UNKNOWN MATRIX DATATYPE: %.2X SKIP DATA\n", data_type);
- fseek(f, valuesize*size, SEEK_CUR);
+ fprintf(debug, "UNKNOWN MATRIX DATATYPE: %.2X SKIP DATA\n",
+ data_type);
+ CHECKED_FSEEK(debug, f, valuesize * size, SEEK_CUR);
MATRIX.pop_back();
}
break;
case 0x10C8:
- fprintf(debug,"NEW FUNCTION\n");
+ fprintf(debug, "NEW FUNCTION\n");
FUNCTION.push_back(function(sname, dataIndex));
dataIndex++;
char *cmd;
- cmd=new char[valuesize+1];
- cmd[size_t(valuesize)]='\0';
- fread(cmd,valuesize,1,f);
- FUNCTION.back().formula=cmd;
+ cmd = new char[valuesize + 1];
+ cmd[size_t(valuesize)] = '\0';
+ CHECKED_FREAD(debug, cmd, valuesize, 1, f);
+ FUNCTION.back().formula = cmd;
int oldpos;
- oldpos=int(ftell(f));
+ oldpos = int(ftell(f));
short t;
- fseek(f,colpos+0xA,SEEK_SET);
- fread(&t,2,1,f);
- if(IsBigEndian()) SwapBytes(t);
- if(t==0x1194)
- FUNCTION.back().type=1;
+ CHECKED_FSEEK(debug, f, colpos + 0xA, SEEK_SET);
+ CHECKED_FREAD(debug, &t, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(t);
+ if (t == 0x1194)
+ FUNCTION.back().type = 1;
int N;
- fseek(f,colpos+0x21,SEEK_SET);
- fread(&N,4,1,f);
- if(IsBigEndian()) SwapBytes(N);
- FUNCTION.back().points=N;
+ CHECKED_FSEEK(debug, f, colpos + 0x21, SEEK_SET);
+ CHECKED_FREAD(debug, &N, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(N);
+ FUNCTION.back().points = N;
double d;
- fread(&d,8,1,f);
- if(IsBigEndian()) SwapBytes(d);
- FUNCTION.back().begin=d;
- fread(&d,8,1,f);
- if(IsBigEndian()) SwapBytes(d);
- FUNCTION.back().end=FUNCTION.back().begin+d*(FUNCTION.back().points-1);
- fprintf(debug,"FUNCTION %s : %s \n", FUNCTION.back().name.c_str(), FUNCTION.back().formula.c_str());
- fprintf(debug," interval %g : %g, number of points %d \n", FUNCTION.back().begin, FUNCTION.back().end, FUNCTION.back().points);
- fseek(f,oldpos,SEEK_SET);
-
- delete [] cmd;
+ CHECKED_FREAD(debug, &d, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(d);
+ FUNCTION.back().begin = d;
+ CHECKED_FREAD(debug, &d, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(d);
+ FUNCTION.back().end =
+ FUNCTION.back().begin + d * (FUNCTION.back().points - 1);
+ fprintf(debug, "FUNCTION %s : %s \n", FUNCTION.back().name.c_str(),
+ FUNCTION.back().formula.c_str());
+ fprintf(debug, " interval %g : %g, number of points %d \n",
+ FUNCTION.back().begin, FUNCTION.back().end,
+ FUNCTION.back().points);
+ CHECKED_FSEEK(debug, f, oldpos, SEEK_SET);
+
+ delete[] cmd;
break;
default:
- fprintf(debug,"UNKNOWN SIGNATURE: %.2X SKIP DATA\n", signature);
- fseek(f, valuesize*size, SEEK_CUR);
- if(valuesize != 8 && valuesize <= 16)
- fseek(f, 2, SEEK_CUR);
+ fprintf(debug, "UNKNOWN SIGNATURE: %.2X SKIP DATA\n", signature);
+ CHECKED_FSEEK(debug, f, valuesize * size, SEEK_CUR);
+ if (valuesize != 8 && valuesize <= 16)
+ CHECKED_FSEEK(debug, f, 2, SEEK_CUR);
}
- fprintf(debug,"\n");
+ fprintf(debug, "\n");
fflush(debug);
- }
- else { // worksheet
- if(SPREADSHEET.size() == 0 || compareSpreadnames(sname) == -1) {
- fprintf(debug,"NEW SPREADSHEET\n");
- current_col=1;
+ } else { // worksheet
+ if (SPREADSHEET.size() == 0 || compareSpreadnames(sname) == -1) {
+ fprintf(debug, "NEW SPREADSHEET\n");
+ current_col = 1;
SPREADSHEET.push_back(spreadSheet(sname));
- spread=static_cast<int>(SPREADSHEET.size())-1;
- SPREADSHEET.back().maxRows=0;
- }
- else {
+ spread = static_cast<int>(SPREADSHEET.size()) - 1;
+ SPREADSHEET.back().maxRows = 0;
+ } else {
- spread=compareSpreadnames(sname);
+ spread = compareSpreadnames(sname);
- current_col=static_cast<int>(SPREADSHEET[spread].column.size());
+ current_col = static_cast<int>(SPREADSHEET[spread].column.size());
- if(!current_col)
- current_col=1;
+ if (!current_col)
+ current_col = 1;
current_col++;
}
- fprintf(debug,"SPREADSHEET = %s COLUMN NAME = %s (%d) (@0x%X)\n",
- sname, cname,current_col,(unsigned int) ftell(f));
+ fprintf(debug, "SPREADSHEET = %s COLUMN NAME = %s (%d) (@0x%X)\n", sname,
+ cname, current_col, (unsigned int)ftell(f));
fflush(debug);
SPREADSHEET[spread].column.push_back(spreadColumn(cname, dataIndex));
- int sheetpos=static_cast<int>(SPREADSHEET[spread].column.back().name.find_last_of("@"));
- if(!SPREADSHEET[spread].bMultisheet && sheetpos!=-1)
- if(atoi(string(cname).substr(sheetpos+1).c_str())>1)
- {
- SPREADSHEET[spread].bMultisheet=true;
- fprintf(debug,"SPREADSHEET \"%s\" IS MULTISHEET \n", sname);
+ int sheetpos = static_cast<int>(
+ SPREADSHEET[spread].column.back().name.find_last_of("@"));
+ if (!SPREADSHEET[spread].bMultisheet && sheetpos != -1)
+ if (atoi(string(cname).substr(sheetpos + 1).c_str()) > 1) {
+ SPREADSHEET[spread].bMultisheet = true;
+ fprintf(debug, "SPREADSHEET \"%s\" IS MULTISHEET \n", sname);
}
dataIndex++;
-////////////////////////////// SIZE of column /////////////////////////////////////////////
- do{ // skip until '\n'
- fread(&c,1,1,f);
+ ////////////////////////////// SIZE of column
+ ////////////////////////////////////////////////
+ do { // skip until '\n'
+ CHECKED_FREAD(debug, &c, 1, 1, f);
} while (c != '\n');
- fread(&nbytes,4,1,f);
- if(IsBigEndian()) SwapBytes(nbytes);
- if(fmod(nbytes,(double)valuesize)>0)
- fprintf(debug,"WARNING: data section could not be read correct\n");
+ CHECKED_FREAD(debug, &nbytes, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(nbytes);
+ if (fmod(nbytes, (double)valuesize) > 0)
+ fprintf(debug, "WARNING: data section could not be read correct\n");
nr = nbytes / valuesize;
- fprintf(debug," [number of rows = %d (%d Bytes) @ 0x%X]\n",nr,nbytes,(unsigned int) ftell(f));
+ fprintf(debug, " [number of rows = %d (%d Bytes) @ 0x%X]\n", nr, nbytes,
+ (unsigned int)ftell(f));
fflush(debug);
- SPREADSHEET[spread].maxRows<nr?SPREADSHEET[spread].maxRows=nr:0;
+ SPREADSHEET[spread].maxRows < nr ? SPREADSHEET[spread].maxRows = nr : 0;
-////////////////////////////////////// DATA ////////////////////////////////////////////////
- fread(&c,1,1,f); // skip '\n'
+ ////////////////////////////////////// DATA
+ ///////////////////////////////////////////////////
+ CHECKED_FREAD(debug, &c, 1, 1, f); // skip '\n'
/*if(valuesize != 8 && valuesize <= 16 && nbytes>0) { // skip 0 0
- fread(&c,1,1,f);
- fread(&c,1,1,f);
+ CHECKED_FREAD(debug, &c,1,1,f);
+ CHECKED_FREAD(debug, &c,1,1,f);
}*/
- fprintf(debug," [data @ 0x%X]\n",(unsigned int) ftell(f));
+ fprintf(debug, " [data @ 0x%X]\n", (unsigned int)ftell(f));
fflush(debug);
- for (i=0;i<nr;i++) {
- if(valuesize <= 8) { // Numeric, Time, Date, Month, Day
- fread(&a,valuesize,1,f);
- if(IsBigEndian()) SwapBytes(a);
- fprintf(debug,"%g ",a);
- SPREADSHEET[spread].column[(current_col-1)].odata.push_back(originData(a));
- }
- else if((data_type&0x100)==0x100) // Text&Numeric
+ for (i = 0; i < nr; i++) {
+ if (valuesize <= 8) { // Numeric, Time, Date, Month, Day
+ CHECKED_FREAD(debug, &a, valuesize, 1, f);
+ if (IsBigEndian())
+ SwapBytes(a);
+ fprintf(debug, "%g ", a);
+ SPREADSHEET[spread].column[(current_col - 1)].odata.push_back(
+ originData(a));
+ } else if ((data_type & 0x100) == 0x100) // Text&Numeric
{
- fread(&c,1,1,f);
- fseek(f,1,SEEK_CUR);
- if(c==0) //value
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
+ if (c == 0) // value
{
- //fread(&a,valuesize-2,1,f);
- fread(&a,8,1,f);
- if(IsBigEndian()) SwapBytes(a);
- fprintf(debug,"%g ",a);
- SPREADSHEET[spread].column[(current_col-1)].odata.push_back(originData(a));
- fseek(f,valuesize-10,SEEK_CUR);
- }
- else //text
+ // CHECKED_FREAD(debug, &a,valuesize-2,1,f);
+ CHECKED_FREAD(debug, &a, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(a);
+ fprintf(debug, "%g ", a);
+ SPREADSHEET[spread].column[(current_col - 1)].odata.push_back(
+ originData(a));
+ CHECKED_FSEEK(debug, f, valuesize - 10, SEEK_CUR);
+ } else // text
{
- char *stmp = new char[valuesize-1];
- fread(stmp,valuesize-2,1,f);
- if(strchr(stmp,0x0E)) // try find non-printable symbol - garbage test
- stmp[0]='\0';
- SPREADSHEET[spread].column[(current_col-1)].odata.push_back(originData(stmp));
- fprintf(debug,"%s ",stmp);
- delete [] stmp;
+ char *stmp = new char[valuesize - 1];
+ CHECKED_FREAD(debug, stmp, valuesize - 2, 1, f);
+ if (strchr(stmp,
+ 0x0E)) // try find non-printable symbol - garbage test
+ stmp[0] = '\0';
+ SPREADSHEET[spread].column[(current_col - 1)].odata.push_back(
+ originData(stmp));
+ fprintf(debug, "%s ", stmp);
+ delete[] stmp;
}
- }
- else //Text
+ } else // Text
{
- char *stmp = new char[valuesize+1];
- fread(stmp,valuesize,1,f);
- if(strchr(stmp,0x0E)) // try find non-printable symbol - garbage test
- stmp[0]='\0';
- SPREADSHEET[spread].column[(current_col-1)].odata.push_back(originData(stmp));
- fprintf(debug,"%s ",stmp);
- delete [] stmp;
+ char *stmp = new char[valuesize + 1];
+ CHECKED_FREAD(debug, stmp, valuesize, 1, f);
+ if (strchr(stmp,
+ 0x0E)) // try find non-printable symbol - garbage test
+ stmp[0] = '\0';
+ SPREADSHEET[spread].column[(current_col - 1)].odata.push_back(
+ originData(stmp));
+ fprintf(debug, "%s ", stmp);
+ delete[] stmp;
}
}
} // else
- fprintf(debug,"\n");
+ fprintf(debug, "\n");
fflush(debug);
- if(nbytes>0||cname==0)
- fseek(f,1,SEEK_CUR);
+ if (nbytes > 0 || cname == 0)
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
int tailsize;
- fread(&tailsize,4,1,f);
- if(IsBigEndian()) SwapBytes(tailsize);
- fseek(f,1+tailsize+(tailsize>0?1:0),SEEK_CUR); //skip tail
- //fseek(f,5+((nbytes>0||cname==0)?1:0),SEEK_CUR);
- fread(&col_found,4,1,f);
- if(IsBigEndian()) SwapBytes(col_found);
- fseek(f,1,SEEK_CUR); // skip '\n'
- fprintf(debug," [column found = %d/0x%X (@ 0x%X)]\n",col_found,col_found,(unsigned int) ftell(f)-5);
- colpos=int(ftell(f));
+ CHECKED_FREAD(debug, &tailsize, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(tailsize);
+ CHECKED_FSEEK(debug, f, 1 + tailsize + (tailsize > 0 ? 1 : 0),
+ SEEK_CUR); // skip tail
+ // fseek(f,5+((nbytes>0||cname==0)?1:0),SEEK_CUR);
+ CHECKED_FREAD(debug, &col_found, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(col_found);
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR); // skip '\n'
+ fprintf(debug, " [column found = %d/0x%X (@ 0x%X)]\n", col_found, col_found,
+ (unsigned int)ftell(f) - 5);
+ colpos = int(ftell(f));
fflush(debug);
}
-////////////////////////////////////////////////////////////////////////////
- for(unsigned int i=0; i<SPREADSHEET.size(); ++i)
- if(SPREADSHEET[i].bMultisheet)
- {
- fprintf(debug," CONVERT SPREADSHEET \"%s\" to EXCEL\n", SPREADSHEET[i].name.c_str());
+ ////////////////////////////////////////////////////////////////////////////
+ for (unsigned int i = 0; i < SPREADSHEET.size(); ++i)
+ if (SPREADSHEET[i].bMultisheet) {
+ fprintf(debug, " CONVERT SPREADSHEET \"%s\" to EXCEL\n",
+ SPREADSHEET[i].name.c_str());
fflush(debug);
convertSpreadToExcel(i);
i--;
}
-////////////////////////////////////////////////////////////////////////////
-////////////////////// HEADER SECTION //////////////////////////////////////
+ ////////////////////////////////////////////////////////////////////////////
+ ////////////////////// HEADER SECTION //////////////////////////////////////
- int POS = int(ftell(f)-11);
- fprintf(debug,"\nHEADER SECTION\n");
- fprintf(debug," nr_spreads = %zu\n",SPREADSHEET.size());
- fprintf(debug," [position @ 0x%X]\n",POS);
+ int POS = int(ftell(f) - 11);
+ fprintf(debug, "\nHEADER SECTION\n");
+ fprintf(debug, " nr_spreads = %zu\n", SPREADSHEET.size());
+ fprintf(debug, " [position @ 0x%X]\n", POS);
fflush(debug);
-//////////////////////// OBJECT INFOS //////////////////////////////////////
- POS+=0xB;
- fseek(f,POS,SEEK_SET);
- while(1) {
+ //////////////////////// OBJECT INFOS //////////////////////////////////////
+ POS += 0xB;
+ CHECKED_FSEEK(debug, f, POS, SEEK_SET);
+ while (1) {
- fprintf(debug," reading Header\n");
+ fprintf(debug, " reading Header\n");
fflush(debug);
// HEADER
// check header
- POS=int(ftell(f));
+ POS = int(ftell(f));
int headersize;
- fread(&headersize,4,1,f);
- if(IsBigEndian()) SwapBytes(headersize);
- if(headersize==0)
+ CHECKED_FREAD(debug, &headersize, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(headersize);
+ if (headersize == 0)
break;
char object_type[10];
char object_name[25];
- fseek(f,POS + 0x7,SEEK_SET);
- fread(&object_name,25,1,f);
- fseek(f,POS + 0x4A,SEEK_SET);
- fread(&object_type,10,1,f);
-
- fseek(f,POS,SEEK_SET);
-
- if(compareSpreadnames(object_name)!=-1)
- readSpreadInfo(f, debug);
- else if(compareMatrixnames(object_name)!=-1)
- readMatrixInfo(f, debug);
- else if(compareExcelnames(object_name)!=-1)
- readExcelInfo(f, debug);
+ CHECKED_FSEEK(debug, f, POS + 0x7, SEEK_SET);
+ CHECKED_FREAD(debug, &object_name, 25, 1, f);
+ CHECKED_FSEEK(debug, f, POS + 0x4A, SEEK_SET);
+ CHECKED_FREAD(debug, &object_type, 10, 1, f);
+
+ CHECKED_FSEEK(debug, f, POS, SEEK_SET);
+
+ if (compareSpreadnames(object_name) != -1)
+ readSpreadInfo(f, file_size, debug);
+ else if (compareMatrixnames(object_name) != -1)
+ readMatrixInfo(f, file_size, debug);
+ else if (compareExcelnames(object_name) != -1)
+ readExcelInfo(f, file_size, debug);
else
- readGraphInfo(f, debug);
+ readGraphInfo(f, file_size, debug);
}
-
-
- fseek(f,1,SEEK_CUR);
- fprintf(debug,"Some Origin params @ 0x%X:\n", (unsigned int)ftell(f));
- fread(&c,1,1,f);
- while(c!=0)
- {
- fprintf(debug," ");
- while(c!='\n'){
- fprintf(debug,"%c",c);
- fread(&c,1,1,f);
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
+ fprintf(debug, "Some Origin params @ 0x%X:\n", (unsigned int)ftell(f));
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ while (c != 0) {
+ fprintf(debug, " ");
+ while (c != '\n') {
+ fprintf(debug, "%c", c);
+ CHECKED_FREAD(debug, &c, 1, 1, f);
}
double parvalue;
- fread(&parvalue,8,1,f);
- if(IsBigEndian()) SwapBytes(parvalue);
- fprintf(debug,": %g\n", parvalue);
- fseek(f,1,SEEK_CUR);
- fread(&c,1,1,f);
+ CHECKED_FREAD(debug, &parvalue, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(parvalue);
+ fprintf(debug, ": %g\n", parvalue);
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
+ CHECKED_FREAD(debug, &c, 1, 1, f);
}
- fseek(f,1+5,SEEK_CUR);
- while(1)
- {
- //fseek(f,5+0x40+1,SEEK_CUR);
+ CHECKED_FSEEK(debug, f, 1 + 5, SEEK_CUR);
+ while (1) {
+ // fseek(f,5+0x40+1,SEEK_CUR);
int size;
- fread(&size,4,1,f);
- if(IsBigEndian()) SwapBytes(size);
- if(size!=0x40)
+ CHECKED_FREAD(debug, &size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(size);
+ if (size != 0x40)
break;
double creation_date, modification_date;
- fseek(f,1+0x20,SEEK_CUR);
- fread(&creation_date,8,1,f);
- if(IsBigEndian()) SwapBytes(creation_date);
+ CHECKED_FSEEK(debug, f, 1 + 0x20, SEEK_CUR);
+ CHECKED_FREAD(debug, &creation_date, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(creation_date);
- fread(&modification_date,8,1,f);
- if(IsBigEndian()) SwapBytes(modification_date);
+ CHECKED_FREAD(debug, &modification_date, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(modification_date);
- fseek(f,0x10-4,SEEK_CUR);
+ CHECKED_FSEEK(debug, f, 0x10 - 4, SEEK_CUR);
unsigned char labellen;
- fread(&labellen,1,1,f);
-
- fseek(f,4,SEEK_CUR);
- fread(&size,4,1,f);
- if(IsBigEndian()) SwapBytes(size);
- fseek(f,1,SEEK_CUR);
- char *stmp = new char[size+1];
- fread(stmp,size,1,f);
- if(0==strcmp(stmp,"ResultsLog"))
- {
- delete [] stmp;
- fseek(f,1,SEEK_CUR);
- fread(&size,4,1,f);
- if(IsBigEndian()) SwapBytes(size);
- fseek(f,1,SEEK_CUR);
- stmp = new char[size+1];
- fread(stmp,size,1,f);
- resultsLog=stmp;
- fprintf(debug,"Results Log: %s\n", resultsLog.c_str());
- delete [] stmp;
+ CHECKED_FREAD(debug, &labellen, 1, 1, f);
+
+ CHECKED_FSEEK(debug, f, 4, SEEK_CUR);
+ CHECKED_FREAD(debug, &size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(size);
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
+ char *stmp = new char[size + 1];
+ CHECKED_FREAD(debug, stmp, size, 1, f);
+ if (0 == strcmp(stmp, "ResultsLog")) {
+ delete[] stmp;
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
+ CHECKED_FREAD(debug, &size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(size);
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
+ stmp = new char[size + 1];
+ CHECKED_FREAD(debug, stmp, size, 1, f);
+ resultsLog = stmp;
+ fprintf(debug, "Results Log: %s\n", resultsLog.c_str());
+ delete[] stmp;
break;
- }
- else
- {
+ } else {
NOTE.push_back(note(stmp));
- NOTE.back().objectID=objectIndex;
- NOTE.back().creation_date=creation_date;
- NOTE.back().modification_date=modification_date;
+ NOTE.back().objectID = objectIndex;
+ NOTE.back().creation_date = creation_date;
+ NOTE.back().modification_date = modification_date;
objectIndex++;
- delete [] stmp;
- fseek(f,1,SEEK_CUR);
- fread(&size,4,1,f);
- if(IsBigEndian()) SwapBytes(size);
- fseek(f,1,SEEK_CUR);
- if(labellen>1)
- {
+ delete[] stmp;
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
+ CHECKED_FREAD(debug, &size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(size);
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
+ if (labellen > 1) {
stmp = new char[labellen];
- stmp[labellen-1]='\0';
- fread(stmp,labellen-1,1,f);
- NOTE.back().label=stmp;
- delete [] stmp;
- fseek(f,1,SEEK_CUR);
+ stmp[labellen - 1] = '\0';
+ CHECKED_FREAD(debug, stmp, labellen - 1, 1, f);
+ NOTE.back().label = stmp;
+ delete[] stmp;
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
}
- stmp = new char[size-labellen+1];
- fread(stmp,size-labellen,1,f);
- NOTE.back().text=stmp;
- fprintf(debug,"NOTE %zu NAME: %s\n", NOTE.size(), NOTE.back().name.c_str());
- fprintf(debug,"NOTE %zu LABEL: %s\n", NOTE.size(), NOTE.back().label.c_str());
- fprintf(debug,"NOTE %zu TEXT:\n%s\n", NOTE.size(), NOTE.back().text.c_str());
- delete [] stmp;
- fseek(f,1,SEEK_CUR);
+ stmp = new char[size - labellen + 1];
+ CHECKED_FREAD(debug, stmp, size - labellen, 1, f);
+ NOTE.back().text = stmp;
+ fprintf(debug, "NOTE %zu NAME: %s\n", NOTE.size(),
+ NOTE.back().name.c_str());
+ fprintf(debug, "NOTE %zu LABEL: %s\n", NOTE.size(),
+ NOTE.back().label.c_str());
+ fprintf(debug, "NOTE %zu TEXT:\n%s\n", NOTE.size(),
+ NOTE.back().text.c_str());
+ delete[] stmp;
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
}
}
- fseek(f,1+4*5+0x10+1,SEEK_CUR);
- try
- {
+ CHECKED_FSEEK(debug, f, 1 + 4 * 5 + 0x10 + 1, SEEK_CUR);
+ try {
readProjectTree(f, debug);
+ } catch (...) {
}
- catch(...)
- {}
- fprintf(debug,"Done parsing\n");
+ fprintf(debug, "Done parsing\n");
fclose(debug);
return 0;
}
-void OPJFile::readSpreadInfo(FILE *f, FILE *debug)
-{
- int POS=int(ftell(f));
+void OPJFile::readSpreadInfo(FILE *f, int file_size, FILE *debug) {
+ int POS = int(ftell(f));
int headersize;
- fread(&headersize,4,1,f);
- if(IsBigEndian()) SwapBytes(headersize);
+ CHECKED_FREAD(debug, &headersize, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(headersize);
- POS+=5;
+ POS += 5;
- fprintf(debug," [Spreadsheet SECTION (@ 0x%X)]\n",POS);
+ fprintf(debug, " [Spreadsheet SECTION (@ 0x%X)]\n", POS);
fflush(debug);
// check spreadsheet name
char name[25];
- fseek(f,POS + 0x2,SEEK_SET);
- fread(&name,25,1,f);
+ CHECKED_FSEEK(debug, f, POS + 0x2, SEEK_SET);
+ CHECKED_FREAD(debug, &name, 25, 1, f);
- int spread=compareSpreadnames(name);
- SPREADSHEET[spread].name=name;
+ int spread = compareSpreadnames(name);
+ SPREADSHEET[spread].name = name;
readWindowProperties(SPREADSHEET[spread], f, debug, POS, headersize);
- SPREADSHEET[spread].bLoose=false;
+ SPREADSHEET[spread].bLoose = false;
char c = 0;
int LAYER = POS;
{
// LAYER section
- LAYER += headersize + 0x1 + 0x5/* length of block = 0x12D + '\n'*/ + 0x12D + 0x1;
- //now structure is next : section_header_size=0x6F(4 bytes) + '\n' + section_header(0x6F bytes) + section_body_1_size(4 bytes) + '\n' + section_body_1 + section_body_2_size(maybe=0)(4 bytes) + '\n' + section_body_2 + '\n'
- //possible sections: column formulas, __WIPR, __WIOTN, __LayerInfoStorage etc
- //section name(column name in formula case) starts with 0x46 position
- while(1)
- {
+ LAYER += headersize + 0x1 + 0x5 /* length of block = 0x12D + '\n'*/ +
+ 0x12D + 0x1;
+ // now structure is next : section_header_size=0x6F(4 bytes) + '\n' +
+ // section_header(0x6F bytes) + section_body_1_size(4 bytes) + '\n' +
+ // section_body_1 + section_body_2_size(maybe=0)(4 bytes) + '\n' +
+ // section_body_2 + '\n'
+ // possible sections: column formulas, __WIPR, __WIOTN, __LayerInfoStorage
+ // etc
+ // section name(column name in formula case) starts with 0x46 position
+ while (1) {
int sec_size;
- //section_header_size=0x6F(4 bytes) + '\n'
- LAYER+=0x5;
+ // section_header_size=0x6F(4 bytes) + '\n'
+ LAYER += 0x5;
- //section_header
- fseek(f,LAYER+0x46,SEEK_SET);
+ // section_header
+ CHECKED_FSEEK(debug, f, LAYER + 0x46, SEEK_SET);
char sec_name[42];
- fread(&sec_name,41,1,f);
- sec_name[41]='\0';
+ CHECKED_FREAD(debug, &sec_name, 41, 1, f);
+ sec_name[41] = '\0';
- fprintf(debug," DEBUG SECTION NAME: %s (@ 0x%X)\n", sec_name, LAYER+0x46);
+ fprintf(debug, " DEBUG SECTION NAME: %s (@ 0x%X)\n", sec_name,
+ LAYER + 0x46);
fflush(debug);
- //section_body_1_size
- LAYER+=0x6F+0x1;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
+ // section_body_1_size
+ LAYER += 0x6F + 0x1;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
if (INT_MAX == sec_size) {
// this would end in an overflow and it's obviously wrong
- fprintf(debug, "Error: while reading spread info, found section size: %d\n", sec_size);
+ fprintf(debug,
+ "Error: while reading spread info, found section size: %d\n",
+ sec_size);
fflush(debug);
}
- //section_body_1
- LAYER+=0x5;
- fseek(f,LAYER,SEEK_SET);
- //check if it is a formula
- int col_index=compareColumnnames(spread,sec_name);
- if(col_index!=-1)
- {
- char *stmp=new char[sec_size+1];
+ if (file_size < sec_size) {
+ fprintf(debug, "Error in readSpread: found section size (%d) bigger "
+ "than total file size: %d\n",
+ sec_size, file_size);
+ fflush(debug);
+ return;
+ }
+
+ // section_body_1
+ LAYER += 0x5;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ // check if it is a formula
+ int col_index = compareColumnnames(spread, sec_name);
+ if (col_index != -1) {
+ char *stmp = new char[sec_size + 1];
if (!stmp)
break;
- stmp[sec_size]='\0';
- fread(stmp,sec_size,1,f);
- SPREADSHEET[spread].column[col_index].command=stmp;
- delete [] stmp;
+ stmp[sec_size] = '\0';
+ CHECKED_FREAD(debug, stmp, sec_size, 1, f);
+ SPREADSHEET[spread].column[col_index].command = stmp;
+ delete[] stmp;
}
- //section_body_2_size
- LAYER+=sec_size+0x1;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
+ // section_body_2_size
+ LAYER += sec_size + 0x1;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
- //section_body_2
- LAYER+=0x5;
+ // section_body_2
+ LAYER += 0x5;
- //close section 00 00 00 00 0A
- LAYER+=sec_size+(sec_size>0?0x1:0)+0x5;
+ // close section 00 00 00 00 0A
+ LAYER += sec_size + (sec_size > 0 ? 0x1 : 0) + 0x5;
- if(0==strcmp(sec_name,"__LayerInfoStorage"))
+ if (0 == strcmp(sec_name, "__LayerInfoStorage"))
break;
-
}
- LAYER+=0x5;
-
+ LAYER += 0x5;
}
fflush(debug);
/////////////// COLUMN Types ///////////////////////////////////////////
- fprintf(debug," Spreadsheet has %zu columns\n",SPREADSHEET[spread].column.size());
-
- while(1)
- {
- LAYER+=0x5;
- fseek(f,LAYER+0x12, SEEK_SET);
- fread(&name,12,1,f);
-
- fseek(f,LAYER+0x11, SEEK_SET);
- fread(&c,1,1,f);
- short width=0;
- fseek(f,LAYER+0x4A, SEEK_SET);
- fread(&width,2,1,f);
- if(IsBigEndian()) SwapBytes(width);
- int col_index=compareColumnnames(spread,name);
- if(col_index!=-1)
- {
+ fprintf(debug, " Spreadsheet has %zu columns\n",
+ SPREADSHEET[spread].column.size());
+
+ while (1) {
+ LAYER += 0x5;
+ CHECKED_FSEEK(debug, f, LAYER + 0x12, SEEK_SET);
+ CHECKED_FREAD(debug, &name, 12, 1, f);
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x11, SEEK_SET);
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ short width = 0;
+ CHECKED_FSEEK(debug, f, LAYER + 0x4A, SEEK_SET);
+ CHECKED_FREAD(debug, &width, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(width);
+ int col_index = compareColumnnames(spread, name);
+ if (col_index != -1) {
ColumnType type;
- switch(c) {
- case 3:
- type = X;
- break;
- case 0:
- type = Y;
- break;
- case 5:
- type = Z;
- break;
- case 6:
- type = XErr;
- break;
- case 2:
- type = YErr;
- break;
- case 4:
- type = Label;
- break;
- default:
- type = NONE;
- break;
+ switch (c) {
+ case 3:
+ type = X;
+ break;
+ case 0:
+ type = Y;
+ break;
+ case 5:
+ type = Z;
+ break;
+ case 6:
+ type = XErr;
+ break;
+ case 2:
+ type = YErr;
+ break;
+ case 4:
+ type = Label;
+ break;
+ default:
+ type = NONE;
+ break;
}
- SPREADSHEET[spread].column[col_index].type=type;
- width/=0xA;
- if(width==0)
- width=8;
- SPREADSHEET[spread].column[col_index].width=width;
- fseek(f,LAYER+0x1E, SEEK_SET);
- unsigned char c1,c2;
- fread(&c1,1,1,f);
- fread(&c2,1,1,f);
- switch(c1)
- {
+ SPREADSHEET[spread].column[col_index].type = type;
+ width /= 0xA;
+ if (width == 0)
+ width = 8;
+ SPREADSHEET[spread].column[col_index].width = width;
+ CHECKED_FSEEK(debug, f, LAYER + 0x1E, SEEK_SET);
+ unsigned char c1, c2;
+ CHECKED_FREAD(debug, &c1, 1, 1, f);
+ CHECKED_FREAD(debug, &c2, 1, 1, f);
+ switch (c1) {
case 0x00: // Numeric - Dec1000
case 0x09: // Text&Numeric - Dec1000
case 0x10: // Numeric - Scientific
@@ -1434,229 +1546,246 @@ void OPJFile::readSpreadInfo(FILE *f, FILE *debug)
case 0x29: // Text&Numeric - Engeneering
case 0x30: // Numeric - Dec1,000
case 0x39: // Text&Numeric - Dec1,000
- SPREADSHEET[spread].column[col_index].value_type=(c1%0x10==0x9)?6:0;
- SPREADSHEET[spread].column[col_index].value_type_specification=c1/0x10;
- if(c2>=0x80)
- {
- SPREADSHEET[spread].column[col_index].significant_digits=c2-0x80;
- SPREADSHEET[spread].column[col_index].numeric_display_type=2;
- }
- else if(c2>0)
- {
- SPREADSHEET[spread].column[col_index].decimal_places=c2-0x03;
- SPREADSHEET[spread].column[col_index].numeric_display_type=1;
+ SPREADSHEET[spread].column[col_index].value_type =
+ (c1 % 0x10 == 0x9) ? 6 : 0;
+ SPREADSHEET[spread].column[col_index].value_type_specification =
+ c1 / 0x10;
+ if (c2 >= 0x80) {
+ SPREADSHEET[spread].column[col_index].significant_digits = c2 - 0x80;
+ SPREADSHEET[spread].column[col_index].numeric_display_type = 2;
+ } else if (c2 > 0) {
+ SPREADSHEET[spread].column[col_index].decimal_places = c2 - 0x03;
+ SPREADSHEET[spread].column[col_index].numeric_display_type = 1;
}
break;
case 0x02: // Time
- SPREADSHEET[spread].column[col_index].value_type=3;
- SPREADSHEET[spread].column[col_index].value_type_specification=c2-0x80;
+ SPREADSHEET[spread].column[col_index].value_type = 3;
+ SPREADSHEET[spread].column[col_index].value_type_specification =
+ c2 - 0x80;
break;
case 0x03: // Date
- SPREADSHEET[spread].column[col_index].value_type=2;
- SPREADSHEET[spread].column[col_index].value_type_specification=c2-0x80;
+ SPREADSHEET[spread].column[col_index].value_type = 2;
+ SPREADSHEET[spread].column[col_index].value_type_specification =
+ c2 - 0x80;
break;
case 0x31: // Text
- SPREADSHEET[spread].column[col_index].value_type=1;
+ SPREADSHEET[spread].column[col_index].value_type = 1;
break;
case 0x4: // Month
case 0x34:
- SPREADSHEET[spread].column[col_index].value_type=4;
- SPREADSHEET[spread].column[col_index].value_type_specification=c2;
+ SPREADSHEET[spread].column[col_index].value_type = 4;
+ SPREADSHEET[spread].column[col_index].value_type_specification = c2;
break;
case 0x5: // Day
case 0x35:
- SPREADSHEET[spread].column[col_index].value_type=5;
- SPREADSHEET[spread].column[col_index].value_type_specification=c2;
+ SPREADSHEET[spread].column[col_index].value_type = 5;
+ SPREADSHEET[spread].column[col_index].value_type_specification = c2;
break;
default: // Text
- SPREADSHEET[spread].column[col_index].value_type=1;
+ SPREADSHEET[spread].column[col_index].value_type = 1;
break;
}
- fprintf(debug," COLUMN \"%s\" type = %s(%d) (@ 0x%X)\n",
- SPREADSHEET[spread].column[col_index].name.c_str(),colTypeNames[type],c,LAYER+0x11);
+ fprintf(debug, " COLUMN \"%s\" type = %s(%d) (@ 0x%X)\n",
+ SPREADSHEET[spread].column[col_index].name.c_str(),
+ colTypeNames[type], c, LAYER + 0x11);
fflush(debug);
}
- LAYER+=0x1E7+0x1;
- fseek(f,LAYER,SEEK_SET);
- int comm_size=0;
- fread(&comm_size,4,1,f);
- if(IsBigEndian()) SwapBytes(comm_size);
- LAYER+=0x5;
- if(comm_size>0)
- {
- char* comment=new char[comm_size+1];
- comment[comm_size]='\0';
- fseek(f,LAYER,SEEK_SET);
- fread(comment,comm_size,1,f);
- if(col_index!=-1)
- SPREADSHEET[spread].column[col_index].comment=comment;
- LAYER+=comm_size+0x1;
- delete [] comment;
+ LAYER += 0x1E7 + 0x1;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ int comm_size = 0;
+ CHECKED_FREAD(debug, &comm_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(comm_size);
+ LAYER += 0x5;
+ if (comm_size > 0) {
+ char *comment = new char[comm_size + 1];
+ comment[comm_size] = '\0';
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, comment, comm_size, 1, f);
+ if (col_index != -1)
+ SPREADSHEET[spread].column[col_index].comment = comment;
+ LAYER += comm_size + 0x1;
+ delete[] comment;
}
- fseek(f,LAYER,SEEK_SET);
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
int ntmp;
- fread(&ntmp,4,1,f);
- if(IsBigEndian()) SwapBytes(ntmp);
- if(ntmp!=0x1E7)
+ CHECKED_FREAD(debug, &ntmp, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(ntmp);
+ if (ntmp != 0x1E7)
break;
}
- fprintf(debug," Done with spreadsheet %d\n",spread);
+ fprintf(debug, " Done with spreadsheet %d\n", spread);
fflush(debug);
- POS = LAYER+0x5*0x6+0x1ED*0x12;
- fseek(f,POS,SEEK_SET);
+ POS = LAYER + 0x5 * 0x6 + 0x1ED * 0x12;
+ CHECKED_FSEEK(debug, f, POS, SEEK_SET);
}
-void OPJFile::readExcelInfo(FILE *f, FILE *debug)
-{
- int POS=int(ftell(f));
+void OPJFile::readExcelInfo(FILE *f, int file_size, FILE *debug) {
+ int POS = int(ftell(f));
int headersize;
- fread(&headersize,4,1,f);
- if(IsBigEndian()) SwapBytes(headersize);
+ CHECKED_FREAD(debug, &headersize, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(headersize);
- POS+=5;
+ POS += 5;
- fprintf(debug," [EXCEL SECTION (@ 0x%X)]\n",POS);
+ fprintf(debug, " [EXCEL SECTION (@ 0x%X)]\n", POS);
fflush(debug);
// check spreadsheet name
char name[25];
- fseek(f,POS + 0x2,SEEK_SET);
- fread(&name,25,1,f);
+ CHECKED_FSEEK(debug, f, POS + 0x2, SEEK_SET);
+ CHECKED_FREAD(debug, &name, 25, 1, f);
- int iexcel=compareExcelnames(name);
- EXCEL[iexcel].name=name;
+ int iexcel = compareExcelnames(name);
+ EXCEL[iexcel].name = name;
readWindowProperties(EXCEL[iexcel], f, debug, POS, headersize);
- EXCEL[iexcel].bLoose=false;
+ EXCEL[iexcel].bLoose = false;
char c = 0;
int LAYER = POS;
LAYER += headersize + 0x1;
int sec_size;
- int isheet=0;
- while(1)// multisheet loop
+ int isheet = 0;
+ while (1) // multisheet loop
{
// LAYER section
- LAYER += 0x5/* length of block = 0x12D + '\n'*/ + 0x12D + 0x1;
- //now structure is next : section_header_size=0x6F(4 bytes) + '\n' + section_header(0x6F bytes) + section_body_1_size(4 bytes) + '\n' + section_body_1 + section_body_2_size(maybe=0)(4 bytes) + '\n' + section_body_2 + '\n'
- //possible sections: column formulas, __WIPR, __WIOTN, __LayerInfoStorage etc
- //section name(column name in formula case) starts with 0x46 position
- while(1)
- {
- //section_header_size=0x6F(4 bytes) + '\n'
- LAYER+=0x5;
-
- //section_header
- fseek(f,LAYER+0x46,SEEK_SET);
+ LAYER += 0x5 /* length of block = 0x12D + '\n'*/ + 0x12D + 0x1;
+ // now structure is next : section_header_size=0x6F(4 bytes) + '\n' +
+ // section_header(0x6F bytes) + section_body_1_size(4 bytes) + '\n' +
+ // section_body_1 + section_body_2_size(maybe=0)(4 bytes) + '\n' +
+ // section_body_2 + '\n'
+ // possible sections: column formulas, __WIPR, __WIOTN, __LayerInfoStorage
+ // etc
+ // section name(column name in formula case) starts with 0x46 position
+ while (1) {
+ // section_header_size=0x6F(4 bytes) + '\n'
+ LAYER += 0x5;
+
+ // section_header
+ CHECKED_FSEEK(debug, f, LAYER + 0x46, SEEK_SET);
char sec_name[42];
- fread(&sec_name,41,1,f);
- sec_name[41]='\0';
+ CHECKED_FREAD(debug, &sec_name, 41, 1, f);
+ sec_name[41] = '\0';
- fprintf(debug," DEBUG SECTION NAME: %s (@ 0x%X)\n", sec_name, LAYER+0x46);
+ fprintf(debug, " DEBUG SECTION NAME: %s (@ 0x%X)\n", sec_name,
+ LAYER + 0x46);
fflush(debug);
- //section_body_1_size
- LAYER+=0x6F+0x1;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
+ // section_body_1_size
+ LAYER += 0x6F + 0x1;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
if (INT_MAX == sec_size) {
- // this would end in an overflow for new[] below and it's obviously wrong
- fprintf(debug, "Error: while reading Excel info, found section size: %d\n", sec_size);
+ // this would end in an overflow for new[] below and it's obviously
+ // wrong
+ fprintf(debug,
+ "Error: while reading Excel info, found section size: %d\n",
+ sec_size);
fflush(debug);
}
- //section_body_1
- LAYER+=0x5;
- fseek(f,LAYER,SEEK_SET);
- //check if it is a formula
- int col_index=compareExcelColumnnames(iexcel, isheet, sec_name);
- if(col_index!=-1)
- {
- char *stmp=new char[sec_size+1];
- stmp[sec_size]='\0';
- fread(stmp,sec_size,1,f);
- EXCEL[iexcel].sheet[isheet].column[col_index].command=stmp;
- delete [] stmp;
+ if (file_size < sec_size) {
+ fprintf(debug, "Error in readExcel: found section size (%d) bigger "
+ "than total file size: %d\n",
+ sec_size, file_size);
+ fflush(debug);
+ return;
}
- //section_body_2_size
- LAYER+=sec_size+0x1;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
+ // section_body_1
+ LAYER += 0x5;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ // check if it is a formula
+ int col_index = compareExcelColumnnames(iexcel, isheet, sec_name);
+ if (col_index != -1) {
+ char *stmp = new char[sec_size + 1];
+ stmp[sec_size] = '\0';
+ CHECKED_FREAD(debug, stmp, sec_size, 1, f);
+ EXCEL[iexcel].sheet[isheet].column[col_index].command = stmp;
+ delete[] stmp;
+ }
- //section_body_2
- LAYER+=0x5;
+ // section_body_2_size
+ LAYER += sec_size + 0x1;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
- //close section 00 00 00 00 0A
- LAYER+=sec_size+(sec_size>0?0x1:0)+0x5;
+ // section_body_2
+ LAYER += 0x5;
- if(0==strcmp(sec_name,"__LayerInfoStorage"))
- break;
+ // close section 00 00 00 00 0A
+ LAYER += sec_size + (sec_size > 0 ? 0x1 : 0) + 0x5;
+ if (0 == strcmp(sec_name, "__LayerInfoStorage"))
+ break;
}
- LAYER+=0x5;
+ LAYER += 0x5;
fflush(debug);
/////////////// COLUMN Types ///////////////////////////////////////////
- fprintf(debug," Excel sheet %d has %zu columns\n",isheet,EXCEL[iexcel].sheet[isheet].column.size());
-
- while(1)
- {
- LAYER+=0x5;
- fseek(f,LAYER+0x12, SEEK_SET);
- fread(&name,12,1,f);
-
- fseek(f,LAYER+0x11, SEEK_SET);
- fread(&c,1,1,f);
- short width=0;
- fseek(f,LAYER+0x4A, SEEK_SET);
- fread(&width,2,1,f);
- if(IsBigEndian()) SwapBytes(width);
- //char col_name[30];
- //sprintf(col_name, "%s@%d", name, isheet);
- int col_index=compareExcelColumnnames(iexcel, isheet, name);
- if(col_index!=-1)
- {
+ fprintf(debug, " Excel sheet %d has %zu columns\n", isheet,
+ EXCEL[iexcel].sheet[isheet].column.size());
+
+ while (1) {
+ LAYER += 0x5;
+ CHECKED_FSEEK(debug, f, LAYER + 0x12, SEEK_SET);
+ CHECKED_FREAD(debug, &name, 12, 1, f);
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x11, SEEK_SET);
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ short width = 0;
+ CHECKED_FSEEK(debug, f, LAYER + 0x4A, SEEK_SET);
+ CHECKED_FREAD(debug, &width, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(width);
+ // char col_name[30];
+ // sprintf(col_name, "%s@%d", name, isheet);
+ int col_index = compareExcelColumnnames(iexcel, isheet, name);
+ if (col_index != -1) {
ColumnType type;
- switch(c) {
- case 3:
- type = X;
- break;
- case 0:
- type = Y;
- break;
- case 5:
- type = Z;
- break;
- case 6:
- type = XErr;
- break;
- case 2:
- type = YErr;
- break;
- case 4:
- type = Label;
- break;
- default:
- type = NONE;
- break;
+ switch (c) {
+ case 3:
+ type = X;
+ break;
+ case 0:
+ type = Y;
+ break;
+ case 5:
+ type = Z;
+ break;
+ case 6:
+ type = XErr;
+ break;
+ case 2:
+ type = YErr;
+ break;
+ case 4:
+ type = Label;
+ break;
+ default:
+ type = NONE;
+ break;
}
- EXCEL[iexcel].sheet[isheet].column[col_index].type=type;
- width/=0xA;
- if(width==0)
- width=8;
- EXCEL[iexcel].sheet[isheet].column[col_index].width=width;
- fseek(f,LAYER+0x1E, SEEK_SET);
- unsigned char c1,c2;
- fread(&c1,1,1,f);
- fread(&c2,1,1,f);
- switch(c1)
- {
+ EXCEL[iexcel].sheet[isheet].column[col_index].type = type;
+ width /= 0xA;
+ if (width == 0)
+ width = 8;
+ EXCEL[iexcel].sheet[isheet].column[col_index].width = width;
+ CHECKED_FSEEK(debug, f, LAYER + 0x1E, SEEK_SET);
+ unsigned char c1, c2;
+ CHECKED_FREAD(debug, &c1, 1, 1, f);
+ CHECKED_FREAD(debug, &c2, 1, 1, f);
+ switch (c1) {
case 0x00: // Numeric - Dec1000
case 0x09: // Text&Numeric - Dec1000
case 0x10: // Numeric - Scientific
@@ -1665,115 +1794,134 @@ void OPJFile::readExcelInfo(FILE *f, FILE *debug)
case 0x29: // Text&Numeric - Engeneering
case 0x30: // Numeric - Dec1,000
case 0x39: // Text&Numeric - Dec1,000
- EXCEL[iexcel].sheet[isheet].column[col_index].value_type=(c1%0x10==0x9)?6:0;
- EXCEL[iexcel].sheet[isheet].column[col_index].value_type_specification=c1/0x10;
- if(c2>=0x80)
- {
- EXCEL[iexcel].sheet[isheet].column[col_index].significant_digits=c2-0x80;
- EXCEL[iexcel].sheet[isheet].column[col_index].numeric_display_type=2;
- }
- else if(c2>0)
- {
- EXCEL[iexcel].sheet[isheet].column[col_index].decimal_places=c2-0x03;
- EXCEL[iexcel].sheet[isheet].column[col_index].numeric_display_type=1;
+ EXCEL[iexcel].sheet[isheet].column[col_index].value_type =
+ (c1 % 0x10 == 0x9) ? 6 : 0;
+ EXCEL[iexcel]
+ .sheet[isheet]
+ .column[col_index]
+ .value_type_specification = c1 / 0x10;
+ if (c2 >= 0x80) {
+ EXCEL[iexcel].sheet[isheet].column[col_index].significant_digits =
+ c2 - 0x80;
+ EXCEL[iexcel].sheet[isheet].column[col_index].numeric_display_type =
+ 2;
+ } else if (c2 > 0) {
+ EXCEL[iexcel].sheet[isheet].column[col_index].decimal_places =
+ c2 - 0x03;
+ EXCEL[iexcel].sheet[isheet].column[col_index].numeric_display_type =
+ 1;
}
break;
case 0x02: // Time
- EXCEL[iexcel].sheet[isheet].column[col_index].value_type=3;
- EXCEL[iexcel].sheet[isheet].column[col_index].value_type_specification=c2-0x80;
+ EXCEL[iexcel].sheet[isheet].column[col_index].value_type = 3;
+ EXCEL[iexcel]
+ .sheet[isheet]
+ .column[col_index]
+ .value_type_specification = c2 - 0x80;
break;
case 0x03: // Date
- EXCEL[iexcel].sheet[isheet].column[col_index].value_type=2;
- EXCEL[iexcel].sheet[isheet].column[col_index].value_type_specification=c2-0x80;
+ EXCEL[iexcel].sheet[isheet].column[col_index].value_type = 2;
+ EXCEL[iexcel]
+ .sheet[isheet]
+ .column[col_index]
+ .value_type_specification = c2 - 0x80;
break;
case 0x31: // Text
- EXCEL[iexcel].sheet[isheet].column[col_index].value_type=1;
+ EXCEL[iexcel].sheet[isheet].column[col_index].value_type = 1;
break;
case 0x4: // Month
case 0x34:
- EXCEL[iexcel].sheet[isheet].column[col_index].value_type=4;
- EXCEL[iexcel].sheet[isheet].column[col_index].value_type_specification=c2;
+ EXCEL[iexcel].sheet[isheet].column[col_index].value_type = 4;
+ EXCEL[iexcel]
+ .sheet[isheet]
+ .column[col_index]
+ .value_type_specification = c2;
break;
case 0x5: // Day
case 0x35:
- EXCEL[iexcel].sheet[isheet].column[col_index].value_type=5;
- EXCEL[iexcel].sheet[isheet].column[col_index].value_type_specification=c2;
+ EXCEL[iexcel].sheet[isheet].column[col_index].value_type = 5;
+ EXCEL[iexcel]
+ .sheet[isheet]
+ .column[col_index]
+ .value_type_specification = c2;
break;
default: // Text
- EXCEL[iexcel].sheet[isheet].column[col_index].value_type=1;
+ EXCEL[iexcel].sheet[isheet].column[col_index].value_type = 1;
break;
}
- fprintf(debug," COLUMN \"%s\" type = %s(%d) (@ 0x%X)\n",
- EXCEL[iexcel].sheet[isheet].column[col_index].name.c_str(),colTypeNames[type],c,LAYER+0x11);
+ fprintf(debug, " COLUMN \"%s\" type = %s(%d) (@ 0x%X)\n",
+ EXCEL[iexcel].sheet[isheet].column[col_index].name.c_str(),
+ colTypeNames[type], c, LAYER + 0x11);
fflush(debug);
}
- LAYER+=0x1E7+0x1;
- fseek(f,LAYER,SEEK_SET);
- int comm_size=0;
- fread(&comm_size,4,1,f);
- if(IsBigEndian()) SwapBytes(comm_size);
- LAYER+=0x5;
- if(comm_size>0)
- {
- char* comment=new char[comm_size+1];
- comment[comm_size]='\0';
- fseek(f,LAYER,SEEK_SET);
- fread(comment,comm_size,1,f);
- if(col_index!=-1)
- EXCEL[iexcel].sheet[isheet].column[col_index].comment=comment;
- LAYER+=comm_size+0x1;
- delete [] comment;
+ LAYER += 0x1E7 + 0x1;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ int comm_size = 0;
+ CHECKED_FREAD(debug, &comm_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(comm_size);
+ LAYER += 0x5;
+ if (comm_size > 0) {
+ char *comment = new char[comm_size + 1];
+ comment[comm_size] = '\0';
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, comment, comm_size, 1, f);
+ if (col_index != -1)
+ EXCEL[iexcel].sheet[isheet].column[col_index].comment = comment;
+ LAYER += comm_size + 0x1;
+ delete[] comment;
}
- fseek(f,LAYER,SEEK_SET);
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
int ntmp;
- fread(&ntmp,4,1,f);
- if(IsBigEndian()) SwapBytes(ntmp);
- if(ntmp!=0x1E7)
+ CHECKED_FREAD(debug, &ntmp, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(ntmp);
+ if (ntmp != 0x1E7)
break;
}
- fprintf(debug," Done with excel %d\n", iexcel);
+ fprintf(debug, " Done with excel %d\n", iexcel);
fflush(debug);
- //POS = LAYER+0x5*0x6+0x1ED*0x12;
- LAYER+=0x5*0x5+0x1ED*0x12;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
- if(sec_size==0)
+ // POS = LAYER+0x5*0x6+0x1ED*0x12;
+ LAYER += 0x5 * 0x5 + 0x1ED * 0x12;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
+ if (sec_size == 0)
break;
isheet++;
}
- POS = LAYER+0x5;
+ POS = LAYER + 0x5;
- fseek(f,POS,SEEK_SET);
+ CHECKED_FSEEK(debug, f, POS, SEEK_SET);
}
-void OPJFile::readMatrixInfo(FILE *f, FILE *debug)
-{
- int POS=int(ftell(f));
+void OPJFile::readMatrixInfo(FILE *f, int file_size, FILE *debug) {
+ int POS = int(ftell(f));
int headersize;
- fread(&headersize,4,1,f);
- if(IsBigEndian()) SwapBytes(headersize);
- POS+=5;
+ CHECKED_FREAD(debug, &headersize, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(headersize);
+ POS += 5;
- fprintf(debug," [Matrix SECTION (@ 0x%X)]\n",POS);
+ fprintf(debug, " [Matrix SECTION (@ 0x%X)]\n", POS);
fflush(debug);
// check spreadsheet name
char name[25];
- fseek(f,POS + 0x2,SEEK_SET);
- fread(&name,25,1,f);
+ CHECKED_FSEEK(debug, f, POS + 0x2, SEEK_SET);
+ CHECKED_FREAD(debug, &name, 25, 1, f);
- int idx=compareMatrixnames(name);
- MATRIX[idx].name=name;
+ int idx = compareMatrixnames(name);
+ MATRIX[idx].name = name;
readWindowProperties(MATRIX[idx], f, debug, POS, headersize);
unsigned char h = 0;
- fseek(f,POS+0x87,SEEK_SET);
- fread(&h,1,1,f);
- switch(h)
- {
+ CHECKED_FSEEK(debug, f, POS + 0x87, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ switch (h) {
case 1:
MATRIX[idx].view = matrix::ImageView;
break;
@@ -1786,1086 +1934,1209 @@ void OPJFile::readMatrixInfo(FILE *f, FILE *debug)
LAYER += headersize + 0x1;
int sec_size;
// LAYER section
- LAYER +=0x5;
- fseek(f,LAYER+0x2B,SEEK_SET);
- short w=0;
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- MATRIX[idx].nr_cols=w;
- fseek(f,LAYER+0x52,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- MATRIX[idx].nr_rows=w;
-
- LAYER +=0x12D + 0x1;
- //now structure is next : section_header_size=0x6F(4 bytes) + '\n' + section_header(0x6F bytes) + section_body_1_size(4 bytes) + '\n' + section_body_1 + section_body_2_size(maybe=0)(4 bytes) + '\n' + section_body_2 + '\n'
- //possible sections: column formulas, __WIPR, __WIOTN, __LayerInfoStorage
- //section name(column name in formula case) starts with 0x46 position
- while(1)
- {
- //section_header_size=0x6F(4 bytes) + '\n'
- LAYER+=0x5;
-
- //section_header
- fseek(f,LAYER+0x46,SEEK_SET);
+ LAYER += 0x5;
+ CHECKED_FSEEK(debug, f, LAYER + 0x2B, SEEK_SET);
+ short w = 0;
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ MATRIX[idx].nr_cols = w;
+ CHECKED_FSEEK(debug, f, LAYER + 0x52, SEEK_SET);
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ MATRIX[idx].nr_rows = w;
+
+ LAYER += 0x12D + 0x1;
+ // now structure is next : section_header_size=0x6F(4 bytes) + '\n' +
+ // section_header(0x6F bytes) + section_body_1_size(4 bytes) + '\n' +
+ // section_body_1 + section_body_2_size(maybe=0)(4 bytes) + '\n' +
+ // section_body_2 + '\n'
+ // possible sections: column formulas, __WIPR, __WIOTN, __LayerInfoStorage
+ // section name(column name in formula case) starts with 0x46 position
+ while (1) {
+ // section_header_size=0x6F(4 bytes) + '\n'
+ LAYER += 0x5;
+
+ // section_header
+ CHECKED_FSEEK(debug, f, LAYER + 0x46, SEEK_SET);
char sec_name[42];
- sec_name[41]='\0';
- fread(&sec_name,41,1,f);
+ sec_name[41] = '\0';
+ CHECKED_FREAD(debug, &sec_name, 41, 1, f);
- //section_body_1_size
- LAYER+=0x6F+0x1;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
+ // section_body_1_size
+ LAYER += 0x6F + 0x1;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
if (INT_MAX == sec_size) {
// this would end in an overflow for new[] below and it's obviously wrong
- fprintf(debug, "Error: while reading matrix info, found section size: %d\n", sec_size);
+ fprintf(debug,
+ "Error: while reading matrix info, found section size: %d\n",
+ sec_size);
fflush(debug);
}
- //section_body_1
- LAYER+=0x5;
- //check if it is a formula
- if(0==strcmp(sec_name,"MV"))
- {
- fseek(f,LAYER,SEEK_SET);
- char *stmp=new char[sec_size+1];
- stmp[sec_size]='\0';
- fread(stmp,sec_size,1,f);
- MATRIX[idx].command=stmp;
- delete [] stmp;
+ if (file_size < sec_size) {
+ fprintf(debug, "Error in readMatrix: found section size (%d) bigger than "
+ "total file size: %d\n",
+ sec_size, file_size);
+ fflush(debug);
+ return;
}
- //section_body_2_size
- LAYER+=sec_size+0x1;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
+ // section_body_1
+ LAYER += 0x5;
+ // check if it is a formula
+ if (0 == strcmp(sec_name, "MV")) {
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ char *stmp = new char[sec_size + 1];
+ stmp[sec_size] = '\0';
+ CHECKED_FREAD(debug, stmp, sec_size, 1, f);
+ MATRIX[idx].command = stmp;
+ delete[] stmp;
+ }
- //section_body_2
- LAYER+=0x5;
+ // section_body_2_size
+ LAYER += sec_size + 0x1;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
- //close section 00 00 00 00 0A
- LAYER+=sec_size+(sec_size>0?0x1:0)+0x5;
+ // section_body_2
+ LAYER += 0x5;
- if(0==strcmp(sec_name,"__LayerInfoStorage"))
- break;
+ // close section 00 00 00 00 0A
+ LAYER += sec_size + (sec_size > 0 ? 0x1 : 0) + 0x5;
+ if (0 == strcmp(sec_name, "__LayerInfoStorage"))
+ break;
}
- LAYER+=0x5;
-
- while(1)
- {
- LAYER+=0x5;
-
- short width=0;
- fseek(f,LAYER+0x2B, SEEK_SET);
- fread(&width,2,1,f);
- if(IsBigEndian()) SwapBytes(width);
- width=short((width-55)/0xA);
- if(width==0)
- width=8;
- MATRIX[idx].width=width;
- fseek(f,LAYER+0x1E, SEEK_SET);
- unsigned char c1,c2;
- fread(&c1,1,1,f);
- fread(&c2,1,1,f);
-
- MATRIX[idx].value_type_specification=c1/0x10;
- if(c2>=0x80)
- {
- MATRIX[idx].significant_digits=c2-0x80;
- MATRIX[idx].numeric_display_type=2;
- }
- else if(c2>0)
- {
- MATRIX[idx].decimal_places=c2-0x03;
- MATRIX[idx].numeric_display_type=1;
+ LAYER += 0x5;
+
+ while (1) {
+ LAYER += 0x5;
+
+ short width = 0;
+ CHECKED_FSEEK(debug, f, LAYER + 0x2B, SEEK_SET);
+ CHECKED_FREAD(debug, &width, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(width);
+ width = short((width - 55) / 0xA);
+ if (width == 0)
+ width = 8;
+ MATRIX[idx].width = width;
+ CHECKED_FSEEK(debug, f, LAYER + 0x1E, SEEK_SET);
+ unsigned char c1, c2;
+ CHECKED_FREAD(debug, &c1, 1, 1, f);
+ CHECKED_FREAD(debug, &c2, 1, 1, f);
+
+ MATRIX[idx].value_type_specification = c1 / 0x10;
+ if (c2 >= 0x80) {
+ MATRIX[idx].significant_digits = c2 - 0x80;
+ MATRIX[idx].numeric_display_type = 2;
+ } else if (c2 > 0) {
+ MATRIX[idx].decimal_places = c2 - 0x03;
+ MATRIX[idx].numeric_display_type = 1;
}
- LAYER+=0x1E7+0x1;
- fseek(f,LAYER,SEEK_SET);
- int comm_size=0;
- fread(&comm_size,4,1,f);
- if(IsBigEndian()) SwapBytes(comm_size);
- LAYER+=0x5;
- if(comm_size>0)
- {
- LAYER+=comm_size+0x1;
+ LAYER += 0x1E7 + 0x1;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ int comm_size = 0;
+ CHECKED_FREAD(debug, &comm_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(comm_size);
+ LAYER += 0x5;
+ if (comm_size > 0) {
+ LAYER += comm_size + 0x1;
}
- fseek(f,LAYER,SEEK_SET);
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
int ntmp;
- fread(&ntmp,4,1,f);
- if(IsBigEndian()) SwapBytes(ntmp);
- if(ntmp!=0x1E7)
+ CHECKED_FREAD(debug, &ntmp, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(ntmp);
+ if (ntmp != 0x1E7)
break;
}
- LAYER+=0x5*0x5+0x1ED*0x12;
- POS = LAYER+0x5;
+ LAYER += 0x5 * 0x5 + 0x1ED * 0x12;
+ POS = LAYER + 0x5;
- fseek(f,POS,SEEK_SET);
+ CHECKED_FSEEK(debug, f, POS, SEEK_SET);
}
-
-void OPJFile::readGraphInfo(FILE *f, FILE *debug)
-{
- int POS=int(ftell(f));
+void OPJFile::readGraphInfo(FILE *f, int file_size, FILE *debug) {
+ int POS = int(ftell(f));
int headersize;
- fread(&headersize,4,1,f);
- if(IsBigEndian()) SwapBytes(headersize);
- POS+=5;
+ CHECKED_FREAD(debug, &headersize, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(headersize);
+ POS += 5;
- fprintf(debug," [Graph SECTION (@ 0x%X)]\n",POS);
+ fprintf(debug, " [Graph SECTION (@ 0x%X)]\n", POS);
fflush(debug);
char name[25];
- fseek(f,POS + 0x2,SEEK_SET);
- fread(&name,25,1,f);
+ CHECKED_FSEEK(debug, f, POS + 0x2, SEEK_SET);
+ CHECKED_FREAD(debug, &name, 25, 1, f);
GRAPH.push_back(graph(name));
readWindowProperties(GRAPH.back(), f, debug, POS, headersize);
- //char c = 0;
+ // char c = 0;
unsigned short graph_width;
- fseek(f,POS + 0x23,SEEK_SET);
- fread(&graph_width,2,1,f);
- if(IsBigEndian()) SwapBytes(graph_width);
+ CHECKED_FSEEK(debug, f, POS + 0x23, SEEK_SET);
+ CHECKED_FREAD(debug, &graph_width, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(graph_width);
GRAPH.back().width = graph_width;
unsigned short graph_height;
- fread(&graph_height,2,1,f);
- if(IsBigEndian()) SwapBytes(graph_height);
+ CHECKED_FREAD(debug, &graph_height, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(graph_height);
GRAPH.back().height = graph_height;
int LAYER = POS;
LAYER += headersize + 0x1;
int sec_size;
- while(1)// multilayer loop
+ while (1) // multilayer loop
{
GRAPH.back().layer.push_back(graphLayer());
// LAYER section
- LAYER +=0x5;
- double range=0.0;
- unsigned char m=0;
- fseek(f, LAYER+0xF, SEEK_SET);
- fread(&range,8,1,f);
- if(IsBigEndian()) SwapBytes(range);
- GRAPH.back().layer.back().xAxis.min=range;
- fread(&range,8,1,f);
- if(IsBigEndian()) SwapBytes(range);
- GRAPH.back().layer.back().xAxis.max=range;
- fread(&range,8,1,f);
- if(IsBigEndian()) SwapBytes(range);
- GRAPH.back().layer.back().xAxis.step=range;
- fseek(f, LAYER+0x2B, SEEK_SET);
- fread(&m,1,1,f);
- GRAPH.back().layer.back().xAxis.majorTicks=m;
- fseek(f, LAYER+0x37, SEEK_SET);
- fread(&m,1,1,f);
- GRAPH.back().layer.back().xAxis.minorTicks=m;
- fread(&m,1,1,f);
- GRAPH.back().layer.back().xAxis.scale=m;
-
- fseek(f, LAYER+0x3A, SEEK_SET);
- fread(&range,8,1,f);
- if(IsBigEndian()) SwapBytes(range);
- GRAPH.back().layer.back().yAxis.min=range;
- fread(&range,8,1,f);
- if(IsBigEndian()) SwapBytes(range);
- GRAPH.back().layer.back().yAxis.max=range;
- fread(&range,8,1,f);
- if(IsBigEndian()) SwapBytes(range);
- GRAPH.back().layer.back().yAxis.step=range;
- fseek(f, LAYER+0x56, SEEK_SET);
- fread(&m,1,1,f);
- GRAPH.back().layer.back().yAxis.majorTicks=m;
- fseek(f, LAYER+0x62, SEEK_SET);
- fread(&m,1,1,f);
- GRAPH.back().layer.back().yAxis.minorTicks=m;
- fread(&m,1,1,f);
- GRAPH.back().layer.back().yAxis.scale=m;
+ LAYER += 0x5;
+ double range = 0.0;
+ unsigned char m = 0;
+ CHECKED_FSEEK(debug, f, LAYER + 0xF, SEEK_SET);
+ CHECKED_FREAD(debug, &range, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(range);
+ GRAPH.back().layer.back().xAxis.min = range;
+ CHECKED_FREAD(debug, &range, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(range);
+ GRAPH.back().layer.back().xAxis.max = range;
+ CHECKED_FREAD(debug, &range, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(range);
+ GRAPH.back().layer.back().xAxis.step = range;
+ CHECKED_FSEEK(debug, f, LAYER + 0x2B, SEEK_SET);
+ CHECKED_FREAD(debug, &m, 1, 1, f);
+ GRAPH.back().layer.back().xAxis.majorTicks = m;
+ CHECKED_FSEEK(debug, f, LAYER + 0x37, SEEK_SET);
+ CHECKED_FREAD(debug, &m, 1, 1, f);
+ GRAPH.back().layer.back().xAxis.minorTicks = m;
+ CHECKED_FREAD(debug, &m, 1, 1, f);
+ GRAPH.back().layer.back().xAxis.scale = m;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x3A, SEEK_SET);
+ CHECKED_FREAD(debug, &range, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(range);
+ GRAPH.back().layer.back().yAxis.min = range;
+ CHECKED_FREAD(debug, &range, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(range);
+ GRAPH.back().layer.back().yAxis.max = range;
+ CHECKED_FREAD(debug, &range, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(range);
+ GRAPH.back().layer.back().yAxis.step = range;
+ CHECKED_FSEEK(debug, f, LAYER + 0x56, SEEK_SET);
+ CHECKED_FREAD(debug, &m, 1, 1, f);
+ GRAPH.back().layer.back().yAxis.majorTicks = m;
+ CHECKED_FSEEK(debug, f, LAYER + 0x62, SEEK_SET);
+ CHECKED_FREAD(debug, &m, 1, 1, f);
+ GRAPH.back().layer.back().yAxis.minorTicks = m;
+ CHECKED_FREAD(debug, &m, 1, 1, f);
+ GRAPH.back().layer.back().yAxis.scale = m;
rect r;
- fseek(f, LAYER+0x71, SEEK_SET);
- fread(&r,sizeof(rect),1,f);
- if(IsBigEndian()) SwapBytes(r);
- GRAPH.back().layer.back().clientRect=r;
+ CHECKED_FSEEK(debug, f, LAYER + 0x71, SEEK_SET);
+ CHECKED_FREAD(debug, &r, sizeof(rect), 1, f);
+ if (IsBigEndian())
+ SwapBytes(r);
+ GRAPH.back().layer.back().clientRect = r;
LAYER += 0x12D + 0x1;
- //now structure is next : section_header_size=0x6F(4 bytes) + '\n' + section_header(0x6F bytes) + section_body_1_size(4 bytes) + '\n' + section_body_1 + section_body_2_size(maybe=0)(4 bytes) + '\n' + section_body_2 + '\n'
- //possible sections: axes, legend, __BC02, _202, _231, _232, __LayerInfoStorage etc
- //section name starts with 0x46 position
- while(1)
- {
- //section_header_size=0x6F(4 bytes) + '\n'
- LAYER+=0x5;
-
- //section_header
- fseek(f,LAYER+0x46,SEEK_SET);
+ // now structure is next : section_header_size=0x6F(4 bytes) + '\n' +
+ // section_header(0x6F bytes) + section_body_1_size(4 bytes) + '\n' +
+ // section_body_1 + section_body_2_size(maybe=0)(4 bytes) + '\n' +
+ // section_body_2 + '\n'
+ // possible sections: axes, legend, __BC02, _202, _231, _232,
+ // __LayerInfoStorage etc
+ // section name starts with 0x46 position
+ while (1) {
+ // section_header_size=0x6F(4 bytes) + '\n'
+ LAYER += 0x5;
+
+ // section_header
+ CHECKED_FSEEK(debug, f, LAYER + 0x46, SEEK_SET);
char sec_name[42];
- sec_name[41]='\0';
- fread(&sec_name,41,1,f);
-
- fseek(f, LAYER+0x3, SEEK_SET);
- fread(&r,sizeof(rect),1,f);
- if(IsBigEndian()) SwapBytes(r);
-
- unsigned char attach=0;
- fseek(f,LAYER+0x28,SEEK_SET);
- fread(&attach,1,1,f);
-
- unsigned char border=0;
- fseek(f, LAYER+0x29, SEEK_SET);
- fread(&border,1,1,f);
-
- unsigned char color=0;
- fseek(f,LAYER+0x33,SEEK_SET);
- fread(&color,1,1,f);
-
- //section_body_1_size
- LAYER+=0x6F+0x1;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
-
- //section_body_1
- LAYER+=0x5;
- int size=sec_size;
-
- unsigned char type=0;
- fseek(f,LAYER,SEEK_SET);
- fread(&type,1,1,f);
-
- //text properties
- short rotation=0;
- fseek(f,LAYER+2,SEEK_SET);
- fread(&rotation,2,1,f);
- if(IsBigEndian()) SwapBytes(rotation);
-
- unsigned char fontsize=0;
- fread(&fontsize,1,1,f);
-
- unsigned char tab=0;
- fseek(f,LAYER+0xA,SEEK_SET);
- fread(&tab,1,1,f);
-
- //line properties
+ sec_name[41] = '\0';
+ CHECKED_FREAD(debug, &sec_name, 41, 1, f);
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x3, SEEK_SET);
+ CHECKED_FREAD(debug, &r, sizeof(rect), 1, f);
+ if (IsBigEndian())
+ SwapBytes(r);
+
+ unsigned char attach = 0;
+ CHECKED_FSEEK(debug, f, LAYER + 0x28, SEEK_SET);
+ CHECKED_FREAD(debug, &attach, 1, 1, f);
+
+ unsigned char border = 0;
+ CHECKED_FSEEK(debug, f, LAYER + 0x29, SEEK_SET);
+ CHECKED_FREAD(debug, &border, 1, 1, f);
+
+ unsigned char color = 0;
+ CHECKED_FSEEK(debug, f, LAYER + 0x33, SEEK_SET);
+ CHECKED_FREAD(debug, &color, 1, 1, f);
+
+ // section_body_1_size
+ LAYER += 0x6F + 0x1;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
+
+ // section_body_1
+ LAYER += 0x5;
+ int size = sec_size;
+
+ unsigned char type = 0;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &type, 1, 1, f);
+
+ // text properties
+ short rotation = 0;
+ CHECKED_FSEEK(debug, f, LAYER + 2, SEEK_SET);
+ CHECKED_FREAD(debug, &rotation, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(rotation);
+
+ unsigned char fontsize = 0;
+ CHECKED_FREAD(debug, &fontsize, 1, 1, f);
+
+ unsigned char tab = 0;
+ CHECKED_FSEEK(debug, f, LAYER + 0xA, SEEK_SET);
+ CHECKED_FREAD(debug, &tab, 1, 1, f);
+
+ // line properties
unsigned char line_style = 0;
double width = 0.0;
lineVertex begin, end;
unsigned int w = 0;
- fseek(f,LAYER+0x12,SEEK_SET);
- fread(&line_style,1,1,f);
-
- fseek(f,LAYER+0x13,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- width = (double)w/500.0;
-
- fseek(f,LAYER+0x20,SEEK_SET);
- fread(&begin.x,8,1,f);
- if(IsBigEndian()) SwapBytes(begin.x);
-
- fread(&end.x,8,1,f);
- if(IsBigEndian()) SwapBytes(end.x);
-
- fseek(f,LAYER+0x40,SEEK_SET);
- fread(&begin.y,8,1,f);
- if(IsBigEndian()) SwapBytes(begin.y);
-
- fread(&end.y,8,1,f);
- if(IsBigEndian()) SwapBytes(end.y);
-
- fseek(f,LAYER+0x60,SEEK_SET);
- fread(&begin.shape_type,1,1,f);
-
- fseek(f,LAYER+0x64,SEEK_SET);
- fread(&w,4,1,f);
- if(IsBigEndian()) SwapBytes(w);
- begin.shape_width = (double)w/500.0;
-
- fread(&w,4,1,f);
- if(IsBigEndian()) SwapBytes(w);
- begin.shape_length = (double)w/500.0;
-
- fseek(f,LAYER+0x6C,SEEK_SET);
- fread(&end.shape_type,1,1,f);
-
- fseek(f,LAYER+0x70,SEEK_SET);
- fread(&w,4,1,f);
- if(IsBigEndian()) SwapBytes(w);
- end.shape_width = (double)w/500.0;
-
- fread(&w,4,1,f);
- if(IsBigEndian()) SwapBytes(w);
- end.shape_length = (double)w/500.0;
+ CHECKED_FSEEK(debug, f, LAYER + 0x12, SEEK_SET);
+ CHECKED_FREAD(debug, &line_style, 1, 1, f);
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x13, SEEK_SET);
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ width = (double)w / 500.0;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x20, SEEK_SET);
+ CHECKED_FREAD(debug, &begin.x, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(begin.x);
+
+ CHECKED_FREAD(debug, &end.x, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(end.x);
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x40, SEEK_SET);
+ CHECKED_FREAD(debug, &begin.y, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(begin.y);
+
+ CHECKED_FREAD(debug, &end.y, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(end.y);
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x60, SEEK_SET);
+ CHECKED_FREAD(debug, &begin.shape_type, 1, 1, f);
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x64, SEEK_SET);
+ CHECKED_FREAD(debug, &w, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ begin.shape_width = (double)w / 500.0;
+
+ CHECKED_FREAD(debug, &w, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ begin.shape_length = (double)w / 500.0;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x6C, SEEK_SET);
+ CHECKED_FREAD(debug, &end.shape_type, 1, 1, f);
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x70, SEEK_SET);
+ CHECKED_FREAD(debug, &w, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ end.shape_width = (double)w / 500.0;
+
+ CHECKED_FREAD(debug, &w, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ end.shape_length = (double)w / 500.0;
// bitmap properties
short bitmap_width = 0;
- fseek(f,LAYER+0x1,SEEK_SET);
- fread(&bitmap_width,2,1,f);
- if(IsBigEndian()) SwapBytes(bitmap_width);
+ CHECKED_FSEEK(debug, f, LAYER + 0x1, SEEK_SET);
+ CHECKED_FREAD(debug, &bitmap_width, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(bitmap_width);
short bitmap_height = 0;
- fread(&bitmap_height,2,1,f);
- if(IsBigEndian()) SwapBytes(bitmap_height);
+ CHECKED_FREAD(debug, &bitmap_height, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(bitmap_height);
double bitmap_left = 0.0;
- fseek(f,LAYER+0x13,SEEK_SET);
- fread(&bitmap_left,8,1,f);
- if(IsBigEndian()) SwapBytes(bitmap_left);
+ CHECKED_FSEEK(debug, f, LAYER + 0x13, SEEK_SET);
+ CHECKED_FREAD(debug, &bitmap_left, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(bitmap_left);
double bitmap_top = 0.0;
- fseek(f,LAYER+0x1B,SEEK_SET);
- fread(&bitmap_top,8,1,f);
- if(IsBigEndian()) SwapBytes(bitmap_top);
-
- //section_body_2_size
- LAYER+=sec_size+0x1;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
-
- //section_body_2
- LAYER+=0x5;
- //check if it is a axis or legend
- fseek(f,1,SEEK_CUR);
+ CHECKED_FSEEK(debug, f, LAYER + 0x1B, SEEK_SET);
+ CHECKED_FREAD(debug, &bitmap_top, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(bitmap_top);
+
+ // section_body_2_size
+ LAYER += sec_size + 0x1;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
+
+ if (file_size < sec_size) {
+ fprintf(debug, "Error in readGraph: found section size (%d) bigger "
+ "than total file size: %d\n",
+ sec_size, file_size);
+ fflush(debug);
+ return;
+ }
+
+ // section_body_2
+ LAYER += 0x5;
+ // check if it is a axis or legend
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
char stmp[255];
- if(0==strcmp(sec_name,"XB"))
- {
- stmp[sec_size]='\0';
- fread(&stmp,sec_size,1,f);
+ if (0 == strcmp(sec_name, "XB")) {
+ stmp[sec_size] = '\0';
+ CHECKED_FREAD(debug, &stmp, sec_size, 1, f);
GRAPH.back().layer.back().xAxis.pos = Bottom;
- GRAPH.back().layer.back().xAxis.label = text(stmp, r, color, fontsize, rotation/10, tab, (border >= 0x80 ? border-0x80 : None), attach);
- }
- else if(0==strcmp(sec_name,"XT"))
- {
- stmp[sec_size]='\0';
- fread(&stmp,sec_size,1,f);
- GRAPH.back().layer.back().xAxis.pos=Top;
- GRAPH.back().layer.back().xAxis.label = text(stmp, r, color, fontsize, rotation/10, tab, (border >= 0x80 ? border-0x80 : None), attach);
- }
- else if(0==strcmp(sec_name,"YL"))
- {
- stmp[sec_size]='\0';
- fread(&stmp,sec_size,1,f);
+ GRAPH.back().layer.back().xAxis.label =
+ text(stmp, r, color, fontsize, rotation / 10, tab,
+ (border >= 0x80 ? border - 0x80 : None), attach);
+ } else if (0 == strcmp(sec_name, "XT")) {
+ stmp[sec_size] = '\0';
+ CHECKED_FREAD(debug, &stmp, sec_size, 1, f);
+ GRAPH.back().layer.back().xAxis.pos = Top;
+ GRAPH.back().layer.back().xAxis.label =
+ text(stmp, r, color, fontsize, rotation / 10, tab,
+ (border >= 0x80 ? border - 0x80 : None), attach);
+ } else if (0 == strcmp(sec_name, "YL")) {
+ stmp[sec_size] = '\0';
+ CHECKED_FREAD(debug, &stmp, sec_size, 1, f);
GRAPH.back().layer.back().yAxis.pos = Left;
- GRAPH.back().layer.back().yAxis.label = text(stmp, r, color, fontsize, rotation/10, tab, (border >= 0x80 ? border-0x80 : None), attach);
- }
- else if(0==strcmp(sec_name,"YR"))
- {
- stmp[sec_size]='\0';
- fread(&stmp,sec_size,1,f);
+ GRAPH.back().layer.back().yAxis.label =
+ text(stmp, r, color, fontsize, rotation / 10, tab,
+ (border >= 0x80 ? border - 0x80 : None), attach);
+ } else if (0 == strcmp(sec_name, "YR")) {
+ stmp[sec_size] = '\0';
+ CHECKED_FREAD(debug, &stmp, sec_size, 1, f);
GRAPH.back().layer.back().yAxis.pos = Right;
- GRAPH.back().layer.back().yAxis.label = text(stmp, r, color, fontsize, rotation/10, tab, (border >= 0x80 ? border-0x80 : None), attach);
- }
- else if(0==strcmp(sec_name,"Legend"))
- {
- stmp[sec_size]='\0';
- fread(&stmp,sec_size,1,f);
- GRAPH.back().layer.back().legend = text(stmp, r, color, fontsize, rotation/10, tab, (border >= 0x80 ? border-0x80 : None), attach);
- }
- else if(0==strcmp(sec_name,"__BCO2")) // histogram
+ GRAPH.back().layer.back().yAxis.label =
+ text(stmp, r, color, fontsize, rotation / 10, tab,
+ (border >= 0x80 ? border - 0x80 : None), attach);
+ } else if (0 == strcmp(sec_name, "Legend")) {
+ stmp[sec_size] = '\0';
+ CHECKED_FREAD(debug, &stmp, sec_size, 1, f);
+ GRAPH.back().layer.back().legend =
+ text(stmp, r, color, fontsize, rotation / 10, tab,
+ (border >= 0x80 ? border - 0x80 : None), attach);
+ } else if (0 == strcmp(sec_name, "__BCO2")) // histogram
{
double d;
- fseek(f,LAYER+0x10,SEEK_SET);
- fread(&d,8,1,f);
- if(IsBigEndian()) SwapBytes(d);
- GRAPH.back().layer.back().histogram_bin=d;
- fseek(f,LAYER+0x20,SEEK_SET);
- fread(&d,8,1,f);
- if(IsBigEndian()) SwapBytes(d);
- GRAPH.back().layer.back().histogram_end=d;
- fseek(f,LAYER+0x28,SEEK_SET);
- fread(&d,8,1,f);
- if(IsBigEndian()) SwapBytes(d);
- GRAPH.back().layer.back().histogram_begin=d;
- }
- else if(size==0x3E) // text
+ CHECKED_FSEEK(debug, f, LAYER + 0x10, SEEK_SET);
+ CHECKED_FREAD(debug, &d, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(d);
+ GRAPH.back().layer.back().histogram_bin = d;
+ CHECKED_FSEEK(debug, f, LAYER + 0x20, SEEK_SET);
+ CHECKED_FREAD(debug, &d, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(d);
+ GRAPH.back().layer.back().histogram_end = d;
+ CHECKED_FSEEK(debug, f, LAYER + 0x28, SEEK_SET);
+ CHECKED_FREAD(debug, &d, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(d);
+ GRAPH.back().layer.back().histogram_begin = d;
+ } else if (size == 0x3E) // text
{
- stmp[sec_size]='\0';
- fread(&stmp,sec_size,1,f);
+ stmp[sec_size] = '\0';
+ CHECKED_FREAD(debug, &stmp, sec_size, 1, f);
GRAPH.back().layer.back().texts.push_back(text(stmp));
- GRAPH.back().layer.back().texts.back().color=color;
- GRAPH.back().layer.back().texts.back().clientRect=r;
- GRAPH.back().layer.back().texts.back().tab=tab;
- GRAPH.back().layer.back().texts.back().fontsize=fontsize;
- GRAPH.back().layer.back().texts.back().rotation=rotation/10;
- GRAPH.back().layer.back().texts.back().attach=attach;
- if(border>=0x80)
- GRAPH.back().layer.back().texts.back().border_type=border-0x80;
+ GRAPH.back().layer.back().texts.back().color = color;
+ GRAPH.back().layer.back().texts.back().clientRect = r;
+ GRAPH.back().layer.back().texts.back().tab = tab;
+ GRAPH.back().layer.back().texts.back().fontsize = fontsize;
+ GRAPH.back().layer.back().texts.back().rotation = rotation / 10;
+ GRAPH.back().layer.back().texts.back().attach = attach;
+ if (border >= 0x80)
+ GRAPH.back().layer.back().texts.back().border_type = border - 0x80;
else
- GRAPH.back().layer.back().texts.back().border_type=None;
- }
- else if(size==0x78 && type==2) // line
+ GRAPH.back().layer.back().texts.back().border_type = None;
+ } else if (size == 0x78 && type == 2) // line
{
GRAPH.back().layer.back().lines.push_back(line());
- GRAPH.back().layer.back().lines.back().color=color;
- GRAPH.back().layer.back().lines.back().clientRect=r;
- GRAPH.back().layer.back().lines.back().attach=attach;
- GRAPH.back().layer.back().lines.back().width=width;
- GRAPH.back().layer.back().lines.back().line_style=line_style;
- GRAPH.back().layer.back().lines.back().begin=begin;
- GRAPH.back().layer.back().lines.back().end=end;
- }
- else if(size==0x28 && type==4) // bitmap
+ GRAPH.back().layer.back().lines.back().color = color;
+ GRAPH.back().layer.back().lines.back().clientRect = r;
+ GRAPH.back().layer.back().lines.back().attach = attach;
+ GRAPH.back().layer.back().lines.back().width = width;
+ GRAPH.back().layer.back().lines.back().line_style = line_style;
+ GRAPH.back().layer.back().lines.back().begin = begin;
+ GRAPH.back().layer.back().lines.back().end = end;
+ } else if (size == 0x28 && type == 4) // bitmap
{
- unsigned long filesize=sec_size+14;
+ unsigned long filesize = sec_size + 14;
GRAPH.back().layer.back().bitmaps.push_back(bitmap());
- GRAPH.back().layer.back().bitmaps.back().left=bitmap_left;
- GRAPH.back().layer.back().bitmaps.back().top=bitmap_top;
- GRAPH.back().layer.back().bitmaps.back().width=
- (GRAPH.back().layer.back().xAxis.max - GRAPH.back().layer.back().xAxis.min)*bitmap_width/10000;
- GRAPH.back().layer.back().bitmaps.back().height=
- (GRAPH.back().layer.back().yAxis.max - GRAPH.back().layer.back().yAxis.min)*bitmap_height/10000;
- GRAPH.back().layer.back().bitmaps.back().attach=attach;
- GRAPH.back().layer.back().bitmaps.back().size=filesize;
- GRAPH.back().layer.back().bitmaps.back().data=new unsigned char[filesize];
- unsigned char *data=GRAPH.back().layer.back().bitmaps.back().data;
- //add Bitmap header
+ GRAPH.back().layer.back().bitmaps.back().left = bitmap_left;
+ GRAPH.back().layer.back().bitmaps.back().top = bitmap_top;
+ GRAPH.back().layer.back().bitmaps.back().width =
+ (GRAPH.back().layer.back().xAxis.max -
+ GRAPH.back().layer.back().xAxis.min) *
+ bitmap_width / 10000;
+ GRAPH.back().layer.back().bitmaps.back().height =
+ (GRAPH.back().layer.back().yAxis.max -
+ GRAPH.back().layer.back().yAxis.min) *
+ bitmap_height / 10000;
+ GRAPH.back().layer.back().bitmaps.back().attach = attach;
+ GRAPH.back().layer.back().bitmaps.back().size = filesize;
+ GRAPH.back().layer.back().bitmaps.back().data =
+ new unsigned char[filesize];
+ unsigned char *data = GRAPH.back().layer.back().bitmaps.back().data;
+ // add Bitmap header
memcpy(data, "BM", 2);
- data+=2;
+ data += 2;
memcpy(data, &filesize, 4);
- data+=4;
- unsigned int d=0;
+ data += 4;
+ unsigned int d = 0;
memcpy(data, &d, 4);
- data+=4;
- d=0x36;
+ data += 4;
+ d = 0x36;
memcpy(data, &d, 4);
- data+=4;
- fread(data,sec_size,1,f);
+ data += 4;
+ CHECKED_FREAD(debug, data, sec_size, 1, f);
}
- //close section 00 00 00 00 0A
- LAYER+=sec_size+(sec_size>0?0x1:0);
+ // close section 00 00 00 00 0A
+ LAYER += sec_size + (sec_size > 0 ? 0x1 : 0);
- //section_body_3_size
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
+ // section_body_3_size
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
- //section_body_3
- LAYER+=0x5;
+ // section_body_3
+ LAYER += 0x5;
- //close section 00 00 00 00 0A
- LAYER+=sec_size+(sec_size>0?0x1:0);
+ // close section 00 00 00 00 0A
+ LAYER += sec_size + (sec_size > 0 ? 0x1 : 0);
- if(0==strcmp(sec_name,"__LayerInfoStorage"))
+ if (0 == strcmp(sec_name, "__LayerInfoStorage"))
break;
-
}
- LAYER+=0x5;
+ LAYER += 0x5;
unsigned char h;
short w;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
- if(sec_size==0x1E7)//check layer is not empty
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
+ if (sec_size == 0x1E7) // check layer is not empty
{
- while(1)
- {
- LAYER+=0x5;
+ while (1) {
+ LAYER += 0x5;
graphCurve curve;
vector<string> col;
- fseek(f,LAYER+0x4,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- col=findDataByIndex(w-1);
+ CHECKED_FSEEK(debug, f, LAYER + 0x4, SEEK_SET);
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ col = findDataByIndex(w - 1);
short nColY = w;
- if(col.size()>0)
- {
- fprintf(debug," GRAPH %zu layer %zu curve %zu Y : %s.%s\n",GRAPH.size(),GRAPH.back().layer.size(),GRAPH.back().layer.back().curve.size(),col[1].c_str(),col[0].c_str());
+ if (col.size() > 0) {
+ fprintf(debug, " GRAPH %zu layer %zu curve %zu Y : %s.%s\n",
+ GRAPH.size(), GRAPH.back().layer.size(),
+ GRAPH.back().layer.back().curve.size(), col[1].c_str(),
+ col[0].c_str());
fflush(debug);
- curve.yColName=col[0];
- curve.dataName=col[1];
+ curve.yColName = col[0];
+ curve.dataName = col[1];
}
- fseek(f,LAYER+0x23,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- col=findDataByIndex(w-1);
- if(col.size()>0)
- {
- fprintf(debug," GRAPH %zu layer %zu curve %zu X : %s.%s\n",GRAPH.size(),GRAPH.back().layer.size(),GRAPH.back().layer.back().curve.size(),col[1].c_str(),col[0].c_str());
+ CHECKED_FSEEK(debug, f, LAYER + 0x23, SEEK_SET);
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ col = findDataByIndex(w - 1);
+ if (col.size() > 0) {
+ fprintf(debug, " GRAPH %zu layer %zu curve %zu X : %s.%s\n",
+ GRAPH.size(), GRAPH.back().layer.size(),
+ GRAPH.back().layer.back().curve.size(), col[1].c_str(),
+ col[0].c_str());
fflush(debug);
- curve.xColName=col[0];
- if(curve.dataName!=col[1])
- fprintf(debug," GRAPH %zu X and Y from different tables\n",GRAPH.size());
+ curve.xColName = col[0];
+ if (curve.dataName != col[1])
+ fprintf(debug, " GRAPH %zu X and Y from different tables\n",
+ GRAPH.size());
}
- fseek(f,LAYER+0x4C,SEEK_SET);
- fread(&h,1,1,f);
- curve.type=h;
-
- fseek(f,LAYER+0x11,SEEK_SET);
- fread(&h,1,1,f);
- curve.line_connect=h;
-
- fseek(f,LAYER+0x12,SEEK_SET);
- fread(&h,1,1,f);
- curve.line_style=h;
-
- fseek(f,LAYER+0x15,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- curve.line_width=(double)w/500.0;
-
- fseek(f,LAYER+0x19,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- curve.symbol_size=(double)w/500.0;
-
- fseek(f,LAYER+0x1C,SEEK_SET);
- fread(&h,1,1,f);
- curve.fillarea=(h==2?true:false);
-
- fseek(f,LAYER+0x1E,SEEK_SET);
- fread(&h,1,1,f);
- curve.fillarea_type=h;
-
- //vector
- if(curve.type == FlowVector || curve.type == Vector)
- {
- fseek(f,LAYER+0x56,SEEK_SET);
- fread(&curve.vector.multiplier,4,1,f);
- if(IsBigEndian()) SwapBytes(curve.vector.multiplier);
-
- fseek(f,LAYER+0x5E,SEEK_SET);
- fread(&h,1,1,f);
- col=findDataByIndex(nColY - 1 + h - 0x64);
- if(col.size()>0)
- {
+ CHECKED_FSEEK(debug, f, LAYER + 0x4C, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.type = h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x11, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.line_connect = h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x12, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.line_style = h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x15, SEEK_SET);
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ curve.line_width = (double)w / 500.0;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x19, SEEK_SET);
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ curve.symbol_size = (double)w / 500.0;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x1C, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.fillarea = (h == 2 ? true : false);
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x1E, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.fillarea_type = h;
+
+ // vector
+ if (curve.type == FlowVector || curve.type == Vector) {
+ CHECKED_FSEEK(debug, f, LAYER + 0x56, SEEK_SET);
+ CHECKED_FREAD(debug, &curve.vector.multiplier, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(curve.vector.multiplier);
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x5E, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ col = findDataByIndex(nColY - 1 + h - 0x64);
+ if (col.size() > 0) {
curve.vector.endXColName = col[0];
}
- fseek(f,LAYER+0x62,SEEK_SET);
- fread(&h,1,1,f);
- col=findDataByIndex(nColY - 1 + h - 0x64);
- if(col.size()>0)
- {
+ CHECKED_FSEEK(debug, f, LAYER + 0x62, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ col = findDataByIndex(nColY - 1 + h - 0x64);
+ if (col.size() > 0) {
curve.vector.endYColName = col[0];
}
- fseek(f,LAYER+0x18,SEEK_SET);
- fread(&h,1,1,f);
- if(h >= 0x64)
- {
- col=findDataByIndex(nColY - 1 + h - 0x64);
- if(col.size()>0)
+ CHECKED_FSEEK(debug, f, LAYER + 0x18, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ if (h >= 0x64) {
+ col = findDataByIndex(nColY - 1 + h - 0x64);
+ if (col.size() > 0)
curve.vector.angleColName = col[0];
- }
- else if(h <= 0x08)
- {
- curve.vector.const_angle = 45*h;
+ } else if (h <= 0x08) {
+ curve.vector.const_angle = 45 * h;
}
- fseek(f,LAYER+0x19,SEEK_SET);
- fread(&h,1,1,f);
- if(h >= 0x64)
- {
- col=findDataByIndex(nColY - 1 + h - 0x64);
- if(col.size()>0)
+ CHECKED_FSEEK(debug, f, LAYER + 0x19, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ if (h >= 0x64) {
+ col = findDataByIndex(nColY - 1 + h - 0x64);
+ if (col.size() > 0)
curve.vector.magnitudeColName = col[0];
- }
- else
- {
+ } else {
curve.vector.const_magnitude = static_cast<int>(curve.symbol_size);
}
- fseek(f,LAYER+0x66,SEEK_SET);
- fread(&curve.vector.arrow_lenght,2,1,f);
- if(IsBigEndian()) SwapBytes(curve.vector.arrow_lenght);
+ CHECKED_FSEEK(debug, f, LAYER + 0x66, SEEK_SET);
+ CHECKED_FREAD(debug, &curve.vector.arrow_lenght, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(curve.vector.arrow_lenght);
- fread(&curve.vector.arrow_angle,1,1,f);
+ CHECKED_FREAD(debug, &curve.vector.arrow_angle, 1, 1, f);
- fread(&h,1,1,f);
- curve.vector.arrow_closed = !(h&0x1);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.vector.arrow_closed = !(h & 0x1);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- curve.vector.width=(double)w/500.0;
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ curve.vector.width = (double)w / 500.0;
- fseek(f,LAYER+0x142,SEEK_SET);
- fread(&h,1,1,f);
- switch(h)
- {
+ CHECKED_FSEEK(debug, f, LAYER + 0x142, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ switch (h) {
case 2:
curve.vector.position = Midpoint;
break;
case 4:
curve.vector.position = Head;
- break;
+ break;
default:
curve.vector.position = Tail;
- break;
+ break;
}
-
}
- //pie
- if(curve.type == Pie)
- {
- fseek(f,LAYER+0x92,SEEK_SET);
- fread(&h,1,1,f);
- curve.pie.format_percentages = (h&0x01);
- curve.pie.format_values = (h&0x02);
- curve.pie.position_associate = (h&0x08);
- curve.pie.clockwise_rotation = (h&0x20);
- curve.pie.format_categories = (h&0x80);
-
- fread(&h,1,1,f);
+ // pie
+ if (curve.type == Pie) {
+ CHECKED_FSEEK(debug, f, LAYER + 0x92, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.pie.format_percentages = (h & 0x01);
+ curve.pie.format_values = (h & 0x02);
+ curve.pie.position_associate = (h & 0x08);
+ curve.pie.clockwise_rotation = (h & 0x20);
+ curve.pie.format_categories = (h & 0x80);
+
+ CHECKED_FREAD(debug, &h, 1, 1, f);
curve.pie.format_automatic = h;
- fread(&curve.pie.distance,2,1,f);
- if(IsBigEndian()) SwapBytes(curve.pie.distance);
+ CHECKED_FREAD(debug, &curve.pie.distance, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(curve.pie.distance);
- fread(&curve.pie.view_angle,1,1,f);
+ CHECKED_FREAD(debug, &curve.pie.view_angle, 1, 1, f);
- fseek(f,LAYER+0x98,SEEK_SET);
- fread(&curve.pie.thickness,1,1,f);
+ CHECKED_FSEEK(debug, f, LAYER + 0x98, SEEK_SET);
+ CHECKED_FREAD(debug, &curve.pie.thickness, 1, 1, f);
- fseek(f,LAYER+0x9A,SEEK_SET);
- fread(&curve.pie.rotation,2,1,f);
- if(IsBigEndian()) SwapBytes(curve.pie.rotation);
+ CHECKED_FSEEK(debug, f, LAYER + 0x9A, SEEK_SET);
+ CHECKED_FREAD(debug, &curve.pie.rotation, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(curve.pie.rotation);
- fseek(f,LAYER+0x9E,SEEK_SET);
- fread(&curve.pie.displacement,2,1,f);
- if(IsBigEndian()) SwapBytes(curve.pie.displacement);
+ CHECKED_FSEEK(debug, f, LAYER + 0x9E, SEEK_SET);
+ CHECKED_FREAD(debug, &curve.pie.displacement, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(curve.pie.displacement);
- fseek(f,LAYER+0xA0,SEEK_SET);
- fread(&curve.pie.radius,2,1,f);
- if(IsBigEndian()) SwapBytes(curve.pie.radius);
+ CHECKED_FSEEK(debug, f, LAYER + 0xA0, SEEK_SET);
+ CHECKED_FREAD(debug, &curve.pie.radius, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(curve.pie.radius);
- fseek(f,LAYER+0xA2,SEEK_SET);
- fread(&curve.pie.horizontal_offset,2,1,f);
- if(IsBigEndian()) SwapBytes(curve.pie.horizontal_offset);
+ CHECKED_FSEEK(debug, f, LAYER + 0xA2, SEEK_SET);
+ CHECKED_FREAD(debug, &curve.pie.horizontal_offset, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(curve.pie.horizontal_offset);
- fseek(f,LAYER+0xA6,SEEK_SET);
- fread(&curve.pie.displaced_sections,4,1,f);
- if(IsBigEndian()) SwapBytes(curve.pie.displaced_sections);
+ CHECKED_FSEEK(debug, f, LAYER + 0xA6, SEEK_SET);
+ CHECKED_FREAD(debug, &curve.pie.displaced_sections, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(curve.pie.displaced_sections);
}
-
- fseek(f,LAYER+0xC2,SEEK_SET);
- fread(&h,1,1,f);
- curve.fillarea_color=h;
-
- fseek(f,LAYER+0xC3,SEEK_SET);
- fread(&h,1,1,f);
- curve.fillarea_first_color=h;
-
- fseek(f,LAYER+0xCE,SEEK_SET);
- fread(&h,1,1,f);
- curve.fillarea_pattern=h;
-
- fseek(f,LAYER+0xCA,SEEK_SET);
- fread(&h,1,1,f);
- curve.fillarea_pattern_color=h;
-
- fseek(f,LAYER+0xC6,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- curve.fillarea_pattern_width=(double)w/500.0;
-
- fseek(f,LAYER+0xCF,SEEK_SET);
- fread(&h,1,1,f);
- curve.fillarea_pattern_border_style=h;
-
- fseek(f,LAYER+0xD2,SEEK_SET);
- fread(&h,1,1,f);
- curve.fillarea_pattern_border_color=h;
-
- fseek(f,LAYER+0xD0,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- curve.fillarea_pattern_border_width=(double)w/500.0;
-
- fseek(f,LAYER+0x16A,SEEK_SET);
- fread(&h,1,1,f);
- curve.line_color=h;
-
- fseek(f,LAYER+0x17,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- curve.symbol_type=w;
-
- fseek(f,LAYER+0x12E,SEEK_SET);
- fread(&h,1,1,f);
- curve.symbol_fill_color=h;
-
- fseek(f,LAYER+0x132,SEEK_SET);
- fread(&h,1,1,f);
- curve.symbol_color=h;
- curve.vector.color=h;
-
- fseek(f,LAYER+0x136,SEEK_SET);
- fread(&h,1,1,f);
- curve.symbol_thickness=(h==255?1:h);
-
- fseek(f,LAYER+0x137,SEEK_SET);
- fread(&h,1,1,f);
- curve.point_offset=h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0xC2, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.fillarea_color = h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0xC3, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.fillarea_first_color = h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0xCE, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.fillarea_pattern = h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0xCA, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.fillarea_pattern_color = h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0xC6, SEEK_SET);
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ curve.fillarea_pattern_width = (double)w / 500.0;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0xCF, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.fillarea_pattern_border_style = h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0xD2, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.fillarea_pattern_border_color = h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0xD0, SEEK_SET);
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ curve.fillarea_pattern_border_width = (double)w / 500.0;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x16A, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.line_color = h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x17, SEEK_SET);
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ curve.symbol_type = w;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x12E, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.symbol_fill_color = h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x132, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.symbol_color = h;
+ curve.vector.color = h;
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x136, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.symbol_thickness = (h == 255 ? 1 : h);
+
+ CHECKED_FSEEK(debug, f, LAYER + 0x137, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ curve.point_offset = h;
GRAPH.back().layer.back().curve.push_back(curve);
- LAYER+=0x1E7+0x1;
- fseek(f,LAYER,SEEK_SET);
- int comm_size=0;
- fread(&comm_size,4,1,f);
- if(IsBigEndian()) SwapBytes(comm_size);
- LAYER+=0x5;
- if(comm_size>0)
- {
- LAYER+=comm_size+0x1;
+ LAYER += 0x1E7 + 0x1;
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ int comm_size = 0;
+ CHECKED_FREAD(debug, &comm_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(comm_size);
+ LAYER += 0x5;
+ if (comm_size > 0) {
+ LAYER += comm_size + 0x1;
}
- fseek(f,LAYER,SEEK_SET);
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
int ntmp;
- fread(&ntmp,4,1,f);
- if(IsBigEndian()) SwapBytes(ntmp);
- if(ntmp!=0x1E7)
+ CHECKED_FREAD(debug, &ntmp, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(ntmp);
+ if (ntmp != 0x1E7)
break;
}
-
}
- //LAYER+=0x5*0x5+0x1ED*0x12;
- //LAYER+=2*0x5;
-
- LAYER+=0x5;
- //read axis breaks
- while(1)
- {
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
- if(sec_size == 0x2D)
- {
- LAYER+=0x5;
- fseek(f,LAYER+2,SEEK_SET);
- fread(&h,1,1,f);
- if(h==2)
- {
- GRAPH.back().layer.back().xAxisBreak.minor_ticks_before = (unsigned char)(GRAPH.back().layer.back().xAxis.minorTicks);
- GRAPH.back().layer.back().xAxisBreak.scale_increment_before = GRAPH.back().layer.back().xAxis.step;
- readGraphAxisBreakInfo(GRAPH.back().layer.back().xAxisBreak, f, LAYER);
+ // LAYER+=0x5*0x5+0x1ED*0x12;
+ // LAYER+=2*0x5;
+
+ LAYER += 0x5;
+ // read axis breaks
+ while (1) {
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
+ if (sec_size == 0x2D) {
+ LAYER += 0x5;
+ CHECKED_FSEEK(debug, f, LAYER + 2, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ if (h == 2) {
+ GRAPH.back().layer.back().xAxisBreak.minor_ticks_before =
+ (unsigned char)(GRAPH.back().layer.back().xAxis.minorTicks);
+ GRAPH.back().layer.back().xAxisBreak.scale_increment_before =
+ GRAPH.back().layer.back().xAxis.step;
+ readGraphAxisBreakInfo(GRAPH.back().layer.back().xAxisBreak, f, debug,
+ LAYER);
+ } else if (h == 4) {
+ GRAPH.back().layer.back().yAxisBreak.minor_ticks_before =
+ (unsigned char)(GRAPH.back().layer.back().yAxis.minorTicks);
+ GRAPH.back().layer.back().yAxisBreak.scale_increment_before =
+ GRAPH.back().layer.back().yAxis.step;
+ readGraphAxisBreakInfo(GRAPH.back().layer.back().yAxisBreak, f, debug,
+ LAYER);
}
- else if(h==4)
- {
- GRAPH.back().layer.back().yAxisBreak.minor_ticks_before = (unsigned char)(GRAPH.back().layer.back().yAxis.minorTicks);
- GRAPH.back().layer.back().yAxisBreak.scale_increment_before = GRAPH.back().layer.back().yAxis.step;
- readGraphAxisBreakInfo(GRAPH.back().layer.back().yAxisBreak, f, LAYER);
- }
- LAYER+=0x2D + 0x1;
- }
- else
+ LAYER += 0x2D + 0x1;
+ } else
break;
}
- LAYER+=0x5;
-
-
- LAYER+=0x5;
- readGraphGridInfo(GRAPH.back().layer.back().xAxis.minorGrid, f, LAYER);
- LAYER+=0x1E7+1;
-
- LAYER+=0x5;
- readGraphGridInfo(GRAPH.back().layer.back().xAxis.majorGrid, f, LAYER);
- LAYER+=0x1E7+1;
-
- LAYER+=0x5;
- readGraphAxisTickLabelsInfo(GRAPH.back().layer.back().xAxis.tickAxis[0], f, LAYER);
- LAYER+=0x1E7+1;
-
- LAYER+=0x5;
- readGraphAxisFormatInfo(GRAPH.back().layer.back().xAxis.formatAxis[0], f, LAYER);
- LAYER+=0x1E7+1;
-
- LAYER+=0x5;
- readGraphAxisTickLabelsInfo(GRAPH.back().layer.back().xAxis.tickAxis[1], f, LAYER);
- LAYER+=0x1E7+1;
-
- LAYER+=0x5;
- readGraphAxisFormatInfo(GRAPH.back().layer.back().xAxis.formatAxis[1], f, LAYER);
- LAYER+=0x1E7+1;
-
- LAYER+=0x5;
-
-
- LAYER+=0x5;
- readGraphGridInfo(GRAPH.back().layer.back().yAxis.minorGrid, f, LAYER);
- LAYER+=0x1E7+1;
-
- LAYER+=0x5;
- readGraphGridInfo(GRAPH.back().layer.back().yAxis.majorGrid, f, LAYER);
- LAYER+=0x1E7+1;
-
- LAYER+=0x5;
- readGraphAxisTickLabelsInfo(GRAPH.back().layer.back().yAxis.tickAxis[0], f, LAYER);
- LAYER+=0x1E7+1;
-
- LAYER+=0x5;
- readGraphAxisFormatInfo(GRAPH.back().layer.back().yAxis.formatAxis[0], f, LAYER);
- LAYER+=0x1E7+1;
-
- LAYER+=0x5;
- readGraphAxisTickLabelsInfo(GRAPH.back().layer.back().yAxis.tickAxis[1], f, LAYER);
- LAYER+=0x1E7+1;
-
- LAYER+=0x5;
- readGraphAxisFormatInfo(GRAPH.back().layer.back().yAxis.formatAxis[1], f, LAYER);
- LAYER+=0x1E7+1;
-
- LAYER+=0x2*0x5+0x1ED*0x6;
-
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
- if(sec_size==0)
+ LAYER += 0x5;
+
+ LAYER += 0x5;
+ readGraphGridInfo(GRAPH.back().layer.back().xAxis.minorGrid, f, debug,
+ LAYER);
+ LAYER += 0x1E7 + 1;
+
+ LAYER += 0x5;
+ readGraphGridInfo(GRAPH.back().layer.back().xAxis.majorGrid, f, debug,
+ LAYER);
+ LAYER += 0x1E7 + 1;
+
+ LAYER += 0x5;
+ readGraphAxisTickLabelsInfo(GRAPH.back().layer.back().xAxis.tickAxis[0],
+ debug, f, LAYER);
+ LAYER += 0x1E7 + 1;
+
+ LAYER += 0x5;
+ readGraphAxisFormatInfo(GRAPH.back().layer.back().xAxis.formatAxis[0], f,
+ debug, LAYER);
+ LAYER += 0x1E7 + 1;
+
+ LAYER += 0x5;
+ readGraphAxisTickLabelsInfo(GRAPH.back().layer.back().xAxis.tickAxis[1],
+ debug, f, LAYER);
+ LAYER += 0x1E7 + 1;
+
+ LAYER += 0x5;
+ readGraphAxisFormatInfo(GRAPH.back().layer.back().xAxis.formatAxis[1],
+ debug, f, LAYER);
+ LAYER += 0x1E7 + 1;
+
+ LAYER += 0x5;
+
+ LAYER += 0x5;
+ readGraphGridInfo(GRAPH.back().layer.back().yAxis.minorGrid, f, debug,
+ LAYER);
+ LAYER += 0x1E7 + 1;
+
+ LAYER += 0x5;
+ readGraphGridInfo(GRAPH.back().layer.back().yAxis.majorGrid, f, debug,
+ LAYER);
+ LAYER += 0x1E7 + 1;
+
+ LAYER += 0x5;
+ readGraphAxisTickLabelsInfo(GRAPH.back().layer.back().yAxis.tickAxis[0], f,
+ debug, LAYER);
+ LAYER += 0x1E7 + 1;
+
+ LAYER += 0x5;
+ readGraphAxisFormatInfo(GRAPH.back().layer.back().yAxis.formatAxis[0], f,
+ debug, LAYER);
+ LAYER += 0x1E7 + 1;
+
+ LAYER += 0x5;
+ readGraphAxisTickLabelsInfo(GRAPH.back().layer.back().yAxis.tickAxis[1], f,
+ debug, LAYER);
+ LAYER += 0x1E7 + 1;
+
+ LAYER += 0x5;
+ readGraphAxisFormatInfo(GRAPH.back().layer.back().yAxis.formatAxis[1], f,
+ debug, LAYER);
+ LAYER += 0x1E7 + 1;
+
+ LAYER += 0x2 * 0x5 + 0x1ED * 0x6;
+
+ CHECKED_FSEEK(debug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(debug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
+ if (sec_size == 0)
break;
}
- POS = LAYER+0x5;
+ POS = LAYER + 0x5;
- fseek(f,POS,SEEK_SET);
+ CHECKED_FSEEK(debug, f, POS, SEEK_SET);
}
-void OPJFile::skipObjectInfo(FILE *f, FILE *)
-{
- int POS=int(ftell(f));
+void OPJFile::skipObjectInfo(FILE *f, FILE *fdebug) {
+ int POS = int(ftell(f));
int headersize;
- fread(&headersize,4,1,f);
- if(IsBigEndian()) SwapBytes(headersize);
- POS+=5;
+ CHECKED_FREAD(fdebug, &headersize, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(headersize);
+ POS += 5;
int LAYER = POS;
LAYER += headersize + 0x1;
int sec_size;
- while(1)// multilayer loop
+ while (1) // multilayer loop
{
// LAYER section
- LAYER +=0x5/* length of block = 0x12D + '\n'*/ + 0x12D + 0x1;
- //now structure is next : section_header_size=0x6F(4 bytes) + '\n' + section_header(0x6F bytes) + section_body_1_size(4 bytes) + '\n' + section_body_1 + section_body_2_size(maybe=0)(4 bytes) + '\n' + section_body_2 + '\n'
- //possible sections: column formulas, __WIPR, __WIOTN, __LayerInfoStorage
- //section name(column name in formula case) starts with 0x46 position
- while(1)
- {
- //section_header_size=0x6F(4 bytes) + '\n'
- LAYER+=0x5;
-
- //section_header
- fseek(f,LAYER+0x46,SEEK_SET);
+ LAYER += 0x5 /* length of block = 0x12D + '\n'*/ + 0x12D + 0x1;
+ // now structure is next : section_header_size=0x6F(4 bytes) + '\n' +
+ // section_header(0x6F bytes) + section_body_1_size(4 bytes) + '\n' +
+ // section_body_1 + section_body_2_size(maybe=0)(4 bytes) + '\n' +
+ // section_body_2 + '\n'
+ // possible sections: column formulas, __WIPR, __WIOTN, __LayerInfoStorage
+ // section name(column name in formula case) starts with 0x46 position
+ while (1) {
+ // section_header_size=0x6F(4 bytes) + '\n'
+ LAYER += 0x5;
+
+ // section_header
+ CHECKED_FSEEK(fdebug, f, LAYER + 0x46, SEEK_SET);
char sec_name[42];
- sec_name[41]='\0';
- fread(&sec_name,41,1,f);
+ sec_name[41] = '\0';
+ CHECKED_FREAD(fdebug, &sec_name, 41, 1, f);
- //section_body_1_size
- LAYER+=0x6F+0x1;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
+ // section_body_1_size
+ LAYER += 0x6F + 0x1;
+ CHECKED_FSEEK(fdebug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(fdebug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
- //section_body_1
- LAYER+=0x5;
+ // section_body_1
+ LAYER += 0x5;
- //section_body_2_size
- LAYER+=sec_size+0x1;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
+ // section_body_2_size
+ LAYER += sec_size + 0x1;
+ CHECKED_FSEEK(fdebug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(fdebug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
- //section_body_2
- LAYER+=0x5;
+ // section_body_2
+ LAYER += 0x5;
- //close section 00 00 00 00 0A
- LAYER+=sec_size+(sec_size>0?0x1:0);
+ // close section 00 00 00 00 0A
+ LAYER += sec_size + (sec_size > 0 ? 0x1 : 0);
- //section_body_3_size
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
+ // section_body_3_size
+ CHECKED_FSEEK(fdebug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(fdebug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
- //section_body_3
- LAYER+=0x5;
+ // section_body_3
+ LAYER += 0x5;
- //close section 00 00 00 00 0A
- LAYER+=sec_size+(sec_size>0?0x1:0);
+ // close section 00 00 00 00 0A
+ LAYER += sec_size + (sec_size > 0 ? 0x1 : 0);
- if(0==strcmp(sec_name,"__LayerInfoStorage"))
+ if (0 == strcmp(sec_name, "__LayerInfoStorage"))
break;
-
}
- LAYER+=0x5;
-
- while(1)
- {
- LAYER+=0x5;
-
- LAYER+=0x1E7+0x1;
- fseek(f,LAYER,SEEK_SET);
- int comm_size=0;
- fread(&comm_size,4,1,f);
- if(IsBigEndian()) SwapBytes(comm_size);
- LAYER+=0x5;
- if(comm_size>0)
- {
- LAYER+=comm_size+0x1;
+ LAYER += 0x5;
+
+ while (1) {
+ LAYER += 0x5;
+
+ LAYER += 0x1E7 + 0x1;
+ CHECKED_FSEEK(fdebug, f, LAYER, SEEK_SET);
+ int comm_size = 0;
+ CHECKED_FREAD(fdebug, &comm_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(comm_size);
+ LAYER += 0x5;
+ if (comm_size > 0) {
+ LAYER += comm_size + 0x1;
}
- fseek(f,LAYER,SEEK_SET);
+ CHECKED_FSEEK(fdebug, f, LAYER, SEEK_SET);
int ntmp;
- fread(&ntmp,4,1,f);
- if(IsBigEndian()) SwapBytes(ntmp);
- if(ntmp!=0x1E7)
+ CHECKED_FREAD(fdebug, &ntmp, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(ntmp);
+ if (ntmp != 0x1E7)
break;
}
- LAYER+=0x5*0x5+0x1ED*0x12;
- fseek(f,LAYER,SEEK_SET);
- fread(&sec_size,4,1,f);
- if(IsBigEndian()) SwapBytes(sec_size);
- if(sec_size==0)
+ LAYER += 0x5 * 0x5 + 0x1ED * 0x12;
+ CHECKED_FSEEK(fdebug, f, LAYER, SEEK_SET);
+ CHECKED_FREAD(fdebug, &sec_size, 4, 1, f);
+ if (IsBigEndian())
+ SwapBytes(sec_size);
+ if (sec_size == 0)
break;
}
- POS = LAYER+0x5;
+ POS = LAYER + 0x5;
- fseek(f,POS,SEEK_SET);
+ CHECKED_FSEEK(fdebug, f, POS, SEEK_SET);
}
-void OPJFile::readGraphGridInfo(graphGrid &grid, FILE *f, int pos)
-{
+void OPJFile::readGraphGridInfo(graphGrid &grid, FILE *f, FILE *debug,
+ int pos) {
unsigned char h;
short w;
- fseek(f,pos+0x26,SEEK_SET);
- fread(&h,1,1,f);
- grid.hidden=(h==0);
+ CHECKED_FSEEK(debug, f, pos + 0x26, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ grid.hidden = (h == 0);
+
+ CHECKED_FSEEK(debug, f, pos + 0xF, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ grid.color = h;
+
+ CHECKED_FSEEK(debug, f, pos + 0x12, SEEK_SET);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+ grid.style = h;
+
+ CHECKED_FSEEK(debug, f, pos + 0x15, SEEK_SET);
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+ if (IsBigEndian())
+ SwapBytes(w);
+ grid.width = (double)w / 500.0;
+}
- fseek(f,pos+0xF,SEEK_SET);
- fread(&h,1,1,f);
- grid.color=h;
+void OPJFile::readGraphAxisBreakInfo(graphAxisBreak &axis_break, FILE *f,
+ FILE *debug, int pos) {
+ axis_break.show = true;
+ CHECKED_FSEEK(debug, f, pos + 0x0B, SEEK_SET);
- fseek(f,pos+0x12,SEEK_SET);
- fread(&h,1,1,f);
- grid.style=h;
+ CHECKED_FREAD(debug, &axis_break.from, 8, 1, f);
- fseek(f,pos+0x15,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- grid.width=(double)w/500.0;
-}
+ if (IsBigEndian())
+ SwapBytes(axis_break.from);
+
+ CHECKED_FREAD(debug, &axis_break.to, 8, 1, f);
-void OPJFile::readGraphAxisBreakInfo(graphAxisBreak &axis_break, FILE *f, int pos)
-{
- axis_break.show=true;
+ if (IsBigEndian())
+ SwapBytes(axis_break.to);
- fseek(f,pos+0x0B,SEEK_SET);
- fread(&axis_break.from,8,1,f);
- if(IsBigEndian()) SwapBytes(axis_break.from);
-
- fread(&axis_break.to,8,1,f);
- if(IsBigEndian()) SwapBytes(axis_break.to);
+ CHECKED_FREAD(debug, &axis_break.scale_increment_after, 8, 1, f);
- fread(&axis_break.scale_increment_after,8,1,f);
- if(IsBigEndian()) SwapBytes(axis_break.scale_increment_after);
+ if (IsBigEndian())
+ SwapBytes(axis_break.scale_increment_after);
- double position=0.0;
- fread(&position,8,1,f);
- if(IsBigEndian()) SwapBytes(position);
- axis_break.position=(int)position;
+ double position = 0.0;
+ CHECKED_FREAD(debug, &position, 8, 1, f);
+
+ if (IsBigEndian())
+ SwapBytes(position);
+ axis_break.position = (int)position;
unsigned char h;
- fread(&h,1,1,f);
- axis_break.log10=(h==1);
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+
+ axis_break.log10 = (h == 1);
- fread(&axis_break.minor_ticks_after,1,1,f);
+ CHECKED_FREAD(debug, &axis_break.minor_ticks_after, 1, 1, f);
}
-void OPJFile::readGraphAxisFormatInfo(graphAxisFormat &format, FILE *f, int pos)
-{
+void OPJFile::readGraphAxisFormatInfo(graphAxisFormat &format, FILE *f,
+ FILE *debug, int pos) {
unsigned char h;
short w;
double p;
- fseek(f,pos+0x26,SEEK_SET);
- fread(&h,1,1,f);
- format.hidden=(h==0);
-
- fseek(f,pos+0xF,SEEK_SET);
- fread(&h,1,1,f);
- format.color=h;
-
- fseek(f,pos+0x4A,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- format.majorTickLength=(double)w/10.0;
-
- fseek(f,pos+0x15,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- format.thickness=(double)w/500.0;
-
- fseek(f,pos+0x25,SEEK_SET);
- fread(&h,1,1,f);
- format.minorTicksType=(h>>6);
- format.majorTicksType=((h>>4)&3);
- format.axisPosition=(h&0xF);
- switch(format.axisPosition)
- {
- case 1:
- fseek(f,pos+0x37,SEEK_SET);
- fread(&h,1,1,f);
- format.axisPositionValue=(double)h;
- break;
- case 2:
- fseek(f,pos+0x2F,SEEK_SET);
- fread(&p,8,1,f);
- if(IsBigEndian()) SwapBytes(p);
- format.axisPositionValue=p;
- break;
+ CHECKED_FSEEK(debug, f, pos + 0x26, SEEK_SET);
+
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+
+ format.hidden = (h == 0);
+
+ CHECKED_FSEEK(debug, f, pos + 0xF, SEEK_SET);
+
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+
+ format.color = h;
+
+ CHECKED_FSEEK(debug, f, pos + 0x4A, SEEK_SET);
+
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+
+ if (IsBigEndian())
+ SwapBytes(w);
+ format.majorTickLength = (double)w / 10.0;
+
+ CHECKED_FSEEK(debug, f, pos + 0x15, SEEK_SET);
+
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+
+ if (IsBigEndian())
+ SwapBytes(w);
+ format.thickness = (double)w / 500.0;
+
+ CHECKED_FSEEK(debug, f, pos + 0x25, SEEK_SET);
+
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+
+ format.minorTicksType = (h >> 6);
+ format.majorTicksType = ((h >> 4) & 3);
+ format.axisPosition = (h & 0xF);
+ switch (format.axisPosition) {
+ case 1:
+ CHECKED_FSEEK(debug, f, pos + 0x37, SEEK_SET);
+
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+
+ format.axisPositionValue = (double)h;
+ break;
+ case 2:
+ CHECKED_FSEEK(debug, f, pos + 0x2F, SEEK_SET);
+
+ CHECKED_FREAD(debug, &p, 8, 1, f);
+
+ if (IsBigEndian())
+ SwapBytes(p);
+ format.axisPositionValue = p;
+ break;
}
}
-void OPJFile::readGraphAxisTickLabelsInfo(graphAxisTick &tick, FILE *f, int pos) {
+void OPJFile::readGraphAxisTickLabelsInfo(graphAxisTick &tick, FILE *f,
+ FILE *debug, int pos) {
unsigned char h;
unsigned char h1;
short w;
- fseek(f,pos+0x26,SEEK_SET);
- fread(&h,1,1,f);
- tick.hidden=(h==0);
+ CHECKED_FSEEK(debug, f, pos + 0x26, SEEK_SET);
+
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+
+ tick.hidden = (h == 0);
+
+ CHECKED_FSEEK(debug, f, pos + 0xF, SEEK_SET);
+
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+
+ tick.color = h;
+
+ CHECKED_FSEEK(debug, f, pos + 0x13, SEEK_SET);
- fseek(f,pos+0xF,SEEK_SET);
- fread(&h,1,1,f);
- tick.color=h;
+ CHECKED_FREAD(debug, &w, 2, 1, f);
- fseek(f,pos+0x13,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- tick.rotation=w/10;
+ if (IsBigEndian())
+ SwapBytes(w);
+ tick.rotation = w / 10;
- fseek(f,pos+0x15,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
- tick.fontsize=w;
+ CHECKED_FSEEK(debug, f, pos + 0x15, SEEK_SET);
- fseek(f,pos+0x1A,SEEK_SET);
- fread(&h,1,1,f);
- tick.fontbold=(h&0x8);
+ CHECKED_FREAD(debug, &w, 2, 1, f);
- fseek(f,pos+0x23,SEEK_SET);
- fread(&w,2,1,f);
- if(IsBigEndian()) SwapBytes(w);
+ if (IsBigEndian())
+ SwapBytes(w);
+ tick.fontsize = w;
- fseek(f,pos+0x25,SEEK_SET);
- fread(&h,1,1,f);
- fread(&h1,1,1,f);
- tick.value_type=(h&0xF);
+ CHECKED_FSEEK(debug, f, pos + 0x1A, SEEK_SET);
+
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+
+ tick.fontbold = (h & 0x8);
+
+ CHECKED_FSEEK(debug, f, pos + 0x23, SEEK_SET);
+
+ CHECKED_FREAD(debug, &w, 2, 1, f);
+
+ if (IsBigEndian())
+ SwapBytes(w);
+
+ CHECKED_FSEEK(debug, f, pos + 0x25, SEEK_SET);
+
+ CHECKED_FREAD(debug, &h, 1, 1, f);
+
+ CHECKED_FREAD(debug, &h1, 1, 1, f);
+
+ tick.value_type = (h & 0xF);
vector<string> col;
- switch(tick.value_type)
- {
- case 0: //Numeric
+ switch (tick.value_type) {
+ case 0: // Numeric
/*switch((h>>4))
{
@@ -2881,15 +3152,12 @@ void OPJFile::readGraphAxisTickLabelsInfo(graphAxisTick &tick, FILE *f, int pos)
default:
tick.value_type_specification=0;
}*/
- if((h>>4)>7)
- {
- tick.value_type_specification=(h>>4)-8;
- tick.decimal_places=h1-0x40;
- }
- else
- {
- tick.value_type_specification=(h>>4);
- tick.decimal_places=-1;
+ if ((h >> 4) > 7) {
+ tick.value_type_specification = (h >> 4) - 8;
+ tick.decimal_places = h1 - 0x40;
+ } else {
+ tick.value_type_specification = (h >> 4);
+ tick.decimal_places = -1;
}
break;
@@ -2898,185 +3166,220 @@ void OPJFile::readGraphAxisTickLabelsInfo(graphAxisTick &tick, FILE *f, int pos)
case 4: // Month
case 5: // Day
case 6: // Column heading
- tick.value_type_specification=h1-0x40;
+ tick.value_type_specification = h1 - 0x40;
break;
- case 1: // Text
- case 7: // Tick-indexed dataset
+ case 1: // Text
+ case 7: // Tick-indexed dataset
case 10: // Categorical
- col=findDataByIndex(w-1);
- if(col.size()>0)
- {
- tick.colName=col[0];
- tick.dataName=col[1];
+ col = findDataByIndex(w - 1);
+ if (col.size() > 0) {
+ tick.colName = col[0];
+ tick.dataName = col[1];
}
break;
default: // Numeric Decimal 1.000
- tick.value_type=Numeric;
- tick.value_type_specification=0;
+ tick.value_type = Numeric;
+ tick.value_type_specification = 0;
break;
}
}
-void OPJFile::readProjectTree(FILE *f, FILE *debug)
-{
+void OPJFile::readProjectTree(FILE *f, FILE *debug) {
readProjectTreeFolder(f, debug, projectTree.begin());
- fprintf(debug,"Origin project Tree\n");
- tree<projectNode>::iterator sib2=projectTree.begin(projectTree.begin());
- tree<projectNode>::iterator end2=projectTree.end(projectTree.begin());
- while(sib2!=end2)
- {
- for(int i=0; i<projectTree.depth(sib2)-1; ++i)
- fprintf(debug," ");
- fprintf(debug,"%s\n",(*sib2).name.c_str());
- ++sib2;
- }
+ fprintf(debug, "Origin project Tree\n");
+ tree<projectNode>::iterator sib2 = projectTree.begin(projectTree.begin());
+ tree<projectNode>::iterator end2 = projectTree.end(projectTree.begin());
+ while (sib2 != end2) {
+ for (int i = 0; i < projectTree.depth(sib2) - 1; ++i)
+ fprintf(debug, " ");
+ fprintf(debug, "%s\n", (*sib2).name.c_str());
+ ++sib2;
+ }
fflush(debug);
}
-void OPJFile::readProjectTreeFolder(FILE *f, FILE *debug, tree<projectNode>::iterator parent)
-{
- int POS=int(ftell(f));
+void OPJFile::readProjectTreeFolder(FILE *f, FILE *debug,
+ tree<projectNode>::iterator parent) {
+ int POS = int(ftell(f));
+
+ int file_size = 0;
+ {
+ int rv = fseek(f, 0, SEEK_END);
+ if (rv < 0)
+ fprintf(debug, "Error: could not move to the end of the file\n");
+ file_size = static_cast<int>(ftell(f));
+ rv = fseek(f, POS, SEEK_SET);
+ if (rv < 0)
+ fprintf(debug, "Error: could not move to the beginning of the file\n");
+ }
double creation_date, modification_date;
- POS+=5;
- fseek(f,POS+0x10,SEEK_SET);
- fread(&creation_date,8,1,f);
- if(IsBigEndian()) SwapBytes(creation_date);
+ POS += 5;
+ CHECKED_FSEEK(debug, f, POS + 0x10, SEEK_SET);
+
+ CHECKED_FREAD(debug, &creation_date, 8, 1, f);
- fread(&modification_date,8,1,f);
- if(IsBigEndian()) SwapBytes(modification_date);
+ if (IsBigEndian())
+ SwapBytes(creation_date);
- POS+=0x20+1+5;
- fseek(f,POS,SEEK_SET);
+ CHECKED_FREAD(debug, &modification_date, 8, 1, f);
+
+ if (IsBigEndian())
+ SwapBytes(modification_date);
+
+ POS += 0x20 + 1 + 5;
+ CHECKED_FSEEK(debug, f, POS, SEEK_SET);
int namesize;
- fread(&namesize,4,1,f);
- if(IsBigEndian()) SwapBytes(namesize);
+ CHECKED_FREAD(debug, &namesize, 4, 1, f);
+
+ if (IsBigEndian())
+ SwapBytes(namesize);
if (INT_MAX == namesize) {
// this would cause an overflow and it's anyway obviously wrong
- fprintf(debug, "Error: while reading project tree folder, found project/folder name size: %d\n", namesize);
+ fprintf(debug, "Error: while reading project tree folder, found "
+ "project/folder name size: %d\n",
+ namesize);
fflush(debug);
}
// read folder name
- char* name=new char[namesize+1];
- name[namesize]='\0';
+ char *name = new char[namesize + 1];
+ name[namesize] = '\0';
- POS+=5;
- fseek(f,POS,SEEK_SET);
- fread(name,namesize,1,f);
- tree<projectNode>::iterator current_folder=projectTree.append_child(parent, projectNode(name, 1, creation_date, modification_date));
- POS+=namesize+1+5+5;
+ POS += 5;
+ CHECKED_FSEEK(debug, f, POS, SEEK_SET);
+
+ CHECKED_FREAD(debug, name, namesize, 1, f);
+
+ tree<projectNode>::iterator current_folder = projectTree.append_child(
+ parent, projectNode(name, 1, creation_date, modification_date));
+ POS += namesize + 1 + 5 + 5;
int objectcount;
- fseek(f,POS,SEEK_SET);
- fread(&objectcount,4,1,f);
- if(IsBigEndian()) SwapBytes(objectcount);
- POS+=5+5;
+ CHECKED_FSEEK(debug, f, POS, SEEK_SET);
- for(int i=0; i<objectcount; ++i)
- {
- POS+=5;
+ CHECKED_FREAD(debug, &objectcount, 4, 1, f);
+
+ if (IsBigEndian())
+ SwapBytes(objectcount);
+ POS += 5 + 5;
+
+ // there cannot be more objects than bytes
+ if (objectcount > file_size)
+ objectcount = 0;
+
+ for (int i = 0; i < objectcount; ++i) {
+ POS += 5;
char c;
- fseek(f,POS+0x2,SEEK_SET);
- fread(&c,1,1,f);
+ CHECKED_FSEEK(debug, f, POS + 0x2, SEEK_SET);
+
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+
int objectID;
- fseek(f,POS+0x4,SEEK_SET);
- fread(&objectID,4,1,f);
- if(IsBigEndian()) SwapBytes(objectID);
- if(c==0x10)
- {
- projectTree.append_child(current_folder, projectNode(NOTE[objectID].name, 0));
- }
- else
- projectTree.append_child(current_folder, projectNode(findObjectByIndex(objectID), 0));
- POS+=8+1+5+5;
+ CHECKED_FSEEK(debug, f, POS + 0x4, SEEK_SET);
+
+ CHECKED_FREAD(debug, &objectID, 4, 1, f);
+
+ if (IsBigEndian())
+ SwapBytes(objectID);
+ if (c == 0x10) {
+ projectTree.append_child(current_folder,
+ projectNode(NOTE[objectID].name, 0));
+ } else
+ projectTree.append_child(current_folder,
+ projectNode(findObjectByIndex(objectID), 0));
+ POS += 8 + 1 + 5 + 5;
}
- fseek(f,POS,SEEK_SET);
- fread(&objectcount,4,1,f);
- if(IsBigEndian()) SwapBytes(objectcount);
- fseek(f,1,SEEK_CUR);
- for(int i=0; i<objectcount; ++i)
+
+ CHECKED_FSEEK(debug, f, POS, SEEK_SET);
+
+ CHECKED_FREAD(debug, &objectcount, 4, 1, f);
+
+ if (IsBigEndian())
+ SwapBytes(objectcount);
+ CHECKED_FSEEK(debug, f, 1, SEEK_CUR);
+
+ for (int i = 0; i < objectcount; ++i)
readProjectTreeFolder(f, debug, current_folder);
-
- delete [] name;
+
+ delete[] name;
}
-void OPJFile::readWindowProperties(originWindow& window, FILE *f, FILE *debug, int POS, int headersize)
-{
- window.objectID=objectIndex;
+void OPJFile::readWindowProperties(originWindow &window, FILE *f, FILE *debug,
+ int POS, int headersize) {
+ window.objectID = objectIndex;
objectIndex++;
- fseek(f,POS + 0x1B,SEEK_SET);
- fread(&window.clientRect,8,1,f);
- if(IsBigEndian()) SwapBytes(window.clientRect);
+ CHECKED_FSEEK(debug, f, POS + 0x1B, SEEK_SET);
+ CHECKED_FREAD(debug, &window.clientRect, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(window.clientRect);
char c;
- fseek(f,POS + 0x32,SEEK_SET);
- fread(&c,1,1,f);
+ CHECKED_FSEEK(debug, f, POS + 0x32, SEEK_SET);
+ CHECKED_FREAD(debug, &c, 1, 1, f);
- if(c&0x01)
+ if (c & 0x01)
window.state = originWindow::Minimized;
- else if(c&0x02)
+ else if (c & 0x02)
window.state = originWindow::Maximized;
- fseek(f,POS + 0x69,SEEK_SET);
- fread(&c,1,1,f);
+ CHECKED_FSEEK(debug, f, POS + 0x69, SEEK_SET);
+ CHECKED_FREAD(debug, &c, 1, 1, f);
- if(c&0x01)
+ if (c & 0x01)
window.title = originWindow::Label;
- else if(c&0x02)
+ else if (c & 0x02)
window.title = originWindow::Name;
else
window.title = originWindow::Both;
- window.bHidden = (c&0x08);
- if(window.bHidden)
- {
- fprintf(debug," WINDOW %d NAME : %s is hidden\n", objectIndex, window.name.c_str());
+ window.bHidden = (c & 0x08);
+ if (window.bHidden) {
+ fprintf(debug, " WINDOW %d NAME : %s is hidden\n", objectIndex,
+ window.name.c_str());
fflush(debug);
}
- fseek(f,POS + 0x73,SEEK_SET);
- fread(&window.creation_date,8,1,f);
- if(IsBigEndian()) SwapBytes(window.creation_date);
+ CHECKED_FSEEK(debug, f, POS + 0x73, SEEK_SET);
+ CHECKED_FREAD(debug, &window.creation_date, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(window.creation_date);
- fread(&window.modification_date,8,1,f);
- if(IsBigEndian()) SwapBytes(window.modification_date);
-
- if(headersize > 0xC3)
- {
+ CHECKED_FREAD(debug, &window.modification_date, 8, 1, f);
+ if (IsBigEndian())
+ SwapBytes(window.modification_date);
+
+ if (headersize > 0xC3) {
int labellen = 0;
- fseek(f,POS + 0xC3,SEEK_SET);
- fread(&c,1,1,f);
- while (c != '@')
- {
- fread(&c,1,1,f);
+ CHECKED_FSEEK(debug, f, POS + 0xC3, SEEK_SET);
+ CHECKED_FREAD(debug, &c, 1, 1, f);
+ while (c != '@') {
+ CHECKED_FREAD(debug, &c, 1, 1, f);
labellen++;
}
- if(labellen > 0)
- {
- char *label=new char[labellen+1];
- label[labellen]='\0';
- fseek(f,POS + 0xC3,SEEK_SET);
- fread(label,labellen,1,f);
- window.label=label;
- delete [] label;
- }
- else
- window.label="";
- fprintf(debug," WINDOW %d LABEL: %s\n", objectIndex, window.label.c_str());
+ if (labellen > 0) {
+ char *label = new char[labellen + 1];
+ label[labellen] = '\0';
+ CHECKED_FSEEK(debug, f, POS + 0xC3, SEEK_SET);
+ CHECKED_FREAD(debug, label, labellen, 1, f);
+ window.label = label;
+ delete[] label;
+ } else
+ window.label = "";
+ fprintf(debug, " WINDOW %d LABEL: %s\n", objectIndex,
+ window.label.c_str());
fflush(debug);
}
}
-bool OPJFile::IsBigEndian()
-{
- short word = 0x4321;
- if((*(char *)& word) != 0x21 )
- return true;
- else
- return false;
+bool OPJFile::IsBigEndian() {
+ short word = 0x4321;
+ if ((*(char *)&word) != 0x21)
+ return true;
+ else
+ return false;
}
diff --git a/MantidPlot/src/origin/OPJFile.h b/MantidPlot/src/origin/OPJFile.h
index 7f4f529ad2930f7b4f87b3e496087b44ff50599e..5bb8cbcb92dbd5541b8e5f13c22f5beb42747435 100644
--- a/MantidPlot/src/origin/OPJFile.h
+++ b/MantidPlot/src/origin/OPJFile.h
@@ -40,774 +40,1006 @@
#include <vector>
#include "tree.hh"
-// Russell Taylor, 23/07/10: Remove evil import - caused clash with std::tr1::function
-//using namespace std;
+// Russell Taylor, 23/07/10: Remove evil import - caused clash with
+// std::tr1::function
+// using namespace std;
struct rect {
- short left;
- short top;
- short right;
- short bottom;
- int height() const
- {
- return bottom-top;
- };
- int width() const
- {
- return right-left;
- };
- rect() : left(0), top(0), right(0), bottom(0)
- {
- }
- rect(short width, short height)
- : left(0)
- , top(0)
- , right(width)
- , bottom(height)
- {
- }
+ short left;
+ short top;
+ short right;
+ short bottom;
+ int height() const { return bottom - top; };
+ int width() const { return right - left; };
+ rect() : left(0), top(0), right(0), bottom(0) {}
+ rect(short width, short height)
+ : left(0), top(0), right(width), bottom(height) {}
};
struct originWindow {
- enum State {Normal, Minimized, Maximized};
- enum Title {Name, Label, Both};
-
- std::string name;
- std::string label;
- int objectID;
- bool bHidden;
- State state;
- Title title;
- rect clientRect;
- double creation_date; // Julian date/time
- double modification_date; // Julian date/time
-
- originWindow(std::string _name="", std::string _label="", bool _bHidden=false)
- : name(_name)
- , label(_label)
- , objectID(0)
- , bHidden(_bHidden)
- , state(Normal)
- , title(Both)
- , creation_date(0.0)
- , modification_date(0.0)
- {};
+ enum State { Normal, Minimized, Maximized };
+ enum Title { Name, Label, Both };
+
+ std::string name;
+ std::string label;
+ int objectID;
+ bool bHidden;
+ State state;
+ Title title;
+ rect clientRect;
+ double creation_date; // Julian date/time
+ double modification_date; // Julian date/time
+
+ originWindow(std::string _name = "", std::string _label = "",
+ bool _bHidden = false)
+ : name(_name), label(_label), objectID(0), bHidden(_bHidden),
+ state(Normal), title(Both), creation_date(0.0),
+ modification_date(0.0){};
};
struct originData {
- int type; // 0 - double, 1 - string
- double d;
- std::string s;
- originData(double _d)
- : type(0)
- , d(_d)
- , s("")
- {};
- originData(char* _s)
- : type(1)
- , d(1.0e-307)
- , s(_s)
- {};
+ int type; // 0 - double, 1 - string
+ double d;
+ std::string s;
+ originData(double _d) : type(0), d(_d), s(""){};
+ originData(char *_s) : type(1), d(1.0e-307), s(_s){};
};
-enum ColumnType {X, Y, Z, XErr, YErr, Label, NONE};
+enum ColumnType { X, Y, Z, XErr, YErr, Label, NONE };
struct spreadColumn {
- std::string name;
- ColumnType type;
- int value_type;//Numeric = 0, Text = 1, Date = 2, Time = 3, Month = 4, Day = 5, Text&Numeric = 6
- int value_type_specification; //see above
- int significant_digits;
- int decimal_places;
- int numeric_display_type;//Default Decimal Digits=0, Decimal Places=1, Significant Digits=2
- std::string command;
- std::string comment;
- int width;
- int index;
- std::vector <originData> odata;
- spreadColumn(std::string _name="", int _index=0)
- : name(_name)
- , type(NONE)
- , value_type(0)
- , value_type_specification(0)
- , significant_digits(6)
- , decimal_places(6)
- , numeric_display_type(0)
- , command("")
- , comment("")
- , width(8)
- , index(_index)
- {};
+ std::string name;
+ ColumnType type;
+ int value_type; // Numeric = 0, Text = 1, Date = 2, Time = 3, Month = 4, Day =
+ // 5, Text&Numeric = 6
+ int value_type_specification; // see above
+ int significant_digits;
+ int decimal_places;
+ int numeric_display_type; // Default Decimal Digits=0, Decimal Places=1,
+ // Significant Digits=2
+ std::string command;
+ std::string comment;
+ int width;
+ int index;
+ std::vector<originData> odata;
+ spreadColumn(std::string _name = "", int _index = 0)
+ : name(_name), type(NONE), value_type(0), value_type_specification(0),
+ significant_digits(6), decimal_places(6), numeric_display_type(0),
+ command(""), comment(""), width(8), index(_index){};
};
struct spreadSheet : public originWindow {
- int maxRows;
- bool bLoose;
- bool bMultisheet;
- std::vector <spreadColumn> column;
- spreadSheet(std::string _name="")
- : originWindow(_name)
- , maxRows(0)
- , bLoose(true)
- , bMultisheet(false)
- , column()
- {};
+ int maxRows;
+ bool bLoose;
+ bool bMultisheet;
+ std::vector<spreadColumn> column;
+ spreadSheet(std::string _name = "")
+ : originWindow(_name), maxRows(0), bLoose(true), bMultisheet(false),
+ column(){};
};
struct excel : public originWindow {
- int maxRows;
- bool bLoose;
- std::vector <spreadSheet> sheet;
- excel(std::string _name="", std::string _label="", int _maxRows=0, bool _bHidden=false, bool _bLoose=true)
- : originWindow(_name, _label, _bHidden)
- , maxRows(_maxRows)
- , bLoose(_bLoose)
- {
- };
+ int maxRows;
+ bool bLoose;
+ std::vector<spreadSheet> sheet;
+ excel(std::string _name = "", std::string _label = "", int _maxRows = 0,
+ bool _bHidden = false, bool _bLoose = true)
+ : originWindow(_name, _label, _bHidden), maxRows(_maxRows),
+ bLoose(_bLoose){};
};
struct matrix : public originWindow {
- enum ViewType {DataView, ImageView};
- enum HeaderViewType {ColumnRow, XY};
- int nr_rows;
- int nr_cols;
- int value_type_specification;
- int significant_digits;
- int decimal_places;
- int numeric_display_type;//Default Decimal Digits=0, Decimal Places=1, Significant Digits=2
- std::string command;
- int width;
- int index;
- ViewType view;
- HeaderViewType header;
- std::vector <double> data;
- matrix(std::string _name="", int _index=0)
- : originWindow(_name)
- , nr_rows(0)
- , nr_cols(0)
- , value_type_specification(0)
- , significant_digits(6)
- , decimal_places(6)
- , numeric_display_type(0)
- , command("")
- , width(8)
- , index(_index)
- , view(DataView)
- , header(ColumnRow)
- {};
+ enum ViewType { DataView, ImageView };
+ enum HeaderViewType { ColumnRow, XY };
+ int nr_rows;
+ int nr_cols;
+ int value_type_specification;
+ int significant_digits;
+ int decimal_places;
+ int numeric_display_type; // Default Decimal Digits=0, Decimal Places=1,
+ // Significant Digits=2
+ std::string command;
+ int width;
+ int index;
+ ViewType view;
+ HeaderViewType header;
+ std::vector<double> data;
+ matrix(std::string _name = "", int _index = 0)
+ : originWindow(_name), nr_rows(0), nr_cols(0),
+ value_type_specification(0), significant_digits(6), decimal_places(6),
+ numeric_display_type(0), command(""), width(8), index(_index),
+ view(DataView), header(ColumnRow){};
};
struct function {
- std::string name;
- int type;//Normal = 0, Polar = 1
- std::string formula;
- double begin;
- double end;
- int points;
- int index;
- function(std::string _name="", int _index=0)
- : name(_name)
- , type(0)
- , formula("")
- , begin(0.0)
- , end(0.0)
- , points(0)
- , index(_index)
- {};
+ std::string name;
+ int type; // Normal = 0, Polar = 1
+ std::string formula;
+ double begin;
+ double end;
+ int points;
+ int index;
+ function(std::string _name = "", int _index = 0)
+ : name(_name), type(0), formula(""), begin(0.0), end(0.0), points(0),
+ index(_index){};
};
-
struct text {
- std::string txt;
- rect clientRect;
- int color;
- int fontsize;
- int rotation;
- int tab;
- int border_type;
- int attach;
-
- text(const std::string& _txt="")
- : txt(_txt)
- , clientRect()
- , color(0)
- , fontsize(0)
- , rotation(0)
- , tab(0)
- , border_type(0)
- , attach(0)
- {};
-
- text(const std::string& _txt, const rect& _clientRect, int _color, int _fontsize, int _rotation, int _tab, int _border_type, int _attach)
- : txt(_txt)
- , clientRect(_clientRect)
- , color(_color)
- , fontsize(_fontsize)
- , rotation(_rotation)
- , tab(_tab)
- , border_type(_border_type)
- , attach(_attach)
- {};
+ std::string txt;
+ rect clientRect;
+ int color;
+ int fontsize;
+ int rotation;
+ int tab;
+ int border_type;
+ int attach;
+
+ text(const std::string &_txt = "")
+ : txt(_txt), clientRect(), color(0), fontsize(0), rotation(0), tab(0),
+ border_type(0), attach(0){};
+
+ text(const std::string &_txt, const rect &_clientRect, int _color,
+ int _fontsize, int _rotation, int _tab, int _border_type, int _attach)
+ : txt(_txt), clientRect(_clientRect), color(_color), fontsize(_fontsize),
+ rotation(_rotation), tab(_tab), border_type(_border_type),
+ attach(_attach){};
};
-struct pieProperties
-{
- unsigned char view_angle;
- unsigned char thickness;
- bool clockwise_rotation;
- short rotation;
- unsigned short radius;
- unsigned short horizontal_offset;
- unsigned long displaced_sections; // maximum - 32 sections
- unsigned short displacement;
-
- //labels
- bool format_automatic;
- bool format_values;
- bool format_percentages;
- bool format_categories;
- bool position_associate;
- unsigned short distance;
-
- pieProperties()
- : view_angle(0)
- , thickness(0)
- , clockwise_rotation(false)
- , rotation(0)
- , radius(0)
- , horizontal_offset(0)
- , displaced_sections(0)
- , displacement(0)
- , format_automatic(false)
- , format_values(false)
- , format_percentages(false)
- , format_categories(false)
- , position_associate(false)
- , distance(0)
- {};
+struct pieProperties {
+ unsigned char view_angle;
+ unsigned char thickness;
+ bool clockwise_rotation;
+ short rotation;
+ unsigned short radius;
+ unsigned short horizontal_offset;
+ unsigned long displaced_sections; // maximum - 32 sections
+ unsigned short displacement;
+
+ // labels
+ bool format_automatic;
+ bool format_values;
+ bool format_percentages;
+ bool format_categories;
+ bool position_associate;
+ unsigned short distance;
+
+ pieProperties()
+ : view_angle(0), thickness(0), clockwise_rotation(false), rotation(0),
+ radius(0), horizontal_offset(0), displaced_sections(0), displacement(0),
+ format_automatic(false), format_values(false),
+ format_percentages(false), format_categories(false),
+ position_associate(false), distance(0){};
};
-struct vectorProperties
-{
- int color;
- double width;
- unsigned short arrow_lenght;
- unsigned char arrow_angle;
- bool arrow_closed;
- std::string endXColName;
- std::string endYColName;
-
- int position;
- std::string angleColName;
- std::string magnitudeColName;
- float multiplier;
- int const_angle;
- int const_magnitude;
-
- vectorProperties()
- : color(0)
- , width(0.0)
- , arrow_lenght(0)
- , arrow_angle(0)
- , arrow_closed(false)
- , endXColName()
- , endYColName()
- , position(0)
- , angleColName()
- , magnitudeColName(0)
- , multiplier(1.0)
- , const_angle(0)
- , const_magnitude(0)
- {};
+struct vectorProperties {
+ int color;
+ double width;
+ unsigned short arrow_lenght;
+ unsigned char arrow_angle;
+ bool arrow_closed;
+ std::string endXColName;
+ std::string endYColName;
+
+ int position;
+ std::string angleColName;
+ std::string magnitudeColName;
+ float multiplier;
+ int const_angle;
+ int const_magnitude;
+
+ vectorProperties()
+ : color(0), width(0.0), arrow_lenght(0), arrow_angle(0),
+ arrow_closed(false), endXColName(), endYColName(), position(0),
+ angleColName(), magnitudeColName(0), multiplier(1.0), const_angle(0),
+ const_magnitude(0){};
};
struct graphCurve {
- int type;
- std::string dataName;
- std::string xColName;
- std::string yColName;
- int line_color;
- int line_style;
- int line_connect;
- double line_width;
-
- bool fillarea;
- int fillarea_type;
- int fillarea_pattern;
- int fillarea_color;
- int fillarea_first_color;
- int fillarea_pattern_color;
- double fillarea_pattern_width;
- int fillarea_pattern_border_style;
- int fillarea_pattern_border_color;
- double fillarea_pattern_border_width;
-
- int symbol_type;
- int symbol_color;
- int symbol_fill_color;
- double symbol_size;
- int symbol_thickness;
- int point_offset;
-
- //pie
- pieProperties pie;
-
- //vector
- vectorProperties vector;
+ int type;
+ std::string dataName;
+ std::string xColName;
+ std::string yColName;
+ int line_color;
+ int line_style;
+ int line_connect;
+ double line_width;
+
+ bool fillarea;
+ int fillarea_type;
+ int fillarea_pattern;
+ int fillarea_color;
+ int fillarea_first_color;
+ int fillarea_pattern_color;
+ double fillarea_pattern_width;
+ int fillarea_pattern_border_style;
+ int fillarea_pattern_border_color;
+ double fillarea_pattern_border_width;
+
+ int symbol_type;
+ int symbol_color;
+ int symbol_fill_color;
+ double symbol_size;
+ int symbol_thickness;
+ int point_offset;
+
+ // pie
+ pieProperties pie;
+
+ // vector
+ vectorProperties vector;
};
-enum AxisPosition {Left = 0, Bottom = 1, Right = 2, Top = 3};
+enum AxisPosition { Left = 0, Bottom = 1, Right = 2, Top = 3 };
struct graphAxisBreak {
- bool show;
-
- bool log10;
- double from;
- double to;
- int position;
-
- double scale_increment_before;
- double scale_increment_after;
-
- unsigned char minor_ticks_before;
- unsigned char minor_ticks_after;
-
- graphAxisBreak()
- : show(false)
- , log10(false)
- , from(0.0)
- , to(0.0)
- , position(0)
- , scale_increment_before(0)
- , scale_increment_after(0)
- , minor_ticks_before(0)
- , minor_ticks_after(0)
- {
- }
+ bool show;
+
+ bool log10;
+ double from;
+ double to;
+ int position;
+
+ double scale_increment_before;
+ double scale_increment_after;
+
+ unsigned char minor_ticks_before;
+ unsigned char minor_ticks_after;
+
+ graphAxisBreak()
+ : show(false), log10(false), from(0.0), to(0.0), position(0),
+ scale_increment_before(0), scale_increment_after(0),
+ minor_ticks_before(0), minor_ticks_after(0) {}
};
struct graphGrid {
- bool hidden;
- int color;
- int style;
- double width;
+ bool hidden;
+ int color;
+ int style;
+ double width;
};
struct graphAxisFormat {
- bool hidden;
- int color;
- double thickness;
- double majorTickLength;
- int majorTicksType;
- int minorTicksType;
- int axisPosition;
- double axisPositionValue;
+ bool hidden;
+ int color;
+ double thickness;
+ double majorTickLength;
+ int majorTicksType;
+ int minorTicksType;
+ int axisPosition;
+ double axisPositionValue;
};
struct graphAxisTick {
- bool hidden;
- int color;
- int value_type;//Numeric = 0, Text = 1, Date = 2, Time = 3, Month = 4, Day = 5, Text&Numeric = 6
- int value_type_specification;
- int decimal_places;
- int fontsize;
- bool fontbold;
- std::string dataName;
- std::string colName;
- int rotation;
+ bool hidden;
+ int color;
+ int value_type; // Numeric = 0, Text = 1, Date = 2, Time = 3, Month = 4, Day =
+ // 5, Text&Numeric = 6
+ int value_type_specification;
+ int decimal_places;
+ int fontsize;
+ bool fontbold;
+ std::string dataName;
+ std::string colName;
+ int rotation;
};
struct graphAxis {
- int pos;
- text label;
- double min;
- double max;
- double step;
- int majorTicks;
- int minorTicks;
- int scale;
- graphGrid majorGrid;
- graphGrid minorGrid;
- graphAxisFormat formatAxis[2];
- graphAxisTick tickAxis[2]; //bottom-top, left-right
+ int pos;
+ text label;
+ double min;
+ double max;
+ double step;
+ int majorTicks;
+ int minorTicks;
+ int scale;
+ graphGrid majorGrid;
+ graphGrid minorGrid;
+ graphAxisFormat formatAxis[2];
+ graphAxisTick tickAxis[2]; // bottom-top, left-right
};
struct rectangle {
- rect clientRect;
- int attach;
+ rect clientRect;
+ int attach;
};
struct circle {
- rect clientRect;
- int attach;
+ rect clientRect;
+ int attach;
};
struct lineVertex {
- int shape_type;
- double shape_width;
- double shape_length;
- double x;
- double y;
- lineVertex()
- : shape_type(0)
- , shape_width(0.0)
- , shape_length(0.0)
- , x(0.0)
- , y(0.0)
- {}
+ int shape_type;
+ double shape_width;
+ double shape_length;
+ double x;
+ double y;
+ lineVertex()
+ : shape_type(0), shape_width(0.0), shape_length(0.0), x(0.0), y(0.0) {}
};
struct line {
- rect clientRect;
- int color;
- int attach;
- double width;
- int line_style;
- lineVertex begin;
- lineVertex end;
+ rect clientRect;
+ int color;
+ int attach;
+ double width;
+ int line_style;
+ lineVertex begin;
+ lineVertex end;
};
struct bitmap {
- rect clientRect;
- int attach;
- unsigned long size;
- unsigned char* data;
- double left;
- double top;
- double width;
- double height;
+ rect clientRect;
+ int attach;
+ unsigned long size;
+ unsigned char *data;
+ double left;
+ double top;
+ double width;
+ double height;
};
struct metafile {
- rect clientRect;
- int attach;
+ rect clientRect;
+ int attach;
};
struct graphLayer {
- rect clientRect;
- text legend;
- graphAxis xAxis;
- graphAxis yAxis;
-
- graphAxisBreak xAxisBreak;
- graphAxisBreak yAxisBreak;
-
- double histogram_bin;
- double histogram_begin;
- double histogram_end;
-
- std::vector<text> texts;
- std::vector<line> lines;
- std::vector<bitmap> bitmaps;
- std::vector<graphCurve> curve;
+ rect clientRect;
+ text legend;
+ graphAxis xAxis;
+ graphAxis yAxis;
+
+ graphAxisBreak xAxisBreak;
+ graphAxisBreak yAxisBreak;
+
+ double histogram_bin;
+ double histogram_begin;
+ double histogram_end;
+
+ std::vector<text> texts;
+ std::vector<line> lines;
+ std::vector<bitmap> bitmaps;
+ std::vector<graphCurve> curve;
};
struct graphLayerRange {
- double min;
- double max;
- double step;
-
- graphLayerRange(double _min=0.0, double _max=0.0, double _step=0.0)
- {
- min=_min;
- max=_max;
- step=_step;
- };
+ double min;
+ double max;
+ double step;
+
+ graphLayerRange(double _min = 0.0, double _max = 0.0, double _step = 0.0) {
+ min = _min;
+ max = _max;
+ step = _step;
+ };
};
struct graph : public originWindow {
- std::vector<graphLayer> layer;
- unsigned short width;
- unsigned short height;
-
- graph(std::string _name="")
- : originWindow(_name)
- , width(0)
- , height(0)
- {};
+ std::vector<graphLayer> layer;
+ unsigned short width;
+ unsigned short height;
+
+ graph(std::string _name = "") : originWindow(_name), width(0), height(0){};
};
struct note : public originWindow {
- std::string text;
- note(std::string _name="")
- : originWindow(_name)
- {};
+ std::string text;
+ note(std::string _name = "") : originWindow(_name){};
};
struct projectNode {
- int type; // 0 - object, 1 - folder
- std::string name;
- double creation_date; // Julian date/time
- double modification_date; // Julian date/time
-
- projectNode(std::string _name="", int _type=0, double _creation_date=0.0, double _modification_date=0.0)
- : type(_type)
- , name(_name)
- , creation_date(_creation_date)
- , modification_date(_modification_date)
- {};
+ int type; // 0 - object, 1 - folder
+ std::string name;
+ double creation_date; // Julian date/time
+ double modification_date; // Julian date/time
+
+ projectNode(std::string _name = "", int _type = 0,
+ double _creation_date = 0.0, double _modification_date = 0.0)
+ : type(_type), name(_name), creation_date(_creation_date),
+ modification_date(_modification_date){};
};
-class OPJFile
-{
+class OPJFile {
public:
- OPJFile(const char* filename);
- ~OPJFile()
- {
- for(unsigned int g=0; g<GRAPH.size(); ++g)
- for(unsigned int l=0; l<GRAPH[g].layer.size(); ++l)
- for(unsigned int b=0; b<GRAPH[g].layer[l].bitmaps.size(); ++b)
- if(GRAPH[g].layer[l].bitmaps[b].size > 0)
- delete GRAPH[g].layer[l].bitmaps[b].data;
- }
- int Parse();
- double Version() const { return version/100.0; } //!< get version of project file
-
- const tree<projectNode>* project() const { return &projectTree; }
- //spreadsheet properties
- int numSpreads() const { return static_cast<int>(SPREADSHEET.size()); } //!< get number of spreadsheets
- const char *spreadName(int s) const { return SPREADSHEET[s].name.c_str(); } //!< get name of spreadsheet s
- bool spreadHidden(int s) const { return SPREADSHEET[s].bHidden; } //!< is spreadsheet s hidden
- bool spreadLoose(int s) const { return SPREADSHEET[s].bLoose; } //!< is spreadsheet s loose
- rect spreadWindowRect(int s) const { return SPREADSHEET[s].clientRect; } //!< get window rectangle of spreadsheet s
- const char *spreadLabel(int s) const { return SPREADSHEET[s].label.c_str(); } //!< get label of spreadsheet s
- double spreadCreationDate(int s) const { return SPREADSHEET[s].creation_date; } //!< get creation date of spreadsheet s
- double spreadModificationDate(int s) const { return SPREADSHEET[s].modification_date; } //!< get modification date of spreadsheet s
- originWindow::State spreadState(int s) const { return SPREADSHEET[s].state; } //!< get window state of spreadsheet s
- originWindow::Title spreadTitle(int s) const { return SPREADSHEET[s].title; } //!< get window state of spreadsheet s
- int numCols(int s) const { return static_cast<int>(SPREADSHEET[s].column.size()); } //!< get number of columns of spreadsheet s
- int numRows(int s,int c) const { return static_cast<int>(SPREADSHEET[s].column[c].odata.size()); } //!< get number of rows of column c of spreadsheet s
- int maxRows(int s) const { return SPREADSHEET[s].maxRows; } //!< get maximum number of rows of spreadsheet s
-
- //spreadsheet's column properties
- const char *colName(int s, int c) const { return SPREADSHEET[s].column[c].name.c_str(); } //!< get name of column c of spreadsheet s
- ColumnType colType(int s, int c) const { return SPREADSHEET[s].column[c].type; } //!< get type of column c of spreadsheet s
- const char *colCommand(int s, int c) const { return SPREADSHEET[s].column[c].command.c_str(); } //!< get command of column c of spreadsheet s
- const char *colComment(int s, int c) const { return SPREADSHEET[s].column[c].comment.c_str(); } //!< get comment of column c of spreadsheet s
- int colValueType(int s, int c) const { return SPREADSHEET[s].column[c].value_type; } //!< get value type of column c of spreadsheet s
- int colValueTypeSpec(int s, int c) const { return SPREADSHEET[s].column[c].value_type_specification; } //!< get value type specification of column c of spreadsheet s
- int colSignificantDigits(int s, int c) const { return SPREADSHEET[s].column[c].significant_digits; } //!< get significant digits of column c of spreadsheet s
- int colDecPlaces(int s, int c) const { return SPREADSHEET[s].column[c].decimal_places; } //!< get decimal places of column c of spreadsheet s
- int colNumDisplayType(int s, int c) const { return SPREADSHEET[s].column[c].numeric_display_type; } //!< get numeric display type of column c of spreadsheet s
- int colWidth(int s, int c) const { return SPREADSHEET[s].column[c].width; } //!< get width of column c of spreadsheet s
- void* oData(int s, int c, int r, bool alwaysDouble=false) const {
- if(alwaysDouble)
- return (void*)const_cast<double*>(&SPREADSHEET[s].column[c].odata[r].d);
- if(SPREADSHEET[s].column[c].odata[r].type==0)
- return (void*)const_cast<double*>(&SPREADSHEET[s].column[c].odata[r].d);
- else
- return (void*)const_cast<char*>(SPREADSHEET[s].column[c].odata[r].s.c_str());
- } //!< get data of column c/row r of spreadsheet s
-
- //matrix properties
- int numMatrices() const { return static_cast<int>(MATRIX.size()); } //!< get number of matrices
- const char *matrixName(int m) const { return MATRIX[m].name.c_str(); } //!< get name of matrix m
- bool matrixHidden(int m) const { return MATRIX[m].bHidden; } //!< is matrix m hidden
- rect matrixWindowRect(int m) const { return MATRIX[m].clientRect; } //!< get window rectangle of matrix m
- const char *matrixLabel(int m) const { return MATRIX[m].label.c_str(); } //!< get label of matrix m
- double matrixCreationDate(int m) const { return MATRIX[m].creation_date; } //!< get creation date of matrix m
- double matrixModificationDate(int m) const { return MATRIX[m].modification_date; } //!< get modification date of matrix m
- originWindow::State matrixState(int m) const { return MATRIX[m].state; } //!< get window state of matrix m
- originWindow::Title matrixTitle(int m) const { return MATRIX[m].title; } //!< get window state of matrix m
- int numMatrixCols(int m) const { return MATRIX[m].nr_cols; } //!< get number of columns of matrix m
- int numMatrixRows(int m) const { return MATRIX[m].nr_rows; } //!< get number of rows of matrix m
- const char *matrixFormula(int m) const { return MATRIX[m].command.c_str(); } //!< get formula of matrix m
- int matrixValueTypeSpec(int m) const { return MATRIX[m].value_type_specification; } //!< get value type specification of matrix m
- int matrixSignificantDigits(int m) const { return MATRIX[m].significant_digits; } //!< get significant digits of matrix m
- int matrixDecPlaces(int m) const { return MATRIX[m].decimal_places; } //!< get decimal places of matrix m
- int matrixNumDisplayType(int m) const { return MATRIX[m].numeric_display_type; } //!< get numeric display type of matrix m
- int matrixWidth(int m) const { return MATRIX[m].width; } //!< get width of matrix m
- matrix::ViewType matrixViewType(int m) const { return MATRIX[m].view; } //!< get view type of matrix m
- matrix::HeaderViewType matrixHeaderViewType(int m) const { return MATRIX[m].header; } //!< get header view type of matrix m
- double matrixData(int m, int c, int r) const { return MATRIX[m].data[r*MATRIX[m].nr_cols+c]; } //!< get data of row r of column c of matrix m
- std::vector<double> matrixData(int m) const { return MATRIX[m].data; } //!< get data of matrix m
-
- //function properties
- int numFunctions() const { return static_cast<int>(FUNCTION.size()); } //!< get number of functions
- int functionIndex(const char* s) const { return compareFunctionnames(s); } //!< get name of function s
- const char *functionName(int s) const { return FUNCTION[s].name.c_str(); } //!< get name of function s
- int functionType(int s) const { return FUNCTION[s].type; } //!< get type of function s
- double functionBegin(int s) const { return FUNCTION[s].begin; } //!< get begin of interval of function s
- double functionEnd(int s) const { return FUNCTION[s].end; } //!< get end of interval of function s
- int functionPoints(int s) const { return FUNCTION[s].points; } //!< get number of points in interval of function s
- const char *functionFormula(int s) const { return FUNCTION[s].formula.c_str(); } //!< get formula of function s
-
- //graph properties
- enum Color {Black=0, Red=1, Green=2, Blue=3, Cyan=4, Magenta=5, Yellow=6, DarkYellow=7, Navy=8,
- Purple=9, Wine=10, Olive=11, DarkCyan=12, Royal=13, Orange=14, Violet=15, Pink=16, White=17,
- LightGray=18, Gray=19, LTYellow=20, LTCyan=21, LTMagenta=22, DarkGray=23, Custom=255};
-
- enum Plot {Line=200, Scatter=201, LineSymbol=202, Column=203, Area=204, HiLoClose=205, Box=206,
- ColumnFloat=207, Vector=208, PlotDot=209, Wall3D=210, Ribbon3D=211, Bar3D=212, ColumnStack=213,
- AreaStack=214, Bar=215, BarStack=216, FlowVector=218, Histogram=219, MatrixImage=220, Pie=225,
- Contour=226, Unknown=230, ErrorBar=231, TextPlot=232, XErrorBar=233, SurfaceColorMap=236,
- SurfaceColorFill=237, SurfaceWireframe=238, SurfaceBars=239, Line3D=240, Text3D=241, Mesh3D=242,
- XYZTriangular=245, LineSeries=246, YErrorBar=254, XYErrorBar=255, GraphScatter3D=0x8AF0,
- GraphTrajectory3D=0x8AF1, Polar=0x00020000, SmithChart=0x00040000, FillArea=0x00800000};
-
- enum LineStyle {Solid=0, Dash=1, Dot=2, DashDot=3, DashDotDot=4, ShortDash=5, ShortDot=6, ShortDashDot=7};
-
- enum LineConnect {NoLine=0, Straight=1, TwoPointSegment=2, ThreePointSegment=3, BSpline=8, Spline=9, StepHorizontal=11, StepVertical=12, StepHCenter=13, StepVCenter=14, Bezier=15};
-
- enum Scale {Linear=0, Log10=1, Probability=2, Probit=3, Reciprocal=4, OffsetReciprocal=5, Logit=6, Ln=7, Log2=8};
-
- enum ValueType {Numeric=0, Text=1, Time=2, Date=3, Month=4, Day=5, ColumnHeading=6, TickIndexedDataset=7, TextNumeric=9, Categorical=10};
-
- enum BorderType {BlackLine=0, Shadow=1, DarkMarble=2, WhiteOut=3, BlackOut=4, None=-1};
-
- enum Attach {Frame=0, Page=1, Scale=2};
-
- enum VectorPosition {Tail, Midpoint, Head};
-
- int numGraphs() const { return static_cast<int>(GRAPH.size()); } //!< get number of graphs
- const char *graphName(int s) const { return GRAPH[s].name.c_str(); } //!< get name of graph s
- const char *graphLabel(int s) const { return GRAPH[s].label.c_str(); } //!< get name of graph s
- double graphCreationDate(int s) const { return GRAPH[s].creation_date; } //!< get creation date of graph s
- double graphModificationDate(int s) const { return GRAPH[s].modification_date; } //!< get modification date of graph s
- originWindow::State graphState(int s) const { return GRAPH[s].state; } //!< get window state of graph s
- originWindow::Title graphTitle(int s) const { return GRAPH[s].title; } //!< get window state of graph s
- bool graphHidden(int s) const { return GRAPH[s].bHidden; } //!< is graph s hidden
- rect graphRect(int s) const { return rect(GRAPH[s].width, GRAPH[s].height); } //!< get rectangle of graph s
- rect graphWindowRect(int s) const { return GRAPH[s].clientRect; } //!< get window rectangle of graph s
- int numLayers(int s) const { return static_cast<int>(GRAPH[s].layer.size()); } //!< get number of layers of graph s
- rect layerRect(int s, int l) const { return GRAPH[s].layer[l].clientRect; } //!< get rectangle of layer l of graph s
- text layerXAxisTitle(int s, int l) const { return GRAPH[s].layer[l].xAxis.label; } //!< get label of X-axis of layer l of graph s
- text layerYAxisTitle(int s, int l) const { return GRAPH[s].layer[l].yAxis.label; } //!< get label of Y-axis of layer l of graph s
- text layerLegend(int s, int l) const { return GRAPH[s].layer[l].legend; } //!< get legend of layer l of graph s
- std::vector<text> layerTexts(int s, int l) const { return GRAPH[s].layer[l].texts; } //!< get texts of layer l of graph s
- std::vector<line> layerLines(int s, int l) const { return GRAPH[s].layer[l].lines; } //!< get lines of layer l of graph s
- std::vector<bitmap> layerBitmaps(int s, int l) const { return GRAPH[s].layer[l].bitmaps; } //!< get bitmaps of layer l of graph s
- graphAxisBreak layerXBreak(int s, int l) const { return GRAPH[s].layer[l].xAxisBreak; } //!< get break of horizontal axis of layer l of graph s
- graphAxisBreak layerYBreak(int s, int l) const { return GRAPH[s].layer[l].yAxisBreak; } //!< get break of vertical axis of layer l of graph s
- graphLayerRange layerXRange(int s, int l) const {
- return graphLayerRange(GRAPH[s].layer[l].xAxis.min, GRAPH[s].layer[l].xAxis.max, GRAPH[s].layer[l].xAxis.step);
- } //!< get X-range of layer l of graph s
- graphLayerRange layerYRange(int s, int l) const {
- return graphLayerRange(GRAPH[s].layer[l].yAxis.min, GRAPH[s].layer[l].yAxis.max, GRAPH[s].layer[l].yAxis.step);
- } //!< get Y-range of layer l of graph s
- std::vector<int> layerXTicks(int s, int l) const {
- std::vector<int> tick;
- tick.push_back(GRAPH[s].layer[l].xAxis.majorTicks);
- tick.push_back(GRAPH[s].layer[l].xAxis.minorTicks);
- return tick;
- } //!< get X-axis ticks of layer l of graph s
- std::vector<int> layerYTicks(int s, int l) const {
- std::vector<int> tick;
- tick.push_back(GRAPH[s].layer[l].yAxis.majorTicks);
- tick.push_back(GRAPH[s].layer[l].yAxis.minorTicks);
- return tick;
- } //!< get Y-axis ticks of layer l of graph s
- std::vector<graphGrid> layerGrid(int s, int l) const {
- std::vector<graphGrid> grid;
- grid.push_back(GRAPH[s].layer[l].xAxis.majorGrid);
- grid.push_back(GRAPH[s].layer[l].xAxis.minorGrid);
- grid.push_back(GRAPH[s].layer[l].yAxis.majorGrid);
- grid.push_back(GRAPH[s].layer[l].yAxis.minorGrid);
- return grid;
- } //!< get grid of layer l of graph s
- std::vector<graphAxisFormat> layerAxisFormat(int s, int l) const {
- std::vector<graphAxisFormat> format;
- format.push_back(GRAPH[s].layer[l].yAxis.formatAxis[0]); //bottom
- format.push_back(GRAPH[s].layer[l].yAxis.formatAxis[1]); //top
- format.push_back(GRAPH[s].layer[l].xAxis.formatAxis[0]); //left
- format.push_back(GRAPH[s].layer[l].xAxis.formatAxis[1]); //right
- return format;
- } //!< get title and format of axes of layer l of graph s
- std::vector<graphAxisTick> layerAxisTickLabels(int s, int l) const {
- std::vector<graphAxisTick> tick;
- tick.push_back(GRAPH[s].layer[l].yAxis.tickAxis[0]); //bottom
- tick.push_back(GRAPH[s].layer[l].yAxis.tickAxis[1]); //top
- tick.push_back(GRAPH[s].layer[l].xAxis.tickAxis[0]); //left
- tick.push_back(GRAPH[s].layer[l].xAxis.tickAxis[1]); //right
- return tick;
- } //!< get tick labels of axes of layer l of graph s
- std::vector<double> layerHistogram(int s, int l) const {
- std::vector<double> range;
- range.push_back(GRAPH[s].layer[l].histogram_bin);
- range.push_back(GRAPH[s].layer[l].histogram_begin);
- range.push_back(GRAPH[s].layer[l].histogram_end);
- return range;
- } //!< get histogram bin of layer l of graph s
- int layerXScale(int s, int l) const { return GRAPH[s].layer[l].xAxis.scale; } //!< get scale of X-axis of layer l of graph s
- int layerYScale(int s, int l) const { return GRAPH[s].layer[l].yAxis.scale; } //!< get scale of Y-axis of layer l of graph s
- int numCurves(int s, int l) const { return static_cast<int>(GRAPH[s].layer[l].curve.size()); } //!< get number of curves of layer l of graph s
- const char *curveDataName(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].dataName.c_str(); } //!< get data source name of curve c of layer l of graph s
- const char *curveXColName(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].xColName.c_str(); } //!< get X-column name of curve c of layer l of graph s
- const char *curveYColName(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].yColName.c_str(); } //!< get Y-column name of curve c of layer l of graph s
- int curveType(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].type; } //!< get type of curve c of layer l of graph s
- int curveLineStyle(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].line_style; } //!< get line style of curve c of layer l of graph s
- int curveLineColor(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].line_color; } //!< get line color of curve c of layer l of graph s
- int curveLineConnect(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].line_connect; } //!< get line connect of curve c of layer l of graph s
- double curveLineWidth(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].line_width; } //!< get line width of curve c of layer l of graph s
-
- bool curveIsFilledArea(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].fillarea; } //!< get is filled area of curve c of layer l of graph s
- int curveFillAreaColor(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].fillarea_color; } //!< get area fillcolor of curve c of layer l of graph s
- int curveFillAreaFirstColor(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].fillarea_first_color; } //!< get area first fillcolor of curve c of layer l of graph s
- int curveFillPattern(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].fillarea_pattern; } //!< get fill pattern of curve c of layer l of graph s
- int curveFillPatternColor(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].fillarea_pattern_color; } //!< get fill pattern color of curve c of layer l of graph s
- double curveFillPatternWidth(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].fillarea_pattern_width; } //!< get fill pattern line width of curve c of layer l of graph s
- int curveFillPatternBorderStyle(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].fillarea_pattern_border_style; } //!< get fill pattern border style of curve c of layer l of graph s
- int curveFillPatternBorderColor(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].fillarea_pattern_border_color; } //!< get fill pattern border color of curve c of layer l of graph s
- double curveFillPatternBorderWidth(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].fillarea_pattern_border_width; } //!< get fill pattern border line width of curve c of layer l of graph s
-
- int curveSymbolType(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].symbol_type; } //!< get symbol type of curve c of layer l of graph s
- int curveSymbolColor(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].symbol_color; } //!< get symbol color of curve c of layer l of graph s
- int curveSymbolFillColor(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].symbol_fill_color; } //!< get symbol fill color of curve c of layer l of graph s
- double curveSymbolSize(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].symbol_size; } //!< get symbol size of curve c of layer l of graph s
- int curveSymbolThickness(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].symbol_thickness; } //!< get symbol thickness of curve c of layer l of graph s
-
- pieProperties curvePieProperties(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].pie; } //!< get pie properties of curve c of layer l of graph s
- vectorProperties curveVectorProperties(int s, int l, int c) const { return GRAPH[s].layer[l].curve[c].vector; } //!< get vector properties of curve c of layer l of graph s
-
- int numNotes() const { return static_cast<int>(NOTE.size()); } //!< get number of notes
- const char *noteName(int n) const { return NOTE[n].name.c_str(); } //!< get name of note n
- const char *noteLabel(int n) const { return NOTE[n].label.c_str(); } //!< get label of note n
- const char *noteText(int n) const { return NOTE[n].text.c_str(); } //!< get text of note n
- double noteCreationDate(int n) const { return NOTE[n].creation_date; } //!< get creation date of note n
- double noteModificationDate(int n) const { return NOTE[n].modification_date; } //!< get modification date of note n
- originWindow::State noteState(int n) const { return NOTE[n].state; } //!< get window state of note n
- originWindow::Title noteTitle(int n) const { return NOTE[n].title; } //!< get window state of note n
-
- const char* resultsLogString() const { return resultsLog.c_str();} //!< get Results Log
+ OPJFile(const char *filename);
+ ~OPJFile() {
+ for (unsigned int g = 0; g < GRAPH.size(); ++g)
+ for (unsigned int l = 0; l < GRAPH[g].layer.size(); ++l)
+ for (unsigned int b = 0; b < GRAPH[g].layer[l].bitmaps.size(); ++b)
+ if (GRAPH[g].layer[l].bitmaps[b].size > 0)
+ delete GRAPH[g].layer[l].bitmaps[b].data;
+ }
+ int Parse();
+ double Version() const {
+ return version / 100.0;
+ } //!< get version of project file
+
+ const tree<projectNode> *project() const { return &projectTree; }
+ // spreadsheet properties
+ int numSpreads() const {
+ return static_cast<int>(SPREADSHEET.size());
+ } //!< get number of spreadsheets
+ const char *spreadName(int s) const {
+ return SPREADSHEET[s].name.c_str();
+ } //!< get name of spreadsheet s
+ bool spreadHidden(int s) const {
+ return SPREADSHEET[s].bHidden;
+ } //!< is spreadsheet s hidden
+ bool spreadLoose(int s) const {
+ return SPREADSHEET[s].bLoose;
+ } //!< is spreadsheet s loose
+ rect spreadWindowRect(int s) const {
+ return SPREADSHEET[s].clientRect;
+ } //!< get window rectangle of spreadsheet s
+ const char *spreadLabel(int s) const {
+ return SPREADSHEET[s].label.c_str();
+ } //!< get label of spreadsheet s
+ double spreadCreationDate(int s) const {
+ return SPREADSHEET[s].creation_date;
+ } //!< get creation date of spreadsheet s
+ double spreadModificationDate(int s) const {
+ return SPREADSHEET[s].modification_date;
+ } //!< get modification date of spreadsheet s
+ originWindow::State spreadState(int s) const {
+ return SPREADSHEET[s].state;
+ } //!< get window state of spreadsheet s
+ originWindow::Title spreadTitle(int s) const {
+ return SPREADSHEET[s].title;
+ } //!< get window state of spreadsheet s
+ int numCols(int s) const {
+ return static_cast<int>(SPREADSHEET[s].column.size());
+ } //!< get number of columns of spreadsheet s
+ int numRows(int s, int c) const {
+ return static_cast<int>(SPREADSHEET[s].column[c].odata.size());
+ } //!< get number of rows of column c of spreadsheet s
+ int maxRows(int s) const {
+ return SPREADSHEET[s].maxRows;
+ } //!< get maximum number of rows of spreadsheet s
+
+ // spreadsheet's column properties
+ const char *colName(int s, int c) const {
+ return SPREADSHEET[s].column[c].name.c_str();
+ } //!< get name of column c of spreadsheet s
+ ColumnType colType(int s, int c) const {
+ return SPREADSHEET[s].column[c].type;
+ } //!< get type of column c of spreadsheet s
+ const char *colCommand(int s, int c) const {
+ return SPREADSHEET[s].column[c].command.c_str();
+ } //!< get command of column c of spreadsheet s
+ const char *colComment(int s, int c) const {
+ return SPREADSHEET[s].column[c].comment.c_str();
+ } //!< get comment of column c of spreadsheet s
+ int colValueType(int s, int c) const {
+ return SPREADSHEET[s].column[c].value_type;
+ } //!< get value type of column c of spreadsheet s
+ int colValueTypeSpec(int s, int c) const {
+ return SPREADSHEET[s].column[c].value_type_specification;
+ } //!< get value type specification of column c of spreadsheet s
+ int colSignificantDigits(int s, int c) const {
+ return SPREADSHEET[s].column[c].significant_digits;
+ } //!< get significant digits of column c of spreadsheet s
+ int colDecPlaces(int s, int c) const {
+ return SPREADSHEET[s].column[c].decimal_places;
+ } //!< get decimal places of column c of spreadsheet s
+ int colNumDisplayType(int s, int c) const {
+ return SPREADSHEET[s].column[c].numeric_display_type;
+ } //!< get numeric display type of column c of spreadsheet s
+ int colWidth(int s, int c) const {
+ return SPREADSHEET[s].column[c].width;
+ } //!< get width of column c of spreadsheet s
+ void *oData(int s, int c, int r, bool alwaysDouble = false) const {
+ if (alwaysDouble)
+ return (void *)const_cast<double *>(&SPREADSHEET[s].column[c].odata[r].d);
+ if (SPREADSHEET[s].column[c].odata[r].type == 0)
+ return (void *)const_cast<double *>(&SPREADSHEET[s].column[c].odata[r].d);
+ else
+ return (void *)const_cast<char *>(
+ SPREADSHEET[s].column[c].odata[r].s.c_str());
+ } //!< get data of column c/row r of spreadsheet s
+
+ // matrix properties
+ int numMatrices() const {
+ return static_cast<int>(MATRIX.size());
+ } //!< get number of matrices
+ const char *matrixName(int m) const {
+ return MATRIX[m].name.c_str();
+ } //!< get name of matrix m
+ bool matrixHidden(int m) const {
+ return MATRIX[m].bHidden;
+ } //!< is matrix m hidden
+ rect matrixWindowRect(int m) const {
+ return MATRIX[m].clientRect;
+ } //!< get window rectangle of matrix m
+ const char *matrixLabel(int m) const {
+ return MATRIX[m].label.c_str();
+ } //!< get label of matrix m
+ double matrixCreationDate(int m) const {
+ return MATRIX[m].creation_date;
+ } //!< get creation date of matrix m
+ double matrixModificationDate(int m) const {
+ return MATRIX[m].modification_date;
+ } //!< get modification date of matrix m
+ originWindow::State matrixState(int m) const {
+ return MATRIX[m].state;
+ } //!< get window state of matrix m
+ originWindow::Title matrixTitle(int m) const {
+ return MATRIX[m].title;
+ } //!< get window state of matrix m
+ int numMatrixCols(int m) const {
+ return MATRIX[m].nr_cols;
+ } //!< get number of columns of matrix m
+ int numMatrixRows(int m) const {
+ return MATRIX[m].nr_rows;
+ } //!< get number of rows of matrix m
+ const char *matrixFormula(int m) const {
+ return MATRIX[m].command.c_str();
+ } //!< get formula of matrix m
+ int matrixValueTypeSpec(int m) const {
+ return MATRIX[m].value_type_specification;
+ } //!< get value type specification of matrix m
+ int matrixSignificantDigits(int m) const {
+ return MATRIX[m].significant_digits;
+ } //!< get significant digits of matrix m
+ int matrixDecPlaces(int m) const {
+ return MATRIX[m].decimal_places;
+ } //!< get decimal places of matrix m
+ int matrixNumDisplayType(int m) const {
+ return MATRIX[m].numeric_display_type;
+ } //!< get numeric display type of matrix m
+ int matrixWidth(int m) const {
+ return MATRIX[m].width;
+ } //!< get width of matrix m
+ matrix::ViewType matrixViewType(int m) const {
+ return MATRIX[m].view;
+ } //!< get view type of matrix m
+ matrix::HeaderViewType matrixHeaderViewType(int m) const {
+ return MATRIX[m].header;
+ } //!< get header view type of matrix m
+ double matrixData(int m, int c, int r) const {
+ return MATRIX[m].data[r * MATRIX[m].nr_cols + c];
+ } //!< get data of row r of column c of matrix m
+ std::vector<double> matrixData(int m) const {
+ return MATRIX[m].data;
+ } //!< get data of matrix m
+
+ // function properties
+ int numFunctions() const {
+ return static_cast<int>(FUNCTION.size());
+ } //!< get number of functions
+ int functionIndex(const char *s) const {
+ return compareFunctionnames(s);
+ } //!< get name of function s
+ const char *functionName(int s) const {
+ return FUNCTION[s].name.c_str();
+ } //!< get name of function s
+ int functionType(int s) const {
+ return FUNCTION[s].type;
+ } //!< get type of function s
+ double functionBegin(int s) const {
+ return FUNCTION[s].begin;
+ } //!< get begin of interval of function s
+ double functionEnd(int s) const {
+ return FUNCTION[s].end;
+ } //!< get end of interval of function s
+ int functionPoints(int s) const {
+ return FUNCTION[s].points;
+ } //!< get number of points in interval of function s
+ const char *functionFormula(int s) const {
+ return FUNCTION[s].formula.c_str();
+ } //!< get formula of function s
+
+ // graph properties
+ enum Color {
+ Black = 0,
+ Red = 1,
+ Green = 2,
+ Blue = 3,
+ Cyan = 4,
+ Magenta = 5,
+ Yellow = 6,
+ DarkYellow = 7,
+ Navy = 8,
+ Purple = 9,
+ Wine = 10,
+ Olive = 11,
+ DarkCyan = 12,
+ Royal = 13,
+ Orange = 14,
+ Violet = 15,
+ Pink = 16,
+ White = 17,
+ LightGray = 18,
+ Gray = 19,
+ LTYellow = 20,
+ LTCyan = 21,
+ LTMagenta = 22,
+ DarkGray = 23,
+ Custom = 255
+ };
+
+ enum Plot {
+ Line = 200,
+ Scatter = 201,
+ LineSymbol = 202,
+ Column = 203,
+ Area = 204,
+ HiLoClose = 205,
+ Box = 206,
+ ColumnFloat = 207,
+ Vector = 208,
+ PlotDot = 209,
+ Wall3D = 210,
+ Ribbon3D = 211,
+ Bar3D = 212,
+ ColumnStack = 213,
+ AreaStack = 214,
+ Bar = 215,
+ BarStack = 216,
+ FlowVector = 218,
+ Histogram = 219,
+ MatrixImage = 220,
+ Pie = 225,
+ Contour = 226,
+ Unknown = 230,
+ ErrorBar = 231,
+ TextPlot = 232,
+ XErrorBar = 233,
+ SurfaceColorMap = 236,
+ SurfaceColorFill = 237,
+ SurfaceWireframe = 238,
+ SurfaceBars = 239,
+ Line3D = 240,
+ Text3D = 241,
+ Mesh3D = 242,
+ XYZTriangular = 245,
+ LineSeries = 246,
+ YErrorBar = 254,
+ XYErrorBar = 255,
+ GraphScatter3D = 0x8AF0,
+ GraphTrajectory3D = 0x8AF1,
+ Polar = 0x00020000,
+ SmithChart = 0x00040000,
+ FillArea = 0x00800000
+ };
+
+ enum LineStyle {
+ Solid = 0,
+ Dash = 1,
+ Dot = 2,
+ DashDot = 3,
+ DashDotDot = 4,
+ ShortDash = 5,
+ ShortDot = 6,
+ ShortDashDot = 7
+ };
+
+ enum LineConnect {
+ NoLine = 0,
+ Straight = 1,
+ TwoPointSegment = 2,
+ ThreePointSegment = 3,
+ BSpline = 8,
+ Spline = 9,
+ StepHorizontal = 11,
+ StepVertical = 12,
+ StepHCenter = 13,
+ StepVCenter = 14,
+ Bezier = 15
+ };
+
+ enum Scale {
+ Linear = 0,
+ Log10 = 1,
+ Probability = 2,
+ Probit = 3,
+ Reciprocal = 4,
+ OffsetReciprocal = 5,
+ Logit = 6,
+ Ln = 7,
+ Log2 = 8
+ };
+
+ enum ValueType {
+ Numeric = 0,
+ Text = 1,
+ Time = 2,
+ Date = 3,
+ Month = 4,
+ Day = 5,
+ ColumnHeading = 6,
+ TickIndexedDataset = 7,
+ TextNumeric = 9,
+ Categorical = 10
+ };
+
+ enum BorderType {
+ BlackLine = 0,
+ Shadow = 1,
+ DarkMarble = 2,
+ WhiteOut = 3,
+ BlackOut = 4,
+ None = -1
+ };
+
+ enum Attach { Frame = 0, Page = 1, Scale = 2 };
+
+ enum VectorPosition { Tail, Midpoint, Head };
+
+ int numGraphs() const {
+ return static_cast<int>(GRAPH.size());
+ } //!< get number of graphs
+ const char *graphName(int s) const {
+ return GRAPH[s].name.c_str();
+ } //!< get name of graph s
+ const char *graphLabel(int s) const {
+ return GRAPH[s].label.c_str();
+ } //!< get name of graph s
+ double graphCreationDate(int s) const {
+ return GRAPH[s].creation_date;
+ } //!< get creation date of graph s
+ double graphModificationDate(int s) const {
+ return GRAPH[s].modification_date;
+ } //!< get modification date of graph s
+ originWindow::State graphState(int s) const {
+ return GRAPH[s].state;
+ } //!< get window state of graph s
+ originWindow::Title graphTitle(int s) const {
+ return GRAPH[s].title;
+ } //!< get window state of graph s
+ bool graphHidden(int s) const {
+ return GRAPH[s].bHidden;
+ } //!< is graph s hidden
+ rect graphRect(int s) const {
+ return rect(GRAPH[s].width, GRAPH[s].height);
+ } //!< get rectangle of graph s
+ rect graphWindowRect(int s) const {
+ return GRAPH[s].clientRect;
+ } //!< get window rectangle of graph s
+ int numLayers(int s) const {
+ return static_cast<int>(GRAPH[s].layer.size());
+ } //!< get number of layers of graph s
+ rect layerRect(int s, int l) const {
+ return GRAPH[s].layer[l].clientRect;
+ } //!< get rectangle of layer l of graph s
+ text layerXAxisTitle(int s, int l) const {
+ return GRAPH[s].layer[l].xAxis.label;
+ } //!< get label of X-axis of layer l of graph s
+ text layerYAxisTitle(int s, int l) const {
+ return GRAPH[s].layer[l].yAxis.label;
+ } //!< get label of Y-axis of layer l of graph s
+ text layerLegend(int s, int l) const {
+ return GRAPH[s].layer[l].legend;
+ } //!< get legend of layer l of graph s
+ std::vector<text> layerTexts(int s, int l) const {
+ return GRAPH[s].layer[l].texts;
+ } //!< get texts of layer l of graph s
+ std::vector<line> layerLines(int s, int l) const {
+ return GRAPH[s].layer[l].lines;
+ } //!< get lines of layer l of graph s
+ std::vector<bitmap> layerBitmaps(int s, int l) const {
+ return GRAPH[s].layer[l].bitmaps;
+ } //!< get bitmaps of layer l of graph s
+ graphAxisBreak layerXBreak(int s, int l) const {
+ return GRAPH[s].layer[l].xAxisBreak;
+ } //!< get break of horizontal axis of layer l of graph s
+ graphAxisBreak layerYBreak(int s, int l) const {
+ return GRAPH[s].layer[l].yAxisBreak;
+ } //!< get break of vertical axis of layer l of graph s
+ graphLayerRange layerXRange(int s, int l) const {
+ return graphLayerRange(GRAPH[s].layer[l].xAxis.min,
+ GRAPH[s].layer[l].xAxis.max,
+ GRAPH[s].layer[l].xAxis.step);
+ } //!< get X-range of layer l of graph s
+ graphLayerRange layerYRange(int s, int l) const {
+ return graphLayerRange(GRAPH[s].layer[l].yAxis.min,
+ GRAPH[s].layer[l].yAxis.max,
+ GRAPH[s].layer[l].yAxis.step);
+ } //!< get Y-range of layer l of graph s
+ std::vector<int> layerXTicks(int s, int l) const {
+ std::vector<int> tick;
+ tick.push_back(GRAPH[s].layer[l].xAxis.majorTicks);
+ tick.push_back(GRAPH[s].layer[l].xAxis.minorTicks);
+ return tick;
+ } //!< get X-axis ticks of layer l of graph s
+ std::vector<int> layerYTicks(int s, int l) const {
+ std::vector<int> tick;
+ tick.push_back(GRAPH[s].layer[l].yAxis.majorTicks);
+ tick.push_back(GRAPH[s].layer[l].yAxis.minorTicks);
+ return tick;
+ } //!< get Y-axis ticks of layer l of graph s
+ std::vector<graphGrid> layerGrid(int s, int l) const {
+ std::vector<graphGrid> grid;
+ grid.push_back(GRAPH[s].layer[l].xAxis.majorGrid);
+ grid.push_back(GRAPH[s].layer[l].xAxis.minorGrid);
+ grid.push_back(GRAPH[s].layer[l].yAxis.majorGrid);
+ grid.push_back(GRAPH[s].layer[l].yAxis.minorGrid);
+ return grid;
+ } //!< get grid of layer l of graph s
+ std::vector<graphAxisFormat> layerAxisFormat(int s, int l) const {
+ std::vector<graphAxisFormat> format;
+ format.push_back(GRAPH[s].layer[l].yAxis.formatAxis[0]); // bottom
+ format.push_back(GRAPH[s].layer[l].yAxis.formatAxis[1]); // top
+ format.push_back(GRAPH[s].layer[l].xAxis.formatAxis[0]); // left
+ format.push_back(GRAPH[s].layer[l].xAxis.formatAxis[1]); // right
+ return format;
+ } //!< get title and format of axes of layer l of graph s
+ std::vector<graphAxisTick> layerAxisTickLabels(int s, int l) const {
+ std::vector<graphAxisTick> tick;
+ tick.push_back(GRAPH[s].layer[l].yAxis.tickAxis[0]); // bottom
+ tick.push_back(GRAPH[s].layer[l].yAxis.tickAxis[1]); // top
+ tick.push_back(GRAPH[s].layer[l].xAxis.tickAxis[0]); // left
+ tick.push_back(GRAPH[s].layer[l].xAxis.tickAxis[1]); // right
+ return tick;
+ } //!< get tick labels of axes of layer l of graph s
+ std::vector<double> layerHistogram(int s, int l) const {
+ std::vector<double> range;
+ range.push_back(GRAPH[s].layer[l].histogram_bin);
+ range.push_back(GRAPH[s].layer[l].histogram_begin);
+ range.push_back(GRAPH[s].layer[l].histogram_end);
+ return range;
+ } //!< get histogram bin of layer l of graph s
+ int layerXScale(int s, int l) const {
+ return GRAPH[s].layer[l].xAxis.scale;
+ } //!< get scale of X-axis of layer l of graph s
+ int layerYScale(int s, int l) const {
+ return GRAPH[s].layer[l].yAxis.scale;
+ } //!< get scale of Y-axis of layer l of graph s
+ int numCurves(int s, int l) const {
+ return static_cast<int>(GRAPH[s].layer[l].curve.size());
+ } //!< get number of curves of layer l of graph s
+ const char *curveDataName(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].dataName.c_str();
+ } //!< get data source name of curve c of layer l of graph s
+ const char *curveXColName(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].xColName.c_str();
+ } //!< get X-column name of curve c of layer l of graph s
+ const char *curveYColName(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].yColName.c_str();
+ } //!< get Y-column name of curve c of layer l of graph s
+ int curveType(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].type;
+ } //!< get type of curve c of layer l of graph s
+ int curveLineStyle(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].line_style;
+ } //!< get line style of curve c of layer l of graph s
+ int curveLineColor(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].line_color;
+ } //!< get line color of curve c of layer l of graph s
+ int curveLineConnect(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].line_connect;
+ } //!< get line connect of curve c of layer l of graph s
+ double curveLineWidth(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].line_width;
+ } //!< get line width of curve c of layer l of graph s
+
+ bool curveIsFilledArea(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].fillarea;
+ } //!< get is filled area of curve c of layer l of graph s
+ int curveFillAreaColor(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].fillarea_color;
+ } //!< get area fillcolor of curve c of layer l of graph s
+ int curveFillAreaFirstColor(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].fillarea_first_color;
+ } //!< get area first fillcolor of curve c of layer l of graph s
+ int curveFillPattern(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].fillarea_pattern;
+ } //!< get fill pattern of curve c of layer l of graph s
+ int curveFillPatternColor(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].fillarea_pattern_color;
+ } //!< get fill pattern color of curve c of layer l of graph s
+ double curveFillPatternWidth(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].fillarea_pattern_width;
+ } //!< get fill pattern line width of curve c of layer l of graph s
+ int curveFillPatternBorderStyle(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].fillarea_pattern_border_style;
+ } //!< get fill pattern border style of curve c of layer l of graph s
+ int curveFillPatternBorderColor(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].fillarea_pattern_border_color;
+ } //!< get fill pattern border color of curve c of layer l of graph s
+ double curveFillPatternBorderWidth(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].fillarea_pattern_border_width;
+ } //!< get fill pattern border line width of curve c of layer l of graph s
+
+ int curveSymbolType(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].symbol_type;
+ } //!< get symbol type of curve c of layer l of graph s
+ int curveSymbolColor(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].symbol_color;
+ } //!< get symbol color of curve c of layer l of graph s
+ int curveSymbolFillColor(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].symbol_fill_color;
+ } //!< get symbol fill color of curve c of layer l of graph s
+ double curveSymbolSize(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].symbol_size;
+ } //!< get symbol size of curve c of layer l of graph s
+ int curveSymbolThickness(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].symbol_thickness;
+ } //!< get symbol thickness of curve c of layer l of graph s
+
+ pieProperties curvePieProperties(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].pie;
+ } //!< get pie properties of curve c of layer l of graph s
+ vectorProperties curveVectorProperties(int s, int l, int c) const {
+ return GRAPH[s].layer[l].curve[c].vector;
+ } //!< get vector properties of curve c of layer l of graph s
+
+ int numNotes() const {
+ return static_cast<int>(NOTE.size());
+ } //!< get number of notes
+ const char *noteName(int n) const {
+ return NOTE[n].name.c_str();
+ } //!< get name of note n
+ const char *noteLabel(int n) const {
+ return NOTE[n].label.c_str();
+ } //!< get label of note n
+ const char *noteText(int n) const {
+ return NOTE[n].text.c_str();
+ } //!< get text of note n
+ double noteCreationDate(int n) const {
+ return NOTE[n].creation_date;
+ } //!< get creation date of note n
+ double noteModificationDate(int n) const {
+ return NOTE[n].modification_date;
+ } //!< get modification date of note n
+ originWindow::State noteState(int n) const {
+ return NOTE[n].state;
+ } //!< get window state of note n
+ originWindow::Title noteTitle(int n) const {
+ return NOTE[n].title;
+ } //!< get window state of note n
+
+ const char *resultsLogString() const {
+ return resultsLog.c_str();
+ } //!< get Results Log
private:
- bool IsBigEndian();
- void ByteSwap(unsigned char * b, int n);
- int ParseFormatOld();
- int ParseFormatNew();
- int compareSpreadnames(char *sname) const; //!< returns matching spread index
- int compareExcelnames(char *sname) const; //!< returns matching excel index
- int compareColumnnames(int spread, char *sname) const; //!< returns matching column index
- int compareExcelColumnnames(int excel, int sheet, char *sname) const; //!< returns matching column index
- int compareMatrixnames(char *sname) const; //!< returns matching matrix index
- int compareFunctionnames(const char *sname) const; //!< returns matching function index
- std::vector<std::string> findDataByIndex(int index) const;
- std::string findObjectByIndex(int index);
- void readSpreadInfo(FILE *fopj, FILE *fdebug);
- void readExcelInfo(FILE *f, FILE *debug);
- void readMatrixInfo(FILE *fopj, FILE *fdebug);
- void readGraphInfo(FILE *fopj, FILE *fdebug);
- void readGraphGridInfo(graphGrid &grid, FILE *fopj, int pos);
- void readGraphAxisBreakInfo(graphAxisBreak &axis_break, FILE *fopj, int pos);
- void readGraphAxisFormatInfo(graphAxisFormat &format, FILE *fopj, int pos);
- void readGraphAxisTickLabelsInfo(graphAxisTick &tick, FILE *fopj, int pos);
- void readProjectTree(FILE *f, FILE *debug);
- void readProjectTreeFolder(FILE *f, FILE *debug, tree<projectNode>::iterator parent);
- void readWindowProperties(originWindow& window, FILE *f, FILE *debug, int POS, int headersize);
- void skipObjectInfo(FILE *fopj, FILE *fdebug);
- void setColName(int spread); //!< set default column name starting from spreadsheet spread
- void convertSpreadToExcel(int spread);
- const char* filename; //!< project file name
- int version; //!< project version
- int dataIndex;
- int objectIndex;
- std::string resultsLog;
- std::vector <spreadSheet> SPREADSHEET;
- std::vector <matrix> MATRIX;
- std::vector <excel> EXCEL;
- std::vector <function> FUNCTION;
- std::vector <graph> GRAPH;
- std::vector <note> NOTE;
- tree <projectNode> projectTree;
+ bool IsBigEndian();
+ void ByteSwap(unsigned char *b, int n);
+ int ParseFormatOld();
+ int ParseFormatNew();
+ int compareSpreadnames(char *sname) const; //!< returns matching spread index
+ int compareExcelnames(char *sname) const; //!< returns matching excel index
+ int compareColumnnames(int spread,
+ char *sname) const; //!< returns matching column index
+ int compareExcelColumnnames(int excel, int sheet, char *sname)
+ const; //!< returns matching column index
+ int compareMatrixnames(char *sname) const; //!< returns matching matrix index
+ int compareFunctionnames(
+ const char *sname) const; //!< returns matching function index
+ std::vector<std::string> findDataByIndex(int index) const;
+ std::string findObjectByIndex(int index);
+ void readSpreadInfo(FILE *fopj, int file_size, FILE *fdebug);
+ void readExcelInfo(FILE *f, int file_size, FILE *debug);
+ void readMatrixInfo(FILE *fopj, int file_size, FILE *fdebug);
+ void readGraphInfo(FILE *fopj, int file_size, FILE *fdebug);
+ void readGraphGridInfo(graphGrid &grid, FILE *fopj, FILE *debug, int pos);
+ void readGraphAxisBreakInfo(graphAxisBreak &axis_break, FILE *fopj,
+ FILE *debug, int pos);
+ void readGraphAxisFormatInfo(graphAxisFormat &format, FILE *fopj, FILE *debug,
+ int pos);
+ void readGraphAxisTickLabelsInfo(graphAxisTick &tick, FILE *fopj, FILE *debug,
+ int pos);
+ void readProjectTree(FILE *f, FILE *debug);
+ void readProjectTreeFolder(FILE *f, FILE *debug,
+ tree<projectNode>::iterator parent);
+ void readWindowProperties(originWindow &window, FILE *f, FILE *debug, int POS,
+ int headersize);
+ void skipObjectInfo(FILE *fopj, FILE *fdebug);
+ void setColName(
+ int spread); //!< set default column name starting from spreadsheet spread
+ void convertSpreadToExcel(int spread);
+ const char *filename; //!< project file name
+ int version; //!< project version
+ int dataIndex;
+ int objectIndex;
+ std::string resultsLog;
+ std::vector<spreadSheet> SPREADSHEET;
+ std::vector<matrix> MATRIX;
+ std::vector<excel> EXCEL;
+ std::vector<function> FUNCTION;
+ std::vector<graph> GRAPH;
+ std::vector<note> NOTE;
+ tree<projectNode> projectTree;
};
#endif // OPJFILE_H
diff --git a/MantidQt/API/test/PlotAxisTest.h b/MantidQt/API/test/PlotAxisTest.h
index 8816dce04c058560b7f0dedc5eaae17b7abefa4e..302f9be5c1512e1386832e218ea1e9e82a8ae8cf 100644
--- a/MantidQt/API/test/PlotAxisTest.h
+++ b/MantidQt/API/test/PlotAxisTest.h
@@ -138,8 +138,10 @@ public:
using MantidQt::API::PlotAxis;
using Mantid::Geometry::MDHistoDimension;
using Mantid::Kernel::UnitLabel;
-
- MDHistoDimension dim("tof", "dimx", UnitLabel("us",L"\u03bcs","\\mu s"), 0.0f, 1.0f, 10);
+ Mantid::Geometry::GeneralFrame frame(
+ Mantid::Geometry::GeneralFrame::GeneralFrameTOF,
+ UnitLabel("us", L"\u03bcs", "\\mu s"));
+ MDHistoDimension dim("tof", "dimx", frame, 0.0f, 1.0f, 10);
QString expected = QString::fromWCharArray(L"tof (\u03bcs)");
TS_ASSERT_EQUALS(expected, PlotAxis(dim).title());
}
diff --git a/MantidQt/CustomInterfaces/inc/MantidQtCustomInterfaces/Indirect/ContainerSubtraction.ui b/MantidQt/CustomInterfaces/inc/MantidQtCustomInterfaces/Indirect/ContainerSubtraction.ui
index f940b14a98cff79d60eb0e22dce578a06f62279c..c98b9805596623d125ca25a3e9e1ea2108344948 100644
--- a/MantidQt/CustomInterfaces/inc/MantidQtCustomInterfaces/Indirect/ContainerSubtraction.ui
+++ b/MantidQt/CustomInterfaces/inc/MantidQtCustomInterfaces/Indirect/ContainerSubtraction.ui
@@ -114,7 +114,7 @@
<item row="0" column="0">
<widget class="QCheckBox" name="ckScaleCan">
<property name="text">
- <string>Scale Can by factor:</string>
+ <string>Scale Container by factor:</string>
</property>
<property name="checked">
<bool>false</bool>
@@ -134,6 +134,9 @@
<property name="maximum">
<double>999.990000000000009</double>
</property>
+ <property name="minimum">
+ <double>-0.000000000000000</double>
+ </property>
<property name="singleStep">
<double>0.100000000000000</double>
</property>
@@ -142,18 +145,41 @@
</property>
</widget>
</item>
+ </layout>
+ </item>
+ <item row="1" column="0">
+ <widget class="QCheckBox" name="ckShiftCan">
+ <property name="text">
+ <string>Shift x-values of container by adding:</string>
+ </property>
+ <property name="checked">
+ <bool>false</bool>
+ </property>
+ </widget>
+ </item>
+ <item row="1" column="1">
+ <layout class="QHBoxLayout" name="loShift">
<item>
- <spacer name="horizontalSpacer">
- <property name="orientation">
- <enum>Qt::Horizontal</enum>
+ <widget class="QDoubleSpinBox" name="spShift">
+ <property name="enabled">
+ <bool>false</bool>
</property>
- <property name="sizeHint" stdset="0">
- <size>
- <width>40</width>
- <height>20</height>
- </size>
+ <property name="decimals">
+ <number>5</number>
</property>
- </spacer>
+ <property name="maximum">
+ <double>999.990000000000009</double>
+ </property>
+ <property name="minimum">
+ <double>-999.990000000000009</double>
+ </property>
+ <property name="singleStep">
+ <double>0.100000000000000</double>
+ </property>
+ <property name="value">
+ <double>0.000000000000000</double>
+ </property>
+ </widget>
</item>
</layout>
</item>
@@ -342,9 +368,9 @@
</hints>
</connection>
<connection>
- <sender>ckUseCorrections</sender>
+ <sender>ckShiftCan</sender>
<signal>toggled(bool)</signal>
- <receiver>dsCorrections</receiver>
+ <receiver>spShift</receiver>
<slot>setEnabled(bool)</slot>
<hints>
<hint type="sourcelabel">
diff --git a/MantidQt/CustomInterfaces/inc/MantidQtCustomInterfaces/SANSRunWindow.h b/MantidQt/CustomInterfaces/inc/MantidQtCustomInterfaces/SANSRunWindow.h
index 0ba6251d4073010e8896130e90d16bf94af5591c..0dc60514e8c56492f6a263d1a0f58d40ac7aeb7c 100644
--- a/MantidQt/CustomInterfaces/inc/MantidQtCustomInterfaces/SANSRunWindow.h
+++ b/MantidQt/CustomInterfaces/inc/MantidQtCustomInterfaces/SANSRunWindow.h
@@ -21,51 +21,46 @@
#include "MantidKernel/ConfigService.h"
#include <vector>
-namespace Mantid
-{
- namespace Kernel
- {
- class Logger;
- }
- namespace API
- {
- class MatrixWorkspace;
- }
+namespace Mantid {
+namespace Kernel {
+class Logger;
+}
+namespace API {
+class MatrixWorkspace;
+}
}
class QAction;
-namespace MantidQt
-{
-namespace CustomInterfaces
-{
- /**
- Implements the SANS, small angle neutron scattering, dialog box
+namespace MantidQt {
+namespace CustomInterfaces {
+/**
+Implements the SANS, small angle neutron scattering, dialog box
- @author Martyn Gigg
+@author Martyn Gigg
- Copyright © 2010 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge National Laboratory & European Spallation Source
+Copyright © 2010 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
+National Laboratory & European Spallation Source
- This file is part of Mantid.
+This file is part of Mantid.
- Mantid is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 3 of the License, or
- (at your option) any later version.
+Mantid is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
- Mantid is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
+Mantid is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
- File change history is stored at: <https://github.com/mantidproject/mantid>
- Code Documentation is available at: <http://doxygen.mantidproject.org>
- */
-class SANSRunWindow : public MantidQt::API::UserSubWindow
-{
+File change history is stored at: <https://github.com/mantidproject/mantid>
+Code Documentation is available at: <http://doxygen.mantidproject.org>
+*/
+class SANSRunWindow : public MantidQt::API::UserSubWindow {
Q_OBJECT
Q_ENUMS(States)
@@ -75,38 +70,43 @@ public:
// This interface's categories.
static QString categoryInfo() { return "SANS"; }
- ///Stores the batch or single run mode selection
+ /// Stores the batch or single run mode selection
enum States {
- NoSample, ///< No sample workspace has yet been loaded
- Loading, ///< Workspaces are loading
- Ready, ///< A sample workspace is loaded and the reduce buttons should be active
- OneD, ///< Signifies a 1D reduction
- TwoD ///< For 2D reductions
+ NoSample, ///< No sample workspace has yet been loaded
+ Loading, ///< Workspaces are loading
+ Ready, ///< A sample workspace is loaded and the reduce buttons should be
+ ///active
+ OneD, ///< Signifies a 1D reduction
+ TwoD ///< For 2D reductions
};
/// Default Constructor
SANSRunWindow(QWidget *parent = 0);
/// Destructor
- ~SANSRunWindow();
-
-
+ ~SANSRunWindow();
+
signals:
- ///Indicate the state of the loaded data.
+ /// Indicate the state of the loaded data.
void dataReadyToProcess(bool state);
- //signal to notify mask file loaded
+ // signal to notify mask file loaded
void userfileLoaded();
private:
- ///Stores the batch or single run mode selection
+ /// Stores the batch or single run mode selection
enum RunMode { SingleMode = 0, BatchMode };
/// mask type
- enum MaskType{ DefaultMask=0,TimeMask=1,PixelMask=2};
+ enum MaskType { DefaultMask = 0, TimeMask = 1, PixelMask = 2 };
/// Enumerate the tabs of this interface.
- enum Tab
- {
- RUN_NUMBERS, REDUCTION_SETTINGS, GEOMETRY, MASKING,
- LOGGING, ADD_RUNS, DIAGNOSTICS, ONE_D_ANALYSIS
+ enum Tab {
+ RUN_NUMBERS,
+ REDUCTION_SETTINGS,
+ GEOMETRY,
+ MASKING,
+ LOGGING,
+ ADD_RUNS,
+ DIAGNOSTICS,
+ ONE_D_ANALYSIS
};
/// Initialize the layout
@@ -123,102 +123,122 @@ private:
void connectAnalysDetSignals();
/// Create the necessary widget maps
void initWidgetMaps();
- ///Read previous settings
+ /// Read previous settings
void readSettings();
- /// Sets the states of the save box controls to the states read from the QSettings object
- void readSaveSettings(QSettings & valueStore);
- ///Save settings
+ /// Sets the states of the save box controls to the states read from the
+ /// QSettings object
+ void readSaveSettings(QSettings &valueStore);
+ /// Save settings
void saveSettings();
- ///Stores the state of the save box controls in QSettings
- void saveSaveSettings(QSettings & valueStore);
+ /// Stores the state of the save box controls in QSettings
+ void saveSaveSettings(QSettings &valueStore);
/// Run a reduce function
- QString runReduceScriptFunction(const QString & pycode);
+ QString runReduceScriptFunction(const QString &pycode);
/// Trim python print markers
- void trimPyMarkers(QString & txt);
+ void trimPyMarkers(QString &txt);
/// Load the user file specified in the text field
bool loadUserFile();
/// Load a CSV file
bool loadCSVFile();
/// Set limits step and type options
- void setLimitStepParameter(const QString & pname, QString param, QLineEdit* step_value, QComboBox* step_type);
- ///Construct mask table
+ void setLimitStepParameter(const QString &pname, QString param,
+ QLineEdit *step_value, QComboBox *step_type);
+ /// Construct mask table
void updateMaskTable();
/// Add spectrum masks to table
- void addSpectrumMasksToTable(const QString & mask_string, const QString & det_name);
+ void addSpectrumMasksToTable(const QString &mask_string,
+ const QString &det_name);
/// Add a time mask string to the mask table
- void addTimeMasksToTable(const QString & mask_string, const QString & det_name);
+ void addTimeMasksToTable(const QString &mask_string, const QString &det_name);
/// Append the given information as a new row to the masking table.
- void appendRowToMaskTable(const QString & type, const QString & detector, const QString & details);
- void readNumberOfEntries(const QString & RunStep, MantidWidgets::MWRunFiles * const output);
+ void appendRowToMaskTable(const QString &type, const QString &detector,
+ const QString &details);
+ void readNumberOfEntries(const QString &RunStep,
+ MantidWidgets::MWRunFiles *const output);
QString readUserFileGUIChanges(const States type);
QString readSampleObjectGUIChanges();
/// Get the component distances
- void componentLOQDistances(boost::shared_ptr<const Mantid::API::MatrixWorkspace> workspace, double & lms, double & lsda, double & lsdb);
+ void componentLOQDistances(
+ boost::shared_ptr<const Mantid::API::MatrixWorkspace> workspace,
+ double &lms, double &lsda, double &lsdb);
/// Enable/disable user interaction
void setProcessingState(const States action);
- ///Check for workspace name in the AnalysisDataService
- bool workspaceExists(const QString & ws_name) const;
- Mantid::API::MatrixWorkspace_sptr getGroupMember(Mantid::API::Workspace_const_sptr in, const int member) const;
- ///Construct a QStringList of the currently loaded workspaces
+ /// Check for workspace name in the AnalysisDataService
+ bool workspaceExists(const QString &ws_name) const;
+ Mantid::API::MatrixWorkspace_sptr
+ getGroupMember(Mantid::API::Workspace_const_sptr in, const int member) const;
+ /// Construct a QStringList of the currently loaded workspaces
QStringList currentWorkspaceList() const;
- ///Is the user file loaded
+ /// Is the user file loaded
bool isUserFileLoaded() const;
/// Create a mask string
- void addUserMaskStrings(QString & exec_script,const QString& importCommand,enum MaskType mType);
+ void addUserMaskStrings(QString &exec_script, const QString &importCommand,
+ enum MaskType mType);
/// Set geometry details
void setGeometryDetails();
/// Set the SANS2D geometry
- void setSANS2DGeometry(boost::shared_ptr<const Mantid::API::MatrixWorkspace> workspace, int wscode);
+ void setSANS2DGeometry(
+ boost::shared_ptr<const Mantid::API::MatrixWorkspace> workspace,
+ int wscode);
/// Set LOQ geometry
- void setLOQGeometry(boost::shared_ptr<const Mantid::API::MatrixWorkspace> workspace, int wscode);
+ void setLOQGeometry(
+ boost::shared_ptr<const Mantid::API::MatrixWorkspace> workspace,
+ int wscode);
/// Mark an error on a label
- void markError(QLabel* label);
+ void markError(QLabel *label);
/// set the name of the output workspace, empty means there is no output
- void resetDefaultOutput(const QString & wsName="");
+ void resetDefaultOutput(const QString &wsName = "");
/// Run an assign command
- bool runAssign(int key, QString & logs);
- /// Load a scatter sample file or can run via Python objects using the passed Python command
- bool assignDetBankRun(MantidWidgets::MWRunFiles & runFile, const QString & assignFn);
+ bool runAssign(int key, QString &logs);
+ /// Load a scatter sample file or can run via Python objects using the passed
+ /// Python command
+ bool assignDetBankRun(MantidWidgets::MWRunFiles &runFile,
+ const QString &assignFn);
/// runs that contain only monitor counts can be direct or transmission runs
- bool assignMonitorRun(MantidWidgets::MWRunFiles & trans, MantidWidgets::MWRunFiles & direct, const QString & assignFn);
+ bool assignMonitorRun(MantidWidgets::MWRunFiles &trans,
+ MantidWidgets::MWRunFiles &direct,
+ const QString &assignFn);
/// Get the detectors' names
void fillDetectNames(QComboBox *output);
QStringList getSaveAlgs();
/// Handle a delete notification from Mantid
- void handleMantidDeleteWorkspace(Mantid::API::WorkspacePostDeleteNotification_ptr p_dnf);
+ void handleMantidDeleteWorkspace(
+ Mantid::API::WorkspacePostDeleteNotification_ptr p_dnf);
// Format a double in a string with a specfied colour, format and precision
- QString formatDouble(double value, const QString & colour = "black", char format = 'f', int precision = 3);
- /// Issue a warning
- void raiseOneTimeMessage(const QString & msg, int index = -1);
+ QString formatDouble(double value, const QString &colour = "black",
+ char format = 'f', int precision = 3);
+ /// Issue a warning
+ void raiseOneTimeMessage(const QString &msg, int index = -1);
/// Reset the geometry box to blank
void resetGeometryDetailsBox();
- ///Cleanup old raw files
+ /// Cleanup old raw files
void cleanup();
/// Flip the reload flag
void forceDataReload(bool force = true);
/// Browse for a file
- bool browseForFile(const QString & box_title, QLineEdit* file_field, QString file_filter = QString());
+ bool browseForFile(const QString &box_title, QLineEdit *file_field,
+ QString file_filter = QString());
/// Add a csv line to the batch grid
int addBatchLine(QString csv_line, QString separator = "");
- ///Save the batch file
- QString saveBatchGrid(const QString & filename = "");
+ /// Save the batch file
+ QString saveBatchGrid(const QString &filename = "");
/// Check that the workspace can have the zero errors removed
- bool isValidWsForRemovingZeroErrors(QString& originalWorkspaceName);
+ bool isValidWsForRemovingZeroErrors(QString &originalWorkspaceName);
//@}
- public slots:
- /// apply mask
- void applyMask(const QString& wsName,bool time_pixel);
+public slots:
+ /// apply mask
+ void applyMask(const QString &wsName, bool time_pixel);
/// Create a zero error free clone for the specified workspace
- void createZeroErrorFreeClone(QString& originalWorkspaceName, QString& clonedWorkspaceName);
+ void createZeroErrorFreeClone(QString &originalWorkspaceName,
+ QString &clonedWorkspaceName);
/// Destroy a zero error free cloned workspace
- void deleteZeroErrorFreeClone(QString& clonedWorkspaceName);
-
+ void deleteZeroErrorFreeClone(QString &clonedWorkspaceName);
private slots:
- /// phi masking has changed
+ /// phi masking has changed
void phiMaskingChanged();
/// phi masking has changed
- void phiMaskingChanged(int i);
+ void phiMaskingChanged(int i);
/// Select the data directory
void selectDataDir();
/// Select the user file
@@ -229,40 +249,42 @@ private slots:
void saveFileBrowse();
/// Raises a dialog that allows people to save multiple workspaces
void saveWorkspacesDialog();
- ///deals with the save workspaces dialog box closing
+ /// deals with the save workspaces dialog box closing
void saveWorkspacesClosed();
/// Receive a load button click
bool handleLoadButtonClick();
/// Reduce button clicked
- void handleReduceButtonClick(const QString & type);
+ void handleReduceButtonClick(const QString &type);
/// Find centre button click handler
void handleRunFindCentre();
- ///Save the output from a single run reduction in the user selected formats
+ /// Save the output from a single run reduction in the user selected formats
void handleDefSaveClick();
void handleWavComboChange(int new_index);
/// A ComboBox option change
void handleStepComboChange(int new_index);
/// Called when the show mask button has been clicked
void handleShowMaskButtonClick();
- ///Handle the change in instrument
+ /// Handle the change in instrument
void handleInstrumentChange();
- ///Record if that user has changed the default filename
+ /// Record if that user has changed the default filename
void setUserFname();
/// Enables or disables the floodFile run widget
void prepareFlood(int state);
- /// Enable the default save button only if there an output workspace and a filename to save it to
+ /// Enable the default save button only if there an output workspace and a
+ /// filename to save it to
void enableOrDisableDefaultSave();
- /// connected to the Multi-period check box it shows or hides the multi-period boxes on the file widgets
+ /// connected to the Multi-period check box it shows or hides the multi-period
+ /// boxes on the file widgets
void disOrEnablePeriods(const int);
/// Switch mode
void switchMode();
- ///Paste to batch table
+ /// Paste to batch table
void pasteToBatchTable();
- ///Clear the batch table
+ /// Clear the batch table
void clearBatchTable();
- ///Clear logger
- void clearLogger();
- ///Default trans changed state
+ /// Clear logger
+ void clearLogger();
+ /// Default trans changed state
void updateTransInfo(int state);
/// So user can decide to use fixed q range or not
void updateFrontDetQrange(int state);
@@ -270,9 +292,9 @@ private slots:
/// Adds a warning message to the tab title
void setLoggerTabTitleToWarn();
/// Handle selection of the transmission
- void transSelectorChanged(int );
+ void transSelectorChanged(int);
void loadTransmissionSettings();
-
+
void handleSlicePushButton();
/// Open the help page of whichever tab the user is currently viewing.
void openHelpPage();
@@ -291,31 +313,26 @@ private slots:
private:
/// used to specify the range of validation to do
- enum ValCheck
- {
- ALL, ///< for checking all validators
- LOAD, ///< for checking the load validators only
- RUN ///< for checking the run validators only
+ enum ValCheck {
+ ALL, ///< for checking all validators
+ LOAD, ///< for checking the load validators only
+ RUN ///< for checking the run validators only
};
- enum TransSettings {
- M3,
- M4,
- RADIUS,
- ROI
- };
+ enum TransSettings { M3, M4, RADIUS, ROI };
/// holds pointer to validators and their locations
- typedef std::map<QWidget * const, std::pair<QWidget *, QWidget *> > ValMap;
+ typedef std::map<QWidget *const, std::pair<QWidget *, QWidget *>> ValMap;
/// The form generated by Qt Designer
Ui::SANSRunWindow m_uiForm;
/// this object holds the functionality in the Add Files tab
SANSAddFiles *m_addFilesTab;
/// this object holds the functionality/ui for the "Display" tab
- SANSPlotSpecial* m_displayTab;
+ SANSPlotSpecial *m_displayTab;
- SANSDiagnostics* m_diagnosticsTab;
- /// this points to a saveWorkspaces, which allows users to save any workspace, when one is opened
+ SANSDiagnostics *m_diagnosticsTab;
+ /// this points to a saveWorkspaces, which allows users to save any workspace,
+ /// when one is opened
MantidWidgets::SaveWorkspaces *m_saveWorkspaces;
/// The data directory (as an absolute path)
QString m_data_dir;
@@ -325,23 +342,29 @@ private:
QString m_last_dir;
/// Is the user file loaded
bool m_cfg_loaded;
- ///True if the user cahnged the default filename text, false otherwise
+ /// True if the user cahnged the default filename text, false otherwise
bool m_userFname;
/// The sample that was loaded
QString m_sample_file;
- /// The workspace containing the experimental run one the sample under investigation
+ /// The workspace containing the experimental run one the sample under
+ /// investigation
QString m_experWksp;
/// The workspace containing the can run
QString m_experCan;
/// List of all run entry widgets, which are on tab page 1
- std::vector< MantidWidgets::MWRunFiles * > m_runFiles;
- /// There validators are searched before a reduction begins. Where there is a problem focus goes to the widget linked to a validator whose tab is also stored in the pair. Disabling a validator QLabel disables checking that validator
+ std::vector<MantidWidgets::MWRunFiles *> m_runFiles;
+ /// There validators are searched before a reduction begins. Where there is a
+ /// problem focus goes to the widget linked to a validator whose tab is also
+ /// stored in the pair. Disabling a validator QLabel disables checking that
+ /// validator
ValMap m_validators;
- /// List of all validators searched through before a load operation is possible
+ /// List of all validators searched through before a load operation is
+ /// possible
ValMap m_loadValids;
/// A list of the full workspace names
std::set<QString> m_workspaceNames;
- /// Stores the last output workspace from single run mode, should be emptied when run in batch mode
+ /// Stores the last output workspace from single run mode, should be emptied
+ /// when run in batch mode
QString m_outputWS;
/// A signal mapper to pick up various button clicks
QSignalMapper *m_reducemapper;
@@ -349,19 +372,23 @@ private:
bool m_warnings_issued;
/// A flag that causes the reload of the data
bool m_force_reload;
- /// Holds pointers to the check box for each supported save format with the name of its save algorithm
- QHash<const QCheckBox * const, QString> m_savFormats;
- typedef QHash<const QCheckBox * const, QString>::const_iterator SavFormatsConstIt;
+ /// Holds pointers to the check box for each supported save format with the
+ /// name of its save algorithm
+ QHash<const QCheckBox *const, QString> m_savFormats;
+ typedef QHash<const QCheckBox *const, QString>::const_iterator
+ SavFormatsConstIt;
/// Get notified when the system input directories have changed
- Poco::NObserver<SANSRunWindow, Mantid::Kernel::ConfigValChangeNotification> m_newInDir;
+ Poco::NObserver<SANSRunWindow, Mantid::Kernel::ConfigValChangeNotification>
+ m_newInDir;
/// An observer for a delete notification from Mantid
- Poco::NObserver<SANSRunWindow, Mantid::API::WorkspacePostDeleteNotification> m_delete_observer;
+ Poco::NObserver<SANSRunWindow, Mantid::API::WorkspacePostDeleteNotification>
+ m_delete_observer;
/// A map of S2D detector names to QLabel pointers
- QList<QHash<QString, QLabel*> > m_s2d_detlabels;
+ QList<QHash<QString, QLabel *>> m_s2d_detlabels;
/// A map of LOQ detector names to QLabel pointers
- QList<QHash<QString, QLabel*> > m_loq_detlabels;
+ QList<QHash<QString, QLabel *>> m_loq_detlabels;
/// A map of allowed batch csv tags to column numbers
- QHash<QString,int> m_allowed_batchtags;
+ QHash<QString, int> m_allowed_batchtags;
/// Indicate if the reduce module has been loaded?
bool m_have_reducemodule;
/// A flag marking if the batch grid has been changed
@@ -370,26 +397,28 @@ private:
QString m_tmp_batchfile;
/// A paste action for the batch table
QAction *m_batch_paste;
- ///A clear action for the batch table
+ /// A clear action for the batch table
QAction *m_batch_clear;
- //Time/Pixel mask string
+ // Time/Pixel mask string
QString m_maskScript;
/// Stores the URL of each tab's help page.
QMap<Tab, QString> m_helpPageUrls;
/// SANS constants
SANSConstants m_constants;
/// Validators
- QValidator* m_mustBeDouble;
- QValidator* m_doubleValidatorZeroToMax;
- QValidator* m_intValidatorZeroToMax;
+ QValidator *m_mustBeDouble;
+ QValidator *m_doubleValidatorZeroToMax;
+ QValidator *m_intValidatorZeroToMax;
void initAnalysDetTab();
- void makeValidator(QLabel * const newValid, QWidget * control, QWidget * tab, const QString & errorMsg);
+ void makeValidator(QLabel *const newValid, QWidget *control, QWidget *tab,
+ const QString &errorMsg);
void upDateDataDir();
- void handleInputDirChange(Mantid::Kernel::ConfigValChangeNotification_ptr pDirInfo);
+ void handleInputDirChange(
+ Mantid::Kernel::ConfigValChangeNotification_ptr pDirInfo);
QString getInstrumentClass() const;
- bool entriesAreValid(const ValCheck check=ALL);
- bool entriesAreValid(ValMap & vals);
+ bool entriesAreValid(const ValCheck check = ALL);
+ bool entriesAreValid(ValMap &vals);
bool runFilesAreValid();
QString reduceSingleRun() const;
void setValidators();
@@ -403,19 +432,21 @@ private:
/// set logic for ROI and mask
void setROIAndMaskLogic(bool isNowChecked);
/// validate float input
- //void validateNumericInput(QString numericInput);
+ // void validateNumericInput(QString numericInput);
/// validate file input
- //void valideateFileInput(QString fileInput);
+ // void valideateFileInput(QString fileInput);
/// set the transmission settings
- //void sendTransmissionSettings();
+ // void sendTransmissionSettings();
/// get the transmission settings
void setTransmissionSettingsFromUserFile();
/// write the transmission settings to a python script
- void writeTransmissionSettingsToPythonScript(QString& pythonCode);
+ void writeTransmissionSettingsToPythonScript(QString &pythonCode);
/// initialize the connections for the transmission settings
void initTransmissionSettings();
/// Set all trans fields to a certain enabled state
void resetAllTransFields();
+ /// Reset the to M3
+ void resetToM3IfNecessary();
/// Check the validty of inputs
bool areSettingsValid();
/// Check setting for wavelengths and Q values
@@ -424,14 +455,14 @@ private:
QComboBox *selection, QString type);
/// Update the beam center fields
void updateBeamCenterCoordinates();
+ /// LOQ specific settings
+ void applyLOQSettings(bool isNowLOQ);
/// Set the beam finder details
void setBeamFinderDetails();
- UserSubWindow * slicingWindow;
-
+ UserSubWindow *slicingWindow;
};
-
}
}
-#endif //MANTIDQTCUSTOMINTERFACES_SANSRUNWINDOW_H_
+#endif // MANTIDQTCUSTOMINTERFACES_SANSRUNWINDOW_H_
diff --git a/MantidQt/CustomInterfaces/src/Indirect/ContainerSubtraction.cpp b/MantidQt/CustomInterfaces/src/Indirect/ContainerSubtraction.cpp
index 0992f1d648ee3dc5ce1a59abc80e75be61dd3ea9..c008d22bafa302038efdbe92ce5fd55943da9ba6 100644
--- a/MantidQt/CustomInterfaces/src/Indirect/ContainerSubtraction.cpp
+++ b/MantidQt/CustomInterfaces/src/Indirect/ContainerSubtraction.cpp
@@ -50,15 +50,41 @@ void ContainerSubtraction::run() {
MatrixWorkspace_sptr canWs =
AnalysisDataService::Instance().retrieveWS<MatrixWorkspace>(
canWsName.toStdString());
+ QString canCloneName = canWsName + "_Shifted";
+ IAlgorithm_sptr clone = AlgorithmManager::Instance().create("CloneWorkspace");
+ clone->initialize();
+ clone->setProperty("InputWorkspace", canWs);
+ clone->setProperty("Outputworkspace", canCloneName.toStdString());
+ clone->execute();
+ MatrixWorkspace_sptr canCloneWs =
+ AnalysisDataService::Instance().retrieveWS<MatrixWorkspace>(
+ canCloneName.toStdString());
+
+ if (m_uiForm.ckShiftCan->isChecked()) {
+ IAlgorithm_sptr scaleX = AlgorithmManager::Instance().create("ScaleX");
+ scaleX->initialize();
+ scaleX->setProperty("InputWorkspace", canCloneWs);
+ scaleX->setProperty("OutputWorkspace", canCloneName.toStdString());
+ scaleX->setProperty("Factor", m_uiForm.spShift->value());
+ scaleX->setProperty("Operation", "Add");
+ scaleX->execute();
+ IAlgorithm_sptr rebin =
+ AlgorithmManager::Instance().create("RebinToWorkspace");
+ rebin->initialize();
+ rebin->setProperty("WorkspaceToRebin", canCloneWs);
+ rebin->setProperty("WorkspaceToMatch", sampleWs);
+ rebin->setProperty("OutputWorkspace", canCloneName.toStdString());
+ rebin->execute();
+ }
// If not in wavelength then do conversion
- std::string originalCanUnits = canWs->getAxis(0)->unit()->unitID();
+ std::string originalCanUnits = canCloneWs->getAxis(0)->unit()->unitID();
if (originalCanUnits != "Wavelength") {
g_log.information("Container workspace not in wavelength, need to "
"convert to continue.");
- absCorProps["CanWorkspace"] = addConvertUnitsStep(canWs, "Wavelength");
+ absCorProps["CanWorkspace"] = addConvertUnitsStep(canCloneWs, "Wavelength");
} else {
- absCorProps["CanWorkspace"] = canWsName.toStdString();
+ absCorProps["CanWorkspace"] = canCloneName.toStdString();
}
bool useCanScale = m_uiForm.ckScaleCan->isChecked();
@@ -68,7 +94,7 @@ void ContainerSubtraction::run() {
}
// Check for same binning across sample and container
- if (!checkWorkspaceBinningMatches(sampleWs, canWs)) {
+ if (!checkWorkspaceBinningMatches(sampleWs, canCloneWs)) {
QString text = "Binning on sample and container does not match."
"Would you like to rebin the sample to match the container?";
@@ -77,7 +103,7 @@ void ContainerSubtraction::run() {
QMessageBox::NoButton);
if (result == QMessageBox::Yes) {
- addRebinStep(sampleWsName, canWsName);
+ addRebinStep(canCloneName, sampleWsName);
} else {
m_batchAlgoRunner->clearQueue();
g_log.error("Cannot apply absorption corrections using a sample and "
@@ -205,9 +231,15 @@ void ContainerSubtraction::plotPreview(int specIndex) {
Qt::green);
// Plot container
- m_uiForm.ppPreview->addSpectrum("Container",
- m_uiForm.dsContainer->getCurrentDataName(),
- specIndex, Qt::red);
+ if (m_uiForm.ckShiftCan->isChecked()) {
+ m_uiForm.ppPreview->addSpectrum(
+ "Container", (m_uiForm.dsContainer->getCurrentDataName() + "_Shifted"),
+ specIndex, Qt::red);
+ } else {
+ m_uiForm.ppPreview->addSpectrum("Container",
+ m_uiForm.dsContainer->getCurrentDataName(),
+ specIndex, Qt::red);
+ }
}
void ContainerSubtraction::postProcessComplete(bool error) {
diff --git a/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp b/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp
index ce826508a671f2b9daba8a086b58cc77a9d36186..fdb9b58f4dec0cb0c1b326bdd302e3c0b6d53e45 100644
--- a/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp
+++ b/MantidQt/CustomInterfaces/src/SANSRunWindow.cpp
@@ -55,13 +55,10 @@
using Mantid::detid_t;
-//Add this class to the list of specialised dialogs in this namespace
-namespace MantidQt
-{
-namespace CustomInterfaces
-{
- DECLARE_SUBWINDOW(SANSRunWindow)
-
+// Add this class to the list of specialised dialogs in this namespace
+namespace MantidQt {
+namespace CustomInterfaces {
+DECLARE_SUBWINDOW(SANSRunWindow)
using namespace MantidQt::MantidWidgets;
using namespace MantidQt::API;
@@ -71,90 +68,91 @@ using namespace Mantid::API;
using namespace Mantid;
using Mantid::Geometry::Instrument_const_sptr;
-namespace
-{
- /// static logger for main window
- Logger g_log("SANSRunWindow");
- /// static logger for centre finding
- Logger g_centreFinderLog("CentreFinder");
-
- typedef boost::shared_ptr<Kernel::PropertyManager> ReductionSettings_sptr;
-
- /**
- * Returns the PropertyManager object that is used to store the settings
- * used by the reduction.
- *
- * There is a corresponding function in scripts/SANS/isis_reducer.py with
- * more information.
- *
- * @returns the reduction settings.
- */
- ReductionSettings_sptr getReductionSettings()
- {
- // Must match name of the PropertyManager used in the reduction.
- static const std::string SETTINGS_PROP_MAN_NAME = "ISISSANSReductionSettings";
-
- if( !PropertyManagerDataService::Instance().doesExist(SETTINGS_PROP_MAN_NAME) )
- {
- g_log.debug() << "Creating reduction settings PropertyManager object, with name "
- << SETTINGS_PROP_MAN_NAME << ".";
-
- const auto propertyManager = boost::make_shared<Kernel::PropertyManager>();
- PropertyManagerDataService::Instance().add(SETTINGS_PROP_MAN_NAME, propertyManager);
-
- return propertyManager;
- }
+namespace {
+/// static logger for main window
+Logger g_log("SANSRunWindow");
+/// static logger for centre finding
+Logger g_centreFinderLog("CentreFinder");
- return PropertyManagerDataService::Instance().retrieve(SETTINGS_PROP_MAN_NAME);
- }
+typedef boost::shared_ptr<Kernel::PropertyManager> ReductionSettings_sptr;
- /**
- * Returns the value of the setting with given name, unless the setting does not
- * exist in which case the given defaultValue is returned.
- *
- * @param settingName :: the name of the setting who's value to return
- * @param defaultValue :: the value to return if the setting does not exist
- *
- * @returns the setting value else defaultValue if the setting does not exist
- */
- QString getSettingWithDefault(const QString & settingName, const QString & defaultValue )
- {
- const auto settings = getReductionSettings();
-
- if( settings->existsProperty(settingName.toStdString()) )
- return QString::fromStdString(settings->getPropertyValue(settingName.toStdString()));
- else
- return defaultValue;
- }
-
- /**
- * Convenience method to set the setting with given name to the given value.
- * If a property with the given name does not exist, then one is created.
- *
- * We could have a templated method at some later date, but at the moment this
- * only works for string properties.
- *
- * @param settingName :: the name of the setting to set
- * @param settingValue :: the value to set this setting with
- */
- void setStringSetting(const QString & settingName, const QString & settingValue )
- {
- const auto settings = getReductionSettings();
- const auto name = settingName.toStdString();
- const auto value = settingValue.toStdString();
-
- if( !settings->existsProperty(name) )
- settings->declareProperty(new Kernel::PropertyWithValue<std::string>(name, ""), value);
- else
- settings->setProperty(name, value);
+/**
+ * Returns the PropertyManager object that is used to store the settings
+ * used by the reduction.
+ *
+ * There is a corresponding function in scripts/SANS/isis_reducer.py with
+ * more information.
+ *
+ * @returns the reduction settings.
+ */
+ReductionSettings_sptr getReductionSettings() {
+ // Must match name of the PropertyManager used in the reduction.
+ static const std::string SETTINGS_PROP_MAN_NAME = "ISISSANSReductionSettings";
+
+ if (!PropertyManagerDataService::Instance().doesExist(
+ SETTINGS_PROP_MAN_NAME)) {
+ g_log.debug()
+ << "Creating reduction settings PropertyManager object, with name "
+ << SETTINGS_PROP_MAN_NAME << ".";
+
+ const auto propertyManager = boost::make_shared<Kernel::PropertyManager>();
+ PropertyManagerDataService::Instance().add(SETTINGS_PROP_MAN_NAME,
+ propertyManager);
+
+ return propertyManager;
}
+
+ return PropertyManagerDataService::Instance().retrieve(
+ SETTINGS_PROP_MAN_NAME);
}
+/**
+ * Returns the value of the setting with given name, unless the setting does not
+ * exist in which case the given defaultValue is returned.
+ *
+ * @param settingName :: the name of the setting who's value to return
+ * @param defaultValue :: the value to return if the setting does not exist
+ *
+ * @returns the setting value else defaultValue if the setting does not exist
+ */
+QString getSettingWithDefault(const QString &settingName,
+ const QString &defaultValue) {
+ const auto settings = getReductionSettings();
+
+ if (settings->existsProperty(settingName.toStdString()))
+ return QString::fromStdString(
+ settings->getPropertyValue(settingName.toStdString()));
+ else
+ return defaultValue;
+}
+
+/**
+ * Convenience method to set the setting with given name to the given value.
+ * If a property with the given name does not exist, then one is created.
+ *
+ * We could have a templated method at some later date, but at the moment this
+ * only works for string properties.
+ *
+ * @param settingName :: the name of the setting to set
+ * @param settingValue :: the value to set this setting with
+ */
+void setStringSetting(const QString &settingName, const QString &settingValue) {
+ const auto settings = getReductionSettings();
+ const auto name = settingName.toStdString();
+ const auto value = settingValue.toStdString();
+
+ if (!settings->existsProperty(name))
+ settings->declareProperty(
+ new Kernel::PropertyWithValue<std::string>(name, ""), value);
+ else
+ settings->setProperty(name, value);
+}
+}
//----------------------------------------------
// Public member functions
//----------------------------------------------
-///Constructor
+/// Constructor
SANSRunWindow::SANSRunWindow(QWidget *parent)
: UserSubWindow(parent), m_addFilesTab(NULL), m_displayTab(NULL),
m_diagnosticsTab(NULL), m_saveWorkspaces(NULL), m_ins_defdir(""),
@@ -166,30 +164,25 @@ SANSRunWindow::SANSRunWindow(QWidget *parent)
m_have_reducemodule(false), m_dirty_batch_grid(false),
m_tmp_batchfile(""), m_batch_paste(NULL), m_batch_clear(NULL),
m_mustBeDouble(NULL), m_doubleValidatorZeroToMax(NULL),
- m_intValidatorZeroToMax(NULL),
- slicingWindow(NULL) {
+ m_intValidatorZeroToMax(NULL), slicingWindow(NULL) {
ConfigService::Instance().addObserver(m_newInDir);
}
-///Destructor
-SANSRunWindow::~SANSRunWindow()
-{
- try
- {
+/// Destructor
+SANSRunWindow::~SANSRunWindow() {
+ try {
ConfigService::Instance().removeObserver(m_newInDir);
- if( isInitialized() )
- {
- // Seems to crash on destruction of if I don't do this
- AnalysisDataService::Instance().notificationCenter.removeObserver(m_delete_observer);
+ if (isInitialized()) {
+ // Seems to crash on destruction of if I don't do this
+ AnalysisDataService::Instance().notificationCenter.removeObserver(
+ m_delete_observer);
saveSettings();
delete m_addFilesTab;
}
delete m_displayTab;
delete m_diagnosticsTab;
- }
- catch(...)
- {
- //we've cleaned up the best we can, move on
+ } catch (...) {
+ // we've cleaned up the best we can, move on
}
}
@@ -199,8 +192,7 @@ SANSRunWindow::~SANSRunWindow()
/**
* Set up the dialog layout
*/
-void SANSRunWindow::initLayout()
-{
+void SANSRunWindow::initLayout() {
g_log.debug("Initializing interface layout");
m_uiForm.setupUi(this);
m_uiForm.inst_opt->addItem("LARMOR");
@@ -210,11 +202,11 @@ void SANSRunWindow::initLayout()
m_reducemapper = new QSignalMapper(this);
- //Set column stretch on the mask table
+ // Set column stretch on the mask table
m_uiForm.mask_table->horizontalHeader()->setStretchLastSection(true);
setupSaveBox();
-
+
connectButtonSignals();
m_uiForm.tabWidget->setCurrentWidget(m_uiForm.runNumbers);
@@ -222,42 +214,44 @@ void SANSRunWindow::initLayout()
m_uiForm.oneDBtn->setEnabled(false);
m_uiForm.twoDBtn->setEnabled(false);
m_uiForm.saveDefault_btn->setEnabled(false);
- for( int i = 1; i < 4; ++i)
- {
+ for (int i = 1; i < 4; ++i) {
m_uiForm.tabWidget->setTabEnabled(i, false);
}
- //Mode switches
- connect(m_uiForm.single_mode_btn, SIGNAL(clicked()),this,SLOT(switchMode()));
- connect(m_uiForm.batch_mode_btn, SIGNAL(clicked()), this,SLOT(switchMode()));
+ // Mode switches
+ connect(m_uiForm.single_mode_btn, SIGNAL(clicked()), this,
+ SLOT(switchMode()));
+ connect(m_uiForm.batch_mode_btn, SIGNAL(clicked()), this, SLOT(switchMode()));
- //Set a custom context menu for the batch table
+ // Set a custom context menu for the batch table
m_uiForm.batch_table->setContextMenuPolicy(Qt::ActionsContextMenu);
- m_batch_paste = new QAction(tr("&Paste"),m_uiForm.batch_table);
+ m_batch_paste = new QAction(tr("&Paste"), m_uiForm.batch_table);
m_batch_paste->setShortcut(tr("Ctrl+P"));
connect(m_batch_paste, SIGNAL(activated()), this, SLOT(pasteToBatchTable()));
m_uiForm.batch_table->addAction(m_batch_paste);
- m_batch_clear = new QAction(tr("&Clear"),m_uiForm.batch_table);
+ m_batch_clear = new QAction(tr("&Clear"), m_uiForm.batch_table);
m_uiForm.batch_table->addAction(m_batch_clear);
connect(m_batch_clear, SIGNAL(activated()), this, SLOT(clearBatchTable()));
// Main Logging
m_uiForm.logging_field->attachLoggingChannel();
- connect(m_uiForm.logging_field, SIGNAL(warningReceived(const QString &)), this, SLOT(setLoggerTabTitleToWarn()));
+ connect(m_uiForm.logging_field, SIGNAL(warningReceived(const QString &)),
+ this, SLOT(setLoggerTabTitleToWarn()));
connect(m_uiForm.logger_clear, SIGNAL(clicked()), this, SLOT(clearLogger()));
// Centre finder logger
m_uiForm.centre_logging->attachLoggingChannel();
- connect(m_uiForm.clear_centre_log, SIGNAL(clicked()), m_uiForm.centre_logging, SLOT(clear()));
+ connect(m_uiForm.clear_centre_log, SIGNAL(clicked()), m_uiForm.centre_logging,
+ SLOT(clear()));
connect(m_uiForm.up_down_checkbox, SIGNAL(stateChanged(int)), this, SLOT(onUpDownCheckboxChanged()));
connect(m_uiForm.left_right_checkbox, SIGNAL(stateChanged(int)), this, SLOT(onLeftRightCheckboxChanged()));
- //Create the widget hash maps
+ // Create the widget hash maps
initWidgetMaps();
m_runFiles.reserve(6);
- //Text edit map
+ // Text edit map
m_runFiles.push_back(m_uiForm.scatterSample);
m_runFiles.push_back(m_uiForm.scatCan);
@@ -267,8 +261,7 @@ void SANSRunWindow::initLayout()
m_runFiles.push_back(m_uiForm.direct);
m_runFiles.push_back(m_uiForm.dirCan);
std::vector<MWRunFiles *>::const_iterator it = m_runFiles.begin();
- for ( ; it != m_runFiles.end(); ++it )
- {
+ for (; it != m_runFiles.end(); ++it) {
(*it)->doButtonOpt(MWRunFiles::Icon);
}
@@ -276,45 +269,52 @@ void SANSRunWindow::initLayout()
initAnalysDetTab();
- if( ! m_addFilesTab )
- {//sets up the AddFiles tab which must be deleted in the destructor
+ if (!m_addFilesTab) { // sets up the AddFiles tab which must be deleted in the
+ // destructor
m_addFilesTab = new SANSAddFiles(this, &m_uiForm);
}
- //diagnostics tab
- if(!m_diagnosticsTab)
- {
- m_diagnosticsTab = new SANSDiagnostics(this,&m_uiForm);
+ // diagnostics tab
+ if (!m_diagnosticsTab) {
+ m_diagnosticsTab = new SANSDiagnostics(this, &m_uiForm);
}
- connect(this,SIGNAL(userfileLoaded()),m_diagnosticsTab,SLOT(enableMaskFileControls()));
- //Listen for Workspace delete signals
- AnalysisDataService::Instance().notificationCenter.addObserver(m_delete_observer);
+ connect(this, SIGNAL(userfileLoaded()), m_diagnosticsTab,
+ SLOT(enableMaskFileControls()));
+ // Listen for Workspace delete signals
+ AnalysisDataService::Instance().notificationCenter.addObserver(
+ m_delete_observer);
// Create the "Display" tab
- if ( ! m_displayTab )
- {
+ if (!m_displayTab) {
m_displayTab = new SANSPlotSpecial(this);
m_uiForm.displayLayout->addWidget(m_displayTab);
}
const QString ISIS_SANS_WIKI = "http://www.mantidproject.org/ISIS_SANS:";
- m_helpPageUrls[Tab::RUN_NUMBERS] = ISIS_SANS_WIKI + "_Run_Numbers";
- m_helpPageUrls[Tab::REDUCTION_SETTINGS] = ISIS_SANS_WIKI + "_Reduction_Settings";
- m_helpPageUrls[Tab::GEOMETRY] = ISIS_SANS_WIKI + "_Geometry";
- m_helpPageUrls[Tab::MASKING] = ISIS_SANS_WIKI + "_Masking";
- m_helpPageUrls[Tab::LOGGING] = ISIS_SANS_WIKI + "_Logging";
- m_helpPageUrls[Tab::ADD_RUNS] = ISIS_SANS_WIKI + "_Add_Runs";
- m_helpPageUrls[Tab::DIAGNOSTICS] = ISIS_SANS_WIKI + "_Diagnostics";
- m_helpPageUrls[Tab::ONE_D_ANALYSIS] = ISIS_SANS_WIKI + "_1D_Analysis";
-
- // connect up phi masking on analysis tab to be in sync with info on masking tab
- connect(m_uiForm.mirror_phi, SIGNAL(clicked()), this, SLOT(phiMaskingChanged()));
- connect(m_uiForm.detbank_sel, SIGNAL(currentIndexChanged(int)), this, SLOT(phiMaskingChanged(int)));
- connect(m_uiForm.phi_min, SIGNAL(editingFinished()), this, SLOT(phiMaskingChanged()));
- connect(m_uiForm.phi_max, SIGNAL(editingFinished()), this, SLOT(phiMaskingChanged()));
- connect(m_uiForm.slicePb, SIGNAL(clicked()), this, SLOT(handleSlicePushButton()));
- connect(m_uiForm.pushButton_Help, SIGNAL(clicked()), this, SLOT(openHelpPage()));
-
+ m_helpPageUrls[Tab::RUN_NUMBERS] = ISIS_SANS_WIKI + "_Run_Numbers";
+ m_helpPageUrls[Tab::REDUCTION_SETTINGS] =
+ ISIS_SANS_WIKI + "_Reduction_Settings";
+ m_helpPageUrls[Tab::GEOMETRY] = ISIS_SANS_WIKI + "_Geometry";
+ m_helpPageUrls[Tab::MASKING] = ISIS_SANS_WIKI + "_Masking";
+ m_helpPageUrls[Tab::LOGGING] = ISIS_SANS_WIKI + "_Logging";
+ m_helpPageUrls[Tab::ADD_RUNS] = ISIS_SANS_WIKI + "_Add_Runs";
+ m_helpPageUrls[Tab::DIAGNOSTICS] = ISIS_SANS_WIKI + "_Diagnostics";
+ m_helpPageUrls[Tab::ONE_D_ANALYSIS] = ISIS_SANS_WIKI + "_1D_Analysis";
+
+ // connect up phi masking on analysis tab to be in sync with info on masking
+ // tab
+ connect(m_uiForm.mirror_phi, SIGNAL(clicked()), this,
+ SLOT(phiMaskingChanged()));
+ connect(m_uiForm.detbank_sel, SIGNAL(currentIndexChanged(int)), this,
+ SLOT(phiMaskingChanged(int)));
+ connect(m_uiForm.phi_min, SIGNAL(editingFinished()), this,
+ SLOT(phiMaskingChanged()));
+ connect(m_uiForm.phi_max, SIGNAL(editingFinished()), this,
+ SLOT(phiMaskingChanged()));
+ connect(m_uiForm.slicePb, SIGNAL(clicked()), this,
+ SLOT(handleSlicePushButton()));
+ connect(m_uiForm.pushButton_Help, SIGNAL(clicked()), this,
+ SLOT(openHelpPage()));
// Setup the Transmission Settings
initTransmissionSettings();
@@ -326,34 +326,36 @@ void SANSRunWindow::initLayout()
}
/** Ssetup the controls for the Analysis Tab on this form
*/
-void SANSRunWindow::initAnalysDetTab()
-{
- //Add shortened forms of step types to step boxes
+void SANSRunWindow::initAnalysDetTab() {
+ // Add shortened forms of step types to step boxes
m_uiForm.q_dq_opt->setItemData(0, "LIN");
m_uiForm.q_dq_opt->setItemData(1, "LOG");
m_uiForm.qy_dqy_opt->setItemData(0, "LIN");
-//remove the following two lines once the beamfinder is in the new framework
+ // remove the following two lines once the beamfinder is in the new framework
m_uiForm.wav_dw_opt->setItemData(0, "LIN");
m_uiForm.wav_dw_opt->setItemData(1, "LOG");
- //the file widget always has a *.* filter, passing an empty list means we get only that
+ // the file widget always has a *.* filter, passing an empty list means we get
+ // only that
m_uiForm.floodRearFile->setAlgorithmProperty("CorrectToFile|Filename");
m_uiForm.floodRearFile->isOptional(true);
m_uiForm.floodFrontFile->setAlgorithmProperty("CorrectToFile|Filename");
m_uiForm.floodFrontFile->isOptional(true);
- //the unicode code for the angstrom symbol is 197, doing the below keeps this file ASCII compatible
+ // the unicode code for the angstrom symbol is 197, doing the below keeps this
+ // file ASCII compatible
static const QChar ANGSROM_SYM(197);
m_uiForm.wavlength_lb->setText(QString("Wavelength (%1)").arg(ANGSROM_SYM));
m_uiForm.qx_lb->setText(QString("Qx (%1^-1)").arg(ANGSROM_SYM));
m_uiForm.qxy_lb->setText(QString("Qxy (%1^-1)").arg(ANGSROM_SYM));
m_uiForm.transFitOnOff->setText(QString("Trans Fit (%1)").arg(ANGSROM_SYM));
- m_uiForm.transFitOnOff_can->setText(QString("Trans Fit (%1)").arg(ANGSROM_SYM));
- m_uiForm.q_rebin->setToolTip("Any string allowed by the Rebin algorithm may be used");
-
-
+ m_uiForm.transFitOnOff_can->setText(
+ QString("Trans Fit (%1)").arg(ANGSROM_SYM));
+ m_uiForm.q_rebin->setToolTip(
+ "Any string allowed by the Rebin algorithm may be used");
+
makeValidator(m_uiForm.wavRanVal_lb, m_uiForm.wavRanges, m_uiForm.tab_2,
- "A comma separated list of numbers is required here");
+ "A comma separated list of numbers is required here");
connectAnalysDetSignals();
}
@@ -364,8 +366,8 @@ void SANSRunWindow::initAnalysDetTab()
* @param tab :: the tab that contains this widgets
* @param errorMsg :: the tooltip message that the validator should have
*/
-void SANSRunWindow::makeValidator(QLabel * const newValid, QWidget * control, QWidget * tab, const QString & errorMsg)
-{
+void SANSRunWindow::makeValidator(QLabel *const newValid, QWidget *control,
+ QWidget *tab, const QString &errorMsg) {
QPalette pal = newValid->palette();
pal.setColor(QPalette::WindowText, Qt::darkRed);
newValid->setPalette(pal);
@@ -378,16 +380,14 @@ void SANSRunWindow::makeValidator(QLabel * const newValid, QWidget * control, QW
/**
* Run local Python initialization code
*/
-void SANSRunWindow::initLocalPython()
-{
+void SANSRunWindow::initLocalPython() {
// Import the SANS module and set the correct instrument
- QString result = runPythonCode("try:\n\timport isis_reducer\nexcept (ImportError,SyntaxError), details:\tprint 'Error importing isis_reducer: ' + str(details)\n");
- if( result.trimmed().isEmpty() )
- {
+ QString result = runPythonCode(
+ "try:\n\timport isis_reducer\nexcept (ImportError,SyntaxError), "
+ "details:\tprint 'Error importing isis_reducer: ' + str(details)\n");
+ if (result.trimmed().isEmpty()) {
m_have_reducemodule = true;
- }
- else
- {
+ } else {
showInformationBox(result);
m_have_reducemodule = false;
setProcessingState(NoSample);
@@ -401,203 +401,211 @@ void SANSRunWindow::initLocalPython()
}
/** Initialise some of the data and signal connections in the save box
*/
-void SANSRunWindow::setupSaveBox()
-{
- connect(m_uiForm.saveDefault_btn, SIGNAL(clicked()), this, SLOT(handleDefSaveClick()));
- connect(m_uiForm.saveSel_btn, SIGNAL(clicked()),
- this, SLOT(saveWorkspacesDialog()));
- connect(m_uiForm.saveFilename_btn, SIGNAL(clicked()),
- this, SLOT(saveFileBrowse()));
- connect(m_uiForm.outfile_edit, SIGNAL(textEdited(const QString &)),
- this, SLOT(setUserFname()));
-
- //link the save option tick boxes to their save algorithm
+void SANSRunWindow::setupSaveBox() {
+ connect(m_uiForm.saveDefault_btn, SIGNAL(clicked()), this,
+ SLOT(handleDefSaveClick()));
+ connect(m_uiForm.saveSel_btn, SIGNAL(clicked()), this,
+ SLOT(saveWorkspacesDialog()));
+ connect(m_uiForm.saveFilename_btn, SIGNAL(clicked()), this,
+ SLOT(saveFileBrowse()));
+ connect(m_uiForm.outfile_edit, SIGNAL(textEdited(const QString &)), this,
+ SLOT(setUserFname()));
+
+ // link the save option tick boxes to their save algorithm
m_savFormats.insert(m_uiForm.saveNex_check, "SaveNexus");
m_savFormats.insert(m_uiForm.saveNIST_Qxy_check, "SaveNISTDAT");
m_savFormats.insert(m_uiForm.saveCan_check, "SaveCanSAS1D");
m_savFormats.insert(m_uiForm.saveRKH_check, "SaveRKH");
m_savFormats.insert(m_uiForm.saveCSV_check, "SaveCSV");
- for(SavFormatsConstIt i=m_savFormats.begin(); i != m_savFormats.end(); ++i)
- {
- connect(i.key(), SIGNAL(stateChanged(int)),
- this, SLOT(enableOrDisableDefaultSave()));
+ for (SavFormatsConstIt i = m_savFormats.begin(); i != m_savFormats.end();
+ ++i) {
+ connect(i.key(), SIGNAL(stateChanged(int)), this,
+ SLOT(enableOrDisableDefaultSave()));
}
}
/** Raises a saveWorkspaces dialog which allows people to save any workspace
* workspaces the user chooses
*/
-void SANSRunWindow::saveWorkspacesDialog()
-{
- //Qt::WA_DeleteOnClose must be set for the dialog to aviod a memory leak
+void SANSRunWindow::saveWorkspacesDialog() {
+ // Qt::WA_DeleteOnClose must be set for the dialog to aviod a memory leak
m_saveWorkspaces =
- new SaveWorkspaces(this, m_uiForm.outfile_edit->text(), m_savFormats, m_uiForm.zeroErrorCheckBox->isChecked());
- //this dialog sometimes needs to run Python, pass this to Mantidplot via our runAsPythonScript() signal
- connect(m_saveWorkspaces, SIGNAL(runAsPythonScript(const QString&, bool)),
- this, SIGNAL(runAsPythonScript(const QString&, bool)));
- //we need know if we have a pointer to a valid window or not
- connect(m_saveWorkspaces, SIGNAL(closing()),
- this, SLOT(saveWorkspacesClosed()));
+ new SaveWorkspaces(this, m_uiForm.outfile_edit->text(), m_savFormats,
+ m_uiForm.zeroErrorCheckBox->isChecked());
+ // this dialog sometimes needs to run Python, pass this to Mantidplot via our
+ // runAsPythonScript() signal
+ connect(m_saveWorkspaces, SIGNAL(runAsPythonScript(const QString &, bool)),
+ this, SIGNAL(runAsPythonScript(const QString &, bool)));
+ // we need know if we have a pointer to a valid window or not
+ connect(m_saveWorkspaces, SIGNAL(closing()), this,
+ SLOT(saveWorkspacesClosed()));
// Connect the request for a zero-error-free workspace
// cpp-check does not understand that the input are two references
- // cppcheck-suppress duplicateExpression
- connect(m_saveWorkspaces, SIGNAL(createZeroErrorFreeWorkspace(QString& , QString&)),
+ connect(m_saveWorkspaces,
+ // cppcheck-suppress duplicateExpression
+ SIGNAL(createZeroErrorFreeWorkspace(QString &, QString &)),
// cppcheck-suppress duplicateExpression
- this, SLOT(createZeroErrorFreeClone(QString&, QString&)));
+ this, SLOT(createZeroErrorFreeClone(QString &, QString &)));
// Connect the request for deleting a zero-error-free workspace
- connect(m_saveWorkspaces, SIGNAL(deleteZeroErrorFreeWorkspace(QString&)),
- this, SLOT(deleteZeroErrorFreeClone(QString&) ));
+ connect(m_saveWorkspaces, SIGNAL(deleteZeroErrorFreeWorkspace(QString &)),
+ this, SLOT(deleteZeroErrorFreeClone(QString &)));
// Connect to change in the zero-error removal checkbox
connect(m_uiForm.zeroErrorCheckBox, SIGNAL(stateChanged(int)),
m_saveWorkspaces, SLOT(onSaveAsZeroErrorFreeChanged(int)));
-
m_uiForm.saveSel_btn->setEnabled(false);
m_saveWorkspaces->show();
}
/**When the save workspaces dialog box is closes its pointer, m_saveWorkspaces,
* is set to NULL and the raise dialog button is re-enabled
*/
-void SANSRunWindow::saveWorkspacesClosed()
-{
+void SANSRunWindow::saveWorkspacesClosed() {
m_uiForm.saveSel_btn->setEnabled(true);
m_saveWorkspaces = NULL;
}
/** Connection the buttons to their signals
*/
-void SANSRunWindow::connectButtonSignals()
-{
+void SANSRunWindow::connectButtonSignals() {
connect(m_uiForm.data_dirBtn, SIGNAL(clicked()), this, SLOT(selectDataDir()));
- connect(m_uiForm.userfileBtn, SIGNAL(clicked()), this, SLOT(selectUserFile()));
- connect(m_uiForm.csv_browse_btn,SIGNAL(clicked()), this, SLOT(selectCSVFile()));
+ connect(m_uiForm.userfileBtn, SIGNAL(clicked()), this,
+ SLOT(selectUserFile()));
+ connect(m_uiForm.csv_browse_btn, SIGNAL(clicked()), this,
+ SLOT(selectCSVFile()));
- connect(m_uiForm.load_dataBtn, SIGNAL(clicked()), this, SLOT(handleLoadButtonClick()));
- connect(m_uiForm.runcentreBtn, SIGNAL(clicked()), this, SLOT(handleRunFindCentre()));
+ connect(m_uiForm.load_dataBtn, SIGNAL(clicked()), this,
+ SLOT(handleLoadButtonClick()));
+ connect(m_uiForm.runcentreBtn, SIGNAL(clicked()), this,
+ SLOT(handleRunFindCentre()));
// Reduction buttons
connect(m_uiForm.oneDBtn, SIGNAL(clicked()), m_reducemapper, SLOT(map()));
m_reducemapper->setMapping(m_uiForm.oneDBtn, "1D");
connect(m_uiForm.twoDBtn, SIGNAL(clicked()), m_reducemapper, SLOT(map()));
m_reducemapper->setMapping(m_uiForm.twoDBtn, "2D");
- connect(m_reducemapper, SIGNAL(mapped(const QString &)), this, SLOT(handleReduceButtonClick(const QString &)));
-
- connect(m_uiForm.showMaskBtn, SIGNAL(clicked()), this, SLOT(handleShowMaskButtonClick()));
+ connect(m_reducemapper, SIGNAL(mapped(const QString &)), this,
+ SLOT(handleReduceButtonClick(const QString &)));
+
+ connect(m_uiForm.showMaskBtn, SIGNAL(clicked()), this,
+ SLOT(handleShowMaskButtonClick()));
}
/** Calls connect to fix up all the slots for the run tab to their events
*/
-void SANSRunWindow::connectFirstPageSignals()
-{
- //controls on the first tab page
+void SANSRunWindow::connectFirstPageSignals() {
+ // controls on the first tab page
- connect(m_uiForm.outfile_edit, SIGNAL(textEdited(const QString&)),
- this, SLOT(enableOrDisableDefaultSave()));
+ connect(m_uiForm.outfile_edit, SIGNAL(textEdited(const QString &)), this,
+ SLOT(enableOrDisableDefaultSave()));
connect(m_uiForm.allowPeriods_ck, SIGNAL(stateChanged(int)), this,
- SLOT(disOrEnablePeriods(const int)));
+ SLOT(disOrEnablePeriods(const int)));
}
-/** Calls connect to fix up all the slots for the analysis details tab to their events
+/** Calls connect to fix up all the slots for the analysis details tab to their
+ * events
*/
-void SANSRunWindow::connectAnalysDetSignals()
-{
- //controls on the second page
- connect(m_uiForm.wav_dw_opt, SIGNAL(currentIndexChanged(int)), this,
- SLOT(handleWavComboChange(int)));
- connect(m_uiForm.q_dq_opt, SIGNAL(currentIndexChanged(int)), this,
- SLOT(handleStepComboChange(int)));
- connect(m_uiForm.qy_dqy_opt, SIGNAL(currentIndexChanged(int)), this,
- SLOT(handleStepComboChange(int)));
-
- connect(m_uiForm.inst_opt, SIGNAL(currentIndexChanged(int)), this,
- SLOT(handleInstrumentChange()));
-
- connect(m_uiForm.transFit_ck, SIGNAL(stateChanged(int)), this, SLOT(updateTransInfo(int)));
- connect(m_uiForm.transFit_ck_can, SIGNAL(stateChanged(int)), this, SLOT(updateTransInfo(int)));
+void SANSRunWindow::connectAnalysDetSignals() {
+ // controls on the second page
+ connect(m_uiForm.wav_dw_opt, SIGNAL(currentIndexChanged(int)), this,
+ SLOT(handleWavComboChange(int)));
+ connect(m_uiForm.q_dq_opt, SIGNAL(currentIndexChanged(int)), this,
+ SLOT(handleStepComboChange(int)));
+ connect(m_uiForm.qy_dqy_opt, SIGNAL(currentIndexChanged(int)), this,
+ SLOT(handleStepComboChange(int)));
+
+ connect(m_uiForm.inst_opt, SIGNAL(currentIndexChanged(int)), this,
+ SLOT(handleInstrumentChange()));
+
+ connect(m_uiForm.transFit_ck, SIGNAL(stateChanged(int)), this,
+ SLOT(updateTransInfo(int)));
+ connect(m_uiForm.transFit_ck_can, SIGNAL(stateChanged(int)), this,
+ SLOT(updateTransInfo(int)));
updateTransInfo(m_uiForm.transFit_ck->state());
m_uiForm.transFit_ck_can->toggle();
- connect(m_uiForm.frontDetQrangeOnOff, SIGNAL(stateChanged(int)), this, SLOT(updateFrontDetQrange(int)));
+ connect(m_uiForm.frontDetQrangeOnOff, SIGNAL(stateChanged(int)), this,
+ SLOT(updateFrontDetQrange(int)));
updateFrontDetQrange(m_uiForm.frontDetQrangeOnOff->state());
- connect(m_uiForm.enableRearFlood_ck, SIGNAL(stateChanged(int)), this, SLOT(prepareFlood(int)));
- connect(m_uiForm.enableFrontFlood_ck, SIGNAL(stateChanged(int)), this, SLOT(prepareFlood(int)));
-
- connect(m_uiForm.trans_selector_opt, SIGNAL(currentIndexChanged(int)), this, SLOT(transSelectorChanged(int)));
+ connect(m_uiForm.enableRearFlood_ck, SIGNAL(stateChanged(int)), this,
+ SLOT(prepareFlood(int)));
+ connect(m_uiForm.enableFrontFlood_ck, SIGNAL(stateChanged(int)), this,
+ SLOT(prepareFlood(int)));
+
+ connect(m_uiForm.trans_selector_opt, SIGNAL(currentIndexChanged(int)), this,
+ SLOT(transSelectorChanged(int)));
transSelectorChanged(0);
- connect(m_uiForm.wavRanges, SIGNAL(editingFinished()),
- this, SLOT(checkList()));
+ connect(m_uiForm.wavRanges, SIGNAL(editingFinished()), this,
+ SLOT(checkList()));
}
/**
* Initialize the widget maps
*/
-void SANSRunWindow::initWidgetMaps()
-{
+void SANSRunWindow::initWidgetMaps() {
// batch mode settings
- m_allowed_batchtags.insert("sample_sans",0);
- m_allowed_batchtags.insert("sample_trans",1);
- m_allowed_batchtags.insert("sample_direct_beam",2);
- m_allowed_batchtags.insert("can_sans",3);
- m_allowed_batchtags.insert("can_trans",4);
- m_allowed_batchtags.insert("can_direct_beam",5);
- m_allowed_batchtags.insert("background_sans",-1);
- m_allowed_batchtags.insert("background_trans",-1);
- m_allowed_batchtags.insert("background_direct_beam",-1);
- m_allowed_batchtags.insert("output_as",6);
- m_allowed_batchtags.insert("user_file",7);
- // detector info
+ m_allowed_batchtags.insert("sample_sans", 0);
+ m_allowed_batchtags.insert("sample_trans", 1);
+ m_allowed_batchtags.insert("sample_direct_beam", 2);
+ m_allowed_batchtags.insert("can_sans", 3);
+ m_allowed_batchtags.insert("can_trans", 4);
+ m_allowed_batchtags.insert("can_direct_beam", 5);
+ m_allowed_batchtags.insert("background_sans", -1);
+ m_allowed_batchtags.insert("background_trans", -1);
+ m_allowed_batchtags.insert("background_direct_beam", -1);
+ m_allowed_batchtags.insert("output_as", 6);
+ m_allowed_batchtags.insert("user_file", 7);
+ // detector info
// SANS2D det names/label map
- QHash<QString, QLabel*> labelsmap;
- labelsmap.insert("Front_Det_Z", m_uiForm.dist_smp_frontZ);
- labelsmap.insert("Front_Det_X", m_uiForm.dist_smp_frontX);
- labelsmap.insert("Front_Det_Rot", m_uiForm.smp_rot);
- labelsmap.insert("Rear_Det_X", m_uiForm.dist_smp_rearX);
- labelsmap.insert("Rear_Det_Z", m_uiForm.dist_smp_rearZ);
- m_s2d_detlabels.append(labelsmap);
-
- labelsmap.clear();
- labelsmap.insert("Front_Det_Z", m_uiForm.dist_can_frontZ);
- labelsmap.insert("Front_Det_X", m_uiForm.dist_can_frontX);
- labelsmap.insert("Front_Det_Rot", m_uiForm.can_rot);
- labelsmap.insert("Rear_Det_X", m_uiForm.dist_can_rearX);
- labelsmap.insert("Rear_Det_Z", m_uiForm.dist_can_rearZ);
- m_s2d_detlabels.append(labelsmap);
-
- labelsmap.clear();
- labelsmap.insert("Front_Det_Z", m_uiForm.dist_bkgd_frontZ);
- labelsmap.insert("Front_Det_X", m_uiForm.dist_bkgd_frontX);
- labelsmap.insert("Front_Det_Rot", m_uiForm.bkgd_rot);
- labelsmap.insert("Rear_Det_X", m_uiForm.dist_bkgd_rearX);
- labelsmap.insert("Rear_Det_Z", m_uiForm.dist_bkgd_rearZ);
- m_s2d_detlabels.append(labelsmap);
-
- //LOQ labels
- labelsmap.clear();
- labelsmap.insert("moderator-sample", m_uiForm.dist_sample_ms);
- labelsmap.insert("sample-main-detector-bank", m_uiForm.dist_smp_mdb);
- labelsmap.insert("sample-HAB",m_uiForm.dist_smp_hab);
- m_loq_detlabels.append(labelsmap);
-
- labelsmap.clear();
- labelsmap.insert("moderator-sample", m_uiForm.dist_can_ms);
- labelsmap.insert("sample-main-detector-bank", m_uiForm.dist_can_mdb);
- labelsmap.insert("sample-HAB",m_uiForm.dist_can_hab);
- m_loq_detlabels.append(labelsmap);
-
- labelsmap.clear();
- labelsmap.insert("moderator-sample", m_uiForm.dist_bkgd_ms);
- labelsmap.insert("sample-main-detector-bank", m_uiForm.dist_bkgd_mdb);
- labelsmap.insert("sample-HAB", m_uiForm.dist_bkgd_hab);
- m_loq_detlabels.append(labelsmap);
-
- // Full workspace names as they appear in the service
- m_workspaceNames.clear();
+ QHash<QString, QLabel *> labelsmap;
+ labelsmap.insert("Front_Det_Z", m_uiForm.dist_smp_frontZ);
+ labelsmap.insert("Front_Det_X", m_uiForm.dist_smp_frontX);
+ labelsmap.insert("Front_Det_Rot", m_uiForm.smp_rot);
+ labelsmap.insert("Rear_Det_X", m_uiForm.dist_smp_rearX);
+ labelsmap.insert("Rear_Det_Z", m_uiForm.dist_smp_rearZ);
+ m_s2d_detlabels.append(labelsmap);
+
+ labelsmap.clear();
+ labelsmap.insert("Front_Det_Z", m_uiForm.dist_can_frontZ);
+ labelsmap.insert("Front_Det_X", m_uiForm.dist_can_frontX);
+ labelsmap.insert("Front_Det_Rot", m_uiForm.can_rot);
+ labelsmap.insert("Rear_Det_X", m_uiForm.dist_can_rearX);
+ labelsmap.insert("Rear_Det_Z", m_uiForm.dist_can_rearZ);
+ m_s2d_detlabels.append(labelsmap);
+
+ labelsmap.clear();
+ labelsmap.insert("Front_Det_Z", m_uiForm.dist_bkgd_frontZ);
+ labelsmap.insert("Front_Det_X", m_uiForm.dist_bkgd_frontX);
+ labelsmap.insert("Front_Det_Rot", m_uiForm.bkgd_rot);
+ labelsmap.insert("Rear_Det_X", m_uiForm.dist_bkgd_rearX);
+ labelsmap.insert("Rear_Det_Z", m_uiForm.dist_bkgd_rearZ);
+ m_s2d_detlabels.append(labelsmap);
+
+ // LOQ labels
+ labelsmap.clear();
+ labelsmap.insert("moderator-sample", m_uiForm.dist_sample_ms);
+ labelsmap.insert("sample-main-detector-bank", m_uiForm.dist_smp_mdb);
+ labelsmap.insert("sample-HAB", m_uiForm.dist_smp_hab);
+ m_loq_detlabels.append(labelsmap);
+
+ labelsmap.clear();
+ labelsmap.insert("moderator-sample", m_uiForm.dist_can_ms);
+ labelsmap.insert("sample-main-detector-bank", m_uiForm.dist_can_mdb);
+ labelsmap.insert("sample-HAB", m_uiForm.dist_can_hab);
+ m_loq_detlabels.append(labelsmap);
+
+ labelsmap.clear();
+ labelsmap.insert("moderator-sample", m_uiForm.dist_bkgd_ms);
+ labelsmap.insert("sample-main-detector-bank", m_uiForm.dist_bkgd_mdb);
+ labelsmap.insert("sample-HAB", m_uiForm.dist_bkgd_hab);
+ m_loq_detlabels.append(labelsmap);
+
+ // Full workspace names as they appear in the service
+ m_workspaceNames.clear();
}
/**
* Restore previous input
*/
-void SANSRunWindow::readSettings()
-{
+void SANSRunWindow::readSettings() {
g_log.debug("Reading settings.");
QSettings value_store;
value_store.beginGroup("CustomInterfaces/SANSRunWindow");
@@ -607,74 +615,73 @@ void SANSRunWindow::readSettings()
m_last_dir = value_store.value("last_dir", "").toString();
int index = m_uiForm.inst_opt->findText(
- value_store.value("instrum", "LOQ").toString());
+ value_store.value("instrum", "LOQ").toString());
// if the saved instrument no longer exists set index to zero
index = index < 0 ? 0 : index;
m_uiForm.inst_opt->setCurrentIndex(index);
-
+
int mode_flag = value_store.value("runmode", 0).toInt();
- if( mode_flag == SANSRunWindow::SingleMode )
- {
+ if (mode_flag == SANSRunWindow::SingleMode) {
m_uiForm.single_mode_btn->click();
- }
- else
- {
+ } else {
m_uiForm.batch_mode_btn->click();
}
- //The instrument definition directory
+ // The instrument definition directory
m_ins_defdir = QString::fromStdString(
- ConfigService::Instance().getString("instrumentDefinition.directory"));
+ ConfigService::Instance().getString("instrumentDefinition.directory"));
upDateDataDir();
// Set allowed extensions
m_uiForm.file_opt->clear();
m_uiForm.file_opt->addItem("nexus", QVariant(".nxs"));
m_uiForm.file_opt->addItem("raw", QVariant(".raw"));
- //Set old file extension
- m_uiForm.file_opt->setCurrentIndex(value_store.value("fileextension", 0).toInt());
-
+ // Set old file extension
+ m_uiForm.file_opt->setCurrentIndex(
+ value_store.value("fileextension", 0).toInt());
+
m_uiForm.allowPeriods_ck->setChecked(
- value_store.value("allow_periods",false).toBool());
+ value_store.value("allow_periods", false).toBool());
int i = m_uiForm.wav_dw_opt->findText(
- value_store.value("wave_binning", "Linear").toString());
+ value_store.value("wave_binning", "Linear").toString());
i = i > -1 ? i : 0;
m_uiForm.wav_dw_opt->setCurrentIndex(i);
- //ensure this is called once even if the index hadn't changed
+ // ensure this is called once even if the index hadn't changed
handleWavComboChange(i);
value_store.endGroup();
readSaveSettings(value_store);
- g_log.debug() << "Found previous data directory " << "\nFound previous user mask file "
- << m_uiForm.userfile_edit->text().toStdString()
- << "\nFound instrument definition directory " << m_ins_defdir.toStdString() << std::endl;
-
+ g_log.debug() << "Found previous data directory "
+ << "\nFound previous user mask file "
+ << m_uiForm.userfile_edit->text().toStdString()
+ << "\nFound instrument definition directory "
+ << m_ins_defdir.toStdString() << std::endl;
}
/** Sets the states of the checkboxes in the save box using those
* in the passed QSettings object
* @param valueStore :: where the settings will be stored
*/
-void SANSRunWindow::readSaveSettings(QSettings & valueStore)
-{
+void SANSRunWindow::readSaveSettings(QSettings &valueStore) {
valueStore.beginGroup("CustomInterfaces/SANSRunWindow/SaveOutput");
- m_uiForm.saveNex_check->setChecked(valueStore.value("nexus",false).toBool());
- m_uiForm.saveCan_check->setChecked(valueStore.value("canSAS",false).toBool());
- m_uiForm.saveNIST_Qxy_check->setChecked(valueStore.value("NIST_Qxy",false).toBool());
+ m_uiForm.saveNex_check->setChecked(valueStore.value("nexus", false).toBool());
+ m_uiForm.saveCan_check->setChecked(
+ valueStore.value("canSAS", false).toBool());
+ m_uiForm.saveNIST_Qxy_check->setChecked(
+ valueStore.value("NIST_Qxy", false).toBool());
m_uiForm.saveRKH_check->setChecked(valueStore.value("RKH", false).toBool());
m_uiForm.saveCSV_check->setChecked(valueStore.value("CSV", false).toBool());
}
/**
- * Save input through QSettings (-> .mantidplot or -> windows registerary) for future use
+ * Save input through QSettings (-> .mantidplot or -> windows registerary) for
+ * future use
*/
-void SANSRunWindow::saveSettings()
-{
+void SANSRunWindow::saveSettings() {
QSettings value_store;
value_store.beginGroup("CustomInterfaces/SANSRunWindow");
- if( !m_uiForm.userfile_edit->text().isEmpty() )
- {
+ if (!m_uiForm.userfile_edit->text().isEmpty()) {
value_store.setValue("user_file", m_uiForm.userfile_edit->text());
}
@@ -687,15 +694,12 @@ void SANSRunWindow::saveSettings()
value_store.setValue("wave_binning", m_uiForm.wav_dw_opt->currentText());
unsigned int mode_id(0);
- if( m_uiForm.single_mode_btn->isChecked() )
- {
+ if (m_uiForm.single_mode_btn->isChecked()) {
mode_id = SANSRunWindow::SingleMode;
- }
- else
- {
+ } else {
mode_id = SANSRunWindow::BatchMode;
}
- value_store.setValue("runmode",mode_id);
+ value_store.setValue("runmode", mode_id);
value_store.endGroup();
saveSaveSettings(value_store);
}
@@ -703,8 +707,7 @@ void SANSRunWindow::saveSettings()
* passed QSettings object
* @param valueStore :: where the settings will be stored
*/
-void SANSRunWindow::saveSaveSettings(QSettings & valueStore)
-{
+void SANSRunWindow::saveSaveSettings(QSettings &valueStore) {
valueStore.beginGroup("CustomInterfaces/SANSRunWindow/SaveOutput");
valueStore.setValue("nexus", m_uiForm.saveNex_check->isChecked());
valueStore.setValue("canSAS", m_uiForm.saveCan_check->isChecked());
@@ -713,27 +716,28 @@ void SANSRunWindow::saveSaveSettings(QSettings & valueStore)
valueStore.setValue("CSV", m_uiForm.saveCSV_check->isChecked());
}
/**
- * Run a function from the SANS reduction script, ensuring that the first call imports the module
+ * Run a function from the SANS reduction script, ensuring that the first call
+ * imports the module
* @param pycode :: The code to execute
* @returns A trimmed string containing the output of the code execution
*/
-QString SANSRunWindow::runReduceScriptFunction(const QString & pycode)
-{
- if( !m_have_reducemodule )
- {
+QString SANSRunWindow::runReduceScriptFunction(const QString &pycode) {
+ if (!m_have_reducemodule) {
return QString();
}
g_log.debug() << "Executing Python: " << pycode.toStdString() << std::endl;
const static QString PYTHON_SEP("C++runReduceScriptFunctionC++");
- QString code_torun = pycode + ";print '"+PYTHON_SEP+"p'";
+ QString code_torun = pycode + ";print '" + PYTHON_SEP + "p'";
QString pythonOut = runPythonCode(code_torun).trimmed();
-
+
QStringList allOutput = pythonOut.split(PYTHON_SEP);
- if ( allOutput.count() < 2 )
- {
- QMessageBox::critical(this, "Fatal error found during reduction", "Error reported by Python script, more information maybe found in the scripting console and results log");
+ if (allOutput.count() < 2) {
+ QMessageBox::critical(this, "Fatal error found during reduction",
+ "Error reported by Python script, more information "
+ "maybe found in the scripting console and results "
+ "log");
return "Error";
}
@@ -741,47 +745,45 @@ QString SANSRunWindow::runReduceScriptFunction(const QString & pycode)
}
/**
- * Trim off Python markers surrounding things like strings or lists that have been
+ * Trim off Python markers surrounding things like strings or lists that have
+ * been
* printed by Python by removing the first and last character
*/
-void SANSRunWindow::trimPyMarkers(QString & txt)
-{
- txt.remove(0,1);
- txt.chop(1);
+void SANSRunWindow::trimPyMarkers(QString &txt) {
+ txt.remove(0, 1);
+ txt.chop(1);
}
/** Issues a Python command to load the user file and returns any output if
* there are warnings or errors
* @return the output printed by the Python commands
*/
-bool SANSRunWindow::loadUserFile()
-{
+bool SANSRunWindow::loadUserFile() {
const std::string facility = ConfigService::Instance().getFacility().name();
- if (facility != "ISIS"){
+ if (facility != "ISIS") {
return false;
}
QString filetext = m_uiForm.userfile_edit->text().trimmed();
- if( filetext.isEmpty() )
- {
- QMessageBox::warning(this, "Error loading user file", "No user file has been specified");
+ if (filetext.isEmpty()) {
+ QMessageBox::warning(this, "Error loading user file",
+ "No user file has been specified");
m_cfg_loaded = false;
return false;
}
QFile user_file(filetext);
- if( !user_file.open(QIODevice::ReadOnly) )
- {
- QMessageBox::critical(this, "Error loading user file", "Could not open user file \""+filetext+"\"");
+ if (!user_file.open(QIODevice::ReadOnly)) {
+ QMessageBox::critical(this, "Error loading user file",
+ "Could not open user file \"" + filetext + "\"");
m_cfg_loaded = false;
return false;
}
user_file.close();
- //Clear the def masking info table.
+ // Clear the def masking info table.
int mask_table_count = m_uiForm.mask_table->rowCount();
- for( int i = mask_table_count - 1; i >= 0; --i )
- {
+ for (int i = mask_table_count - 1; i >= 0; --i) {
m_uiForm.mask_table->removeRow(i);
}
@@ -789,30 +791,27 @@ bool SANSRunWindow::loadUserFile()
pyCode += "\ni." + getInstrumentClass();
pyCode += "\ni.ReductionSingleton().user_settings =";
// Use python function to read the settings file and then extract the fields
- pyCode += "isis_reduction_steps.UserFile(r'"+filetext+"')";
+ pyCode += "isis_reduction_steps.UserFile(r'" + filetext + "')";
runReduceScriptFunction(pyCode);
- QString errors = runReduceScriptFunction(
- "print i.ReductionSingleton().user_settings.execute(i.ReductionSingleton())").trimmed();
+ QString errors =
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().user_settings.execute(i."
+ "ReductionSingleton())").trimmed();
// create a string list with a string for each line
const QStringList allOutput = errors.split("\n");
errors.clear();
bool canContinue = false;
- for (int i = 0; i < allOutput.count(); ++i)
- {
- if ( i < allOutput.count()-1 )
- {
- errors += allOutput[i]+"\n";
- }
- else
- {
+ for (int i = 0; i < allOutput.count(); ++i) {
+ if (i < allOutput.count() - 1) {
+ errors += allOutput[i] + "\n";
+ } else {
canContinue = allOutput[i].trimmed() == "True";
}
}
- if ( ! canContinue )
- {
+ if (!canContinue) {
m_cfg_loaded = false;
return false;
}
@@ -821,436 +820,468 @@ bool SANSRunWindow::loadUserFile()
const double unit_conv(1000.);
// Radius
- double dbl_param = runReduceScriptFunction(
- "print i.ReductionSingleton().mask.min_radius").toDouble();
- m_uiForm.rad_min->setText(QString::number(dbl_param*unit_conv));
+ double dbl_param =
+ runReduceScriptFunction("print i.ReductionSingleton().mask.min_radius")
+ .toDouble();
+ m_uiForm.rad_min->setText(QString::number(dbl_param * unit_conv));
dbl_param = runReduceScriptFunction(
- "print i.ReductionSingleton().mask.max_radius").toDouble();
- m_uiForm.rad_max->setText(QString::number(dbl_param*unit_conv));
- //EventsTime
- m_uiForm.l_events_binning->setText(getSettingWithDefault("events.binning", "").trimmed());
- //Wavelength
+ "print i.ReductionSingleton().mask.max_radius").toDouble();
+ m_uiForm.rad_max->setText(QString::number(dbl_param * unit_conv));
+ // EventsTime
+ m_uiForm.l_events_binning->setText(
+ getSettingWithDefault("events.binning", "").trimmed());
+ // Wavelength
m_uiForm.wav_min->setText(runReduceScriptFunction(
"print i.ReductionSingleton().to_wavelen.wav_low"));
- m_uiForm.wav_max->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().to_wavelen.wav_high").trimmed());
- const QString wav_step = runReduceScriptFunction(
- "print i.ReductionSingleton().to_wavelen.wav_step").trimmed();
+ m_uiForm.wav_max->setText(
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().to_wavelen.wav_high").trimmed());
+ const QString wav_step =
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().to_wavelen.wav_step").trimmed();
setLimitStepParameter("wavelength", wav_step, m_uiForm.wav_dw,
m_uiForm.wav_dw_opt);
- //Q
- QString text = runReduceScriptFunction(
- "print i.ReductionSingleton().to_Q.binning");
+ // Q
+ QString text =
+ runReduceScriptFunction("print i.ReductionSingleton().to_Q.binning");
QStringList values = text.split(",");
- if( values.count() == 3 )
- {
+ if (values.count() == 3) {
m_uiForm.q_min->setText(values[0].trimmed());
m_uiForm.q_max->setText(values[2].trimmed());
setLimitStepParameter("Q", values[1].trimmed(), m_uiForm.q_dq,
- m_uiForm.q_dq_opt);
- }
- else
- {
+ m_uiForm.q_dq_opt);
+ } else {
m_uiForm.q_rebin->setText(text.trimmed());
m_uiForm.q_dq_opt->setCurrentIndex(2);
}
- //Qxy
- m_uiForm.qy_max->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().QXY2"));
- setLimitStepParameter("Qxy", runReduceScriptFunction(
- "print i.ReductionSingleton().DQXY"), m_uiForm.qy_dqy,
- m_uiForm.qy_dqy_opt);
+ // Qxy
+ m_uiForm.qy_max->setText(
+ runReduceScriptFunction("print i.ReductionSingleton().QXY2"));
+ setLimitStepParameter(
+ "Qxy", runReduceScriptFunction("print i.ReductionSingleton().DQXY"),
+ m_uiForm.qy_dqy, m_uiForm.qy_dqy_opt);
- // The tramission line of the Limits section (read settings for sample and can)
- loadTransmissionSettings();
+ // The tramission line of the Limits section (read settings for sample and
+ // can)
+ loadTransmissionSettings();
// The front rescale/shift section
- m_uiForm.frontDetRescale->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.getDetector('FRONT').rescaleAndShift.scale").trimmed());
- m_uiForm.frontDetShift->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.getDetector('FRONT').rescaleAndShift.shift").trimmed());
-
- QString fitScale = runReduceScriptFunction("print i.ReductionSingleton().instrument.getDetector('FRONT').rescaleAndShift.fitScale").trimmed();
- QString fitShift = runReduceScriptFunction("print i.ReductionSingleton().instrument.getDetector('FRONT').rescaleAndShift.fitShift").trimmed();
-
- if ( fitScale == "True" )
+ m_uiForm.frontDetRescale->setText(
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().instrument.getDetector('"
+ "FRONT').rescaleAndShift.scale").trimmed());
+ m_uiForm.frontDetShift->setText(
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().instrument.getDetector('"
+ "FRONT').rescaleAndShift.shift").trimmed());
+
+ QString fitScale =
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().instrument.getDetector('"
+ "FRONT').rescaleAndShift.fitScale").trimmed();
+ QString fitShift =
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().instrument.getDetector('"
+ "FRONT').rescaleAndShift.fitShift").trimmed();
+
+ if (fitScale == "True")
m_uiForm.frontDetRescaleCB->setChecked(true);
else
m_uiForm.frontDetRescaleCB->setChecked(false);
- if ( fitShift == "True" )
+ if (fitShift == "True")
m_uiForm.frontDetShiftCB->setChecked(true);
else
m_uiForm.frontDetShiftCB->setChecked(false);
- QString qRangeUserSelected = runReduceScriptFunction("print i.ReductionSingleton().instrument.getDetector('FRONT').rescaleAndShift.qRangeUserSelected").trimmed();
- if ( qRangeUserSelected == "True" )
- {
- m_uiForm.frontDetQrangeOnOff->setChecked(true);
- m_uiForm.frontDetQmin->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.getDetector('FRONT').rescaleAndShift.qMin").trimmed());
- m_uiForm.frontDetQmax->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.getDetector('FRONT').rescaleAndShift.qMax").trimmed());
- }
- else
- m_uiForm.frontDetQrangeOnOff->setChecked(false);
-
-
- //Monitor spectra
- m_uiForm.monitor_spec->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.get_incident_mon()").trimmed());
- m_uiForm.trans_monitor->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.incid_mon_4_trans_calc").trimmed());
- m_uiForm.monitor_interp->setChecked(runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.is_interpolating_norm()").trimmed() == "True");
- m_uiForm.trans_interp->setChecked(runReduceScriptFunction(
- "print i.ReductionSingleton().transmission_calculator.interpolate"
- ).trimmed() == "True");
+ QString qRangeUserSelected =
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().instrument.getDetector('"
+ "FRONT').rescaleAndShift.qRangeUserSelected")
+ .trimmed();
+ if (qRangeUserSelected == "True") {
+ m_uiForm.frontDetQrangeOnOff->setChecked(true);
+ m_uiForm.frontDetQmin->setText(
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().instrument.getDetector("
+ "'FRONT').rescaleAndShift.qMin").trimmed());
+ m_uiForm.frontDetQmax->setText(
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().instrument.getDetector("
+ "'FRONT').rescaleAndShift.qMax").trimmed());
+ } else
+ m_uiForm.frontDetQrangeOnOff->setChecked(false);
+
+ // Monitor spectra
+ m_uiForm.monitor_spec->setText(
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().instrument.get_incident_mon()")
+ .trimmed());
+ m_uiForm.trans_monitor->setText(
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().instrument.incid_mon_4_trans_calc")
+ .trimmed());
+ m_uiForm.monitor_interp->setChecked(
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().instrument.is_interpolating_norm()")
+ .trimmed() == "True");
+ m_uiForm.trans_interp->setChecked(
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().transmission_calculator.interpolate")
+ .trimmed() == "True");
// Transmission settings
setTransmissionSettingsFromUserFile();
- //Direct efficiency correction
+ // Direct efficiency correction
m_uiForm.direct_file->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.detector_file('rear')"));
+ "print i.ReductionSingleton().instrument.detector_file('rear')"));
m_uiForm.front_direct_file->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.detector_file('front')"));
+ "print i.ReductionSingleton().instrument.detector_file('front')"));
QString file = runReduceScriptFunction(
- "print i.ReductionSingleton().prep_normalize.getPixelCorrFile('REAR')");
+ "print i.ReductionSingleton().prep_normalize.getPixelCorrFile('REAR')");
file = file.trimmed();
- //Check if the file name is set to Python's None object and then adjust the controls if there is an empty entry
+ // Check if the file name is set to Python's None object and then adjust the
+ // controls if there is an empty entry
- m_uiForm.floodRearFile->setFileTextWithSearch(file == "None" ? "" : file);
- m_uiForm.enableRearFlood_ck->setChecked( ! m_uiForm.floodRearFile->isEmpty() );
- m_uiForm.floodRearFile->setEnabled(m_uiForm.enableRearFlood_ck->checkState()
- == Qt::Checked);
+ m_uiForm.floodRearFile->setFileTextWithSearch(file == "None" ? "" : file);
+ m_uiForm.enableRearFlood_ck->setChecked(!m_uiForm.floodRearFile->isEmpty());
+ m_uiForm.floodRearFile->setEnabled(
+ m_uiForm.enableRearFlood_ck->checkState() == Qt::Checked);
file = runReduceScriptFunction(
- "print i.ReductionSingleton().prep_normalize.getPixelCorrFile('FRONT')");
+ "print i.ReductionSingleton().prep_normalize.getPixelCorrFile('FRONT')");
file = file.trimmed();
- m_uiForm.floodFrontFile->setFileTextWithSearch(file == "None" ? "" : file);
- m_uiForm.enableFrontFlood_ck->setChecked( ! m_uiForm.floodFrontFile->isEmpty() );
- m_uiForm.floodFrontFile->setEnabled(m_uiForm.enableFrontFlood_ck->checkState()
- == Qt::Checked);
+ m_uiForm.floodFrontFile->setFileTextWithSearch(file == "None" ? "" : file);
+ m_uiForm.enableFrontFlood_ck->setChecked(!m_uiForm.floodFrontFile->isEmpty());
+ m_uiForm.floodFrontFile->setEnabled(
+ m_uiForm.enableFrontFlood_ck->checkState() == Qt::Checked);
- //Scale factor
- dbl_param = runReduceScriptFunction(
- "print i.ReductionSingleton()._corr_and_scale.rescale").toDouble();
- m_uiForm.scale_factor->setText(QString::number(dbl_param/100.));
+ // Scale factor
+ dbl_param =
+ runReduceScriptFunction(
+ "print i.ReductionSingleton()._corr_and_scale.rescale").toDouble();
+ m_uiForm.scale_factor->setText(QString::number(dbl_param / 100.));
- //Sample offset if one has been specified
- dbl_param = runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.SAMPLE_Z_CORR").toDouble();
- m_uiForm.smpl_offset->setText(QString::number(dbl_param*unit_conv));
+ // Sample offset if one has been specified
+ dbl_param =
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().instrument.SAMPLE_Z_CORR").toDouble();
+ m_uiForm.smpl_offset->setText(QString::number(dbl_param * unit_conv));
- //Centre coordinates
+ // Centre coordinates
// Update the beam centre coordinates
updateBeamCenterCoordinates();
// Set the beam finder specific settings
setBeamFinderDetails();
-
- //Gravity switch
- QString param = runReduceScriptFunction(
- "print i.ReductionSingleton().to_Q.get_gravity()").trimmed();
- if( param == "True" )
- {
+ // get the scale factor1 for the beam centre to scale it correctly
+ double dbl_paramsf =
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().get_beam_center_scale_factor1()")
+ .toDouble();
+ m_uiForm.rear_beam_x->setText(QString::number(dbl_param * dbl_paramsf));
+ // get scale factor2 for the beam centre to scale it correctly
+ dbl_paramsf =
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().get_beam_center_scale_factor2()")
+ .toDouble();
+ dbl_param =
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().get_beam_center('rear')[1]").toDouble();
+ m_uiForm.rear_beam_y->setText(QString::number(dbl_param * dbl_paramsf));
+ // front
+ dbl_param = runReduceScriptFunction(
+ "print i.ReductionSingleton().get_beam_center('front')[0]")
+ .toDouble();
+ m_uiForm.front_beam_x->setText(QString::number(dbl_param * 1000.0));
+ dbl_param = runReduceScriptFunction(
+ "print i.ReductionSingleton().get_beam_center('front')[1]")
+ .toDouble();
+ m_uiForm.front_beam_y->setText(QString::number(dbl_param * 1000.0));
+ // Gravity switch
+ QString param =
+ runReduceScriptFunction("print i.ReductionSingleton().to_Q.get_gravity()")
+ .trimmed();
+ if (param == "True") {
m_uiForm.gravity_check->setChecked(true);
- }
- else
- {
+ } else {
m_uiForm.gravity_check->setChecked(false);
}
// Read the extra length for the gravity correction
- const double extraLengthParam = runReduceScriptFunction(
- "print i.ReductionSingleton().to_Q.get_extra_length()").toDouble();
- m_uiForm.gravity_extra_length_line_edit->setText(QString::number(extraLengthParam));
+ const double extraLengthParam =
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().to_Q.get_extra_length()").toDouble();
+ m_uiForm.gravity_extra_length_line_edit->setText(
+ QString::number(extraLengthParam));
////Detector bank: support REAR, FRONT, HAB, BOTH, MERGED, MERGE options
- QString detName = runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.det_selection").trimmed();
-
- if (detName == "REAR" || detName == "MAIN"){
- m_uiForm.detbank_sel->setCurrentIndex(0);
- }else if (detName == "FRONT" || detName == "HAB"){
- m_uiForm.detbank_sel->setCurrentIndex(1);
- }else if (detName == "BOTH"){
- m_uiForm.detbank_sel->setCurrentIndex(2);
- }else if (detName == "MERGED" || detName== "MERGE"){
- m_uiForm.detbank_sel->setCurrentIndex(3);
- }
-
- // Phi values
- m_uiForm.phi_min->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().mask.phi_min"));
- m_uiForm.phi_max->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().mask.phi_max"));
-
- //Masking table
+ QString detName =
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().instrument.det_selection").trimmed();
+
+ if (detName == "REAR" || detName == "MAIN") {
+ m_uiForm.detbank_sel->setCurrentIndex(0);
+ } else if (detName == "FRONT" || detName == "HAB") {
+ m_uiForm.detbank_sel->setCurrentIndex(1);
+ } else if (detName == "BOTH") {
+ m_uiForm.detbank_sel->setCurrentIndex(2);
+ } else if (detName == "MERGED" || detName == "MERGE") {
+ m_uiForm.detbank_sel->setCurrentIndex(3);
+ }
+
+ // Phi values
+ m_uiForm.phi_min->setText(
+ runReduceScriptFunction("print i.ReductionSingleton().mask.phi_min"));
+ m_uiForm.phi_max->setText(
+ runReduceScriptFunction("print i.ReductionSingleton().mask.phi_max"));
+
+ // Masking table
updateMaskTable();
- if ( runReduceScriptFunction(
- "print i.ReductionSingleton().mask.phi_mirror").trimmed() == "True" )
- {
+ if (runReduceScriptFunction("print i.ReductionSingleton().mask.phi_mirror")
+ .trimmed() == "True") {
m_uiForm.mirror_phi->setChecked(true);
- }
- else
- {
+ } else {
m_uiForm.mirror_phi->setChecked(false);
}
- if ( ! errors.isEmpty() )
- {
- showInformationBox("User file opened with some warnings:\n"+errors);
+ if (!errors.isEmpty()) {
+ showInformationBox("User file opened with some warnings:\n" + errors);
}
m_cfg_loaded = true;
m_uiForm.userfileBtn->setText("Reload");
m_uiForm.tabWidget->setTabEnabled(m_uiForm.tabWidget->count() - 1, true);
-
+
m_cfg_loaded = true;
emit userfileLoaded();
m_uiForm.tabWidget->setTabEnabled(1, true);
m_uiForm.tabWidget->setTabEnabled(2, true);
m_uiForm.tabWidget->setTabEnabled(3, true);
-
return true;
}
/**
- * Load a CSV file specifying information run numbers and populate the batch mode grid
+ * Load a CSV file specifying information run numbers and populate the batch
+ * mode grid
*/
-bool SANSRunWindow::loadCSVFile()
-{
- QString filename = m_uiForm.csv_filename->text();
+bool SANSRunWindow::loadCSVFile() {
+ QString filename = m_uiForm.csv_filename->text();
QFile csv_file(filename);
- if( !csv_file.open(QIODevice::ReadOnly | QIODevice::Text) )
- {
+ if (!csv_file.open(QIODevice::ReadOnly | QIODevice::Text)) {
showInformationBox("Error: Cannot open CSV file \"" + filename + "\"");
return false;
}
-
- //Clear the current table
+
+ // Clear the current table
clearBatchTable();
QTextStream file_in(&csv_file);
int errors(0);
- while( !file_in.atEnd() )
- {
+ while (!file_in.atEnd()) {
QString line = file_in.readLine().simplified();
- if( !line.isEmpty() )
- {
- // if first line of batch contain string MANTID_BATCH_FILE this is a 'metadata' line
- if ( !line.upper().contains("MANTID_BATCH_FILE") )
+ if (!line.isEmpty()) {
+ // if first line of batch contain string MANTID_BATCH_FILE this is a
+ // 'metadata' line
+ if (!line.upper().contains("MANTID_BATCH_FILE"))
errors += addBatchLine(line, ",");
}
}
- if( errors > 0 )
- {
- showInformationBox("Warning: " + QString::number(errors) + " malformed lines detected in \"" + filename + "\". Lines skipped.");
+ if (errors > 0) {
+ showInformationBox("Warning: " + QString::number(errors) +
+ " malformed lines detected in \"" + filename +
+ "\". Lines skipped.");
}
-
- // In order to allow the user to populate the single mode Widgets from a csv file,
- // this code takes the first line of a valid csv batch file and insert inside the
+
+ // In order to allow the user to populate the single mode Widgets from a csv
+ // file,
+ // this code takes the first line of a valid csv batch file and insert inside
+ // the
// single mode widgets. It is usefull for testing.
- QTableWidgetItem * batch_items [] ={
- m_uiForm.batch_table->item(0,0),
- m_uiForm.batch_table->item(0,1),
- m_uiForm.batch_table->item(0,2),
- m_uiForm.batch_table->item(0,3),
- m_uiForm.batch_table->item(0,4),
- m_uiForm.batch_table->item(0,5)
- };
- MWRunFiles * run_files [] = {
- m_uiForm.scatterSample,
- m_uiForm.transmis,
- m_uiForm.direct,
- m_uiForm.scatCan,
- m_uiForm.transCan,
- m_uiForm.dirCan};
+ QTableWidgetItem *batch_items[] = {
+ m_uiForm.batch_table->item(0, 0), m_uiForm.batch_table->item(0, 1),
+ m_uiForm.batch_table->item(0, 2), m_uiForm.batch_table->item(0, 3),
+ m_uiForm.batch_table->item(0, 4), m_uiForm.batch_table->item(0, 5)};
+ MWRunFiles *run_files[] = {m_uiForm.scatterSample, m_uiForm.transmis,
+ m_uiForm.direct, m_uiForm.scatCan,
+ m_uiForm.transCan, m_uiForm.dirCan};
// if the cell is not empty, set the text to the single mode file
- for (unsigned short i=0; i<6; i++){
+ for (unsigned short i = 0; i < 6; i++) {
if (batch_items[i])
run_files[i]->setUserInput(batch_items[i]->text());
else
run_files[i]->setUserInput("");
}
-
+
return true;
}
/**
* Set a pair of an QLineEdit field and type QComboBox using the parameter given
* @param pname :: The name of the parameter
- * @param param :: A string representing a value that maybe prefixed with a minus to indicate a different step type
+ * @param param :: A string representing a value that maybe prefixed with a
+ * minus to indicate a different step type
* @param step_value :: The field to store the actual value
* @param step_type :: The combo box with the type options
*/
-void SANSRunWindow::setLimitStepParameter(const QString& pname, QString param, QLineEdit* step_value, QComboBox* step_type)
-{
- if( param.startsWith("-") )
- {
+void SANSRunWindow::setLimitStepParameter(const QString &pname, QString param,
+ QLineEdit *step_value,
+ QComboBox *step_type) {
+ if (param.startsWith("-")) {
int index = step_type->findText("Logarithmic");
- if( index < 0 )
- {
- raiseOneTimeMessage("Warning: Unable to find logarithmic scale option for " + pname + ", setting as linear.", 1);
- index = step_type->findText("Linear");
+ if (index < 0) {
+ raiseOneTimeMessage(
+ "Warning: Unable to find logarithmic scale option for " + pname +
+ ", setting as linear.",
+ 1);
+ index = step_type->findText("Linear");
}
step_type->setCurrentIndex(index);
- step_value->setText(param.remove(0,1));
- }
- else
- {
+ step_value->setText(param.remove(0, 1));
+ } else {
step_type->setCurrentIndex(step_type->findText("Linear"));
step_value->setText(param);
}
}
/**
- * Construct the mask table on the Mask tab
+ * Construct the mask table on the Mask tab
*/
-void SANSRunWindow::updateMaskTable()
-{
- //Clear the current contents
- for( int i = m_uiForm.mask_table->rowCount() - 1; i >= 0; --i )
- {
- m_uiForm.mask_table->removeRow(i);
- }
+void SANSRunWindow::updateMaskTable() {
+ // Clear the current contents
+ for (int i = m_uiForm.mask_table->rowCount() - 1; i >= 0; --i) {
+ m_uiForm.mask_table->removeRow(i);
+ }
QString reardet_name("rear-detector"), frontdet_name("front-detector");
- if( m_uiForm.inst_opt->currentText() == "LOQ" )
- {
+ if (m_uiForm.inst_opt->currentText() == "LOQ") {
reardet_name = "main-detector-bank";
frontdet_name = "HAB";
}
-
- // First create 2 default mask cylinders at min and max radius for the beam stop and
+
+ // First create 2 default mask cylinders at min and max radius for the beam
+ // stop and
// corners
m_uiForm.mask_table->insertRow(0);
m_uiForm.mask_table->setItem(0, 0, new QTableWidgetItem("beam stop"));
m_uiForm.mask_table->setItem(0, 1, new QTableWidgetItem(reardet_name));
- m_uiForm.mask_table->setItem(0, 2, new QTableWidgetItem("infinite-cylinder, r = rmin"));
- if( m_uiForm.rad_max->text() != "-1" )
- {
+ m_uiForm.mask_table->setItem(
+ 0, 2, new QTableWidgetItem("infinite-cylinder, r = rmin"));
+ if (m_uiForm.rad_max->text() != "-1") {
m_uiForm.mask_table->insertRow(1);
m_uiForm.mask_table->setItem(1, 0, new QTableWidgetItem("corners"));
m_uiForm.mask_table->setItem(1, 1, new QTableWidgetItem(reardet_name));
- m_uiForm.mask_table->setItem(1, 2, new QTableWidgetItem("infinite-cylinder, r = rmax"));
+ m_uiForm.mask_table->setItem(
+ 1, 2, new QTableWidgetItem("infinite-cylinder, r = rmax"));
}
- //Now add information from the mask file
- //Spectrum mask, "Rear" det
- QString mask_string = runReduceScriptFunction(
- "print i.ReductionSingleton().mask.spec_mask_r");
+ // Now add information from the mask file
+ // Spectrum mask, "Rear" det
+ QString mask_string =
+ runReduceScriptFunction("print i.ReductionSingleton().mask.spec_mask_r");
addSpectrumMasksToTable(mask_string, reardet_name);
//"Front" det
- mask_string = runReduceScriptFunction(
- "print i.ReductionSingleton().mask.spec_mask_f");
+ mask_string =
+ runReduceScriptFunction("print i.ReductionSingleton().mask.spec_mask_f");
addSpectrumMasksToTable(mask_string, frontdet_name);
- //Time masks
- mask_string = runReduceScriptFunction(
- "print i.ReductionSingleton().mask.time_mask");
+ // Time masks
+ mask_string =
+ runReduceScriptFunction("print i.ReductionSingleton().mask.time_mask");
addTimeMasksToTable(mask_string, "-");
- //Rear detector
- mask_string = runReduceScriptFunction(
- "print i.ReductionSingleton().mask.time_mask_r");
+ // Rear detector
+ mask_string =
+ runReduceScriptFunction("print i.ReductionSingleton().mask.time_mask_r");
addTimeMasksToTable(mask_string, reardet_name);
- //Front detectors
- mask_string = runReduceScriptFunction(
- "print i.ReductionSingleton().mask.time_mask_f");
+ // Front detectors
+ mask_string =
+ runReduceScriptFunction("print i.ReductionSingleton().mask.time_mask_f");
addTimeMasksToTable(mask_string, frontdet_name);
- //Rear detectors for SANS2D if monitor 4 in place (arm shadow detector)
- mask_string = runReduceScriptFunction(
- "print i.ReductionSingleton().mask.time_mask_f");
+ // Rear detectors for SANS2D if monitor 4 in place (arm shadow detector)
+ mask_string =
+ runReduceScriptFunction("print i.ReductionSingleton().mask.time_mask_f");
addTimeMasksToTable(mask_string, frontdet_name);
-
- if ( getInstrumentClass() == "SANS2D()" )
- {
- QString arm_width = runReduceScriptFunction(
- "print i.ReductionSingleton().mask.arm_width");
- QString arm_angle = runReduceScriptFunction(
- "print i.ReductionSingleton().mask.arm_angle");
- QString arm_x = runReduceScriptFunction(
- "print i.ReductionSingleton().mask.arm_x");
- QString arm_y = runReduceScriptFunction(
- "print i.ReductionSingleton().mask.arm_y");
- if ( arm_width != "None" && arm_angle != "None" )
- {
+ if (getInstrumentClass() == "SANS2D()") {
+ QString arm_width =
+ runReduceScriptFunction("print i.ReductionSingleton().mask.arm_width");
+ QString arm_angle =
+ runReduceScriptFunction("print i.ReductionSingleton().mask.arm_angle");
+ QString arm_x =
+ runReduceScriptFunction("print i.ReductionSingleton().mask.arm_x");
+ QString arm_y =
+ runReduceScriptFunction("print i.ReductionSingleton().mask.arm_y");
+ if (arm_width != "None" && arm_angle != "None") {
int row = m_uiForm.mask_table->rowCount();
m_uiForm.mask_table->insertRow(row);
m_uiForm.mask_table->setItem(row, 0, new QTableWidgetItem("Arm"));
m_uiForm.mask_table->setItem(row, 1, new QTableWidgetItem(reardet_name));
if (arm_x != "None" && arm_y != "None")
- m_uiForm.mask_table->setItem(row, 2, new QTableWidgetItem("LINE " + arm_width + " " + arm_angle + " " + arm_x +" " + arm_y));
+ m_uiForm.mask_table->setItem(
+ row, 2, new QTableWidgetItem("LINE " + arm_width + " " + arm_angle +
+ " " + arm_x + " " + arm_y));
else
- m_uiForm.mask_table->setItem(row, 2, new QTableWidgetItem("LINE " + arm_width + " " + arm_angle));
+ m_uiForm.mask_table->setItem(
+ row, 2,
+ new QTableWidgetItem("LINE " + arm_width + " " + arm_angle));
}
}
auto settings = getReductionSettings();
- if( settings->existsProperty("MaskFiles") )
- {
- const auto maskFiles = QString::fromStdString(settings->getProperty("MaskFiles")).split(",");
+ if (settings->existsProperty("MaskFiles")) {
+ const auto maskFiles =
+ QString::fromStdString(settings->getProperty("MaskFiles")).split(",");
- foreach( const auto & maskFile, maskFiles )
+ foreach (const auto &maskFile, maskFiles)
appendRowToMaskTable("Mask File", "-", maskFile);
}
- // add phi masking to table
- QString phiMin = m_uiForm.phi_min->text();
- QString phiMax = m_uiForm.phi_max->text();
- int row = m_uiForm.mask_table->rowCount();
- m_uiForm.mask_table->insertRow(row);
- m_uiForm.mask_table->setItem(row, 0, new QTableWidgetItem("Phi"));
- m_uiForm.mask_table->setItem(row, 1, new QTableWidgetItem("-"));
- if ( m_uiForm.mirror_phi->isChecked() )
- {
- m_uiForm.mask_table->setItem(row, 2, new QTableWidgetItem("L/PHI " + phiMin + " " + phiMax));
- }
- else
- {
- m_uiForm.mask_table->setItem(row, 2, new QTableWidgetItem("L/PHI/NOMIRROR " + phiMin + " " + phiMax));
- }
-
-
+ // add phi masking to table
+ QString phiMin = m_uiForm.phi_min->text();
+ QString phiMax = m_uiForm.phi_max->text();
+ int row = m_uiForm.mask_table->rowCount();
+ m_uiForm.mask_table->insertRow(row);
+ m_uiForm.mask_table->setItem(row, 0, new QTableWidgetItem("Phi"));
+ m_uiForm.mask_table->setItem(row, 1, new QTableWidgetItem("-"));
+ if (m_uiForm.mirror_phi->isChecked()) {
+ m_uiForm.mask_table->setItem(
+ row, 2, new QTableWidgetItem("L/PHI " + phiMin + " " + phiMax));
+ } else {
+ m_uiForm.mask_table->setItem(
+ row, 2,
+ new QTableWidgetItem("L/PHI/NOMIRROR " + phiMin + " " + phiMax));
+ }
}
/**
* Add a spectrum mask string to the mask table
* @param mask_string :: The string of mask information
- * @param det_name :: The detector it relates to
+ * @param det_name :: The detector it relates to
*/
-void SANSRunWindow::addSpectrumMasksToTable(const QString & mask_string, const QString & det_name)
-{
+void SANSRunWindow::addSpectrumMasksToTable(const QString &mask_string,
+ const QString &det_name) {
QStringList elements = mask_string.split(",", QString::SkipEmptyParts);
QStringListIterator sitr(elements);
- while(sitr.hasNext())
- {
+ while (sitr.hasNext()) {
QString item = sitr.next().trimmed();
QString col1_txt;
- if( item.startsWith('s', Qt::CaseInsensitive) )
- {
+ if (item.startsWith('s', Qt::CaseInsensitive)) {
col1_txt = "Spectrum";
- }
- else if( item.startsWith('h', Qt::CaseInsensitive) || item.startsWith('v', Qt::CaseInsensitive) )
- {
- if( item.contains('+') )
- {
+ } else if (item.startsWith('h', Qt::CaseInsensitive) ||
+ item.startsWith('v', Qt::CaseInsensitive)) {
+ if (item.contains('+')) {
col1_txt = "Box";
- }
- else
- {
+ } else {
col1_txt = "Strip";
}
- }
- else continue;
+ } else
+ continue;
int row = m_uiForm.mask_table->rowCount();
- //Insert line after last row
+ // Insert line after last row
m_uiForm.mask_table->insertRow(row);
m_uiForm.mask_table->setItem(row, 0, new QTableWidgetItem(col1_txt));
m_uiForm.mask_table->setItem(row, 1, new QTableWidgetItem(det_name));
@@ -1261,14 +1292,13 @@ void SANSRunWindow::addSpectrumMasksToTable(const QString & mask_string, const Q
/**
* Add a time mask string to the mask table
* @param mask_string :: The string of mask information
- * @param det_name :: The detector it relates to
+ * @param det_name :: The detector it relates to
*/
-void SANSRunWindow::addTimeMasksToTable(const QString & mask_string, const QString & det_name)
-{
- QStringList elements = mask_string.split(";",QString::SkipEmptyParts);
+void SANSRunWindow::addTimeMasksToTable(const QString &mask_string,
+ const QString &det_name) {
+ QStringList elements = mask_string.split(";", QString::SkipEmptyParts);
QStringListIterator sitr(elements);
- while(sitr.hasNext())
- {
+ while (sitr.hasNext()) {
int row = m_uiForm.mask_table->rowCount();
m_uiForm.mask_table->insertRow(row);
m_uiForm.mask_table->setItem(row, 0, new QTableWidgetItem("time"));
@@ -1285,8 +1315,9 @@ void SANSRunWindow::addTimeMasksToTable(const QString & mask_string, const QStri
* @param detector :: the detector bank this information applies to
* @param details :: the details of the mask
*/
-void SANSRunWindow::appendRowToMaskTable(const QString & type, const QString & detector, const QString & details)
-{
+void SANSRunWindow::appendRowToMaskTable(const QString &type,
+ const QString &detector,
+ const QString &details) {
const int row = m_uiForm.mask_table->rowCount();
m_uiForm.mask_table->insertRow(row);
@@ -1302,74 +1333,70 @@ void SANSRunWindow::appendRowToMaskTable(const QString & type, const QString & d
* @param lsda :: The result of the sample-detector bank 1 distance
* @param lsdb :: The result of the sample-detector bank 2 distance
*/
-void SANSRunWindow::componentLOQDistances(boost::shared_ptr<const Mantid::API::MatrixWorkspace> workspace, double & lms, double & lsda, double & lsdb)
-{
+void SANSRunWindow::componentLOQDistances(
+ boost::shared_ptr<const Mantid::API::MatrixWorkspace> workspace,
+ double &lms, double &lsda, double &lsdb) {
Instrument_const_sptr instr = workspace->getInstrument();
- if( !instr ) return;
+ if (!instr)
+ return;
Mantid::Geometry::IComponent_const_sptr source = instr->getSource();
- if( source == boost::shared_ptr<Mantid::Geometry::IObjComponent>() ) return;
+ if (source == boost::shared_ptr<Mantid::Geometry::IObjComponent>())
+ return;
Mantid::Geometry::IComponent_const_sptr sample = instr->getSample();
- if( sample == boost::shared_ptr<Mantid::Geometry::IObjComponent>() ) return;
+ if (sample == boost::shared_ptr<Mantid::Geometry::IObjComponent>())
+ return;
lms = source->getPos().distance(sample->getPos()) * 1000.;
-
- //Find the main detector bank
- Mantid::Geometry::IComponent_const_sptr comp = instr->getComponentByName("main-detector-bank");
- if( comp != boost::shared_ptr<Mantid::Geometry::IComponent>() )
- {
+
+ // Find the main detector bank
+ Mantid::Geometry::IComponent_const_sptr comp =
+ instr->getComponentByName("main-detector-bank");
+ if (comp != boost::shared_ptr<Mantid::Geometry::IComponent>()) {
lsda = sample->getPos().distance(comp->getPos()) * 1000.;
}
comp = instr->getComponentByName("HAB");
- if( comp != boost::shared_ptr<Mantid::Geometry::IComponent>() )
- {
+ if (comp != boost::shared_ptr<Mantid::Geometry::IComponent>()) {
lsdb = sample->getPos().distance(comp->getPos()) * 1000.;
}
-
}
/**
* Set the state of processing.
* @param action :: can be loading, 1D or 2D reduction
*/
-void SANSRunWindow::setProcessingState(const States action)
-{
+void SANSRunWindow::setProcessingState(const States action) {
const bool running(action == Loading || action == OneD || action == TwoD);
-
- //we only need a load button for single run mode and even then only when the form isn't busy
- if( m_uiForm.single_mode_btn->isChecked() )
- {
+
+ // we only need a load button for single run mode and even then only when the
+ // form isn't busy
+ if (m_uiForm.single_mode_btn->isChecked()) {
m_uiForm.load_dataBtn->setEnabled(!running);
- }
- else
- {
+ } else {
m_uiForm.load_dataBtn->setEnabled(false);
}
- //buttons that are available as long as Python is available
+ // buttons that are available as long as Python is available
m_uiForm.oneDBtn->setEnabled(!running);
m_uiForm.twoDBtn->setEnabled(!running);
m_uiForm.saveSel_btn->setEnabled(!running);
m_uiForm.runcentreBtn->setEnabled(!running);
m_uiForm.userfileBtn->setEnabled(!running);
m_uiForm.data_dirBtn->setEnabled(!running);
-
+
m_uiForm.oneDBtn->setText(action == OneD ? "Running ..." : "1D Reduce");
m_uiForm.twoDBtn->setText(action == TwoD ? "Running ..." : "2D Reduce");
- if( running )
- {
+ if (running) {
m_uiForm.saveDefault_btn->setEnabled(false);
- }
- else
- {
+ } else {
enableOrDisableDefaultSave();
}
- for( int i = 0; i < 4; ++i)
- {
- if( i == m_uiForm.tabWidget->currentIndex() ) continue;
+ for (int i = 0; i < 4; ++i) {
+ if (i == m_uiForm.tabWidget->currentIndex())
+ continue;
m_uiForm.tabWidget->setTabEnabled(i, !running);
}
@@ -1379,23 +1406,23 @@ void SANSRunWindow::setProcessingState(const States action)
/**
* Does the workspace exist in the AnalysisDataService
* @param ws_name :: The name of the workspace
- * @returns A boolean indicatingif the given workspace exists in the AnalysisDataService
+ * @returns A boolean indicatingif the given workspace exists in the
+ * AnalysisDataService
*/
-bool SANSRunWindow::workspaceExists(const QString & ws_name) const
-{
+bool SANSRunWindow::workspaceExists(const QString &ws_name) const {
return AnalysisDataService::Instance().doesExist(ws_name.toStdString());
}
/**
* @returns A list of the currently available workspaces
*/
-QStringList SANSRunWindow::currentWorkspaceList() const
-{
- std::set<std::string> ws_list = AnalysisDataService::Instance().getObjectNames();
+QStringList SANSRunWindow::currentWorkspaceList() const {
+ std::set<std::string> ws_list =
+ AnalysisDataService::Instance().getObjectNames();
std::set<std::string>::const_iterator iend = ws_list.end();
QStringList current_list;
- for( std::set<std::string>::const_iterator itr = ws_list.begin(); itr != iend; ++itr )
- {
+ for (std::set<std::string>::const_iterator itr = ws_list.begin(); itr != iend;
+ ++itr) {
current_list.append(QString::fromStdString(*itr));
}
return current_list;
@@ -1403,13 +1430,10 @@ QStringList SANSRunWindow::currentWorkspaceList() const
/**
* Is the user file loaded
- * @returns A boolean indicating whether the user file has been parsed in to the details tab
+ * @returns A boolean indicating whether the user file has been parsed in to the
+ * details tab
*/
-bool SANSRunWindow::isUserFileLoaded() const
-{
- return m_cfg_loaded;
-}
-
+bool SANSRunWindow::isUserFileLoaded() const { return m_cfg_loaded; }
/**
* Create the mask strings for spectra and times
@@ -1417,80 +1441,65 @@ bool SANSRunWindow::isUserFileLoaded() const
* @param importCommand This may e.g. be mask.parse_instruction
* @param mType This parameter appears to take values PixelMask or TimeMask
*/
-void SANSRunWindow::addUserMaskStrings(QString& exec_script,const QString& importCommand, enum MaskType mType)
-{
- //Clear current
-
- QString temp = importCommand+"('MASK/CLEAR')\n";
+void SANSRunWindow::addUserMaskStrings(QString &exec_script,
+ const QString &importCommand,
+ enum MaskType mType) {
+ // Clear current
+
+ QString temp = importCommand + "('MASK/CLEAR')\n";
exec_script += temp;
temp = importCommand + "('MASK/CLEAR/TIME')\n";
exec_script += temp;
-
- //Pull in the table details first, skipping the first two rows
+
+ // Pull in the table details first, skipping the first two rows
int nrows = m_uiForm.mask_table->rowCount();
- for(int row = 0; row < nrows; ++row)
- {
- if( m_uiForm.mask_table->item(row, 2)->text().startsWith("inf") )
- {
+ for (int row = 0; row < nrows; ++row) {
+ if (m_uiForm.mask_table->item(row, 2)->text().startsWith("inf")) {
continue;
}
- if( m_uiForm.mask_table->item(row, 0)->text() == "Mask File")
- {
+ if (m_uiForm.mask_table->item(row, 0)->text() == "Mask File") {
continue;
}
- if(mType == PixelMask)
- {
- if( m_uiForm.mask_table->item(row, 0)->text() == "time")
- {
+ if (mType == PixelMask) {
+ if (m_uiForm.mask_table->item(row, 0)->text() == "time") {
continue;
}
- }
- else if (mType == TimeMask)
- {
- if( m_uiForm.mask_table->item(row, 0)->text() != "time")
- {
+ } else if (mType == TimeMask) {
+ if (m_uiForm.mask_table->item(row, 0)->text() != "time") {
continue;
}
-
}
- // 'special' case for phi masking since it uses the L command instead of the MASK command
- if ( m_uiForm.mask_table->item(row, 0)->text() == "Phi" )
- {
+ // 'special' case for phi masking since it uses the L command instead of the
+ // MASK command
+ if (m_uiForm.mask_table->item(row, 0)->text() == "Phi") {
+
+ exec_script += importCommand + "('" +
+ m_uiForm.mask_table->item(row, 2)->text() + "')\n";
+ continue;
+ }
- exec_script += importCommand + "('" + m_uiForm.mask_table->item(row, 2)->text()
- + "')\n";
- continue;
- }
-
temp = importCommand + "('MASK";
exec_script += temp;
QString type = m_uiForm.mask_table->item(row, 0)->text();
- if( type == "time")
- {
+ if (type == "time") {
exec_script += "/TIME";
}
QString details = m_uiForm.mask_table->item(row, 2)->text();
QString detname = m_uiForm.mask_table->item(row, 1)->text().trimmed();
- if( detname == "-" )
- {
+ if (detname == "-") {
exec_script += " " + details;
- }
- else if( detname == "rear-detector" || detname == "main-detector-bank" )
- {
- if ( type != "Arm" )
- {
+ } else if (detname == "rear-detector" || detname == "main-detector-bank") {
+ if (type != "Arm") {
// whether it is front or rear bank is inferred from the spectrum number
- if ( type == "Spectrum" )
+ if (type == "Spectrum")
exec_script += " " + details;
else
exec_script += "/REAR " + details;
}
- }
- else
- {
+ } else {
// whether it is front or rear bank is inferred from the spectrum number
- if ( type == "Spectrum" )
+ if (type == "Spectrum")
exec_script += " " + details;
else
exec_script += "/FRONT " + details;
@@ -1498,136 +1507,123 @@ void SANSRunWindow::addUserMaskStrings(QString& exec_script,const QString& impor
exec_script += "')\n";
}
-
- //Spectra mask first
- QStringList mask_params = m_uiForm.user_spec_mask->text().split(",", QString::SkipEmptyParts);
+ // Spectra mask first
+ QStringList mask_params =
+ m_uiForm.user_spec_mask->text().split(",", QString::SkipEmptyParts);
QStringListIterator sitr(mask_params);
QString bad_masks;
- while(sitr.hasNext())
- {
+ while (sitr.hasNext()) {
QString item = sitr.next().trimmed();
- if( item.startsWith("REAR", Qt::CaseInsensitive) || item.startsWith("FRONT", Qt::CaseInsensitive) )
- {
- temp = importCommand+"('MASK/" + item + "')\n";
+ if (item.startsWith("REAR", Qt::CaseInsensitive) ||
+ item.startsWith("FRONT", Qt::CaseInsensitive)) {
+ temp = importCommand + "('MASK/" + item + "')\n";
exec_script += temp;
- }
- else if( item.startsWith('S', Qt::CaseInsensitive) || item.startsWith('H', Qt::CaseInsensitive) ||
- item.startsWith('V', Qt::CaseInsensitive) )
- {
- temp = importCommand +" ('MASK " + item + "')\n";
+ } else if (item.startsWith('S', Qt::CaseInsensitive) ||
+ item.startsWith('H', Qt::CaseInsensitive) ||
+ item.startsWith('V', Qt::CaseInsensitive)) {
+ temp = importCommand + " ('MASK " + item + "')\n";
exec_script += temp;
- }
- else
- {
+ } else {
bad_masks += item + ",";
}
}
- if( !bad_masks.isEmpty() )
- {
+ if (!bad_masks.isEmpty()) {
m_uiForm.tabWidget->setCurrentIndex(3);
- showInformationBox(QString("Warning: Could not parse the following spectrum masks: ") + bad_masks + ". Values skipped.");
+ showInformationBox(
+ QString("Warning: Could not parse the following spectrum masks: ") +
+ bad_masks + ". Values skipped.");
}
- //Time masks
- mask_params = m_uiForm.user_time_mask->text().split(",", QString::SkipEmptyParts);
+ // Time masks
+ mask_params =
+ m_uiForm.user_time_mask->text().split(",", QString::SkipEmptyParts);
sitr = QStringListIterator(mask_params);
bad_masks = "";
- while(sitr.hasNext())
- {
+ while (sitr.hasNext()) {
QString item = sitr.next().trimmed();
- if( item.startsWith("REAR", Qt::CaseInsensitive) || item.startsWith("FRONT", Qt::CaseInsensitive) )
- {
+ if (item.startsWith("REAR", Qt::CaseInsensitive) ||
+ item.startsWith("FRONT", Qt::CaseInsensitive)) {
int ndetails = item.split(" ").count();
- if( ndetails == 3 || ndetails == 2 )
- {
+ if (ndetails == 3 || ndetails == 2) {
temp = importCommand + "('/TIME" + item + "')\n";
exec_script += temp;
- }
- else
- {
+ } else {
bad_masks += item + ",";
}
}
}
- if( !bad_masks.isEmpty() )
- {
+ if (!bad_masks.isEmpty()) {
m_uiForm.tabWidget->setCurrentIndex(3);
- showInformationBox(QString("Warning: Could not parse the following time masks: ") + bad_masks + ". Values skipped.");
+ showInformationBox(
+ QString("Warning: Could not parse the following time masks: ") +
+ bad_masks + ". Values skipped.");
}
-
}
/** This method applys mask to a given workspace
* @param wsName name of the workspace
* @param time_pixel true if time mask needs to be applied
*/
-void SANSRunWindow::applyMask(const QString& wsName,bool time_pixel)
-{
+void SANSRunWindow::applyMask(const QString &wsName, bool time_pixel) {
QString script = "mask= isis_reduction_steps.Mask_ISIS()\n";
QString str;
- if(time_pixel)
- {
- addUserMaskStrings(str,"mask.parse_instruction",TimeMask);
- }
- else
- {
- addUserMaskStrings(str,"mask.parse_instruction",PixelMask);
+ if (time_pixel) {
+ addUserMaskStrings(str, "mask.parse_instruction", TimeMask);
+ } else {
+ addUserMaskStrings(str, "mask.parse_instruction", PixelMask);
}
-
+
script += str;
script += "mask.execute(i.ReductionSingleton(),\"";
script += wsName;
script += "\"";
script += ",xcentre=0,ycentre=0)";
runPythonCode(script.trimmed());
-
}
/**
* Set the information about component distances on the geometry tab
*/
-void SANSRunWindow::setGeometryDetails()
-{
+void SANSRunWindow::setGeometryDetails() {
resetGeometryDetailsBox();
-
+
const std::string wsName = m_experWksp.toStdString();
- if( wsName.empty() )
+ if (wsName.empty())
return;
- const auto & ADS = AnalysisDataService::Instance();
-
- assert( ADS.doesExist(wsName) );
+ const auto &ADS = AnalysisDataService::Instance();
+
+ assert(ADS.doesExist(wsName));
auto ws = ADS.retrieveWS<const Workspace>(wsName);
- if( boost::dynamic_pointer_cast<const WorkspaceGroup>(ws) )
- // Assume all geometry information is in the first member of the group and it is
+ if (boost::dynamic_pointer_cast<const WorkspaceGroup>(ws))
+ // Assume all geometry information is in the first member of the group and
+ // it is
// constant for all group members.
ws = getGroupMember(ws, 1);
MatrixWorkspace_const_sptr monitorWs;
- if( boost::dynamic_pointer_cast<const IEventWorkspace>(ws) )
- {
+ if (boost::dynamic_pointer_cast<const IEventWorkspace>(ws)) {
// EventWorkspaces have their monitors loaded into a separate workspace.
const std::string monitorWsName = ws->name() + "_monitors";
- if( !ADS.doesExist(monitorWsName) )
- {
- g_log.error() << "Expected a sister monitor workspace called \"" << monitorWsName << "\" "
- << "for the EventWorkspace \"" << ws->name() << "\", but could not find one "
+ if (!ADS.doesExist(monitorWsName)) {
+ g_log.error() << "Expected a sister monitor workspace called \""
+ << monitorWsName << "\" "
+ << "for the EventWorkspace \"" << ws->name()
+ << "\", but could not find one "
<< "so unable to set geometry details.\n";
return;
}
monitorWs = ADS.retrieveWS<const MatrixWorkspace>(monitorWsName);
- }
- else
- {
+ } else {
// MatrixWorkspaces have their monitors loaded in the same workspace.
monitorWs = boost::dynamic_pointer_cast<const MatrixWorkspace>(ws);
- assert( monitorWs );
+ assert(monitorWs);
}
-
+
const auto sampleWs = boost::dynamic_pointer_cast<const MatrixWorkspace>(ws);
Instrument_const_sptr instr = sampleWs->getInstrument();
@@ -1636,128 +1632,121 @@ void SANSRunWindow::setGeometryDetails()
// Moderator-monitor distance is common to LOQ and SANS2D.
size_t monitorWsIndex = 0;
const specid_t monitorSpectrum = m_uiForm.monitor_spec->text().toInt();
- try
- {
+ try {
monitorWsIndex = monitorWs->getIndexFromSpectrumNumber(monitorSpectrum);
- }
- catch (std::runtime_error &)
- {
- g_log.error() << "The reported incident monitor spectrum number \"" << monitorSpectrum
+ } catch (std::runtime_error &) {
+ g_log.error() << "The reported incident monitor spectrum number \""
+ << monitorSpectrum
<< "\" does not have a corresponding workspace index in \""
- << monitorWs->name() << "\", so unable to set geometry details.\n";
+ << monitorWs->name()
+ << "\", so unable to set geometry details.\n";
return;
}
- const std::set<detid_t> & dets = monitorWs->getSpectrum(monitorWsIndex)->getDetectorIDs();
- if( dets.empty() ) return;
+ const std::set<detid_t> &dets =
+ monitorWs->getSpectrum(monitorWsIndex)->getDetectorIDs();
+ if (dets.empty())
+ return;
double dist_mm(0.0);
QString colour("black");
- try
- {
- Mantid::Geometry::IDetector_const_sptr detector = instr->getDetector(*dets.begin());
-
+ try {
+ Mantid::Geometry::IDetector_const_sptr detector =
+ instr->getDetector(*dets.begin());
+
double unit_conv(1000.);
dist_mm = detector->getDistance(*source) * unit_conv;
- }
- catch(std::runtime_error&)
- {
+ } catch (std::runtime_error &) {
colour = "red";
}
- if( m_uiForm.inst_opt->currentText() == "LOQ" )
- {
- if( colour == "red" )
- {
+ if (m_uiForm.inst_opt->currentText() == "LOQ") {
+ if (colour == "red") {
m_uiForm.dist_mod_mon->setText("<font color='red'>error<font>");
- }
- else
- {
+ } else {
m_uiForm.dist_mod_mon->setText(formatDouble(dist_mm, colour));
}
setLOQGeometry(sampleWs, 0);
QString can = m_experCan;
- if( !can.isEmpty() )
- {
- Workspace_sptr workspace_ptr = Mantid::API::AnalysisDataService::Instance().retrieve(can.toStdString());
- MatrixWorkspace_sptr can_workspace = boost::dynamic_pointer_cast<MatrixWorkspace>(workspace_ptr);
-
- if ( ! can_workspace )
- {//assume all geometry information is in the first member of the group and it is constant for all group members
- //function throws if a fisrt member can't be retrieved
+ if (!can.isEmpty()) {
+ Workspace_sptr workspace_ptr =
+ Mantid::API::AnalysisDataService::Instance().retrieve(
+ can.toStdString());
+ MatrixWorkspace_sptr can_workspace =
+ boost::dynamic_pointer_cast<MatrixWorkspace>(workspace_ptr);
+
+ if (!can_workspace) { // assume all geometry information is in the first
+ // member of the group and it is constant for all
+ // group members
+ // function throws if a fisrt member can't be retrieved
can_workspace = getGroupMember(workspace_ptr, 1);
}
setLOQGeometry(can_workspace, 1);
}
- }
- else if( m_uiForm.inst_opt->currentText() == "SANS2D" || m_uiForm.inst_opt->currentText() == "SANS2DTUBES")
- {
- if( colour == "red" )
- {
+ } else if (m_uiForm.inst_opt->currentText() == "SANS2D" ||
+ m_uiForm.inst_opt->currentText() == "SANS2DTUBES") {
+ if (colour == "red") {
m_uiForm.dist_mon_s2d->setText("<font color='red'>error<font>");
- }
- else
- {
+ } else {
m_uiForm.dist_mon_s2d->setText(formatDouble(dist_mm, colour));
}
- //SANS2D - Sample
+ // SANS2D - Sample
setSANS2DGeometry(sampleWs, 0);
- //Get the can workspace if there is one
+ // Get the can workspace if there is one
QString can = m_experCan;
- if( can.isEmpty() )
- {
+ if (can.isEmpty()) {
return;
}
Workspace_sptr workspace_ptr;
- try
- {
- workspace_ptr = AnalysisDataService::Instance().retrieve(can.toStdString());
- }
- catch(std::runtime_error&)
- {
+ try {
+ workspace_ptr =
+ AnalysisDataService::Instance().retrieve(can.toStdString());
+ } catch (std::runtime_error &) {
return;
}
- Mantid::API::MatrixWorkspace_sptr can_workspace = boost::dynamic_pointer_cast<Mantid::API::MatrixWorkspace>(workspace_ptr);
- if ( !can_workspace )
- {//assume all geometry information is in the first member of the group and it is constant for all group members
- //function throws if a fisrt member can't be retrieved
+ Mantid::API::MatrixWorkspace_sptr can_workspace =
+ boost::dynamic_pointer_cast<Mantid::API::MatrixWorkspace>(
+ workspace_ptr);
+ if (!can_workspace) { // assume all geometry information is in the first
+ // member of the group and it is constant for all
+ // group members
+ // function throws if a fisrt member can't be retrieved
can_workspace = getGroupMember(workspace_ptr, 1);
}
setSANS2DGeometry(can_workspace, 1);
- //Check for discrepancies
+ // Check for discrepancies
bool warn_user(false);
- double lms_sample(m_uiForm.dist_sample_ms_s2d->text().toDouble()), lms_can(m_uiForm.dist_can_ms_s2d->text().toDouble());
- if( std::fabs(lms_sample - lms_can) > 5e-03 )
- {
+ double lms_sample(m_uiForm.dist_sample_ms_s2d->text().toDouble()),
+ lms_can(m_uiForm.dist_can_ms_s2d->text().toDouble());
+ if (std::fabs(lms_sample - lms_can) > 5e-03) {
warn_user = true;
markError(m_uiForm.dist_sample_ms_s2d);
markError(m_uiForm.dist_can_ms_s2d);
}
- QString marked_dets = runReduceScriptFunction("print i.GetMismatchedDetList(),").trimmed();
+ QString marked_dets =
+ runReduceScriptFunction("print i.GetMismatchedDetList(),").trimmed();
trimPyMarkers(marked_dets);
- if( !marked_dets.isEmpty() )
- {
+ if (!marked_dets.isEmpty()) {
QStringList detnames = marked_dets.split(",");
QStringListIterator itr(detnames);
- while( itr.hasNext() )
- {
+ while (itr.hasNext()) {
QString name = itr.next().trimmed();
trimPyMarkers(name);
- for( int i = 0; i < 2; ++i )
- {
+ for (int i = 0; i < 2; ++i) {
markError(m_s2d_detlabels[i].value(name));
warn_user = true;
}
}
}
- if( warn_user )
- {
- raiseOneTimeMessage("Warning: Some detector distances do not match for the assigned Sample/Can runs, see Geometry tab for details.");
+ if (warn_user) {
+ raiseOneTimeMessage("Warning: Some detector distances do not match for "
+ "the assigned Sample/Can runs, see Geometry tab for "
+ "details.");
}
}
}
@@ -1767,53 +1756,55 @@ void SANSRunWindow::setGeometryDetails()
* @param workspace :: The workspace
* @param wscode :: 0 for sample, 1 for can, others not defined
*/
-void SANSRunWindow::setSANS2DGeometry(boost::shared_ptr<const Mantid::API::MatrixWorkspace> workspace, int wscode)
-{
+void SANSRunWindow::setSANS2DGeometry(
+ boost::shared_ptr<const Mantid::API::MatrixWorkspace> workspace,
+ int wscode) {
double unitconv = 1000.;
Instrument_const_sptr instr = workspace->getInstrument();
- boost::shared_ptr<const Mantid::Geometry::IComponent> sample = instr->getSample();
- boost::shared_ptr<const Mantid::Geometry::IComponent> source = instr->getSource();
+ boost::shared_ptr<const Mantid::Geometry::IComponent> sample =
+ instr->getSample();
+ boost::shared_ptr<const Mantid::Geometry::IComponent> source =
+ instr->getSource();
double distance = source->getDistance(*sample) * unitconv;
- //Moderator-sample
- QLabel *dist_label(NULL);
- if( wscode == 0 )
- {
+ // Moderator-sample
+ QLabel *dist_label(NULL);
+ if (wscode == 0) {
dist_label = m_uiForm.dist_sample_ms_s2d;
- }
- else if( wscode == 1 )
- {
+ } else if (wscode == 1) {
dist_label = m_uiForm.dist_can_ms_s2d;
- }
- else
- {
+ } else {
dist_label = m_uiForm.dist_bkgd_ms_s2d;
}
dist_label->setText(formatDouble(distance, "black", 'f', 1));
-
- // get the tuple of log values and convert to a list of
- QString code_to_run = QString("print ','.join([str(a) for a in i.ReductionSingleton().instrument.getDetValues('%1')])").arg(QString::fromStdString(workspace->name()));
- QStringList logvalues = runReduceScriptFunction(code_to_run).split(",");
-
+ // get the tuple of log values and convert to a list of
+ QString code_to_run =
+ QString("print ','.join([str(a) for a in "
+ "i.ReductionSingleton().instrument.getDetValues('%1')])")
+ .arg(QString::fromStdString(workspace->name()));
+
+ QStringList logvalues = runReduceScriptFunction(code_to_run).split(",");
+
QStringList dets_names;
dets_names << "Front_Det_Z"
- << "Front_Det_X"
+ << "Front_Det_X"
<< "Front_Det_Rot"
- << "Rear_Det_Z"
+ << "Rear_Det_Z"
<< "Rear_Det_X";
int index = 0;
- foreach(QString detname, dets_names){
+ foreach (QString detname, dets_names) {
QString distance = logvalues[index];
- try{
- double d = distance.toDouble();
- distance = QString::number(d, 'f', 1);
- }catch(...){
+ try {
+ double d = distance.toDouble();
+ distance = QString::number(d, 'f', 1);
+ } catch (...) {
// if distance is not a double, for now just proceed
}
- QLabel * lbl = m_s2d_detlabels[wscode].value(detname);
- if (lbl) lbl->setText(distance);
+ QLabel *lbl = m_s2d_detlabels[wscode].value(detname);
+ if (lbl)
+ lbl->setText(distance);
index += 1;
}
}
@@ -1823,41 +1814,36 @@ void SANSRunWindow::setSANS2DGeometry(boost::shared_ptr<const Mantid::API::Matri
* @param workspace :: The workspace to operate on
* @param wscode :: ?????
*/
-void SANSRunWindow::setLOQGeometry(boost::shared_ptr<const Mantid::API::MatrixWorkspace> workspace, int wscode)
-{
+void SANSRunWindow::setLOQGeometry(
+ boost::shared_ptr<const Mantid::API::MatrixWorkspace> workspace,
+ int wscode) {
double dist_ms(0.0), dist_mdb(0.0), dist_hab(0.0);
- //Sample
+ // Sample
componentLOQDistances(workspace, dist_ms, dist_mdb, dist_hab);
-
- QHash<QString, QLabel*> & labels = m_loq_detlabels[wscode];
+
+ QHash<QString, QLabel *> &labels = m_loq_detlabels[wscode];
QLabel *detlabel = labels.value("moderator-sample");
- if( detlabel )
- {
+ if (detlabel) {
detlabel->setText(QString::number(dist_ms));
}
detlabel = labels.value("sample-main-detector-bank");
- if( detlabel )
- {
+ if (detlabel) {
detlabel->setText(QString::number(dist_mdb));
}
detlabel = labels.value("sample-HAB");
- if( detlabel )
- {
+ if (detlabel) {
detlabel->setText(QString::number(dist_hab));
}
-
}
/**
* Mark an error on a label
* @param label :: A pointer to a QLabel instance
*/
-void SANSRunWindow::markError(QLabel* label)
-{
- if( label )
- {
+void SANSRunWindow::markError(QLabel *label) {
+ if (label) {
label->setText("<font color=\"red\">" + label->text() + "</font>");
}
}
@@ -1868,79 +1854,75 @@ void SANSRunWindow::markError(QLabel* label)
/**
* Select the base directory for the data
*/
-void SANSRunWindow::selectDataDir()
-{
+void SANSRunWindow::selectDataDir() {
MantidQt::API::ManageUserDirectories::openUserDirsDialog(this);
}
/**
* Select and load the user file
*/
-void SANSRunWindow::selectUserFile()
-{
- if( !browseForFile("Select a user file", m_uiForm.userfile_edit, "Text files (*.txt)") )
- {
+void SANSRunWindow::selectUserFile() {
+ if (!browseForFile("Select a user file", m_uiForm.userfile_edit,
+ "Text files (*.txt)")) {
return;
}
- //possibly redudent code now
- runReduceScriptFunction("i.ReductionSingleton().user_file_path='"+
- QFileInfo(m_uiForm.userfile_edit->text()).path() + "'");
+ // possibly redudent code now
+ runReduceScriptFunction("i.ReductionSingleton().user_file_path='" +
+ QFileInfo(m_uiForm.userfile_edit->text()).path() +
+ "'");
- if (! loadUserFile() )
- {// the load was successful
+ if (!loadUserFile()) { // the load was successful
return;
}
- //path() returns the directory
+ // path() returns the directory
m_last_dir = QFileInfo(m_uiForm.userfile_edit->text()).path();
}
/**
* Select and load a CSV file
*/
-void SANSRunWindow::selectCSVFile()
-{
- if( !m_cfg_loaded )
- {
+void SANSRunWindow::selectCSVFile() {
+ if (!m_cfg_loaded) {
showInformationBox("Please load the relevant user file.");
return;
}
- if( !browseForFile("Select CSV file",m_uiForm.csv_filename, "CSV files (*.csv)") )
- {
+ if (!browseForFile("Select CSV file", m_uiForm.csv_filename,
+ "CSV files (*.csv)")) {
return;
}
- if( !loadCSVFile() )
- {
+ if (!loadCSVFile()) {
return;
}
- //path() returns the directory
+ // path() returns the directory
m_last_dir = QFileInfo(m_uiForm.csv_filename->text()).path();
- if( m_cfg_loaded ) setProcessingState(Ready);
+ if (m_cfg_loaded)
+ setProcessingState(Ready);
}
/** Raises a browse dialog and inserts the selected file into the
* save text edit box, outfile_edit
*/
-void SANSRunWindow::saveFileBrowse()
-{
+void SANSRunWindow::saveFileBrowse() {
QString title = "Save output workspace as";
QSettings prevValues;
prevValues.beginGroup("CustomInterfaces/SANSRunWindow/SaveOutput");
- //use their previous directory first and go to their default if that fails
- QString prevPath = prevValues.value("dir", QString::fromStdString(
- ConfigService::Instance().getString("defaultsave.directory"))).toString();
+ // use their previous directory first and go to their default if that fails
+ QString prevPath =
+ prevValues.value("dir", QString::fromStdString(
+ ConfigService::Instance().getString(
+ "defaultsave.directory"))).toString();
const QString filter = ";;AllFiles (*.*)";
-
- QString oFile = FileDialogHandler::getSaveFileName(this, title,
- prevPath+"/"+m_uiForm.outfile_edit->text());
- if( ! oFile.isEmpty() )
- {
+ QString oFile = FileDialogHandler::getSaveFileName(
+ this, title, prevPath + "/" + m_uiForm.outfile_edit->text());
+
+ if (!oFile.isEmpty()) {
m_uiForm.outfile_edit->setText(oFile);
-
+
QString directory = QFileInfo(oFile).path();
prevValues.setValue("dir", directory);
}
@@ -1949,10 +1931,7 @@ void SANSRunWindow::saveFileBrowse()
* Flip the flag to confirm whether data is reloaded
* @param force :: If true, the data is reloaded when reduce is clicked
*/
-void SANSRunWindow::forceDataReload(bool force)
-{
- m_force_reload = force;
-}
+void SANSRunWindow::forceDataReload(bool force) { m_force_reload = force; }
/**
* Browse for a file and set the text of the given edit box
@@ -1960,34 +1939,32 @@ void SANSRunWindow::forceDataReload(bool force)
* @param file_field :: QLineEdit box to use for the file path
* @param file_filter :: An optional file filter
*/
-bool SANSRunWindow::browseForFile(const QString & box_title, QLineEdit* file_field, QString file_filter)
-{
+bool SANSRunWindow::browseForFile(const QString &box_title,
+ QLineEdit *file_field, QString file_filter) {
QString box_text = file_field->text();
QString start_path = box_text;
- if( box_text.isEmpty() )
- {
+ if (box_text.isEmpty()) {
start_path = m_last_dir;
}
file_filter += ";;AllFiles (*.*)";
- QString file_path = QFileDialog::getOpenFileName(this, box_title, start_path, file_filter);
- if( file_path.isEmpty() || QFileInfo(file_path).isDir() ) return false;
+ QString file_path =
+ QFileDialog::getOpenFileName(this, box_title, start_path, file_filter);
+ if (file_path.isEmpty() || QFileInfo(file_path).isDir())
+ return false;
file_field->setText(file_path);
return true;
}
/**
* Receive a load button click signal
*/
-bool SANSRunWindow::handleLoadButtonClick()
-{
+bool SANSRunWindow::handleLoadButtonClick() {
// this function looks for and reports any errors to the user
- if ( ! entriesAreValid(LOAD) )
- {
+ if (!entriesAreValid(LOAD)) {
return false;
}
// Check if we have loaded the data_file
- if( !isUserFileLoaded() )
- {
+ if (!isUserFileLoaded()) {
showInformationBox("Please load the relevant user file.");
return false;
}
@@ -1995,12 +1972,13 @@ bool SANSRunWindow::handleLoadButtonClick()
setProcessingState(Loading);
m_uiForm.load_dataBtn->setText("Loading ...");
- if( m_force_reload ) cleanup();
+ if (m_force_reload)
+ cleanup();
bool is_loaded(true);
- if ( ( ! m_uiForm.transmis->isEmpty() ) && m_uiForm.direct->isEmpty() )
- {
- showInformationBox("Error: Can run supplied without direct run, cannot continue.");
+ if ((!m_uiForm.transmis->isEmpty()) && m_uiForm.direct->isEmpty()) {
+ showInformationBox(
+ "Error: Can run supplied without direct run, cannot continue.");
setProcessingState(NoSample);
m_uiForm.load_dataBtn->setText("Load Data");
return false;
@@ -2009,48 +1987,42 @@ bool SANSRunWindow::handleLoadButtonClick()
QString error;
// set the detector just before loading so to correctly move the instrument
runReduceScriptFunction("\ni.ReductionSingleton().instrument.setDetector('" +
- m_uiForm.detbank_sel->currentText() + "')");
+ m_uiForm.detbank_sel->currentText() + "')");
QString sample = m_uiForm.scatterSample->getFirstFilename();
- try
- {//preliminarly error checking is over try to load that data
+ try { // preliminarly error checking is over try to load that data
is_loaded &= assignDetBankRun(*(m_uiForm.scatterSample), "AssignSample");
readNumberOfEntries("get_sample().loader", m_uiForm.scatterSample);
- if (m_uiForm.scatCan->isEmpty())
- {
+ if (m_uiForm.scatCan->isEmpty()) {
m_experCan = "";
- }
- else
- {
+ } else {
is_loaded &= assignDetBankRun(*(m_uiForm.scatCan), "AssignCan");
readNumberOfEntries("get_can().loader", m_uiForm.scatCan);
}
- if ( ( ! m_uiForm.transmis->isEmpty() ) && ( ! m_uiForm.direct->isEmpty() ) )
- {
- is_loaded &= assignMonitorRun(*(m_uiForm.transmis), *(m_uiForm.direct), "TransmissionSample");
+ if ((!m_uiForm.transmis->isEmpty()) && (!m_uiForm.direct->isEmpty())) {
+ is_loaded &= assignMonitorRun(*(m_uiForm.transmis), *(m_uiForm.direct),
+ "TransmissionSample");
readNumberOfEntries("samp_trans_load.trans", m_uiForm.transmis);
readNumberOfEntries("samp_trans_load.direct", m_uiForm.direct);
}
-
- //Quick check that there is a can direct run if a trans can is defined. If not use the sample one
- if ( ( ! m_uiForm.transCan->isEmpty() ) && m_uiForm.dirCan->isEmpty() )
- {
+
+ // Quick check that there is a can direct run if a trans can is defined. If
+ // not use the sample one
+ if ((!m_uiForm.transCan->isEmpty()) && m_uiForm.dirCan->isEmpty()) {
m_uiForm.dirCan->setFileTextWithSearch(m_uiForm.direct->getText());
m_uiForm.dirCan->setEntryNum(m_uiForm.direct->getEntryNum());
}
- if ( ( ! m_uiForm.transCan->isEmpty() ) && ( ! m_uiForm.dirCan->isEmpty() ) )
- {
- is_loaded &= assignMonitorRun(*(m_uiForm.transCan), *(m_uiForm.dirCan), "TransmissionCan");
+ if ((!m_uiForm.transCan->isEmpty()) && (!m_uiForm.dirCan->isEmpty())) {
+ is_loaded &= assignMonitorRun(*(m_uiForm.transCan), *(m_uiForm.dirCan),
+ "TransmissionCan");
readNumberOfEntries("can_trans_load.trans", m_uiForm.transCan);
readNumberOfEntries("can_trans_load.direct", m_uiForm.dirCan);
}
- }
- catch(std::runtime_error &)
- {//the user should already have seen an error message box pop up
+ } catch (std::runtime_error &) { // the user should already have seen an error
+ // message box pop up
g_log.error() << "Problem loading file\n";
is_loaded = false;
}
- if (!is_loaded)
- {
+ if (!is_loaded) {
setProcessingState(NoSample);
m_uiForm.load_dataBtn->setText("Load Data");
return false;
@@ -2058,66 +2030,70 @@ bool SANSRunWindow::handleLoadButtonClick()
// Sort out the log information
setGeometryDetails();
-
+
Mantid::API::Workspace_sptr baseWS =
- Mantid::API::AnalysisDataService::Instance().retrieve(m_experWksp.toStdString());
+ Mantid::API::AnalysisDataService::Instance().retrieve(
+ m_experWksp.toStdString());
// Enter information from sample workspace on to analysis and geometry tab
Mantid::API::MatrixWorkspace_sptr sample_workspace =
- boost::dynamic_pointer_cast<Mantid::API::MatrixWorkspace>(baseWS);
-
- if( sample_workspace && ( ! sample_workspace->readX(0).empty() ) )
- {
- m_uiForm.tof_min->setText(QString::number(sample_workspace->readX(0).front()));
- m_uiForm.tof_max->setText(QString::number(sample_workspace->readX(0).back()));
+ boost::dynamic_pointer_cast<Mantid::API::MatrixWorkspace>(baseWS);
+
+ if (sample_workspace && (!sample_workspace->readX(0).empty())) {
+ m_uiForm.tof_min->setText(
+ QString::number(sample_workspace->readX(0).front()));
+ m_uiForm.tof_max->setText(
+ QString::number(sample_workspace->readX(0).back()));
}
// Set the geometry if the sample has been changed
- if ( m_sample_file != sample )
- {
+ if (m_sample_file != sample) {
const auto sample = sample_workspace->sample();
- const int geomId = sample.getGeometryFlag();
+ const int geomId = sample.getGeometryFlag();
- if( geomId > 0 && geomId < 4 )
- {
+ if (geomId > 0 && geomId < 4) {
m_uiForm.sample_geomid->setCurrentIndex(geomId - 1);
using namespace boost;
- typedef tuple<QLineEdit *, function<double(const Sample*)>, std::string> GeomSampleInfo;
+ typedef tuple<QLineEdit *, function<double(const Sample *)>, std::string>
+ GeomSampleInfo;
std::vector<GeomSampleInfo> sampleInfoList;
- sampleInfoList.push_back(make_tuple(m_uiForm.sample_thick, &Sample::getThickness, "thickness"));
- sampleInfoList.push_back(make_tuple(m_uiForm.sample_width, &Sample::getWidth, "width"));
- sampleInfoList.push_back(make_tuple(m_uiForm.sample_height, &Sample::getHeight, "height"));
-
- // Populate the sample geometry fields, but replace any zero values with 1.0, and
+ sampleInfoList.push_back(make_tuple(m_uiForm.sample_thick,
+ &Sample::getThickness, "thickness"));
+ sampleInfoList.push_back(
+ make_tuple(m_uiForm.sample_width, &Sample::getWidth, "width"));
+ sampleInfoList.push_back(
+ make_tuple(m_uiForm.sample_height, &Sample::getHeight, "height"));
+
+ // Populate the sample geometry fields, but replace any zero values with
+ // 1.0, and
// warn the user where this has occured.
- BOOST_FOREACH( auto info, sampleInfoList )
- {
+ BOOST_FOREACH (auto info, sampleInfoList) {
const auto value = info.get<1>()(&sample);
- if( value == 0.0 )
- g_log.warning("The sample geometry " + info.get<2>() + " was found to be zero, so using a default value of 1.0 instead.");
+ if (value == 0.0)
+ g_log.warning("The sample geometry " + info.get<2>() +
+ " was found to be zero, so using a default value of "
+ "1.0 instead.");
info.get<0>()->setText(QString::number(value == 0.0 ? 1.0 : value));
}
- }
- else
- {
+ } else {
m_uiForm.sample_geomid->setCurrentIndex(2);
m_uiForm.sample_thick->setText("1");
m_uiForm.sample_width->setText("8");
m_uiForm.sample_height->setText("8");
- //Warn user
- showInformationBox("Warning: Incorrect geometry flag encountered: " + QString::number(geomId) +". Using default values.");
+ // Warn user
+ showInformationBox("Warning: Incorrect geometry flag encountered: " +
+ QString::number(geomId) + ". Using default values.");
}
}
forceDataReload(false);
- for( int index = 1; index < m_uiForm.tabWidget->count(); ++index )
- {
+ for (int index = 1; index < m_uiForm.tabWidget->count(); ++index) {
m_uiForm.tabWidget->setTabEnabled(index, true);
}
-
+
m_sample_file = sample;
setProcessingState(Ready);
m_uiForm.load_dataBtn->setText("Load Data");
@@ -2133,103 +2109,119 @@ bool SANSRunWindow::handleLoadButtonClick()
* @param RunStep name of the RunStep Python object
* @param output where the number will be displayed
*/
-void SANSRunWindow::readNumberOfEntries(const QString & RunStep, MantidWidgets::MWRunFiles * const output)
-{
- QString periods = runReduceScriptFunction("print i.ReductionSingleton()."+RunStep+".periods_in_file");
+void SANSRunWindow::readNumberOfEntries(
+ const QString &RunStep, MantidWidgets::MWRunFiles *const output) {
+ QString periods = runReduceScriptFunction("print i.ReductionSingleton()." +
+ RunStep + ".periods_in_file");
output->setNumberOfEntries(periods.toInt());
}
-/** Construct the python code to perform the analysis using the
+/** Construct the python code to perform the analysis using the
* current settings
* @param type :: The reduction type: 1D or 2D
*/
-QString SANSRunWindow::readUserFileGUIChanges(const States type)
-{
- const bool invalidRearFlood = m_uiForm.enableRearFlood_ck->isChecked() && !m_uiForm.floodRearFile->isValid();
- const bool invalidFrontFlood = m_uiForm.enableFrontFlood_ck->isChecked() && !m_uiForm.floodFrontFile->isValid();
-
- if( invalidRearFlood || invalidFrontFlood )
- throw std::runtime_error("Invalid flood file(s). Check the path shown in the \"Reduction Settings\" tab.");
-
- //Construct a run script based upon the current values within the various widgets
+QString SANSRunWindow::readUserFileGUIChanges(const States type) {
+ const bool invalidRearFlood = m_uiForm.enableRearFlood_ck->isChecked() &&
+ !m_uiForm.floodRearFile->isValid();
+ const bool invalidFrontFlood = m_uiForm.enableFrontFlood_ck->isChecked() &&
+ !m_uiForm.floodFrontFile->isValid();
+
+ if (invalidRearFlood || invalidFrontFlood)
+ throw std::runtime_error("Invalid flood file(s). Check the path shown in "
+ "the \"Reduction Settings\" tab.");
+
+ // Construct a run script based upon the current values within the various
+ // widgets
QString exec_reduce;
- if ( m_uiForm.detbank_sel->currentIndex() < 2 )
+ if (m_uiForm.detbank_sel->currentIndex() < 2)
exec_reduce = "i.ReductionSingleton().instrument.setDetector('" +
- m_uiForm.detbank_sel->currentText() + "')\n";
+ m_uiForm.detbank_sel->currentText() + "')\n";
else
// currently, if currentIndex has MAIN,HAB,BOTH,MERGED options. If the user
// selects BOTH or MERGED the reduction will start by the DefaultDetector
- // that is the low-angle detector(MAIN). This is important, because, when loading
- // the data, the reducer needs to know what is the bank detector selected in order
+ // that is the low-angle detector(MAIN). This is important, because, when
+ // loading
+ // the data, the reducer needs to know what is the bank detector selected in
+ // order
// to correctly answer the question: get_beam_center. Added for #5942
exec_reduce = "i.ReductionSingleton().instrument.setDefaultDetector()\n";
const QString outType(type == OneD ? "1D" : "2D");
- exec_reduce += "i.ReductionSingleton().to_Q.output_type='"+outType+"'\n";
- //Analysis details
- exec_reduce +="i.ReductionSingleton().user_settings.readLimitValues('L/R '+'"+
- //get rid of the 1 in the line below, a character is need at the moment to give the correct number of characters
- m_uiForm.rad_min->text()+" '+'"+m_uiForm.rad_max->text()+" '+'1', i.ReductionSingleton())\n";
+ exec_reduce += "i.ReductionSingleton().to_Q.output_type='" + outType + "'\n";
+ // Analysis details
+ exec_reduce +=
+ "i.ReductionSingleton().user_settings.readLimitValues('L/R '+'" +
+ // get rid of the 1 in the line below, a character is need at the moment
+ // to give the correct number of characters
+ m_uiForm.rad_min->text() + " '+'" + m_uiForm.rad_max->text() +
+ " '+'1', i.ReductionSingleton())\n";
setStringSetting("events.binning", m_uiForm.l_events_binning->text());
QString logLin = m_uiForm.wav_dw_opt->currentText().toUpper();
- if (logLin.contains("LOG"))
- {
+ if (logLin.contains("LOG")) {
logLin = "LOG";
}
- if (logLin.contains("LIN"))
- {
+ if (logLin.contains("LIN")) {
logLin = "LIN";
}
- exec_reduce += "i.LimitsWav(" + m_uiForm.wav_min->text().trimmed() + "," + m_uiForm.wav_max->text() + "," +
- m_uiForm.wav_dw->text()+",'"+logLin+"')\n";
+ exec_reduce += "i.LimitsWav(" + m_uiForm.wav_min->text().trimmed() + "," +
+ m_uiForm.wav_max->text() + "," + m_uiForm.wav_dw->text() +
+ ",'" + logLin + "')\n";
- if( m_uiForm.q_dq_opt->currentIndex() == 2 )
- {
- exec_reduce += "i.ReductionSingleton().user_settings.readLimitValues('L/Q "+m_uiForm.q_rebin->text() +
- "', i.ReductionSingleton())\n";
- }
- else
- {
- exec_reduce += "i.ReductionSingleton().user_settings.readLimitValues('L/Q "+
- m_uiForm.q_min->text()+" "+m_uiForm.q_max->text()+" "+m_uiForm.q_dq->text()+"/"+
- m_uiForm.q_dq_opt->itemData(m_uiForm.q_dq_opt->currentIndex()).toString() +
- "', i.ReductionSingleton())\n";
- }
- exec_reduce += "i.LimitsQXY(0.0," + m_uiForm.qy_max->text().trimmed() + "," +
- m_uiForm.qy_dqy->text().trimmed() + ",'"
- + m_uiForm.qy_dqy_opt->itemData(m_uiForm.qy_dqy_opt->currentIndex()).toString()+"')\n";
- exec_reduce += "i.SetPhiLimit(" + m_uiForm.phi_min->text().trimmed() + "," + m_uiForm.phi_max->text().trimmed();
- if ( m_uiForm.mirror_phi->isChecked() )
- {
+ if (m_uiForm.q_dq_opt->currentIndex() == 2) {
+ exec_reduce +=
+ "i.ReductionSingleton().user_settings.readLimitValues('L/Q " +
+ m_uiForm.q_rebin->text() + "', i.ReductionSingleton())\n";
+ } else {
+ exec_reduce +=
+ "i.ReductionSingleton().user_settings.readLimitValues('L/Q " +
+ m_uiForm.q_min->text() + " " + m_uiForm.q_max->text() + " " +
+ m_uiForm.q_dq->text() + "/" +
+ m_uiForm.q_dq_opt->itemData(m_uiForm.q_dq_opt->currentIndex())
+ .toString() +
+ "', i.ReductionSingleton())\n";
+ }
+ exec_reduce +=
+ "i.LimitsQXY(0.0," + m_uiForm.qy_max->text().trimmed() + "," +
+ m_uiForm.qy_dqy->text().trimmed() + ",'" +
+ m_uiForm.qy_dqy_opt->itemData(m_uiForm.qy_dqy_opt->currentIndex())
+ .toString() +
+ "')\n";
+ exec_reduce += "i.SetPhiLimit(" + m_uiForm.phi_min->text().trimmed() + "," +
+ m_uiForm.phi_max->text().trimmed();
+ if (m_uiForm.mirror_phi->isChecked()) {
exec_reduce += ", True";
- }
- else
- {
+ } else {
exec_reduce += ", False";
}
exec_reduce += ")\n";
QString floodRearFile =
- m_uiForm.enableRearFlood_ck->isChecked() ? m_uiForm.floodRearFile->getFirstFilename().trimmed() : "";
+ m_uiForm.enableRearFlood_ck->isChecked()
+ ? m_uiForm.floodRearFile->getFirstFilename().trimmed()
+ : "";
QString floodFrontFile =
- m_uiForm.enableFrontFlood_ck->isChecked() ? m_uiForm.floodFrontFile->getFirstFilename().trimmed() : "";
- exec_reduce += "i.SetDetectorFloodFile('"+floodRearFile+"','REAR')\n";
- exec_reduce += "i.SetDetectorFloodFile('"+floodFrontFile+"','FRONT')\n";
-
- // Set the wavelength ranges, equal to those for the sample unless this box is checked
- // Also check if the Trans Fit on/off tick is on or off. If Off then set the trans_opt to off
- {
- QCheckBox * fit_ck;
- QCheckBox * use_ck;
- QComboBox * method_opt;
- QLineEdit * _min;
- QLineEdit * _max;
+ m_uiForm.enableFrontFlood_ck->isChecked()
+ ? m_uiForm.floodFrontFile->getFirstFilename().trimmed()
+ : "";
+ exec_reduce += "i.SetDetectorFloodFile('" + floodRearFile + "','REAR')\n";
+ exec_reduce += "i.SetDetectorFloodFile('" + floodFrontFile + "','FRONT')\n";
+
+ // Set the wavelength ranges, equal to those for the sample unless this box is
+ // checked
+ // Also check if the Trans Fit on/off tick is on or off. If Off then set the
+ // trans_opt to off
+ {
+ QCheckBox *fit_ck;
+ QCheckBox *use_ck;
+ QComboBox *method_opt;
+ QLineEdit *_min;
+ QLineEdit *_max;
QString selector = "BOTH";
- // if trans_selector_opt == BOTH (index 0) it executes only once.
+ // if trans_selector_opt == BOTH (index 0) it executes only once.
// if trans_selector_opt == SAMPLE (index 1) it executes twice.
- for (int i = 0; i< m_uiForm.trans_selector_opt->currentIndex()+1; i++){
- if (i == 0){
+ for (int i = 0; i < m_uiForm.trans_selector_opt->currentIndex() + 1; i++) {
+ if (i == 0) {
fit_ck = m_uiForm.transFitOnOff;
use_ck = m_uiForm.transFit_ck;
method_opt = m_uiForm.trans_opt;
@@ -2237,7 +2229,7 @@ QString SANSRunWindow::readUserFileGUIChanges(const States type)
_max = m_uiForm.trans_max;
if (m_uiForm.trans_selector_opt->currentIndex() == 1)
selector = "SAMPLE";
- }else{
+ } else {
fit_ck = m_uiForm.transFitOnOff_can;
use_ck = m_uiForm.transFit_ck_can;
method_opt = m_uiForm.trans_opt_can;
@@ -2245,96 +2237,102 @@ QString SANSRunWindow::readUserFileGUIChanges(const States type)
_max = m_uiForm.trans_max_can;
selector = "CAN";
}
-
+
QString lambda_min_option = "lambdamin=None";
- QString lambda_max_option = "lambdamax=None";
+ QString lambda_max_option = "lambdamax=None";
QString mode_option; // = "mode='OFF'";
- QString selector_option = "selector='"+selector+"'";
+ QString selector_option = "selector='" + selector + "'";
if (!fit_ck->isChecked())
mode_option = "mode='Off'";
- else{
- mode_option = "mode='"+ method_opt->currentText() + "'";
- if (use_ck->isChecked()){
- lambda_min_option = "lambdamin='"+ _min->text().trimmed() + "'";
- lambda_max_option = "lambdamax='"+ _max->text().trimmed() + "'";
+ else {
+ mode_option = "mode='" + method_opt->currentText() + "'";
+ if (use_ck->isChecked()) {
+ lambda_min_option = "lambdamin='" + _min->text().trimmed() + "'";
+ lambda_max_option = "lambdamax='" + _max->text().trimmed() + "'";
}
}
- exec_reduce += "i.TransFit(" + mode_option + ", " + lambda_min_option + ", " + lambda_max_option + ", " + selector_option + ")\n";
-
+ exec_reduce += "i.TransFit(" + mode_option + ", " + lambda_min_option +
+ ", " + lambda_max_option + ", " + selector_option + ")\n";
}
}
// Set the Front detector Rescale and Shift
- QString fdArguments = "scale=" + m_uiForm.frontDetRescale->text().trimmed() + ","
- + "shift=" + m_uiForm.frontDetShift->text().trimmed();
- if ( m_uiForm.frontDetRescaleCB->isChecked() )
+ QString fdArguments = "scale=" + m_uiForm.frontDetRescale->text().trimmed() +
+ "," + "shift=" +
+ m_uiForm.frontDetShift->text().trimmed();
+ if (m_uiForm.frontDetRescaleCB->isChecked())
fdArguments += ", fitScale=True";
- if ( m_uiForm.frontDetShiftCB->isChecked() )
+ if (m_uiForm.frontDetShiftCB->isChecked())
fdArguments += ", fitShift=True";
- if ( m_uiForm.frontDetQrangeOnOff->isChecked() && !m_uiForm.frontDetQmin->text().isEmpty()
- && !m_uiForm.frontDetQmax->text().isEmpty() )
- {
+ if (m_uiForm.frontDetQrangeOnOff->isChecked() &&
+ !m_uiForm.frontDetQmin->text().isEmpty() &&
+ !m_uiForm.frontDetQmax->text().isEmpty()) {
fdArguments += ", qMin=" + m_uiForm.frontDetQmin->text().trimmed();
fdArguments += ", qMax=" + m_uiForm.frontDetQmax->text().trimmed();
}
exec_reduce += "i.SetFrontDetRescaleShift(" + fdArguments + ")\n";
- //Gravity correction
+ // Gravity correction
exec_reduce += "i.Gravity(";
- if( m_uiForm.gravity_check->isChecked() )
- {
- exec_reduce += "True";
- }
- else
- {
+ if (m_uiForm.gravity_check->isChecked()) {
+ exec_reduce += "True";
+ } else {
exec_reduce += "False";
}
// Take into acount of the additional length
- exec_reduce += ", extra_length=" + m_uiForm.gravity_extra_length_line_edit->text().trimmed() + ")\n";
+ exec_reduce += ", extra_length=" +
+ m_uiForm.gravity_extra_length_line_edit->text().trimmed() +
+ ")\n";
- //Sample offset
- exec_reduce += "i.SetSampleOffset('"+
- m_uiForm.smpl_offset->text()+"')\n";
+ // Sample offset
+ exec_reduce += "i.SetSampleOffset('" + m_uiForm.smpl_offset->text() + "')\n";
- //Monitor spectrum
- exec_reduce += "i.SetMonitorSpectrum('" + m_uiForm.monitor_spec->text().trimmed() + "',";
+ // Monitor spectrum
+ exec_reduce +=
+ "i.SetMonitorSpectrum('" + m_uiForm.monitor_spec->text().trimmed() + "',";
exec_reduce += m_uiForm.monitor_interp->isChecked() ? "True" : "False";
exec_reduce += ")\n";
- //the monitor to normalise the tranmission spectrum against
- exec_reduce += "i.SetTransSpectrum('" + m_uiForm.trans_monitor->text().trimmed() + "',";
+ // the monitor to normalise the tranmission spectrum against
+ exec_reduce +=
+ "i.SetTransSpectrum('" + m_uiForm.trans_monitor->text().trimmed() + "',";
exec_reduce += m_uiForm.trans_interp->isChecked() ? "True" : "False";
exec_reduce += ")\n";
- //Set the Transmision settings
+ // Set the Transmision settings
writeTransmissionSettingsToPythonScript(exec_reduce);
// set the user defined center (Geometry Tab)
- // this information is used just after loading the data in order to move to the center
+ // this information is used just after loading the data in order to move to
+ // the center
// Introduced for #5942
- QString set_centre = QString("i.SetCentre('%1','%2','rear') \ni.SetCentre('%3','%4','front')\n")
- .arg( m_uiForm.rear_beam_x->text())
- .arg( m_uiForm.rear_beam_y->text())
- .arg( m_uiForm.front_beam_x->text())
- .arg( m_uiForm.front_beam_y->text());
+ QString set_centre =
+ QString(
+ "i.SetCentre('%1','%2','rear') \ni.SetCentre('%3','%4','front')\n")
+ .arg(m_uiForm.rear_beam_x->text())
+ .arg(m_uiForm.rear_beam_y->text())
+ .arg(m_uiForm.front_beam_x->text())
+ .arg(m_uiForm.front_beam_y->text());
exec_reduce += set_centre;
- //mask strings that the user has entered manually on to the GUI
- addUserMaskStrings(exec_reduce,"i.Mask",DefaultMask);
+ // mask strings that the user has entered manually on to the GUI
+ addUserMaskStrings(exec_reduce, "i.Mask", DefaultMask);
// add slicing definition
if (!m_uiForm.sliceEvent->isHidden())
- exec_reduce += "i.SetEventSlices('"+m_uiForm.sliceEvent->text().trimmed()+"')\n";
+ exec_reduce +=
+ "i.SetEventSlices('" + m_uiForm.sliceEvent->text().trimmed() + "')\n";
return exec_reduce;
}
-///Reads the sample geometry, these settings will override what is stored in the run file
-QString SANSRunWindow::readSampleObjectGUIChanges()
-{
- QString exec_reduce("\ni.ReductionSingleton().get_sample().geometry.shape = ");
+/// Reads the sample geometry, these settings will override what is stored in
+/// the run file
+QString SANSRunWindow::readSampleObjectGUIChanges() {
+ QString exec_reduce(
+ "\ni.ReductionSingleton().get_sample().geometry.shape = ");
exec_reduce += m_uiForm.sample_geomid->currentText().at(0);
- exec_reduce +="\ni.ReductionSingleton().get_sample().geometry.height = ";
+ exec_reduce += "\ni.ReductionSingleton().get_sample().geometry.height = ";
exec_reduce += m_uiForm.sample_height->text();
exec_reduce += "\ni.ReductionSingleton().get_sample().geometry.width = ";
@@ -2344,91 +2342,89 @@ QString SANSRunWindow::readSampleObjectGUIChanges()
exec_reduce += m_uiForm.sample_thick->text();
exec_reduce += "\n";
-
+
return exec_reduce;
}
/**
* Run the analysis script
* @param typeStr :: The data reduction type, 1D or 2D
*/
-void SANSRunWindow::handleReduceButtonClick(const QString & typeStr)
-{
+void SANSRunWindow::handleReduceButtonClick(const QString &typeStr) {
const States type = typeStr == "1D" ? OneD : TwoD;
// Make sure that all settings are valid
- if (!areSettingsValid()){
+ if (!areSettingsValid()) {
return;
}
- //new reduction is going to take place, remove the results from the last reduction
+ // new reduction is going to take place, remove the results from the last
+ // reduction
resetDefaultOutput();
- //The possiblities are batch mode or single run mode
+ // The possiblities are batch mode or single run mode
const RunMode runMode =
- m_uiForm.single_mode_btn->isChecked() ? SingleMode : BatchMode;
- if ( runMode == SingleMode )
- {
- // Currently the components are moved with each reduce click. Check if a load is necessary
- // This must be done before the script is written as we need to get correct values from the
+ m_uiForm.single_mode_btn->isChecked() ? SingleMode : BatchMode;
+ if (runMode == SingleMode) {
+ // Currently the components are moved with each reduce click. Check if a
+ // load is necessary
+ // This must be done before the script is written as we need to get correct
+ // values from the
// loaded raw data
- if ( ! handleLoadButtonClick() )
- {
+ if (!handleLoadButtonClick()) {
return;
}
}
-
- if ( ! entriesAreValid(RUN) )
- {
+
+ if (!entriesAreValid(RUN)) {
return;
}
QString py_code;
-
- try
- {
+
+ try {
py_code = readUserFileGUIChanges(type);
- }
- catch(const std::runtime_error & e)
- {
+ } catch (const std::runtime_error &e) {
showInformationBox(e.what());
return;
}
- if( py_code.isEmpty() )
- {
- showInformationBox("Error: An error occurred while constructing the reduction code, please check installation.");
+ if (py_code.isEmpty()) {
+ showInformationBox("Error: An error occurred while constructing the "
+ "reduction code, please check installation.");
return;
}
const static QString PYTHON_SEP("C++handleReduceButtonClickC++");
- //copy the user setting to use as a base for future reductions after the one that is about to start
- py_code += "\n_user_settings_copy = copy.deepcopy(i.ReductionSingleton().user_settings)";
+ // copy the user setting to use as a base for future reductions after the one
+ // that is about to start
+ py_code += "\n_user_settings_copy = "
+ "copy.deepcopy(i.ReductionSingleton().user_settings)";
const QString verb = m_uiForm.verbose_check ? "True" : "False";
py_code += "\ni.SetVerboseMode(" + verb + ")";
- //Need to check which mode we're in
- if ( runMode == SingleMode )
- {
+ // Need to check which mode we're in
+ if (runMode == SingleMode) {
py_code += readSampleObjectGUIChanges();
py_code += reduceSingleRun();
- //output the name of the output workspace, this is returned up by the runPythonCode() call below
- py_code += "\nprint '"+PYTHON_SEP+"'+reduced+'"+PYTHON_SEP+"'";
- }
- else
- {
- //Have we got anything to reduce?
- if( m_uiForm.batch_table->rowCount() == 0 )
- {
+ // output the name of the output workspace, this is returned up by the
+ // runPythonCode() call below
+ py_code += "\nprint '" + PYTHON_SEP + "'+reduced+'" + PYTHON_SEP + "'";
+ } else {
+ // Have we got anything to reduce?
+ if (m_uiForm.batch_table->rowCount() == 0) {
showInformationBox("Error: No run information specified.");
return;
}
// check for the detectors combination option
- // transform the SANS Diagnostic gui option in: 'rear', 'front' , 'both', 'merged', None WavRangeReduction option
+ // transform the SANS Diagnostic gui option in: 'rear', 'front' , 'both',
+ // 'merged', None WavRangeReduction option
QString combineDetOption, combineDetGuiOption;
combineDetGuiOption = m_uiForm.detbank_sel->currentText();
- if (combineDetGuiOption == "main-detector-bank" || combineDetGuiOption == "rear-detector")
+ if (combineDetGuiOption == "main-detector-bank" ||
+ combineDetGuiOption == "rear-detector")
combineDetOption = "'rear'";
- else if (combineDetGuiOption == "HAB" || combineDetGuiOption=="front-detector")
+ else if (combineDetGuiOption == "HAB" ||
+ combineDetGuiOption == "front-detector")
combineDetOption = "'front'";
else if (combineDetGuiOption == "both")
combineDetOption = "'both'";
@@ -2438,39 +2434,40 @@ void SANSRunWindow::handleReduceButtonClick(const QString & typeStr)
combineDetOption = "None";
QString csv_file(m_uiForm.csv_filename->text());
- if( m_dirty_batch_grid )
- {
- QString selected_file = MantidQt::API::FileDialogHandler::getSaveFileName(this, "Save as CSV", m_last_dir);
+ if (m_dirty_batch_grid) {
+ QString selected_file = MantidQt::API::FileDialogHandler::getSaveFileName(
+ this, "Save as CSV", m_last_dir);
csv_file = saveBatchGrid(selected_file);
}
py_code.prepend("import SANSBatchMode as batch\n");
const int fileFormat = m_uiForm.file_opt->currentIndex();
- // create a instance of fit_settings, so it will not complain if the reduction fails
+ // create a instance of fit_settings, so it will not complain if the
+ // reduction fails
// when restoring the scale and fit.
- QString fit = QString("\nfit_settings={'scale':%1,'shift':%2}").arg(m_uiForm.frontDetRescale->text()).arg(m_uiForm.frontDetShift->text());
+ QString fit = QString("\nfit_settings={'scale':%1,'shift':%2}")
+ .arg(m_uiForm.frontDetRescale->text())
+ .arg(m_uiForm.frontDetShift->text());
py_code += fit;
py_code += "\nfit_settings = batch.BatchReduce('" + csv_file + "','" +
- m_uiForm.file_opt->itemData(fileFormat).toString() + "'";
- if( m_uiForm.plot_check->isChecked() )
- {
+ m_uiForm.file_opt->itemData(fileFormat).toString() + "'";
+ if (m_uiForm.plot_check->isChecked()) {
py_code += ", plotresults=True";
}
py_code += ", saveAlgs={";
QStringList algs(getSaveAlgs());
- for ( QStringList::const_iterator it = algs.begin(); it != algs.end(); ++it)
- {// write a Python dict object in the form { algorithm_name : file extension , ... ,}
- py_code += "'"+*it+"':'"+SaveWorkspaces::getSaveAlgExt(*it)+"',";
+ for (QStringList::const_iterator it = algs.begin(); it != algs.end();
+ ++it) { // write a Python dict object in the form { algorithm_name :
+ // file extension , ... ,}
+ py_code += "'" + *it + "':'" + SaveWorkspaces::getSaveAlgExt(*it) + "',";
}
py_code += "}";
- if( m_uiForm.log_colette->isChecked() )
- {
+ if (m_uiForm.log_colette->isChecked()) {
py_code += ", verbose=True";
}
py_code += ", reducer=i.ReductionSingleton().reference(),";
-
py_code += "combineDet=";
py_code += combineDetOption;
py_code += ",";
@@ -2479,93 +2476,104 @@ void SANSRunWindow::handleReduceButtonClick(const QString & typeStr)
py_code += ")";
}
- //Disable buttons so that interaction is limited while processing data
+ // Disable buttons so that interaction is limited while processing data
setProcessingState(type);
- //std::cout << "\n\n" << py_code.toStdString() << "\n\n";
+ // std::cout << "\n\n" << py_code.toStdString() << "\n\n";
QString pythonStdOut = runReduceScriptFunction(py_code);
// update fields in GUI as a consequence of results obtained during reduction
double scale, shift;
- if (runMode == SingleMode)
- {
+ if (runMode == SingleMode) {
// update front rescale and fit values
- scale = runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.getDetector('FRONT').rescaleAndShift.scale").trimmed().toDouble();
+ scale =
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().instrument.getDetector("
+ "'FRONT').rescaleAndShift.scale")
+ .trimmed()
+ .toDouble();
+
+ shift =
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().instrument.getDetector("
+ "'FRONT').rescaleAndShift.shift")
+ .trimmed()
+ .toDouble();
- shift = runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.getDetector('FRONT').rescaleAndShift.shift").trimmed().toDouble();
-
- }else{
- scale = runReduceScriptFunction("print fit_settings['scale']").trimmed().toDouble();
- shift = runReduceScriptFunction("print fit_settings['shift']").trimmed().toDouble();
+ } else {
+ scale = runReduceScriptFunction("print fit_settings['scale']")
+ .trimmed()
+ .toDouble();
+ shift = runReduceScriptFunction("print fit_settings['shift']")
+ .trimmed()
+ .toDouble();
}
// update gui
m_uiForm.frontDetRescale->setText(QString::number(scale, 'f', 8));
m_uiForm.frontDetShift->setText(QString::number(shift, 'f', 8));
// first process pythonStdOut
QStringList pythonDiag = pythonStdOut.split(PYTHON_SEP);
- if ( pythonDiag.count() > 1 )
- {
+ if (pythonDiag.count() > 1) {
QString reducedWS = pythonDiag[1];
reducedWS = reducedWS.split("\n")[0];
resetDefaultOutput(reducedWS);
}
- //Reset the objects by initialising a new reducer object
- if (runMode == SingleMode) // TODO: test if it is really necessary to reload the file settings.
+ // Reset the objects by initialising a new reducer object
+ if (runMode == SingleMode) // TODO: test if it is really necessary to reload
+ // the file settings.
{
- py_code = "\ni.ReductionSingleton.clean(isis_reducer.ISISReducer)";
- py_code += "\ni." + getInstrumentClass();
- //restore the settings from the user file
- py_code += "\ni.ReductionSingleton().user_file_path='"+
- QFileInfo(m_uiForm.userfile_edit->text()).path() + "'";
- py_code += "\ni.ReductionSingleton().user_settings = _user_settings_copy";
- py_code += "\ni.ReductionSingleton().user_settings.execute(i.ReductionSingleton())";
+ py_code = "\ni.ReductionSingleton.clean(isis_reducer.ISISReducer)";
+ py_code += "\ni." + getInstrumentClass();
+ // restore the settings from the user file
+ py_code += "\ni.ReductionSingleton().user_file_path='" +
+ QFileInfo(m_uiForm.userfile_edit->text()).path() + "'";
+ py_code += "\ni.ReductionSingleton().user_settings = _user_settings_copy";
+ py_code += "\ni.ReductionSingleton().user_settings.execute(i."
+ "ReductionSingleton())";
- std::cout << "\n\n" << py_code.toStdString() << "\n\n";
+ std::cout << "\n\n" << py_code.toStdString() << "\n\n";
- runReduceScriptFunction(py_code);
+ runReduceScriptFunction(py_code);
}
// Mark that a reload is necessary to rerun the same reduction
forceDataReload();
- //Reenable stuff
+ // Reenable stuff
setProcessingState(Ready);
- //If we used a temporary file in batch mode, remove it
- if( m_uiForm.batch_mode_btn->isChecked() && !m_tmp_batchfile.isEmpty() )
- {
+ // If we used a temporary file in batch mode, remove it
+ if (m_uiForm.batch_mode_btn->isChecked() && !m_tmp_batchfile.isEmpty()) {
QFile tmp_file(m_tmp_batchfile);
tmp_file.remove();
}
}
-/** Iterates through the validators and stops if it finds one that is shown and enabled
+/** Iterates through the validators and stops if it finds one that is shown and
+* enabled
* @param check the validator set to check
* @return true if there are no validator problems if false if it finds one
*/
-bool SANSRunWindow::entriesAreValid(const ValCheck check)
-{
- if ( check == LOAD || check == ALL )
- {
+bool SANSRunWindow::entriesAreValid(const ValCheck check) {
+ if (check == LOAD || check == ALL) {
return entriesAreValid(m_loadValids) && runFilesAreValid();
}
- if ( check == RUN || check == ALL )
- {
+ if (check == RUN || check == ALL) {
return entriesAreValid(m_validators);
}
return false;
}
-bool SANSRunWindow::entriesAreValid(ValMap & vals)
-{
- for ( ValMap::const_iterator it = vals.begin(); it != vals.end(); ++it )
- {
- // is the validator active denoting a problem? don't do anything if it's been disabled
- if ( ( ! it->first->isHidden() ) && ( it->first->isEnabled() ) )
- {// the first in the pair is the widget whose value we're having a problem with
+bool SANSRunWindow::entriesAreValid(ValMap &vals) {
+ for (ValMap::const_iterator it = vals.begin(); it != vals.end(); ++it) {
+ // is the validator active denoting a problem? don't do anything if it's
+ // been disabled
+ if ((!it->first->isHidden()) &&
+ (it->first->isEnabled())) { // the first in the pair is the widget whose
+ // value we're having a problem with
it->second.first->setFocus();
- //the second part of the pair is the tab it's in
+ // the second part of the pair is the tab it's in
m_uiForm.tabWidget->setCurrentWidget(it->second.second);
- QMessageBox::warning(this, "Validation Error", "There is a problem with one or more entries on the form. These are marked\nwith an *");
+ QMessageBox::warning(this, "Validation Error",
+ "There is a problem with one or more entries on the "
+ "form. These are marked\nwith an *");
return false;
}
}
@@ -2576,16 +2584,15 @@ bool SANSRunWindow::entriesAreValid(ValMap & vals)
* no error state
* @return true if there are no red stars on any run widgets, false otherwise
*/
-bool SANSRunWindow::runFilesAreValid()
-{
+bool SANSRunWindow::runFilesAreValid() {
std::vector<MWRunFiles *>::const_iterator it = m_runFiles.begin();
- for ( ; it != m_runFiles.end(); ++it )
- {
- if ( ! (*it)->isValid() )
- {
+ for (; it != m_runFiles.end(); ++it) {
+ if (!(*it)->isValid()) {
m_uiForm.runNumbers->setFocus();
m_uiForm.tabWidget->setCurrentWidget(*it);
- QMessageBox::warning(this, "Validation Error", "There is a problem with one or more entries on the form. These are marked\nwith an *");
+ QMessageBox::warning(this, "Validation Error",
+ "There is a problem with one or more entries on the "
+ "form. These are marked\nwith an *");
return false;
}
}
@@ -2595,95 +2602,92 @@ bool SANSRunWindow::runFilesAreValid()
/** Generates the code that can run a reduction chain (and then reset it)
* @return Python code that can be passed to a Python interpreter
*/
-QString SANSRunWindow::reduceSingleRun() const
-{
+QString SANSRunWindow::reduceSingleRun() const {
QString reducer_code;
- if ( m_uiForm.wav_dw_opt->currentText().toUpper().startsWith("RANGE") )
- {
+ if (m_uiForm.wav_dw_opt->currentText().toUpper().startsWith("RANGE")) {
reducer_code += "\nreduced = i.CompWavRanges( ";
- reducer_code += "("+m_uiForm.wavRanges->text()+") ";
+ reducer_code += "(" + m_uiForm.wavRanges->text() + ") ";
reducer_code += ", plot=";
reducer_code += m_uiForm.plot_check->isChecked() ? "True" : "False";
- if ( m_uiForm.detbank_sel->currentIndex() >= 2)
- {
- reducer_code += ", combineDet='" + m_uiForm.detbank_sel->currentText() + "'";
+ if (m_uiForm.detbank_sel->currentIndex() >= 2) {
+ reducer_code +=
+ ", combineDet='" + m_uiForm.detbank_sel->currentText() + "'";
}
reducer_code += ", resetSetup=False)";
- }
- else
- {
- if ( m_uiForm.detbank_sel->currentIndex() < 2)
- {
+ } else {
+ if (m_uiForm.detbank_sel->currentIndex() < 2) {
reducer_code += "\nreduced = i.WavRangeReduction(full_trans_wav=False";
reducer_code += ", resetSetup=False)";
- }
- else
- {
+ } else {
reducer_code += "\nreduced = i.WavRangeReduction(full_trans_wav=False";
- reducer_code += ", combineDet='" + m_uiForm.detbank_sel->currentText() + "'";
+ reducer_code +=
+ ", combineDet='" + m_uiForm.detbank_sel->currentText() + "'";
reducer_code += ", resetSetup=False)";
}
- if( m_uiForm.plot_check->isChecked() )
- {
+ if (m_uiForm.plot_check->isChecked()) {
reducer_code += "\ni.PlotResult(reduced)";
}
}
return reducer_code;
}
-/** Returns the Python instrument class name to create for the current instrument
+/** Returns the Python instrument class name to create for the current
+ instrument
@returns the Python class name corrosponding to the user selected instrument
*/
-QString SANSRunWindow::getInstrumentClass() const
-{
+QString SANSRunWindow::getInstrumentClass() const {
QString instrum = m_uiForm.inst_opt->currentText();
instrum = instrum.isEmpty() ? "LOQ" : instrum;
return instrum + "()";
}
-void SANSRunWindow::handleRunFindCentre()
-{
- QLineEdit * beam_x;
- QLineEdit * beam_y;
+void SANSRunWindow::handleRunFindCentre() {
+ QLineEdit *beam_x;
+ QLineEdit *beam_y;
// this function looks for and reports any errors to the user
- if ( ! entriesAreValid() )
- {
+ if (!entriesAreValid()) {
return;
}
- if (m_uiForm.beamstart_box->currentIndex() == 1){
+ if (m_uiForm.beamstart_box->currentIndex() == 1) {
// Index == Start looking the position from the current one
// check if the user provided the current position:
- // see wich radio is selected (REAR or FRONT) and confirm
+ // see wich radio is selected (REAR or FRONT) and confirm
// that the position x and y are given.
- if ((m_uiForm.rear_radio->isChecked() && (m_uiForm.rear_beam_x->text().isEmpty() ||
- m_uiForm.rear_beam_y->text().isEmpty()) )
- ||
- (m_uiForm.front_radio->isChecked() && (m_uiForm.front_beam_x->text().isEmpty() ||
- m_uiForm.front_beam_y->text().isEmpty())))
- {
- showInformationBox("Current centre postion is invalid, please check input.");
- return;
- }
+ if ((m_uiForm.rear_radio->isChecked() &&
+ (m_uiForm.rear_beam_x->text().isEmpty() ||
+ m_uiForm.rear_beam_y->text().isEmpty())) ||
+ (m_uiForm.front_radio->isChecked() &&
+ (m_uiForm.front_beam_x->text().isEmpty() ||
+ m_uiForm.front_beam_y->text().isEmpty()))) {
+ showInformationBox(
+ "Current centre postion is invalid, please check input.");
+ return;
+ }
}
-
+
/*
- A hidden feature. The handleLoadButtonClick method, set the detector
- based on the m_uiForm.detbank_sel, wich will influentiate the loading
- algorithm and the movement of the detector bank. So, we have to
- set the detector bank according to the selected Center.
+ A hidden feature. The handleLoadButtonClick method, set the detector
+ based on the m_uiForm.detbank_sel, wich will influentiate the loading
+ algorithm and the movement of the detector bank. So, we have to
+ set the detector bank according to the selected Center.
*/
QString coordinates_python_code;
- if( m_uiForm.rear_radio->isChecked()){ // REAR selected -> detbank_sel <- REAR
- m_uiForm.detbank_sel->setCurrentIndex(0);
+ if (m_uiForm.rear_radio
+ ->isChecked()) { // REAR selected -> detbank_sel <- REAR
+ m_uiForm.detbank_sel->setCurrentIndex(0);
beam_x = m_uiForm.rear_beam_x;
beam_y = m_uiForm.rear_beam_y;
- coordinates_python_code = "print i.ReductionSingleton().get_beam_center('rear')[0];print i.ReductionSingleton().get_beam_center('rear')[1]";
- }
- else{
- coordinates_python_code = "print i.ReductionSingleton().get_beam_center('front')[0];print i.ReductionSingleton().get_beam_center('front')[1]" ;
- m_uiForm.detbank_sel->setCurrentIndex(1); // FRONT selected -> detbank_sel <- FRONT
+ coordinates_python_code =
+ "print i.ReductionSingleton().get_beam_center('rear')[0];print "
+ "i.ReductionSingleton().get_beam_center('rear')[1]";
+ } else {
+ coordinates_python_code =
+ "print i.ReductionSingleton().get_beam_center('front')[0];print "
+ "i.ReductionSingleton().get_beam_center('front')[1]";
+ m_uiForm.detbank_sel->setCurrentIndex(
+ 1); // FRONT selected -> detbank_sel <- FRONT
beam_x = m_uiForm.front_beam_x;
beam_y = m_uiForm.front_beam_y;
}
@@ -2699,30 +2703,24 @@ void SANSRunWindow::handleRunFindCentre()
QString py_code(readUserFileGUIChanges(OneD));
py_code += readSampleObjectGUIChanges();
- if( py_code.isEmpty() )
- {
+ if (py_code.isEmpty()) {
setProcessingState(Ready);
return;
}
- if( m_uiForm.beam_rmin->text().isEmpty() )
- {
+ if (m_uiForm.beam_rmin->text().isEmpty()) {
m_uiForm.beam_rmin->setText("60");
}
- if( m_uiForm.beam_rmax->text().isEmpty() )
- {
- if( m_uiForm.inst_opt->currentText() == "LOQ" )
- {
+ if (m_uiForm.beam_rmax->text().isEmpty()) {
+ if (m_uiForm.inst_opt->currentText() == "LOQ") {
m_uiForm.beam_rmax->setText("200");
- }
- else if( m_uiForm.inst_opt->currentText() == "SANS2D" || m_uiForm.inst_opt->currentText() == "SANS2DTUBES")
- {
+ } else if (m_uiForm.inst_opt->currentText() == "SANS2D" ||
+ m_uiForm.inst_opt->currentText() == "SANS2DTUBES") {
m_uiForm.beam_rmax->setText("280");
}
}
- if( m_uiForm.beam_iter->text().isEmpty() )
- {
+ if (m_uiForm.beam_iter->text().isEmpty()) {
m_uiForm.beam_iter->setText("15");
}
@@ -2732,31 +2730,29 @@ void SANSRunWindow::handleRunFindCentre()
// We need to load the FinDirectionEnum class
py_code += "from centre_finder import FindDirectionEnum as FindDirectionEnum \n";
+ // Find centre function
+ py_code += "i.FindBeamCentre(rlow=" + m_uiForm.beam_rmin->text() + ",rupp=" +
+ m_uiForm.beam_rmax->text() + ",MaxIter=" +
+ m_uiForm.beam_iter->text() + ",";
- //Find centre function
- py_code += "i.FindBeamCentre(rlow=" + m_uiForm.beam_rmin->text() + ",rupp=" + m_uiForm.beam_rmax->text() +
- ",MaxIter=" + m_uiForm.beam_iter->text() + ",";
-
-
- if( m_uiForm.beamstart_box->currentIndex() == 0 )
- {
+ if (m_uiForm.beamstart_box->currentIndex() == 0) {
py_code += "xstart = None, ystart = None";
- }
- else
- {
- py_code += "xstart=float(" + beam_x->text() + ")/1000.,ystart=float(" + beam_y->text() + ")/1000.";
+ } else {
+ py_code += "xstart=float(" + beam_x->text() + ")/1000.,ystart=float(" +
+ beam_y->text() + ")/1000.";
}
// define the number of interactions and close the FindBeamCentre method call.
- bool ok;
+ bool ok;
QString tolerance_str(m_uiForm.toleranceLineEdit->text());
- double tolerance = tolerance_str.toDouble(&ok);
+ double tolerance = tolerance_str.toDouble(&ok);
if (ok)
tolerance *= 1e-4; // transform in um
- if ((!ok || tolerance < 0) && ! tolerance_str.isEmpty()){
- QString info("You have chosen an invalid value for tolerance. Correct it or leave it blank to use the default value.");
+ if ((!ok || tolerance < 0) && !tolerance_str.isEmpty()) {
+ QString info("You have chosen an invalid value for tolerance. Correct it "
+ "or leave it blank to use the default value.");
QMessageBox::warning(this, "Wrong Input", info);
- m_uiForm.toleranceLineEdit->setFocus(Qt::OtherFocusReason);
+ m_uiForm.toleranceLineEdit->setFocus(Qt::OtherFocusReason);
setProcessingState(Ready);
return;
}
@@ -2777,116 +2773,124 @@ void SANSRunWindow::handleRunFindCentre()
g_centreFinderLog.notice("Beam Centre Finder Start\n");
m_uiForm.beamstart_box->setFocus();
- //Execute the code
+ // Execute the code
runReduceScriptFunction(py_code);
-
- QString coordstr = runReduceScriptFunction(coordinates_python_code);
-
+
+ QString coordstr = runReduceScriptFunction(coordinates_python_code);
+
QString result("");
- if( coordstr.isEmpty() )
- {
+ if (coordstr.isEmpty()) {
result = "No coordinates returned!";
- }
- else
- {
- //Remove all internal whitespace characters and replace with single space
+ } else {
+ // Remove all internal whitespace characters and replace with single space
coordstr = coordstr.simplified();
QStringList xycoords = coordstr.split(" ");
- if( xycoords.count() == 2 )
- {
+ if (xycoords.count() == 2) {
double coord = xycoords[0].toDouble();
- beam_x->setText(QString::number(coord*1000.));
+ beam_x->setText(QString::number(coord * 1000.));
coord = xycoords[1].toDouble();
- beam_y->setText(QString::number(coord*1000.));
+ beam_y->setText(QString::number(coord * 1000.));
result = "Coordinates updated";
+ } else {
+ result = "Incorrect number of parameters returned from function, check "
+ "script.";
}
- else
- {
- result = "Incorrect number of parameters returned from function, check script.";
-
- }
- }
+ }
QString pyCode = "i.ReductionSingleton.clean(isis_reducer.ISISReducer)";
pyCode += "\ni." + getInstrumentClass();
pyCode += "\ni.ReductionSingleton().user_settings =";
// Use python function to read the settings file and then extract the fields
- pyCode += "isis_reduction_steps.UserFile(r'"+m_uiForm.userfile_edit->text().trimmed()+"')";
+ pyCode += "isis_reduction_steps.UserFile(r'" +
+ m_uiForm.userfile_edit->text().trimmed() + "')";
runReduceScriptFunction(pyCode);
- QString errors = runReduceScriptFunction(
- "print i.ReductionSingleton().user_settings.execute(i.ReductionSingleton())").trimmed();
+ QString errors =
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().user_settings.execute(i."
+ "ReductionSingleton())").trimmed();
g_centreFinderLog.notice() << result.toStdString() << "\n";
-
- //Reenable stuff
+
+ // Reenable stuff
setProcessingState(Ready);
}
/** Save the output workspace from a single run reduction (i.e. the
* workspace m_outputWS) in all the user selected formats
*/
-void SANSRunWindow::handleDefSaveClick()
-{
+void SANSRunWindow::handleDefSaveClick() {
const QString fileBase = m_uiForm.outfile_edit->text();
- if (fileBase.isEmpty())
- {
- QMessageBox::warning(this, "Filename required", "A filename must be entered into the text box above to save this file");
+ if (fileBase.isEmpty()) {
+ QMessageBox::warning(
+ this, "Filename required",
+ "A filename must be entered into the text box above to save this file");
}
- // If we save with a zero-error-free correction we need to swap the
+ // If we save with a zero-error-free correction we need to swap the
QString workspaceNameBuffer = m_outputWS;
QString clonedWorkspaceName = m_outputWS + "_cloned_temp";
if (m_uiForm.zeroErrorCheckBox->isChecked()) {
createZeroErrorFreeClone(m_outputWS, clonedWorkspaceName);
- if (AnalysisDataService::Instance().doesExist(clonedWorkspaceName.toStdString())) {
+ if (AnalysisDataService::Instance().doesExist(
+ clonedWorkspaceName.toStdString())) {
m_outputWS = clonedWorkspaceName;
}
}
-
const QStringList algs(getSaveAlgs());
QString saveCommand;
- for(QStringList::const_iterator alg = algs.begin(); alg != algs.end(); ++alg)
- {
+ for (QStringList::const_iterator alg = algs.begin(); alg != algs.end();
+ ++alg) {
QString ext = SaveWorkspaces::getSaveAlgExt(*alg);
- QString fname = fileBase.endsWith(ext) ? fileBase : fileBase+ext;
- if ( (*alg) == "SaveRKH" )
- saveCommand += (*alg)+"('"+m_outputWS+"','"+fname+"', Append=False)\n";
- else if ( (*alg) == "SaveCanSAS1D" )
- {
- saveCommand += (*alg)+"('"+m_outputWS+"','"+fname+"', DetectorNames=";
- Workspace_sptr workspace_ptr = AnalysisDataService::Instance().retrieve(m_outputWS.toStdString());
- MatrixWorkspace_sptr matrix_workspace = boost::dynamic_pointer_cast<MatrixWorkspace>(workspace_ptr);
- if ( matrix_workspace )
- {
- if ( matrix_workspace->getInstrument()->getName() == "SANS2D" )
+ QString fname = fileBase.endsWith(ext) ? fileBase : fileBase + ext;
+ if ((*alg) == "SaveRKH")
+ saveCommand +=
+ (*alg) + "('" + m_outputWS + "','" + fname + "', Append=False)\n";
+ else if ((*alg) == "SaveCanSAS1D") {
+ saveCommand +=
+ (*alg) + "('" + m_outputWS + "','" + fname + "', DetectorNames=";
+ Workspace_sptr workspace_ptr =
+ AnalysisDataService::Instance().retrieve(m_outputWS.toStdString());
+ MatrixWorkspace_sptr matrix_workspace =
+ boost::dynamic_pointer_cast<MatrixWorkspace>(workspace_ptr);
+ if (matrix_workspace) {
+ if (matrix_workspace->getInstrument()->getName() == "SANS2D")
saveCommand += "'front-detector, rear-detector'";
- if ( matrix_workspace->getInstrument()->getName() == "LOQ" )
+ if (matrix_workspace->getInstrument()->getName() == "LOQ")
saveCommand += "'HAB, main-detector-bank'";
- if ( matrix_workspace->getInstrument()->getName() == "LARMOR")
- saveCommand += "'" + m_uiForm.detbank_sel->currentText()+"'";
-
- /* From v2, SaveCanSAS1D is able to save the Transmission workspaces related to the
- reduced data. The name of workspaces of the Transmission are available at the
- sample logs. This part add the parameters Transmission=trans_ws_name and
- TransmissionCan=trans_ws_name_can if they are available at the Workspace Sample log
- and still available inside MantidPlot. */
- const Mantid::API::Run& run= matrix_workspace->run();
- QStringList list; list << "Transmission" << "TransmissionCan";
- foreach(QString property,list){
- if ( run.hasProperty(property.toStdString()) ){
- std::string trans_ws_name = run.getLogData(property.toStdString())->value();
- if (AnalysisDataService::Instance().isValid(trans_ws_name).empty()){
- saveCommand += ", " + property + "=\"" + QString::fromStdString(trans_ws_name) + "\"";
+ if (matrix_workspace->getInstrument()->getName() == "LARMOR")
+ saveCommand += "'" + m_uiForm.detbank_sel->currentText() + "'";
+
+ /* From v2, SaveCanSAS1D is able to save the Transmission workspaces
+ related to the
+ reduced data. The name of workspaces of the Transmission are
+ available at the
+ sample logs. This part add the parameters Transmission=trans_ws_name
+ and
+ TransmissionCan=trans_ws_name_can if they are available at the
+ Workspace Sample log
+ and still available inside MantidPlot. */
+ const Mantid::API::Run &run = matrix_workspace->run();
+ QStringList list;
+ list << "Transmission"
+ << "TransmissionCan";
+ foreach (QString property, list) {
+ if (run.hasProperty(property.toStdString())) {
+ std::string trans_ws_name =
+ run.getLogData(property.toStdString())->value();
+ if (AnalysisDataService::Instance()
+ .isValid(trans_ws_name)
+ .empty()) {
+ saveCommand += ", " + property + "=\"" +
+ QString::fromStdString(trans_ws_name) + "\"";
}
}
- }
+ }
}
// finish the saveCommand for SaveCanSAS1D
saveCommand += ")\n";
- }
- else
- saveCommand += (*alg)+"('"+m_outputWS+"','"+fname+"')\n";
+ } else
+ saveCommand += (*alg) + "('" + m_outputWS + "','" + fname + "')\n";
}
saveCommand += "print 'success'\n";
@@ -2894,42 +2898,37 @@ void SANSRunWindow::handleDefSaveClick()
// Revert changes and delete the zero-free workspace
if (this->m_uiForm.zeroErrorCheckBox->isChecked()) {
- if (AnalysisDataService::Instance().doesExist(clonedWorkspaceName.toStdString())) {
+ if (AnalysisDataService::Instance().doesExist(
+ clonedWorkspaceName.toStdString())) {
deleteZeroErrorFreeClone(clonedWorkspaceName);
}
}
m_outputWS = workspaceNameBuffer;
-
- if ( result != "success" )
- {
- QMessageBox::critical(this, "Error saving workspace", "Problem encountered saving workspace, does it still exist. There may be more information in the results console?");
+ if (result != "success") {
+ QMessageBox::critical(this, "Error saving workspace",
+ "Problem encountered saving workspace, does it still "
+ "exist. There may be more information in the results "
+ "console?");
}
}
/**
* Set up controls based on the users selection in the combination box
* @param new_index :: The new index that has been set
*/
-void SANSRunWindow::handleWavComboChange(int new_index)
-{
+void SANSRunWindow::handleWavComboChange(int new_index) {
QString userSel = m_uiForm.wav_dw_opt->itemText(new_index);
- if ( userSel.toUpper().contains("LOG") )
- {
+ if (userSel.toUpper().contains("LOG")) {
m_uiForm.wav_step_lbl->setText("dW / W");
- }
- else
- {
+ } else {
m_uiForm.wav_step_lbl->setText("step");
}
- if ( userSel.toUpper().startsWith("RANGE") )
- {
+ if (userSel.toUpper().startsWith("RANGE")) {
m_uiForm.wav_stack->setCurrentIndex(1);
m_uiForm.wavRanVal_lb->setEnabled(true);
- }
- else
- {
+ } else {
m_uiForm.wav_stack->setCurrentIndex(0);
m_uiForm.wavRanVal_lb->setEnabled(false);
}
@@ -2938,43 +2937,35 @@ void SANSRunWindow::handleWavComboChange(int new_index)
* A ComboBox option change
* @param new_index :: The new index that has been set
*/
-void SANSRunWindow::handleStepComboChange(int new_index)
-{
- if( !sender() ) return;
+void SANSRunWindow::handleStepComboChange(int new_index) {
+ if (!sender())
+ return;
QString origin = sender()->objectName();
- if( origin.startsWith("q_dq") )
- {
- if( new_index == 0 )
- {
+ if (origin.startsWith("q_dq")) {
+ if (new_index == 0) {
m_uiForm.q_stack->setCurrentIndex(0);
m_uiForm.q_step_lbl->setText("step");
- }
- else if( new_index == 1 )
- {
+ } else if (new_index == 1) {
m_uiForm.q_stack->setCurrentIndex(0);
m_uiForm.q_step_lbl->setText("dQ / Q");
- }
- else
- {
+ } else {
m_uiForm.q_stack->setCurrentIndex(1);
}
- }
- else
- {
- if( new_index == 0 ) m_uiForm.qy_step_lbl->setText("XY step");
- else m_uiForm.qy_step_lbl->setText("dQ / Q");
+ } else {
+ if (new_index == 0)
+ m_uiForm.qy_step_lbl->setText("XY step");
+ else
+ m_uiForm.qy_step_lbl->setText("dQ / Q");
}
-
}
/**
* Called when the show mask button has been clicked
*/
-void SANSRunWindow::handleShowMaskButtonClick()
-{
+void SANSRunWindow::handleShowMaskButtonClick() {
QString analysis_script;
- addUserMaskStrings(analysis_script,"i.Mask",DefaultMask);
+ addUserMaskStrings(analysis_script, "i.Mask", DefaultMask);
analysis_script += "\ni.DisplayMask()";
m_uiForm.showMaskBtn->setEnabled(false);
@@ -2986,141 +2977,151 @@ void SANSRunWindow::handleShowMaskButtonClick()
m_uiForm.showMaskBtn->setText("Display mask");
}
-
/** Update the GUI and the Python objects with the instrument selection
- * @throw runtime_error if the instrument doesn't have exactly two detectors
+ * @throw runtime_error if the instrument doesn't have exactly two detectors
*/
-void SANSRunWindow::handleInstrumentChange()
-{
+void SANSRunWindow::handleInstrumentChange() {
const std::string facility = ConfigService::Instance().getFacility().name();
- if (facility != "ISIS"){
- QMessageBox::critical(this, "Unsupported facility", QString("Only the ISIS facility is supported by this interface.\n")
- + "Select ISIS as your default facility in View->Preferences...->Mantid to continue.");
+ if (facility != "ISIS") {
+ QMessageBox::critical(
+ this, "Unsupported facility",
+ QString("Only the ISIS facility is supported by this interface.\n") +
+ "Select ISIS as your default facility in "
+ "View->Preferences...->Mantid to continue.");
return;
}
// need this if facility changed to force update of technique at this point
// m_uiForm.inst_opt->setTechniques(m_uiForm.inst_opt->getTechniques());
-
- if( m_uiForm.inst_opt->currentText() == "SANS2DTUBES" )
+
+ if (m_uiForm.inst_opt->currentText() == "SANS2DTUBES")
ConfigService::Instance().setString("default.instrument", "SANS2D");
else
- ConfigService::Instance().setString("default.instrument", m_uiForm.inst_opt->currentText().toStdString());
+ ConfigService::Instance().setString(
+ "default.instrument", m_uiForm.inst_opt->currentText().toStdString());
// Hide the "SANS2D_EVENT" instrument, if present.
const int sans2dEventIndex = m_uiForm.inst_opt->findText("SANS2D_EVENT");
- if( sans2dEventIndex != -1 )
+ if (sans2dEventIndex != -1)
m_uiForm.inst_opt->removeItem(sans2dEventIndex);
- //set up the required Python objects and delete what's out of date (perhaps everything is cleaned here)
+ // set up the required Python objects and delete what's out of date (perhaps
+ // everything is cleaned here)
const QString instClass(getInstrumentClass());
// Only set the instrument if it isn't alread set to what has been selected.
- // This is useful on interface start up, where we have already loaded the user file
+ // This is useful on interface start up, where we have already loaded the user
+ // file
// and don't want to set the instrument twice.
- const QString currentInstName = runPythonCode(
- "print i.ReductionSingleton().get_instrument().versioned_name()").trimmed();
- if( currentInstName != m_uiForm.inst_opt->currentText() )
- {
+ const QString currentInstName =
+ runPythonCode(
+ "print i.ReductionSingleton().get_instrument().versioned_name()")
+ .trimmed();
+ if (currentInstName != m_uiForm.inst_opt->currentText()) {
QString pyCode("i.ReductionSingleton.clean(isis_reducer.ISISReducer)");
pyCode += "\ni." + instClass;
runReduceScriptFunction(pyCode);
}
- //now update the GUI
+ // now update the GUI
fillDetectNames(m_uiForm.detbank_sel);
QString detect = runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.cur_detector().name()");
- QString detectorSelection = runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.det_selection").trimmed();
+ "print i.ReductionSingleton().instrument.cur_detector().name()");
+ QString detectorSelection =
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().instrument.det_selection").trimmed();
int ind = m_uiForm.detbank_sel->findText(detect);
// We set the detector selection only if nothing is set yet.
// Previously, we didn't handle merged and both at this point
- if (detectorSelection == m_constants.getPythonEmptyKeyword() || detectorSelection.isEmpty()) {
- if( ind != -1 ) {
+ if (detectorSelection == m_constants.getPythonEmptyKeyword() ||
+ detectorSelection.isEmpty()) {
+ if (ind != -1) {
m_uiForm.detbank_sel->setCurrentIndex(ind);
}
}
m_uiForm.beam_rmin->setText("60");
- if( instClass == "LOQ()" )
- {
+ if (instClass == "LOQ()") {
m_uiForm.beam_rmax->setText("200");
-
+
m_uiForm.geom_stack->setCurrentIndex(0);
- }
- else if ( instClass == "SANS2D()" || instClass == "SANS2DTUBES()")
- {
+ } else if (instClass == "SANS2D()" || instClass == "SANS2DTUBES()") {
m_uiForm.beam_rmax->setText("280");
m_uiForm.geom_stack->setCurrentIndex(1);
-
}
// flag that the user settings file needs to be loaded for this instrument
m_cfg_loaded = false;
// disable the Geometry -> Set Centre widgets that can not be edited
// for SANS2D experiments.
- QWidget * front_center_widgets [] = {m_uiForm.front_beam_x, m_uiForm.front_beam_y, m_uiForm.front_radio};
- bool loq_selected = (instClass == "LOQ()");
- for (int i=0; i<3; i++)
+ QWidget *front_center_widgets[] = {
+ m_uiForm.front_beam_x, m_uiForm.front_beam_y, m_uiForm.front_radio};
+ bool loq_selected = (instClass == "LOQ()");
+ for (int i = 0; i < 3; i++)
front_center_widgets[i]->setEnabled(loq_selected);
- // Set the label of the radio buttons according to the
- // beamline usage:
+ // Set the label of the radio buttons according to the
+ // beamline usage:
// REAR/FRONT -> SANS2D
// MAIN/HAB -> LOQ
- if (loq_selected){
+ if (loq_selected) {
m_uiForm.front_radio->setText("&HAB");
- m_uiForm.rear_radio->setText("&Main");
- }else{
- m_uiForm.front_radio->setText("&Front");
- m_uiForm.rear_radio->setText("&Rear");
+ m_uiForm.rear_radio->setText("&Main");
+ } else {
+ m_uiForm.front_radio->setText("&Front");
+ m_uiForm.rear_radio->setText("&Rear");
}
// LOQ does not have event mode collection
// hence, hide the widgets related to slice event mode data.
- bool hide_events_gui = loq_selected;
+ bool hide_events_gui = loq_selected;
m_uiForm.slicePb->setHidden(hide_events_gui);
m_uiForm.sliceEvent->setHidden(hide_events_gui);
m_uiForm.l_events_label->setHidden(hide_events_gui);
m_uiForm.l_events_binning->setHidden(hide_events_gui);
+
+ // Provide LOQ Specific settings
+ const auto isNowLOQ = m_uiForm.inst_opt->currentText() == "LOQ";
+ applyLOQSettings(isNowLOQ);
+}
+
+/**
+ * Apply or unapply LOQ-specific settings
+ * @param isNowLOQ: if true then apply LOQ settings else unapply
+ */
+void SANSRunWindow::applyLOQSettings(bool isNowLOQ) {
+ // M4 Transmission monitor
+ m_uiForm.trans_M4_check_box->setDisabled(isNowLOQ);
}
+
/** Record if the user has changed the default filename, because then we don't
* change it
*/
-void SANSRunWindow::setUserFname()
-{
- m_userFname = true;
-}
+void SANSRunWindow::setUserFname() { m_userFname = true; }
/** Enables or disables the floodFile run widget
-* @param state :: Qt::CheckState enum value, Checked means enable otherwise disabled
+* @param state :: Qt::CheckState enum value, Checked means enable otherwise
+* disabled
*/
-void SANSRunWindow::prepareFlood(int state)
-{
+void SANSRunWindow::prepareFlood(int state) {
if (sender() == m_uiForm.enableRearFlood_ck)
m_uiForm.floodRearFile->setEnabled(state == Qt::Checked);
if (sender() == m_uiForm.enableFrontFlood_ck)
m_uiForm.floodFrontFile->setEnabled(state == Qt::Checked);
}
-/**Enables the default save button, saveDefault_Btn, if there is an output workspace
+/**Enables the default save button, saveDefault_Btn, if there is an output
+* workspace
* stored in m_outputWS and text in outfile_edit
*/
-void SANSRunWindow::enableOrDisableDefaultSave()
-{
- if ( m_outputWS.isEmpty() )
- {//setEnabled(false) gets run below
- }
- else if ( m_uiForm.outfile_edit->text().isEmpty() )
- {//setEnabled(false) gets run below
- }
- else
- {//ensure that one format box is checked
- for(SavFormatsConstIt i=m_savFormats.begin(); i != m_savFormats.end(); ++i)
- {
- if (i.key()->isChecked())
- {
+void SANSRunWindow::enableOrDisableDefaultSave() {
+ if (m_outputWS.isEmpty()) { // setEnabled(false) gets run below
+ } else if (m_uiForm.outfile_edit->text()
+ .isEmpty()) { // setEnabled(false) gets run below
+ } else { // ensure that one format box is checked
+ for (SavFormatsConstIt i = m_savFormats.begin(); i != m_savFormats.end();
+ ++i) {
+ if (i.key()->isChecked()) {
m_uiForm.saveDefault_btn->setEnabled(true);
return;
}
@@ -3128,16 +3129,16 @@ void SANSRunWindow::enableOrDisableDefaultSave()
}
m_uiForm.saveDefault_btn->setEnabled(false);
}
-/** connected to the Multi-period check box it shows or hides the multi-period boxes
+/** connected to the Multi-period check box it shows or hides the multi-period
+* boxes
* on the file widgets
-* @param tickState an enum (Qt::CheckState) that indicates if check box was ticked or not
+* @param tickState an enum (Qt::CheckState) that indicates if check box was
+* ticked or not
*/
-void SANSRunWindow::disOrEnablePeriods(const int tickState)
-{
+void SANSRunWindow::disOrEnablePeriods(const int tickState) {
const bool enable = tickState == Qt::Checked;
std::vector<MWRunFiles *>::const_iterator it = m_runFiles.begin();
- for ( ; it != m_runFiles.end(); ++it )
- {
+ for (; it != m_runFiles.end(); ++it) {
(*it)->doMultiEntry(enable);
}
}
@@ -3145,59 +3146,54 @@ void SANSRunWindow::disOrEnablePeriods(const int tickState)
/**
* Enable or disable the controls that corrospond to batch or single run mode
*/
-void SANSRunWindow::switchMode()
-{
+void SANSRunWindow::switchMode() {
const RunMode modeId =
- m_uiForm.single_mode_btn->isChecked() ? SingleMode : BatchMode;
+ m_uiForm.single_mode_btn->isChecked() ? SingleMode : BatchMode;
- if( modeId == SingleMode )
- {
+ if (modeId == SingleMode) {
m_uiForm.mode_stack->setCurrentIndex(0);
m_uiForm.load_dataBtn->setEnabled(true);
m_uiForm.sampDetails_gb->setEnabled(true);
m_uiForm.sampDetails_gb->setToolTip("The dimensions of the sample");
- }
- else if( modeId == BatchMode )
- {
+ } else if (modeId == BatchMode) {
m_uiForm.mode_stack->setCurrentIndex(1);
m_uiForm.load_dataBtn->setEnabled(false);
m_uiForm.sampDetails_gb->setEnabled(false);
- m_uiForm.sampDetails_gb->setToolTip("Batch mode has been selected the sample geometry will be read from the sample workspace");
+ m_uiForm.sampDetails_gb->setToolTip("Batch mode has been selected the "
+ "sample geometry will be read from the "
+ "sample workspace");
}
}
/**
* Paste to the batch table
*/
-void SANSRunWindow::pasteToBatchTable()
-{
- if( !m_cfg_loaded )
- {
+void SANSRunWindow::pasteToBatchTable() {
+ if (!m_cfg_loaded) {
showInformationBox("Please load the relevant user file before continuing.");
return;
}
QClipboard *clipboard = QApplication::clipboard();
QString copied_text = clipboard->text();
- if( copied_text.isEmpty() ) return;
-
+ if (copied_text.isEmpty())
+ return;
+
QStringList runlines = copied_text.split("\n");
QStringListIterator sitr(runlines);
int errors(0);
- while( sitr.hasNext() )
- {
+ while (sitr.hasNext()) {
QString line = sitr.next().simplified();
- if( !line.isEmpty() )
- {
+ if (!line.isEmpty()) {
errors += addBatchLine(line);
}
}
- if( errors > 0 )
- {
- showInformationBox("Warning: " + QString::number(errors) + " malformed lines detected in pasted text. Lines skipped.");
+ if (errors > 0) {
+ showInformationBox(
+ "Warning: " + QString::number(errors) +
+ " malformed lines detected in pasted text. Lines skipped.");
}
- if( m_uiForm.batch_table->rowCount() > 0 )
- {
+ if (m_uiForm.batch_table->rowCount() > 0) {
m_dirty_batch_grid = true;
setProcessingState(Ready);
}
@@ -3206,11 +3202,9 @@ void SANSRunWindow::pasteToBatchTable()
/**
* Clear the batch table
*/
-void SANSRunWindow::clearBatchTable()
-{
+void SANSRunWindow::clearBatchTable() {
int row_count = m_uiForm.batch_table->rowCount();
- for( int i = row_count - 1; i >= 0; --i )
- {
+ for (int i = row_count - 1; i >= 0; --i) {
m_uiForm.batch_table->removeRow(i);
}
m_dirty_batch_grid = false;
@@ -3220,28 +3214,25 @@ void SANSRunWindow::clearBatchTable()
/**
* Clear the logger field
*/
-void SANSRunWindow::clearLogger()
-{
+void SANSRunWindow::clearLogger() {
m_uiForm.logging_field->clear();
m_uiForm.tabWidget->setTabText(4, "Logging");
}
-/**Respond to the Front detector Q range check box.
+/**Respond to the Front detector Q range check box.
* @param state :: equal to Qt::Checked or not
*/
-void SANSRunWindow::updateFrontDetQrange(int state)
-{
- if( state == Qt::Checked )
- {
+void SANSRunWindow::updateFrontDetQrange(int state) {
+ if (state == Qt::Checked) {
m_uiForm.frontDetQmin->setEnabled(true);
m_uiForm.frontDetQmax->setEnabled(true);
- runReduceScriptFunction("i.ReductionSingleton().instrument.getDetector('FRONT').rescaleAndShift.qRangeUserSelected=True");
- }
- else
- {
+ runReduceScriptFunction("i.ReductionSingleton().instrument.getDetector('"
+ "FRONT').rescaleAndShift.qRangeUserSelected=True");
+ } else {
m_uiForm.frontDetQmin->setEnabled(false);
m_uiForm.frontDetQmax->setEnabled(false);
- runReduceScriptFunction("i.ReductionSingleton().instrument.getDetector('FRONT').rescaleAndShift.qRangeUserSelected=False");
+ runReduceScriptFunction("i.ReductionSingleton().instrument.getDetector('"
+ "FRONT').rescaleAndShift.qRangeUserSelected=False");
}
}
@@ -3251,29 +3242,26 @@ void SANSRunWindow::updateFrontDetQrange(int state)
* Otherwise they are enabled
* @param state :: equal to Qt::Checked or not
*/
-void SANSRunWindow::updateTransInfo(int state)
-{
- QLineEdit * _min = m_uiForm.trans_min,
- * _max = m_uiForm.trans_max;
-
- if (sender() == m_uiForm.transFit_ck_can){
+void SANSRunWindow::updateTransInfo(int state) {
+ QLineEdit *_min = m_uiForm.trans_min, *_max = m_uiForm.trans_max;
+
+ if (sender() == m_uiForm.transFit_ck_can) {
_min = m_uiForm.trans_min_can;
_max = m_uiForm.trans_max_can;
}
- if( state == Qt::Checked )
- {
+ if (state == Qt::Checked) {
_min->setEnabled(true);
_min->setText(
- runReduceScriptFunction("print i.ReductionSingleton().instrument.WAV_RANGE_MIN").trimmed());
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().instrument.WAV_RANGE_MIN").trimmed());
_max->setEnabled(true);
_max->setText(
- runReduceScriptFunction("print i.ReductionSingleton().instrument.WAV_RANGE_MAX").trimmed());
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().instrument.WAV_RANGE_MAX").trimmed());
- }
- else
- {
+ } else {
_min->setEnabled(false);
_min->setText("");
@@ -3284,237 +3272,240 @@ void SANSRunWindow::updateTransInfo(int state)
/** A slot to validate entries for Python lists and tupples
*/
-void SANSRunWindow::checkList()
-{
+void SANSRunWindow::checkList() {
// may be a need to generalise this
QLineEdit *toValdate = m_uiForm.wavRanges;
QLabel *validator = m_uiForm.wavRanVal_lb;
const std::string input(toValdate->text().trimmed().toStdString());
bool valid(false);
- //split up the comma separated list ignoring spaces
+ // split up the comma separated list ignoring spaces
Poco::StringTokenizer in(input, ",", Poco::StringTokenizer::TOK_TRIM);
- try
- {
- for(Poco::StringTokenizer::Iterator i=in.begin(), end=in.end(); i!=end; ++i)
- {// try a lexical cast, we don't need its result only if there was an error
+ try {
+ for (Poco::StringTokenizer::Iterator i = in.begin(), end = in.end();
+ i != end; ++i) { // try a lexical cast, we don't need its result only
+ // if there was an error
boost::lexical_cast<double>(*i);
}
// there were no errors
- if ( ! input.empty() )
- {
+ if (!input.empty()) {
valid = true;
}
- }
- catch (boost::bad_lexical_cast &)
- {// there is a problem with the input somewhere
+ } catch (boost::bad_lexical_cast &) { // there is a problem with the input
+ // somewhere
valid = false;
}
-
- if (valid)
- {
+
+ if (valid) {
validator->hide();
- }
- else
- {
+ } else {
validator->show();
}
}
-void SANSRunWindow::setLoggerTabTitleToWarn()
-{
+void SANSRunWindow::setLoggerTabTitleToWarn() {
m_uiForm.tabWidget->setTabText(4, "Logging - WARNINGS");
}
-
/** Record the output workspace name, if there is no output
* workspace pass an empty string or an empty argument list
* @param wsName :: the name of the output workspace or empty for no output
*/
-void SANSRunWindow::resetDefaultOutput(const QString & wsName)
-{
+void SANSRunWindow::resetDefaultOutput(const QString &wsName) {
m_outputWS = wsName;
enableOrDisableDefaultSave();
- if ( ! m_userFname )
- {
- if (m_uiForm.detbank_sel->currentIndex() == 2)// both selected
- m_uiForm.outfile_edit->setText("");
+ if (!m_userFname) {
+ if (m_uiForm.detbank_sel->currentIndex() == 2) // both selected
+ m_uiForm.outfile_edit->setText("");
else
m_uiForm.outfile_edit->setText(wsName);
}
}
-/** Passes information about the selected transmission runs to the Python objects
-* @param trans run widget box with the selected transmission (run with a sample present) file
-* @param direct run widget box with the selected direct (run with no sample present) file
+/** Passes information about the selected transmission runs to the Python
+* objects
+* @param trans run widget box with the selected transmission (run with a sample
+* present) file
+* @param direct run widget box with the selected direct (run with no sample
+* present) file
* @param assignFn this is different for can or sample
*/
-bool SANSRunWindow::assignMonitorRun(MantidWidgets::MWRunFiles & trans, MantidWidgets::MWRunFiles & direct, const QString & assignFn)
-{
- //need something to place between names printed by Python that won't be intepreted as the names or removed as white space
+bool SANSRunWindow::assignMonitorRun(MantidWidgets::MWRunFiles &trans,
+ MantidWidgets::MWRunFiles &direct,
+ const QString &assignFn) {
+ // need something to place between names printed by Python that won't be
+ // intepreted as the names or removed as white space
const static QString PYTHON_SEP("C++assignMonitorRunC++");
-
- QString assignCom("i."+assignFn+"(r'" + trans.getFirstFilename() + "'");
- assignCom.append(", r'"+direct.getFirstFilename()+"'");
+
+ QString assignCom("i." + assignFn + "(r'" + trans.getFirstFilename() + "'");
+ assignCom.append(", r'" + direct.getFirstFilename() + "'");
int period = trans.getEntryNum();
- if (period != MWRunFiles::ALL_ENTRIES)
- {
- assignCom.append(", period_t="+QString::number(period));
+ if (period != MWRunFiles::ALL_ENTRIES) {
+ assignCom.append(", period_t=" + QString::number(period));
}
period = direct.getEntryNum();
- //we can only do single period reductions now
- if (period != MWRunFiles::ALL_ENTRIES)
- {
- assignCom.append(", period_d="+QString::number(period));
+ // we can only do single period reductions now
+ if (period != MWRunFiles::ALL_ENTRIES) {
+ assignCom.append(", period_d=" + QString::number(period));
}
- assignCom.append(")");
- //assign the workspace name to a Python variable and read back some details
- QString pythonC="t1, t2 = " + assignCom + ";print '"+PYTHON_SEP+"',t1,'"+PYTHON_SEP+"',t2";
+ assignCom.append(")");
+ // assign the workspace name to a Python variable and read back some details
+ QString pythonC = "t1, t2 = " + assignCom + ";print '" + PYTHON_SEP +
+ "',t1,'" + PYTHON_SEP + "',t2";
QString ws_names = runReduceScriptFunction(pythonC);
- if (ws_names.startsWith("error", Qt::CaseInsensitive))
- {
+ if (ws_names.startsWith("error", Qt::CaseInsensitive)) {
throw std::runtime_error("Couldn't load a transmission file");
}
-
- //read the informtion returned from Python
- QString trans_ws = ws_names.section(PYTHON_SEP, 1,1).trimmed();
+
+ // read the informtion returned from Python
+ QString trans_ws = ws_names.section(PYTHON_SEP, 1, 1).trimmed();
QString direct_ws = ws_names.section(PYTHON_SEP, 2).trimmed();
- bool status = ( ! trans_ws.isEmpty() ) && ( ! direct_ws.isEmpty() );
+ bool status = (!trans_ws.isEmpty()) && (!direct_ws.isEmpty());
- //if the workspaces have loaded
- if (status)
- {//save the workspace names
+ // if the workspaces have loaded
+ if (status) { // save the workspace names
m_workspaceNames.insert(trans_ws);
m_workspaceNames.insert(direct_ws);
}
return status;
}
-/**
- * Load a scatter sample file or can run via Python objects using the passed Python command
+/**
+ * Load a scatter sample file or can run via Python objects using the passed
+ * Python command
* @param[in] runFile name of file to load
* @param[in] assignFn the Python command to run
* @return true if there were no Python errors, false otherwise
*/
-bool SANSRunWindow::assignDetBankRun(MantidWidgets::MWRunFiles & runFile, const QString & assignFn)
-{
- //need something to place between names printed by Python that won't be intepreted as the names or removed as white space
+bool SANSRunWindow::assignDetBankRun(MantidWidgets::MWRunFiles &runFile,
+ const QString &assignFn) {
+ // need something to place between names printed by Python that won't be
+ // intepreted as the names or removed as white space
const static QString PYTHON_SEP("C++assignDetBankRunC++");
-
- QString assignCom("i."+assignFn+"(r'" + runFile.getFirstFilename() + "'");
+
+ QString assignCom("i." + assignFn + "(r'" + runFile.getFirstFilename() + "'");
assignCom.append(", reload = True");
int period = runFile.getEntryNum();
- if (period != MWRunFiles::ALL_ENTRIES)
- {
+ if (period != MWRunFiles::ALL_ENTRIES) {
assignCom.append(", period = " + QString::number(period));
}
-
+
assignCom.append(")");
- //assign the workspace name to a Python variable and read back some details
+ // assign the workspace name to a Python variable and read back some details
QString run_info;
- run_info = QString("i.SetCentre('%1','%2','rear') \ni.SetCentre('%3','%4','front')\n")
- .arg( m_uiForm.rear_beam_x->text())
- .arg( m_uiForm.rear_beam_y->text())
- .arg( m_uiForm.front_beam_x->text())
- .arg( m_uiForm.front_beam_y->text());
+ run_info =
+ QString(
+ "i.SetCentre('%1','%2','rear') \ni.SetCentre('%3','%4','front')\n")
+ .arg(m_uiForm.rear_beam_x->text())
+ .arg(m_uiForm.rear_beam_y->text())
+ .arg(m_uiForm.front_beam_x->text())
+ .arg(m_uiForm.front_beam_y->text());
run_info += "SCATTER_SAMPLE = " + assignCom;
- run_info += ";ws_name = SCATTER_SAMPLE if not isinstance(SCATTER_SAMPLE, tuple) else SCATTER_SAMPLE[0]";
- run_info += ";print '"+PYTHON_SEP+"',ws_name";
+ run_info += ";ws_name = SCATTER_SAMPLE if not isinstance(SCATTER_SAMPLE, "
+ "tuple) else SCATTER_SAMPLE[0]";
+ run_info += ";print '" + PYTHON_SEP + "',ws_name";
run_info = runReduceScriptFunction(run_info);
- if (run_info.startsWith("error", Qt::CaseInsensitive))
- {
+ if (run_info.startsWith("error", Qt::CaseInsensitive)) {
throw std::runtime_error("Couldn't load sample or can");
}
- //read the informtion returned from Python
+ // read the informtion returned from Python
QString base_workspace = run_info.section(PYTHON_SEP, 1, 1).trimmed();
- if ( assignFn.contains("can", Qt::CaseInsensitive) )
- {
+ if (assignFn.contains("can", Qt::CaseInsensitive)) {
m_experCan = base_workspace;
- }
- else
- {
+ } else {
m_experWksp = base_workspace;
}
m_workspaceNames.insert(base_workspace);
- return ! base_workspace.isEmpty();
+ return !base_workspace.isEmpty();
}
/** Gets the detectors that the instrument has and fills the
* combination box with these, there must exactly two detectors
-* @param output [out] this combination box will be cleared and filled with the new names
-* @throw runtime_error if there aren't exactly two detectors
+* @param output [out] this combination box will be cleared and filled with the
+* new names
+* @throw runtime_error if there aren't exactly two detectors
*/
-void SANSRunWindow::fillDetectNames(QComboBox *output)
-{
+void SANSRunWindow::fillDetectNames(QComboBox *output) {
QString detsTuple = runReduceScriptFunction(
- "print i.ReductionSingleton().instrument.listDetectors()");
+ "print i.ReductionSingleton().instrument.listDetectors()");
- if (detsTuple.isEmpty())
- {//this happens if the run Python signal hasn't yet been connected
+ if (detsTuple.isEmpty()) { // this happens if the run Python signal hasn't yet
+ // been connected
return;
}
QStringList dets = detsTuple.split("'", QString::SkipEmptyParts);
- // the tuple will be of the form ('det1', 'det2'), hence the split should return 5 parts
- if ( dets.count() != 5 )
- {
- QMessageBox::critical(this, "Can't Load Instrument", "The instrument must have only 2 detectors. Can't proceed with this instrument");
- throw std::runtime_error("Invalid instrument setting, you should be able to continue by selecting a valid instrument");
+ // the tuple will be of the form ('det1', 'det2'), hence the split should
+ // return 5 parts
+ if (dets.count() != 5) {
+ QMessageBox::critical(this, "Can't Load Instrument",
+ "The instrument must have only 2 detectors. Can't "
+ "proceed with this instrument");
+ throw std::runtime_error("Invalid instrument setting, you should be able "
+ "to continue by selecting a valid instrument");
}
-
+
output->setItemText(0, dets[1]);
output->setItemText(1, dets[3]);
}
-/** Checks if the workspace is a group and returns the first member of group, throws
+/** Checks if the workspace is a group and returns the first member of group,
+* throws
* if nothing can be retrived
* @param in [in] the group to examine
-* @param member [in] entry or period number of the requested workspace, these start at 1
+* @param member [in] entry or period number of the requested workspace, these
+* start at 1
* @return the first member of the passed group
* @throw NotFoundError if a workspace can't be returned
*/
-Mantid::API::MatrixWorkspace_sptr SANSRunWindow::getGroupMember(Mantid::API::Workspace_const_sptr in, const int member) const
-{
+Mantid::API::MatrixWorkspace_sptr
+SANSRunWindow::getGroupMember(Mantid::API::Workspace_const_sptr in,
+ const int member) const {
Mantid::API::WorkspaceGroup_const_sptr group =
- boost::dynamic_pointer_cast<const Mantid::API::WorkspaceGroup>(in);
- if ( ! group )
- {
- throw Mantid::Kernel::Exception::NotFoundError("Problem retrieving workspace ", in->getName());
+ boost::dynamic_pointer_cast<const Mantid::API::WorkspaceGroup>(in);
+ if (!group) {
+ throw Mantid::Kernel::Exception::NotFoundError(
+ "Problem retrieving workspace ", in->getName());
}
-
+
const std::vector<std::string> gNames = group->getNames();
- //currently the names array starts with the name of the group
- if ( static_cast<int>(gNames.size()) < member + 1 )
- {
- throw Mantid::Kernel::Exception::NotFoundError("Workspace group" + in->getName() + " doesn't have " + boost::lexical_cast<std::string>(member) + " entries", member);
- }
- //throws NotFoundError if the workspace couldn't be found
- Mantid::API::Workspace_sptr base = Mantid::API::AnalysisDataService::Instance().retrieve(gNames[member]);
+ // currently the names array starts with the name of the group
+ if (static_cast<int>(gNames.size()) < member + 1) {
+ throw Mantid::Kernel::Exception::NotFoundError(
+ "Workspace group" + in->getName() + " doesn't have " +
+ boost::lexical_cast<std::string>(member) + " entries",
+ member);
+ }
+ // throws NotFoundError if the workspace couldn't be found
+ Mantid::API::Workspace_sptr base =
+ Mantid::API::AnalysisDataService::Instance().retrieve(gNames[member]);
Mantid::API::MatrixWorkspace_sptr memberWS =
- boost::dynamic_pointer_cast<Mantid::API::MatrixWorkspace>(base);
- if ( ! memberWS )
- {
- throw Mantid::Kernel::Exception::NotFoundError("Problem getting period number " + boost::lexical_cast<std::string>(member) + " from group workspace " + base->getName(), member);
+ boost::dynamic_pointer_cast<Mantid::API::MatrixWorkspace>(base);
+ if (!memberWS) {
+ throw Mantid::Kernel::Exception::NotFoundError(
+ "Problem getting period number " +
+ boost::lexical_cast<std::string>(member) +
+ " from group workspace " + base->getName(),
+ member);
}
-
+
return memberWS;
}
-/** Find which save formats have been selected by the user
+/** Find which save formats have been selected by the user
* @return save algorithm names
*/
-QStringList SANSRunWindow::getSaveAlgs()
-{
+QStringList SANSRunWindow::getSaveAlgs() {
QStringList checked;
- for(SavFormatsConstIt i = m_savFormats.begin(); i != m_savFormats.end(); ++i)
- {//the key is the check box
- if (i.key()->isChecked())
- {// and value() is the name of the algorithm associated with that checkbox
+ for (SavFormatsConstIt i = m_savFormats.begin(); i != m_savFormats.end();
+ ++i) { // the key is the check box
+ if (i.key()->isChecked()) { // and value() is the name of the algorithm
+ // associated with that checkbox
checked.append(i.value());
}
}
@@ -3524,11 +3515,10 @@ QStringList SANSRunWindow::getSaveAlgs()
* Handle a delete notification from Mantid
* @param p_dnf :: A Mantid delete notification
*/
-void SANSRunWindow::handleMantidDeleteWorkspace(Mantid::API::WorkspacePostDeleteNotification_ptr p_dnf)
-{
+void SANSRunWindow::handleMantidDeleteWorkspace(
+ Mantid::API::WorkspacePostDeleteNotification_ptr p_dnf) {
QString wkspName = QString::fromStdString(p_dnf->objectName());
- if ( m_workspaceNames.find(wkspName) != m_workspaceNames.end() )
- {
+ if (m_workspaceNames.find(wkspName) != m_workspaceNames.end()) {
forceDataReload();
}
}
@@ -3539,9 +3529,10 @@ void SANSRunWindow::handleMantidDeleteWorkspace(Mantid::API::WorkspacePostDelete
* @param format :: The format char
* @param precision :: The precision
*/
-QString SANSRunWindow::formatDouble(double value, const QString & colour, char format, int precision)
-{
- return QString("<font color='") + colour + QString("'>") + QString::number(value, format, precision) + QString("</font>");
+QString SANSRunWindow::formatDouble(double value, const QString &colour,
+ char format, int precision) {
+ return QString("<font color='") + colour + QString("'>") +
+ QString::number(value, format, precision) + QString("</font>");
}
/**
@@ -3549,63 +3540,55 @@ QString SANSRunWindow::formatDouble(double value, const QString & colour, char f
* @param msg :: The message to include in the box
* @param index :: The tab index to set as current
*/
-void SANSRunWindow::raiseOneTimeMessage(const QString & msg, int index)
-{
- if( m_warnings_issued ) return;
- if( index >= 0 )
- {
+void SANSRunWindow::raiseOneTimeMessage(const QString &msg, int index) {
+ if (m_warnings_issued)
+ return;
+ if (index >= 0) {
m_uiForm.tabWidget->setCurrentIndex(index);
}
showInformationBox(msg);
m_warnings_issued = true;
}
-
/**
- * Rest the geometry details box
+ * Rest the geometry details box
*/
-void SANSRunWindow::resetGeometryDetailsBox()
-{
+void SANSRunWindow::resetGeometryDetailsBox() {
QString blank("-");
- //LOQ
+ // LOQ
m_uiForm.dist_mod_mon->setText(blank);
- //SANS2D
+ // SANS2D
m_uiForm.dist_mon_s2d->setText(blank);
m_uiForm.dist_sample_ms_s2d->setText(blank);
m_uiForm.dist_can_ms_s2d->setText(blank);
m_uiForm.dist_bkgd_ms_s2d->setText(blank);
- for(int i = 0; i < 3; ++i )
- {
- //LOQ
- QMutableHashIterator<QString,QLabel*> litr(m_loq_detlabels[i]);
- while(litr.hasNext())
- {
+ for (int i = 0; i < 3; ++i) {
+ // LOQ
+ QMutableHashIterator<QString, QLabel *> litr(m_loq_detlabels[i]);
+ while (litr.hasNext()) {
litr.next();
litr.value()->setText(blank);
}
- //SANS2D
- QMutableHashIterator<QString,QLabel*> sitr(m_s2d_detlabels[i]);
- while(sitr.hasNext())
- {
+ // SANS2D
+ QMutableHashIterator<QString, QLabel *> sitr(m_s2d_detlabels[i]);
+ while (sitr.hasNext()) {
sitr.next();
sitr.value()->setText(blank);
}
}
-
}
-void SANSRunWindow::cleanup()
-{
- Mantid::API::AnalysisDataServiceImpl & ads = Mantid::API::AnalysisDataService::Instance();
+void SANSRunWindow::cleanup() {
+ Mantid::API::AnalysisDataServiceImpl &ads =
+ Mantid::API::AnalysisDataService::Instance();
std::set<std::string> workspaces = ads.getObjectNames();
std::set<std::string>::const_iterator iend = workspaces.end();
- for( std::set<std::string>::const_iterator itr = workspaces.begin(); itr != iend; ++itr )
- {
+ for (std::set<std::string>::const_iterator itr = workspaces.begin();
+ itr != iend; ++itr) {
QString name = QString::fromStdString(*itr);
- if( name.endsWith("_raw") || name.endsWith("_nxs"))
- {
+ if (name.endsWith("_raw") || name.endsWith("_nxs")) {
ads.remove(*itr);
}
}
@@ -3613,57 +3596,44 @@ void SANSRunWindow::cleanup()
/**
* Add a csv line to the batch grid
- * @param csv_line :: Add a line of csv text to the grid
+ * @param csv_line :: Add a line of csv text to the grid
* @param separator :: An optional separator, default = ","
*/
-int SANSRunWindow::addBatchLine(QString csv_line, QString separator)
-{
- //Try to detect separator if one is not specified
- if( separator.isEmpty() )
- {
- if( csv_line.contains(",") )
- {
+int SANSRunWindow::addBatchLine(QString csv_line, QString separator) {
+ // Try to detect separator if one is not specified
+ if (separator.isEmpty()) {
+ if (csv_line.contains(",")) {
separator = ",";
- }
- else
- {
+ } else {
separator = " ";
}
}
QStringList elements = csv_line.split(separator);
- //Insert new row
+ // Insert new row
int row = m_uiForm.batch_table->rowCount();
m_uiForm.batch_table->insertRow(row);
int nelements = elements.count() - 1;
bool error(false);
- for( int i = 0; i < nelements; )
- {
+ for (int i = 0; i < nelements;) {
QString cola = elements.value(i);
- QString colb = elements.value(i+1);
- if( m_allowed_batchtags.contains(cola) )
- {
- if( !m_allowed_batchtags.contains(colb) )
- {
- if( !colb.isEmpty() && !cola.contains("background") )
- {
- m_uiForm.batch_table->setItem(row, m_allowed_batchtags.value(cola), new QTableWidgetItem(colb));
+ QString colb = elements.value(i + 1);
+ if (m_allowed_batchtags.contains(cola)) {
+ if (!m_allowed_batchtags.contains(colb)) {
+ if (!colb.isEmpty() && !cola.contains("background")) {
+ m_uiForm.batch_table->setItem(row, m_allowed_batchtags.value(cola),
+ new QTableWidgetItem(colb));
}
- i += 2;
- }
- else
- {
+ i += 2;
+ } else {
++i;
}
- }
- else
- {
+ } else {
error = true;
break;
}
}
- if( error )
- {
+ if (error) {
m_uiForm.batch_table->removeRow(row);
return 1;
}
@@ -3672,14 +3642,13 @@ int SANSRunWindow::addBatchLine(QString csv_line, QString separator)
/**
* Save the batch file to a CSV file.
- * @param filename :: An optional filename. If none is given then a temporary file is used and its name returned
+ * @param filename :: An optional filename. If none is given then a temporary
+ * file is used and its name returned
*/
-QString SANSRunWindow::saveBatchGrid(const QString & filename)
-{
+QString SANSRunWindow::saveBatchGrid(const QString &filename) {
QString csv_filename = filename;
- if( csv_filename.isEmpty() )
- {
- //Generate a temporary filename
+ if (csv_filename.isEmpty()) {
+ // Generate a temporary filename
QTemporaryFile tmp;
tmp.open();
csv_filename = tmp.fileName();
@@ -3688,38 +3657,33 @@ QString SANSRunWindow::saveBatchGrid(const QString & filename)
}
QFile csv_file(csv_filename);
- if( !csv_file.open(QIODevice::WriteOnly|QIODevice::Text) )
- {
- showInformationBox("Error: Cannot write to CSV file \"" + csv_filename + "\".");
+ if (!csv_file.open(QIODevice::WriteOnly | QIODevice::Text)) {
+ showInformationBox("Error: Cannot write to CSV file \"" + csv_filename +
+ "\".");
return "";
}
-
+
QTextStream out_strm(&csv_file);
int nrows = m_uiForm.batch_table->rowCount();
const QString separator(",");
- for( int r = 0; r < nrows; ++r )
- {
- for( int c = 0; c < 7; ++c )
- {
+ for (int r = 0; r < nrows; ++r) {
+ for (int c = 0; c < 7; ++c) {
out_strm << m_allowed_batchtags.key(c) << separator;
- if( QTableWidgetItem* item = m_uiForm.batch_table->item(r, c) )
- {
+ if (QTableWidgetItem *item = m_uiForm.batch_table->item(r, c)) {
out_strm << item->text();
}
- if( c < 6 ) out_strm << separator;
+ if (c < 6)
+ out_strm << separator;
}
out_strm << "\n";
}
csv_file.close();
- if( !filename.isEmpty() )
- {
+ if (!filename.isEmpty()) {
m_tmp_batchfile = "";
m_dirty_batch_grid = false;
m_uiForm.csv_filename->setText(csv_filename);
- }
- else
- {
- m_uiForm.csv_filename->clear();
+ } else {
+ m_uiForm.csv_filename->clear();
}
return csv_filename;
}
@@ -3727,156 +3691,149 @@ QString SANSRunWindow::saveBatchGrid(const QString & filename)
/** Display the first data search and the number of data directorys to users and
* update our input directory
*/
-void SANSRunWindow::upDateDataDir()
-{
- const std::vector<std::string> &dirs
- = ConfigService::Instance().getDataSearchDirs();
- if ( ! dirs.empty() )
- {// use the first directory in the list
+void SANSRunWindow::upDateDataDir() {
+ const std::vector<std::string> &dirs =
+ ConfigService::Instance().getDataSearchDirs();
+ if (!dirs.empty()) { // use the first directory in the list
QString dataDir = QString::fromStdString(dirs.front());
- //check for windows and its annoying path separator thing, windows' paths can't contain /
- if ( dataDir.contains('\\') && ! dataDir.contains('/') )
- {
+ // check for windows and its annoying path separator thing, windows' paths
+ // can't contain /
+ if (dataDir.contains('\\') && !dataDir.contains('/')) {
dataDir.replace('\\', '/');
}
m_uiForm.loadDir_lb->setText(dataDir);
m_uiForm.plusDirs_lb->setText(
- QString("+ ") + QString::number(dirs.size()-1) + QString(" others"));
- }
- else
- {
+ QString("+ ") + QString::number(dirs.size() - 1) + QString(" others"));
+ } else {
m_uiForm.loadDir_lb->setText("No input search directories defined");
m_uiForm.plusDirs_lb->setText("");
}
-
}
/** Update the input directory labels if the Mantid system input
* directories have changed
-* @param pDirInfo :: a pointer to an object with the output directory name in it
+* @param pDirInfo :: a pointer to an object with the output directory name in
+* it
*/
-void SANSRunWindow::handleInputDirChange(Mantid::Kernel::ConfigValChangeNotification_ptr pDirInfo)
-{
- if ( pDirInfo->key() == "datasearch.directories" )
- {
+void SANSRunWindow::handleInputDirChange(
+ Mantid::Kernel::ConfigValChangeNotification_ptr pDirInfo) {
+ if (pDirInfo->key() == "datasearch.directories") {
upDateDataDir();
}
}
/** Slot when phi masking changed in GUI
*/
-void SANSRunWindow::phiMaskingChanged()
-{
- updateMaskTable();
-}
+void SANSRunWindow::phiMaskingChanged() { updateMaskTable(); }
/** Slot when phi masking changed in GUI
@param i unused argument required for combobox signal/slot
*/
-void SANSRunWindow::phiMaskingChanged(int i)
-{
+void SANSRunWindow::phiMaskingChanged(int i) {
Q_UNUSED(i);
- updateMaskTable();
-}
+ updateMaskTable();
+}
-void SANSRunWindow::transSelectorChanged(int currindex){
+void SANSRunWindow::transSelectorChanged(int currindex) {
bool visible = false;
if (currindex != 0)
visible = true;
- QWidget * wid [] = {m_uiForm.trans_can_label, m_uiForm.transFitOnOff_can,
- m_uiForm.transFit_ck_can, m_uiForm.trans_min_can,
- m_uiForm.trans_max_can, m_uiForm.trans_opt_can};
- for (size_t i = 0; i< 6; i++) wid[i]->setVisible(visible);
-
+ QWidget *wid[] = {m_uiForm.trans_can_label, m_uiForm.transFitOnOff_can,
+ m_uiForm.transFit_ck_can, m_uiForm.trans_min_can,
+ m_uiForm.trans_max_can, m_uiForm.trans_opt_can};
+ for (size_t i = 0; i < 6; i++)
+ wid[i]->setVisible(visible);
}
-void SANSRunWindow::loadTransmissionSettings(){
+void SANSRunWindow::loadTransmissionSettings() {
- QString transMin = runReduceScriptFunction(
- "print i.ReductionSingleton().transmission_calculator.lambdaMin('SAMPLE')").trimmed();
- if (transMin == "None")
- {
+ QString transMin =
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().transmission_calculator."
+ "lambdaMin('SAMPLE')").trimmed();
+ if (transMin == "None") {
m_uiForm.transFit_ck->setChecked(false);
- }
- else
- {
+ } else {
m_uiForm.transFit_ck->setChecked(true);
m_uiForm.trans_min->setText(transMin);
- m_uiForm.trans_max->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().transmission_calculator.lambdaMax('SAMPLE')").trimmed());
+ m_uiForm.trans_max->setText(
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().transmission_"
+ "calculator.lambdaMax('SAMPLE')").trimmed());
}
- QString text = runReduceScriptFunction(
- "print i.ReductionSingleton().transmission_calculator.fitMethod('SAMPLE')").trimmed();
+ QString text =
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().transmission_calculator."
+ "fitMethod('SAMPLE')").trimmed();
int index = m_uiForm.trans_opt->findText(text, Qt::MatchFixedString);
- if( index >= 0 )
- {
+ if (index >= 0) {
m_uiForm.trans_opt->setCurrentIndex(index);
}
- if ( text == "OFF" || text == "None" )
+ if (text == "OFF" || text == "None")
m_uiForm.transFitOnOff->setChecked(false);
- else
+ else
m_uiForm.transFitOnOff->setChecked(true);
- transMin = runReduceScriptFunction(
- "print i.ReductionSingleton().transmission_calculator.lambdaMin('CAN')").trimmed();
- if (transMin == "None")
- {
+ transMin = runReduceScriptFunction("print "
+ "i.ReductionSingleton().transmission_"
+ "calculator.lambdaMin('CAN')").trimmed();
+ if (transMin == "None") {
m_uiForm.transFit_ck_can->setChecked(false);
- }
- else
- {
+ } else {
m_uiForm.transFit_ck_can->setChecked(true);
m_uiForm.trans_min_can->setText(transMin);
- m_uiForm.trans_max_can->setText(runReduceScriptFunction(
- "print i.ReductionSingleton().transmission_calculator.lambdaMax('CAN')").trimmed());
- }
- text = runReduceScriptFunction(
- "print i.ReductionSingleton().transmission_calculator.fitMethod('CAN')").trimmed();
+ m_uiForm.trans_max_can->setText(
+ runReduceScriptFunction("print "
+ "i.ReductionSingleton().transmission_"
+ "calculator.lambdaMax('CAN')").trimmed());
+ }
+ text = runReduceScriptFunction("print "
+ "i.ReductionSingleton().transmission_"
+ "calculator.fitMethod('CAN')").trimmed();
index = m_uiForm.trans_opt_can->findText(text, Qt::MatchFixedString);
- if( index >= 0 )
- {
+ if (index >= 0) {
m_uiForm.trans_opt_can->setCurrentIndex(index);
}
- if ( text == "OFF" || text == "None" )
+ if (text == "OFF" || text == "None")
m_uiForm.transFitOnOff_can->setChecked(false);
- else
+ else
m_uiForm.transFitOnOff_can->setChecked(true);
- bool separated = runReduceScriptFunction("print i.ReductionSingleton().transmission_calculator.isSeparate()").trimmed()=="True";
-
- m_uiForm.trans_selector_opt->setCurrentIndex(separated?1:0);
-
+ bool separated =
+ runReduceScriptFunction(
+ "print i.ReductionSingleton().transmission_calculator.isSeparate()")
+ .trimmed() == "True";
+ m_uiForm.trans_selector_opt->setCurrentIndex(separated ? 1 : 0);
}
-void SANSRunWindow::handleSlicePushButton(){
- if (!slicingWindow){
+void SANSRunWindow::handleSlicePushButton() {
+ if (!slicingWindow) {
slicingWindow = new SANSEventSlicing(this);
- connect(slicingWindow, SIGNAL(runAsPythonScript(const QString&, bool)),
- this, SIGNAL(runAsPythonScript(const QString&, bool)));
+ connect(slicingWindow, SIGNAL(runAsPythonScript(const QString &, bool)),
+ this, SIGNAL(runAsPythonScript(const QString &, bool)));
// slicingWindow->setParent(this);
slicingWindow->initializeLayout();
slicingWindow->initializeLocalPython();
}
- slicingWindow->show();
+ slicingWindow->show();
slicingWindow->raise();
}
/**
* Slot to open the help page of whichever tab the user is currently viewing.
*/
-void SANSRunWindow::openHelpPage()
-{
- const auto helpPageUrl = m_helpPageUrls[static_cast<Tab>(m_uiForm.tabWidget->currentIndex())];
+void SANSRunWindow::openHelpPage() {
+ const auto helpPageUrl =
+ m_helpPageUrls[static_cast<Tab>(m_uiForm.tabWidget->currentIndex())];
QDesktopServices::openUrl(QUrl(helpPageUrl));
}
// Set the validators for inputs
-void SANSRunWindow::setValidators()
-{
+void SANSRunWindow::setValidators() {
// Validator policies
if (!m_mustBeDouble) {
m_mustBeDouble = new QDoubleValidator(this);
@@ -3893,7 +3850,6 @@ void SANSRunWindow::setValidators()
new QIntValidator(0, m_constants.getMaxIntValue(), this);
}
-
// Run Numbers tab
// ----------- Run Settings Tab---------------------------------
@@ -3956,16 +3912,22 @@ void SANSRunWindow::setValidators()
}
/**
- * Create a zero-error free workspace clone of a reduced workspace, ie one which has been through either
+ * Create a zero-error free workspace clone of a reduced workspace, ie one which
+ * has been through either
* Q1D or Qxy
- * @param originalWorkspaceName :: The name of the original workspace which might contain errors with 0 value.
- * @param clonedWorkspaceName :: The name of cloned workspace which should have its zero erros removed.
+ * @param originalWorkspaceName :: The name of the original workspace which
+ * might contain errors with 0 value.
+ * @param clonedWorkspaceName :: The name of cloned workspace which should have
+ * its zero erros removed.
* @returns The name of the cloned workspace
*/
-void SANSRunWindow::createZeroErrorFreeClone(QString& originalWorkspaceName, QString& clonedWorkspaceName) {
- if (workspaceExists(originalWorkspaceName) && isValidWsForRemovingZeroErrors(originalWorkspaceName)) {
+void SANSRunWindow::createZeroErrorFreeClone(QString &originalWorkspaceName,
+ QString &clonedWorkspaceName) {
+ if (workspaceExists(originalWorkspaceName) &&
+ isValidWsForRemovingZeroErrors(originalWorkspaceName)) {
// Run the python script which creates the cloned workspace
- QString pythonCode("print i.CreateZeroErrorFreeClonedWorkspace(input_workspace_name='");
+ QString pythonCode(
+ "print i.CreateZeroErrorFreeClonedWorkspace(input_workspace_name='");
pythonCode += originalWorkspaceName + "',";
pythonCode += " output_workspace_name='" + clonedWorkspaceName + "')\n";
pythonCode += "print '" + m_constants.getPythonSuccessKeyword() + "'\n";
@@ -3973,26 +3935,32 @@ void SANSRunWindow::createZeroErrorFreeClone(QString& originalWorkspaceName, QSt
result = result.simplified();
if (result != m_constants.getPythonSuccessKeyword()) {
result.replace(m_constants.getPythonSuccessKeyword(), "");
- g_log.warning("Error creating a zerror error free cloned workspace. Will save original workspace. More info: " + result.toStdString());
+ g_log.warning("Error creating a zerror error free cloned workspace. Will "
+ "save original workspace. More info: " +
+ result.toStdString());
}
}
}
/**
* Destroy a zero-error free workspace clone.
- * @param clonedWorkspaceName :: The name of cloned workspace which should have its zero erros removed.
+ * @param clonedWorkspaceName :: The name of cloned workspace which should have
+ * its zero erros removed.
*/
-void SANSRunWindow::deleteZeroErrorFreeClone(QString& clonedWorkspaceName) {
+void SANSRunWindow::deleteZeroErrorFreeClone(QString &clonedWorkspaceName) {
if (workspaceExists(clonedWorkspaceName)) {
// Run the python script which destroys the cloned workspace
- QString pythonCode("print i.DeleteZeroErrorFreeClonedWorkspace(input_workspace_name='");
+ QString pythonCode(
+ "print i.DeleteZeroErrorFreeClonedWorkspace(input_workspace_name='");
pythonCode += clonedWorkspaceName + "')\n";
pythonCode += "print '" + m_constants.getPythonSuccessKeyword() + "'\n";
QString result(runPythonCode(pythonCode, false));
result = result.simplified();
if (result != m_constants.getPythonSuccessKeyword()) {
result.replace(m_constants.getPythonSuccessKeyword(), "");
- g_log.warning("Error deleting a zerror error free cloned workspace. More info: " + result.toStdString());
+ g_log.warning(
+ "Error deleting a zerror error free cloned workspace. More info: " +
+ result.toStdString());
}
}
}
@@ -4001,19 +3969,22 @@ void SANSRunWindow::deleteZeroErrorFreeClone(QString& clonedWorkspaceName) {
* Check if the workspace can have a zero error correction performed on it
* @param wsName :: The name of the workspace.
*/
-bool SANSRunWindow::isValidWsForRemovingZeroErrors(QString& wsName) {
- QString pythonCode("\nprint i.IsValidWsForRemovingZeroErrors(input_workspace_name='");
- pythonCode += wsName + "')";
- pythonCode += "\nprint '" + m_constants.getPythonSuccessKeyword() + "'";
- QString result(runPythonCode(pythonCode, false));
- result = result.simplified();
- bool isValid = true;
- if (result != m_constants.getPythonSuccessKeyword()) {
- result.replace(m_constants.getPythonSuccessKeyword(), "");
- g_log.warning("Not a valid workspace for zero error replacement. Will save original workspace. More info: " + result.toStdString());
- isValid = false;
- }
- return isValid;
+bool SANSRunWindow::isValidWsForRemovingZeroErrors(QString &wsName) {
+ QString pythonCode(
+ "\nprint i.IsValidWsForRemovingZeroErrors(input_workspace_name='");
+ pythonCode += wsName + "')";
+ pythonCode += "\nprint '" + m_constants.getPythonSuccessKeyword() + "'";
+ QString result(runPythonCode(pythonCode, false));
+ result = result.simplified();
+ bool isValid = true;
+ if (result != m_constants.getPythonSuccessKeyword()) {
+ result.replace(m_constants.getPythonSuccessKeyword(), "");
+ g_log.warning("Not a valid workspace for zero error replacement. Will save "
+ "original workspace. More info: " +
+ result.toStdString());
+ isValid = false;
+ }
+ return isValid;
}
/**
@@ -4023,14 +3994,18 @@ bool SANSRunWindow::isValidWsForRemovingZeroErrors(QString& wsName) {
*/
void SANSRunWindow::setM3M4Logic(TransSettings setting, bool isNowChecked) {
switch (setting) {
- case TransSettings::M3:
- this->m_uiForm.trans_M4_check_box->setChecked(false);
- break;
- case TransSettings::M4:
- this->m_uiForm.trans_M3_check_box->setChecked(false);
- break;
- default:
- return;
+ case TransSettings::M3:
+ this->m_uiForm.trans_M4_check_box->setChecked(false);
+ // Enable the M3M4 line edit field
+ this->m_uiForm.trans_M3M4_line_edit->setEnabled(false);
+ break;
+ case TransSettings::M4:
+ this->m_uiForm.trans_M3_check_box->setChecked(false);
+ // Enable the M3M4 line edit field
+ this->m_uiForm.trans_M3M4_line_edit->setEnabled(isNowChecked);
+ break;
+ default:
+ return;
}
// Disable all ROI, Radius and Mask related options
@@ -4040,9 +4015,6 @@ void SANSRunWindow::setM3M4Logic(TransSettings setting, bool isNowChecked) {
// Uncheck the both Radius and ROI
this->m_uiForm.trans_radius_check_box->setChecked(false);
this->m_uiForm.trans_roi_files_checkbox->setChecked(false);
-
- // Enable the M3M4 line edit field
- this->m_uiForm.trans_M3M4_line_edit->setEnabled(isNowChecked);
}
/**
@@ -4068,7 +4040,6 @@ void SANSRunWindow::onLeftRightCheckboxChanged() {
m_uiForm.front_beam_x->setEnabled(checked);
}
}
-
/**
* Set beam stop logic for Radius, ROI and Mask
* @param setting :: the checked item
@@ -4082,8 +4053,7 @@ void SANSRunWindow::setBeamStopLogic(TransSettings setting, bool isNowChecked) {
if (this->m_uiForm.trans_roi_files_checkbox->isChecked() && !isNowChecked) {
this->m_uiForm.trans_masking_line_edit->setEnabled(true);
}
- }
- else if (setting == TransSettings::ROI) {
+ } else if (setting == TransSettings::ROI) {
setROIAndMaskLogic(isNowChecked);
// If we are turning off the radius checkbox and have then ROI checkbox
// enabled, then we don' want to turn off the mask
@@ -4111,12 +4081,13 @@ void SANSRunWindow::setTransmissionSettingsFromUserFile() {
// Read the Radius settings
QString transmissionRadiusRequest("\nprint i.GetTransmissionRadiusInMM()");
- QString resultTransmissionRadius(runPythonCode(transmissionRadiusRequest, false));
+ QString resultTransmissionRadius(
+ runPythonCode(transmissionRadiusRequest, false));
resultTransmissionRadius = resultTransmissionRadius.simplified();
if (resultTransmissionRadius != m_constants.getPythonEmptyKeyword()) {
- this->m_uiForm.trans_radius_line_edit->setText(resultTransmissionRadius);
- this->m_uiForm.trans_radius_check_box->setChecked(true);
- setBeamStopLogic(TransSettings::RADIUS, true);
+ this->m_uiForm.trans_radius_line_edit->setText(resultTransmissionRadius);
+ this->m_uiForm.trans_radius_check_box->setChecked(true);
+ setBeamStopLogic(TransSettings::RADIUS, true);
}
// Read the ROI settings
@@ -4124,36 +4095,51 @@ void SANSRunWindow::setTransmissionSettingsFromUserFile() {
QString resultTransmissionROI(runPythonCode(transmissionROIRequest, false));
resultTransmissionROI = resultTransmissionROI.simplified();
if (resultTransmissionROI != m_constants.getPythonEmptyKeyword()) {
- resultTransmissionROI = runPythonCode("\nprint i.ConvertFromPythonStringList(to_convert=" + resultTransmissionROI+ ")", false);
- this->m_uiForm.trans_roi_files_line_edit->setText(resultTransmissionROI);
- this->m_uiForm.trans_roi_files_checkbox->setChecked(true);
- setBeamStopLogic(TransSettings::ROI, true);
+ resultTransmissionROI =
+ runPythonCode("\nprint i.ConvertFromPythonStringList(to_convert=" +
+ resultTransmissionROI + ")",
+ false);
+ this->m_uiForm.trans_roi_files_line_edit->setText(resultTransmissionROI);
+ this->m_uiForm.trans_roi_files_checkbox->setChecked(true);
+ setBeamStopLogic(TransSettings::ROI, true);
}
-
// Read the MASK settings
QString transmissionMaskRequest("\nprint i.GetTransmissionMask()");
QString resultTransmissionMask(runPythonCode(transmissionMaskRequest, false));
resultTransmissionMask = resultTransmissionMask.simplified();
if (resultTransmissionMask != m_constants.getPythonEmptyKeyword()) {
- resultTransmissionMask = runPythonCode("\nprint i.ConvertFromPythonStringList(to_convert=" + resultTransmissionMask+ ")", false);
+ resultTransmissionMask =
+ runPythonCode("\nprint i.ConvertFromPythonStringList(to_convert=" +
+ resultTransmissionMask + ")",
+ false);
this->m_uiForm.trans_masking_line_edit->setText(resultTransmissionMask);
}
// Read the Transmission Monitor Spectrum Shift
- QString transmissionMonitorSpectrumShiftRequest("\nprint i.GetTransmissionMonitorSpectrumShift()");
- QString resultTransmissionMonitorSpectrumShift(runPythonCode(transmissionMonitorSpectrumShiftRequest, false));
- resultTransmissionMonitorSpectrumShift = resultTransmissionMonitorSpectrumShift.simplified();
- if (resultTransmissionMonitorSpectrumShift != m_constants.getPythonEmptyKeyword()) {
- this->m_uiForm.trans_M3M4_line_edit->setText(resultTransmissionMonitorSpectrumShift);
- }
-
- // Read Transmission Monitor Spectrum, we expect either 3 or 4. If this is selected, then this takes precedence over
+ QString transmissionMonitorSpectrumShiftRequest(
+ "\nprint i.GetTransmissionMonitorSpectrumShift()");
+ QString resultTransmissionMonitorSpectrumShift(
+ runPythonCode(transmissionMonitorSpectrumShiftRequest, false));
+ resultTransmissionMonitorSpectrumShift =
+ resultTransmissionMonitorSpectrumShift.simplified();
+ if (resultTransmissionMonitorSpectrumShift !=
+ m_constants.getPythonEmptyKeyword()) {
+ this->m_uiForm.trans_M3M4_line_edit->setText(
+ resultTransmissionMonitorSpectrumShift);
+ }
+
+ // Read Transmission Monitor Spectrum, we expect either 3 or 4. If this is
+ // selected, then this takes precedence over
// the radius, roi and mask settings
- QString transmissionMonitorSpectrumRequest("\nprint i.GetTransmissionMonitorSpectrum()");
- QString resultTransmissionMonitorSpectrum(runPythonCode(transmissionMonitorSpectrumRequest, false));
- resultTransmissionMonitorSpectrum = resultTransmissionMonitorSpectrum.simplified();
- if (resultTransmissionMonitorSpectrum != m_constants.getPythonEmptyKeyword()) {
+ QString transmissionMonitorSpectrumRequest(
+ "\nprint i.GetTransmissionMonitorSpectrum()");
+ QString resultTransmissionMonitorSpectrum(
+ runPythonCode(transmissionMonitorSpectrumRequest, false));
+ resultTransmissionMonitorSpectrum =
+ resultTransmissionMonitorSpectrum.simplified();
+ if (resultTransmissionMonitorSpectrum !=
+ m_constants.getPythonEmptyKeyword()) {
if (resultTransmissionMonitorSpectrum == "3") {
this->m_uiForm.trans_M3_check_box->setChecked(true);
setM3M4Logic(TransSettings::M3, true);
@@ -4163,11 +4149,17 @@ void SANSRunWindow::setTransmissionSettingsFromUserFile() {
} else {
this->m_uiForm.trans_M3_check_box->setChecked(false);
this->m_uiForm.trans_M4_check_box->setChecked(false);
- setM3M4Logic(TransSettings::M3,false);
+ setM3M4Logic(TransSettings::M3, false);
setM3M4Logic(TransSettings::M4, false);
- g_log.notice("No transmission monitor, transmission radius nor trasmission ROI was set. The reducer will use the default value.");
+ g_log.notice("No transmission monitor, transmission radius nor "
+ "trasmission ROI was set. The reducer will use the default "
+ "value.");
}
}
+
+ // In case we don't have anything, have M3 checked.
+ // This has appeared in LOQ.
+ resetToM3IfNecessary();
}
/**
@@ -4176,33 +4168,35 @@ void SANSRunWindow::setTransmissionSettingsFromUserFile() {
* between user-induced and programmatic changes to the checkbox.
*/
void SANSRunWindow::initTransmissionSettings() {
- QObject::connect(m_uiForm.trans_M3_check_box, SIGNAL(clicked()),
- this, SLOT(onTransmissionM3CheckboxChanged()));
- QObject::connect(m_uiForm.trans_M4_check_box, SIGNAL(clicked()),
- this, SLOT(onTransmissionM4CheckboxChanged()));
- QObject::connect(m_uiForm.trans_radius_check_box, SIGNAL(clicked()),
- this, SLOT(onTransmissionRadiusCheckboxChanged()));
- QObject::connect(m_uiForm.trans_roi_files_checkbox, SIGNAL(clicked()),
- this, SLOT(onTransmissionROIFilesCheckboxChanged()));
+ QObject::connect(m_uiForm.trans_M3_check_box, SIGNAL(clicked()), this,
+ SLOT(onTransmissionM3CheckboxChanged()));
+ QObject::connect(m_uiForm.trans_M4_check_box, SIGNAL(clicked()), this,
+ SLOT(onTransmissionM4CheckboxChanged()));
+ QObject::connect(m_uiForm.trans_radius_check_box, SIGNAL(clicked()), this,
+ SLOT(onTransmissionRadiusCheckboxChanged()));
+ QObject::connect(m_uiForm.trans_roi_files_checkbox, SIGNAL(clicked()), this,
+ SLOT(onTransmissionROIFilesCheckboxChanged()));
// Set the Tooltips
const QString m3CB = "Selects the monitor spectrum 3\n"
"for the transmission calculation.";
const QString m4CB = "Selects the monitor spectrum 4\n"
"for the transmission calculation.";
- const QString shift = "Sets the shift of the selected monitor in mm.";
+ const QString shift = "Sets the shift of the selected monitor in mm. This "
+ "shift is only applicable to M4";
const QString radiusCB = "Selects a radius when using the beam stop\n"
"for the transmission calculation.";
- const QString radius = "Sets a radius in mm when using the beam stop\n"
- "for the transmission calculation.";
+ const QString radius =
+ "Sets a radius in mm when using the beam stop out method\n"
+ "for the transmission calculation.";
const QString roiCB = "Selects a comma-separated list of ROI files\n"
- "when using the beam stop for the\n"
+ "when using the beam stop out method for the\n"
"transmission calculation.";
const QString roi = "Sets a comma-separated list of ROI files\n"
- "when using the beam stop for the\n"
+ "when using the beam stop out method for the\n"
"transmission calculation.";
const QString mask = "Sets a comma-separated list of Mask files\n"
- "when using the beam stop for the\n"
+ "when using the beam stop out method for the\n"
"transmission calculation.";
m_uiForm.trans_M3_check_box->setToolTip(m3CB);
@@ -4219,28 +4213,32 @@ void SANSRunWindow::initTransmissionSettings() {
* React to a change of the M3 transmission monitor spectrum checkbox
*/
void SANSRunWindow::onTransmissionM3CheckboxChanged() {
- setM3M4Logic(TransSettings::M3, this->m_uiForm.trans_M3_check_box->isChecked());
+ setM3M4Logic(TransSettings::M3,
+ this->m_uiForm.trans_M3_check_box->isChecked());
}
/**
* React to a change of the M3 transmission monitor spectrum checkbox
*/
void SANSRunWindow::onTransmissionM4CheckboxChanged() {
- setM3M4Logic(TransSettings::M4, this->m_uiForm.trans_M4_check_box->isChecked());
+ setM3M4Logic(TransSettings::M4,
+ this->m_uiForm.trans_M4_check_box->isChecked());
}
/**
* React to the change of the Radius checkbox
*/
void SANSRunWindow::onTransmissionRadiusCheckboxChanged() {
- setBeamStopLogic(TransSettings::RADIUS, this->m_uiForm.trans_radius_check_box->isChecked());
+ setBeamStopLogic(TransSettings::RADIUS,
+ this->m_uiForm.trans_radius_check_box->isChecked());
}
/**
* React to the change of the ROI file checkbox
*/
void SANSRunWindow::onTransmissionROIFilesCheckboxChanged() {
- setBeamStopLogic(TransSettings::ROI, this->m_uiForm.trans_roi_files_checkbox->isChecked());
+ setBeamStopLogic(TransSettings::ROI,
+ this->m_uiForm.trans_roi_files_checkbox->isChecked());
}
/**
@@ -4250,6 +4248,8 @@ void SANSRunWindow::onTransmissionROIFilesCheckboxChanged() {
void SANSRunWindow::setRadiusAndMaskLogic(bool isNowChecked) {
this->m_uiForm.trans_masking_line_edit->setEnabled(isNowChecked);
this->m_uiForm.trans_radius_line_edit->setEnabled(isNowChecked);
+
+ resetToM3IfNecessary();
}
/**
@@ -4259,6 +4259,8 @@ void SANSRunWindow::setRadiusAndMaskLogic(bool isNowChecked) {
void SANSRunWindow::setROIAndMaskLogic(bool isNowChecked) {
this->m_uiForm.trans_masking_line_edit->setEnabled(isNowChecked);
this->m_uiForm.trans_roi_files_line_edit->setEnabled(isNowChecked);
+
+ resetToM3IfNecessary();
}
/**
@@ -4267,42 +4269,49 @@ void SANSRunWindow::setROIAndMaskLogic(bool isNowChecked) {
* a radius or a ROI being set.
* @param pythonCode :: The python code string
*/
-void SANSRunWindow::writeTransmissionSettingsToPythonScript(QString& pythonCode) {
+void SANSRunWindow::writeTransmissionSettingsToPythonScript(
+ QString &pythonCode) {
auto m3 = m_uiForm.trans_M3_check_box->isChecked();
auto m4 = m_uiForm.trans_M4_check_box->isChecked();
if (m3 || m4) {
// Handle M3/M4 settings and the TRANSPEC
auto spectrum = m3 ? 3 : 4;
- pythonCode+="i.SetTransmissionMonitorSpectrum(trans_mon=" + QString::number(spectrum) + ")\n";
+ pythonCode += "i.SetTransmissionMonitorSpectrum(trans_mon=" +
+ QString::number(spectrum) + ")\n";
auto transSpec = m_uiForm.trans_M3M4_line_edit->text();
if (!transSpec.isEmpty()) {
- pythonCode+="i.SetTransmissionMonitorSpectrumShift(trans_mon_shift=" + transSpec + ")\n";
+ pythonCode += "i.SetTransmissionMonitorSpectrumShift(trans_mon_shift=" +
+ transSpec + ")\n";
}
} else {
// Handle Radius
auto radius = m_uiForm.trans_radius_line_edit->text();
if (m_uiForm.trans_radius_check_box->isChecked() && !radius.isEmpty()) {
- pythonCode+="i.SetTransmissionRadiusInMM(trans_radius=" + radius + ")\n";
+ pythonCode +=
+ "i.SetTransmissionRadiusInMM(trans_radius=" + radius + ")\n";
}
// Handle ROI
auto roi = m_uiForm.trans_roi_files_line_edit->text();
if (m_uiForm.trans_roi_files_checkbox->isChecked() && !roi.isEmpty()) {
roi = "'" + roi.simplified() + "'";
- roi = runPythonCode("\nprint i.ConvertToPythonStringList(to_convert=" + roi + ")", false);
- pythonCode+="i.SetTransmissionROI(trans_roi_files=" + roi + ")\n";
+ roi = runPythonCode(
+ "\nprint i.ConvertToPythonStringList(to_convert=" + roi + ")", false);
+ pythonCode += "i.SetTransmissionROI(trans_roi_files=" + roi + ")\n";
}
// Handle Mask
auto mask = m_uiForm.trans_masking_line_edit->text();
if (!mask.isEmpty()) {
mask = "'" + mask.simplified() + "'";
- mask = runPythonCode("\nprint i.ConvertToPythonStringList(to_convert=" + mask + ")", false);
- pythonCode+="i.SetTransmissionMask(trans_mask_files=" + mask + ")\n";
+ mask = runPythonCode("\nprint i.ConvertToPythonStringList(to_convert=" +
+ mask + ")",
+ false);
+ pythonCode += "i.SetTransmissionMask(trans_mask_files=" + mask + ")\n";
}
// Unset a potential monitor setting which had been set by the user file.
- pythonCode+="i.UnsetTransmissionMonitorSpectrum()\n";
+ pythonCode += "i.UnsetTransmissionMonitorSpectrum()\n";
}
}
@@ -4329,6 +4338,21 @@ void SANSRunWindow::resetAllTransFields() {
m_uiForm.trans_radius_check_box->setChecked(state);
}
+/**
+ * Enable the M3 checkbox if M3, M4, Radius and ROI are disabled.
+ * We need to select one.
+ */
+void SANSRunWindow::resetToM3IfNecessary() {
+ const auto isM3Disabled = !m_uiForm.trans_M3_check_box->isChecked();
+ const auto isM4Disabled = !m_uiForm.trans_M4_check_box->isChecked();
+ const auto isROIDisabled = !m_uiForm.trans_roi_files_checkbox->isChecked();
+ const auto isRadiusDisabled = !m_uiForm.trans_radius_check_box->isChecked();
+
+ if (isM3Disabled && isM4Disabled && isROIDisabled && isRadiusDisabled) {
+ m_uiForm.trans_M3_check_box->setChecked(true);
+ }
+}
+
/**
* Check tha the Settings are valid. We need to do this for inputs which cannot
* be checked with simple validators
@@ -4351,17 +4375,16 @@ bool SANSRunWindow::areSettingsValid() {
"Wavelength");
// QX
- checkWaveLengthAndQValues(isValid, message, m_uiForm.q_min,
- m_uiForm.q_max, m_uiForm.q_dq_opt,
- "Qx");
+ checkWaveLengthAndQValues(isValid, message, m_uiForm.q_min, m_uiForm.q_max,
+ m_uiForm.q_dq_opt, "Qx");
// TRANS SAMPLE
checkWaveLengthAndQValues(isValid, message, m_uiForm.trans_min,
- m_uiForm.trans_max, m_uiForm.trans_opt,
- "Trans");
+ m_uiForm.trans_max, m_uiForm.trans_opt, "Trans");
// TRANS CAN
- if (m_uiForm.trans_selector_opt->currentText().toUpper().contains("SEPARATE")) {
+ if (m_uiForm.trans_selector_opt->currentText().toUpper().contains(
+ "SEPARATE")) {
checkWaveLengthAndQValues(isValid, message, m_uiForm.trans_min_can,
m_uiForm.trans_max_can, m_uiForm.trans_opt_can,
"Trans Can");
@@ -4404,7 +4427,8 @@ bool SANSRunWindow::areSettingsValid() {
*/
void SANSRunWindow::checkWaveLengthAndQValues(bool &isValid, QString &message,
QLineEdit *min, QLineEdit *max,
- QComboBox *selection, QString type) {
+ QComboBox *selection,
+ QString type) {
auto min_value = min->text().simplified().toDouble();
auto max_value = max->text().simplified().toDouble();
@@ -4412,8 +4436,7 @@ void SANSRunWindow::checkWaveLengthAndQValues(bool &isValid, QString &message,
if (min_value > max_value) {
isValid = false;
message += type;
- message +=
- " issue: The min value is larger than the max value. \n";
+ message += " issue: The min value is larger than the max value. \n";
}
// Make sure that when selecting log, then we don't have 0 values
diff --git a/Testing/Data/UnitTest/FITS_empty_file.fits.md5 b/Testing/Data/UnitTest/FITS_empty_file.fits.md5
new file mode 100644
index 0000000000000000000000000000000000000000..df9edc403d3adddfb7fa95830f51404224c67f83
--- /dev/null
+++ b/Testing/Data/UnitTest/FITS_empty_file.fits.md5
@@ -0,0 +1 @@
+d41d8cd98f00b204e9800998ecf8427e
diff --git a/Testing/SystemTests/tests/analysis/ReflectometryISIS.py b/Testing/SystemTests/tests/analysis/ReflectometryISIS.py
index 13465d48ec2d3321d10e18ffc51fb2a7353d94bf..6ab242a9d464a1ab751f934bffeee82f47f79d1b 100644
--- a/Testing/SystemTests/tests/analysis/ReflectometryISIS.py
+++ b/Testing/SystemTests/tests/analysis/ReflectometryISIS.py
@@ -80,9 +80,9 @@ class ReflectometryISIS(stresstesting.MantidStressTest):
OutputExtents='0,0.1,-0.02,0.15',OutputBins='50,50',Parallel='1',OutputWorkspace='PiPf_rebinned')
# Fetch benchmarks for testing against
- LoadMD(Filename="POLREF_qxqy_benchmark.nxs", OutputWorkspace="QxQy_benchmark")
- LoadMD(Filename="POLREF_kikf_benchmark.nxs", OutputWorkspace="KiKf_benchmark")
- LoadMD(Filename="POLREF_pipf_benchmark.nxs", OutputWorkspace="PiPf_benchmark")
+ LoadMD(Filename="POLREF_qxqy_benchmark_v2.nxs", OutputWorkspace="QxQy_benchmark")
+ LoadMD(Filename="POLREF_kikf_benchmark_v2.nxs", OutputWorkspace="KiKf_benchmark")
+ LoadMD(Filename="POLREF_pipf_benchmark_v2.nxs", OutputWorkspace="PiPf_benchmark")
# Check the outputs
qxqy_comparison = CompareMDWorkspaces(Workspace1='QxQy_rebinned',Workspace2='QxQy_benchmark', Tolerance=0.01, CheckEvents=False)
diff --git a/Testing/SystemTests/tests/analysis/reference/POLREF_kikf_benchmark_v2.nxs.md5 b/Testing/SystemTests/tests/analysis/reference/POLREF_kikf_benchmark_v2.nxs.md5
new file mode 100644
index 0000000000000000000000000000000000000000..268247dc8b2750ae3657b71aa0f6b03863e50a7f
--- /dev/null
+++ b/Testing/SystemTests/tests/analysis/reference/POLREF_kikf_benchmark_v2.nxs.md5
@@ -0,0 +1 @@
+55cc97c3fda36f1ad5712ee2aaab1e6e
diff --git a/Testing/SystemTests/tests/analysis/reference/POLREF_pipf_benchmark_v2.nxs.md5 b/Testing/SystemTests/tests/analysis/reference/POLREF_pipf_benchmark_v2.nxs.md5
new file mode 100644
index 0000000000000000000000000000000000000000..f6142103324a2c6c3598cf0c263af6276e1c5b2d
--- /dev/null
+++ b/Testing/SystemTests/tests/analysis/reference/POLREF_pipf_benchmark_v2.nxs.md5
@@ -0,0 +1 @@
+a7b442468db935db73ffd9c6b79dee4e
diff --git a/Testing/SystemTests/tests/analysis/reference/POLREF_qxqy_benchmark_v2.nxs.md5 b/Testing/SystemTests/tests/analysis/reference/POLREF_qxqy_benchmark_v2.nxs.md5
new file mode 100644
index 0000000000000000000000000000000000000000..d2c2539166b0ed5599df245a760fbb5e7bf3b24d
--- /dev/null
+++ b/Testing/SystemTests/tests/analysis/reference/POLREF_qxqy_benchmark_v2.nxs.md5
@@ -0,0 +1 @@
+72680553c7f159ed760e58774c29047e
diff --git a/Vates/VatesAPI/src/LoadVTK.cpp b/Vates/VatesAPI/src/LoadVTK.cpp
index a003d1569f72fb1ba7ef008ada705180e846474e..53c37ca3b04db09e90ebe5e4b86b155051b0247f 100644
--- a/Vates/VatesAPI/src/LoadVTK.cpp
+++ b/Vates/VatesAPI/src/LoadVTK.cpp
@@ -321,12 +321,12 @@ namespace Mantid
double bounds[6];
readDataset->ComputeBounds();
readDataset->GetBounds(bounds);
-
- auto dimX = boost::make_shared<MDHistoDimension>("X", "X", "", static_cast<coord_t>(bounds[0]), static_cast<coord_t>(bounds[1]),
+ Mantid::Geometry::UnknownFrame frame("");
+ auto dimX = boost::make_shared<MDHistoDimension>("X", "X", frame, static_cast<coord_t>(bounds[0]), static_cast<coord_t>(bounds[1]),
dimensions[0]);
- auto dimY = boost::make_shared<MDHistoDimension>("Y", "Y", "", static_cast<coord_t>(bounds[2]), static_cast<coord_t>(bounds[3]),
+ auto dimY = boost::make_shared<MDHistoDimension>("Y", "Y", frame, static_cast<coord_t>(bounds[2]), static_cast<coord_t>(bounds[3]),
dimensions[1]);
- auto dimZ = boost::make_shared<MDHistoDimension>("Z", "Z", "", static_cast<coord_t>(bounds[4]), static_cast<coord_t>(bounds[5]),
+ auto dimZ = boost::make_shared<MDHistoDimension>("Z", "Z", frame, static_cast<coord_t>(bounds[4]), static_cast<coord_t>(bounds[5]),
dimensions[2]);
const int64_t nPoints = static_cast<int64_t>( readDataset->GetNumberOfPoints() );
diff --git a/Vates/VatesAPI/src/MDEWLoadingPresenter.cpp b/Vates/VatesAPI/src/MDEWLoadingPresenter.cpp
index ef6d00898db96ef9faa17df0a07efd65b945a5e0..e551f06583c79fc46c076c2086e53dc4ba0aebce 100644
--- a/Vates/VatesAPI/src/MDEWLoadingPresenter.cpp
+++ b/Vates/VatesAPI/src/MDEWLoadingPresenter.cpp
@@ -65,7 +65,7 @@ namespace Mantid
}
//std::cout << "dim " << d << min << " to " << max << std::endl;
axisLabels.push_back(makeAxisTitle(inDim));
- MDHistoDimension_sptr dim(new MDHistoDimension(inDim->getName(), inDim->getName(), inDim->getUnits(), min, max, inDim->getNBins()));
+ MDHistoDimension_sptr dim(new MDHistoDimension(inDim->getName(), inDim->getName(), inDim->getMDFrame(), min, max, inDim->getNBins()));
dimensions.push_back(dim);
}
diff --git a/Vates/VatesAPI/src/MDHWLoadingPresenter.cpp b/Vates/VatesAPI/src/MDHWLoadingPresenter.cpp
index 305cdf43e8cbc0d0df6a17d0b2ce8e02d2adf385..9db9b9dd4bed614e691c755f2e3ffa5b149cb533 100644
--- a/Vates/VatesAPI/src/MDHWLoadingPresenter.cpp
+++ b/Vates/VatesAPI/src/MDHWLoadingPresenter.cpp
@@ -125,7 +125,7 @@ void MDHWLoadingPresenter::extractMetadata(
axisLabels.push_back(makeAxisTitle(inDim));
MDHistoDimension_sptr dim(
new MDHistoDimension(inDim->getName(), inDim->getName(),
- inDim->getUnits(), min, max, inDim->getNBins()));
+ inDim->getMDFrame(), min, max, inDim->getNBins()));
dimensions.push_back(dim);
}
diff --git a/Vates/VatesAPI/src/SQWLoadingPresenter.cpp b/Vates/VatesAPI/src/SQWLoadingPresenter.cpp
index 537d14a4481648b340867561be679c96921ea725..7e51bd61e9fdca7df18444499b3b213ed9480cf1 100644
--- a/Vates/VatesAPI/src/SQWLoadingPresenter.cpp
+++ b/Vates/VatesAPI/src/SQWLoadingPresenter.cpp
@@ -110,7 +110,7 @@ namespace Mantid
IMDDimension_const_sptr inDim = eventWs->getDimension(d);
axisLabels.push_back(makeAxisTitle(inDim));
//Copy the dimension, but set the ID and name to be the same. This is an assumption in bintohistoworkspace.
- MDHistoDimension_sptr dim(new MDHistoDimension(inDim->getName(), inDim->getName(), inDim->getUnits(), inDim->getMinimum(), inDim->getMaximum(), size_t(10)));
+ MDHistoDimension_sptr dim(new MDHistoDimension(inDim->getName(), inDim->getName(), inDim->getMDFrame(), inDim->getMinimum(), inDim->getMaximum(), size_t(10)));
dimensions.push_back(dim);
}
diff --git a/Vates/VatesAPI/test/LoadVTKTest.h b/Vates/VatesAPI/test/LoadVTKTest.h
index f8e46c2dee856da0851ea4ec3b9987247b646b79..e0698824a20b5dcbc8d84f89873b8b1b4bf99b0b 100644
--- a/Vates/VatesAPI/test/LoadVTKTest.h
+++ b/Vates/VatesAPI/test/LoadVTKTest.h
@@ -5,6 +5,7 @@
#include "MantidVatesAPI/LoadVTK.h"
#include "MantidAPI/IMDHistoWorkspace.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
+#include "MantidGeometry/MDGeometry/UnknownFrame.h"
#include "MantidAPI/AlgorithmManager.h"
using namespace Mantid::API;
@@ -129,9 +130,24 @@ public:
outWSName);
TS_ASSERT_EQUALS(3, outWS->getNumDims());
- do_check_dimension(outWS->getDimension(0), "X", 0, 67, 68); // These numbers are expected min, max, and nbins known from the input file for dim x.
- do_check_dimension(outWS->getDimension(1), "Y", 0, 67, 68); // These numbers are expected min, max, and nbins known from the input file for dim y.
- do_check_dimension(outWS->getDimension(2), "Z", 0, 67, 68); // These numbers are expected min, max, and nbins known from the input file for dim z.
+ do_check_dimension(outWS->getDimension(0), "X", 0, 67,
+ 68); // These numbers are expected min, max, and nbins
+ // known from the input file for dim x.
+ do_check_dimension(outWS->getDimension(1), "Y", 0, 67,
+ 68); // These numbers are expected min, max, and nbins
+ // known from the input file for dim y.
+ do_check_dimension(outWS->getDimension(2), "Z", 0, 67,
+ 68); // These numbers are expected min, max, and nbins
+ // known from the input file for dim z.
+ TSM_ASSERT_EQUALS("Should be an UnknownFrame",
+ Mantid::Geometry::UnknownFrame::UnknownFrameName,
+ outWS->getDimension(0)->getMDFrame().name());
+ TSM_ASSERT_EQUALS("Should be an UnknownFrame",
+ Mantid::Geometry::UnknownFrame::UnknownFrameName,
+ outWS->getDimension(1)->getMDFrame().name());
+ TSM_ASSERT_EQUALS("Should be an UnknownFrame",
+ Mantid::Geometry::UnknownFrame::UnknownFrameName,
+ outWS->getDimension(2)->getMDFrame().name());
double topPercent = loadVTK.getProperty("KeepTopPercent");
TSM_ASSERT_EQUALS("Should default to 25%", 25, topPercent);
diff --git a/Vates/VatesAPI/test/vtkDataSetToNonOrthogonalDataSetTest.h b/Vates/VatesAPI/test/vtkDataSetToNonOrthogonalDataSetTest.h
index 6e2790dc311d14e6f776eeb90b445e8af0f779ff..a3061c905bee51731cefacf4af0305dc7872246f 100644
--- a/Vates/VatesAPI/test/vtkDataSetToNonOrthogonalDataSetTest.h
+++ b/Vates/VatesAPI/test/vtkDataSetToNonOrthogonalDataSetTest.h
@@ -10,6 +10,9 @@
#include "MantidKernel/PropertyWithValue.h"
#include "MantidDataObjects/CoordTransformAffine.h"
#include "MantidTestHelpers/MDEventsTestHelper.h"
+#include "MantidGeometry/MDGeometry/QSample.h"
+#include "MantidGeometry/MDGeometry/HKL.h"
+#include "MantidKernel/MDUnit.h"
#include <vtkDataArray.h>
#include <vtkFieldData.h>
@@ -38,15 +41,17 @@ private:
// Creating an MDEventWorkspace as the content is not germain to the
// information necessary for the non-orthogonal axes
std::string wsName = "simpleWS";
- IMDEventWorkspace_sptr ws = makeAnyMDEW<MDEvent<4>, 4>(1, 0.0, 1.0, 1, wsName);
+ IMDEventWorkspace_sptr ws;
// Set the coordinate system
- if (!wrongCoords)
- {
- ws->setCoordinateSystem(Mantid::Kernel::HKL);
- }
- else
- {
- ws->setCoordinateSystem(QSample);
+ if (wrongCoords) {
+ Mantid::Geometry::QSample frame;
+ ws = MDEventsTestHelper::makeAnyMDEWWithFrames<MDEvent<4>, 4>(
+ 1, 0.0, 1.0, frame, 1, wsName);
+
+ } else {
+ Mantid::Geometry::HKL frame(new Mantid::Kernel::ReciprocalLatticeUnit);
+ ws = MDEventsTestHelper::makeAnyMDEWWithFrames<MDEvent<4>, 4>(
+ 1, 0.0, 1.0, frame, 1, wsName);
}
// Set the UB matrix
diff --git a/buildconfig/CMake/CommonSetup.cmake b/buildconfig/CMake/CommonSetup.cmake
index d85ffa3b0b5cd7c64d21c185838e19153aae5df3..0079ceee3b6c418f7c3786c06c50a0e17b958783 100644
--- a/buildconfig/CMake/CommonSetup.cmake
+++ b/buildconfig/CMake/CommonSetup.cmake
@@ -57,6 +57,11 @@ find_package ( MuParser REQUIRED )
find_package ( JsonCPP REQUIRED )
include_directories ( SYSTEM ${JSONCPP_INCLUDE_DIR} )
+if (ENABLE_OPENCASCADE)
+ find_package ( OpenCascade REQUIRED )
+ add_definitions ( -DENABLE_OPENCASCADE )
+endif ()
+
find_package ( Doxygen ) # optional
# Need to change search path to find zlib include on Windows.
diff --git a/docs/source/algorithms/IntegratePeaksHybrid-v1.rst b/docs/source/algorithms/IntegratePeaksHybrid-v1.rst
index ce322bc845ad3ce4031f917f7afd9d79667f2452..23444e0a196c496364e40ee30a7d489fc732efaf 100644
--- a/docs/source/algorithms/IntegratePeaksHybrid-v1.rst
+++ b/docs/source/algorithms/IntegratePeaksHybrid-v1.rst
@@ -63,14 +63,33 @@ Usage
.. testcode:: IntegratePeaksUsingClustersExample
- # Load an MDEventWorkspace (QLab) containing some SC diffration peaks
- mdew = Load("TOPAZ_3680_5_sec_MDEW.nxs")
- # The following algorithms need to know that frame to use, this is an older file. Newer files will automaticall have this.
- SetSpecialCoordinates(InputWorkspace=mdew, SpecialCoordinates='Q (lab frame)')
- # Find the 5 most intense peaks
- peaks = FindPeaksMD(InputWorkspace=mdew, MaxPeaks=5)
- # Perform the integration
- integrated_peaks, cluster_images = IntegratePeaksHybrid(InputWorkspace=mdew, PeaksWorkspace=peaks, BackgroundOuterRadius=0.4)
+ import os
+ def make_input_workspaces():
+ instrument_path = os.path.join(config.getInstrumentDirectory(), 'SXD_Definition.xml')
+ sxd = LoadEmptyInstrument(Filename=instrument_path)
+ # Set lattice parameters
+ SetUB(sxd, 5.6, 5.6, 5.6, 90, 90, 90)
+ # Predict peaks
+ predicted = PredictPeaks(sxd)
+ # Keep every 20th predicted peak for speed
+ rows_to_delete = set(range(predicted.getNumberPeaks())) - set([i for i in range(predicted.getNumberPeaks()) if i % 20 == 0])
+ DeleteTableRows(predicted, Rows=list(rows_to_delete))
+
+ # Set the Frame to QLab
+ mdws = CreateMDWorkspace(Dimensions=3, Extents='-10,10,-10,10,-10,10',
+ Names='Q_lab_x,Q_lab_y,Q_lab_z', Frames = "QLab,QLab,QLab",
+ Units='U,U,U')
+ qlab = predicted.column('QLab')
+ peak_radius = 0.1
+ n_events = 1000
+ for coords in qlab:
+ FakeMDEventData(InputWorkspace=mdws, PeakParams=[n_events, coords.X(), coords.Y(), coords.Z(), peak_radius])
+
+ return (predicted, mdws, peak_radius)
+
+ predicted, mdws, peak_radius = make_input_workspaces()
+ # Perform the integration
+ integrated, clusters = IntegratePeaksHybrid(InputWorkspace=mdws, PeaksWorkspace=predicted, NumberOfBins=10, BackgroundOuterRadius=peak_radius*3)
.. categories::
diff --git a/docs/source/algorithms/IntegratePeaksUsingClusters-v1.rst b/docs/source/algorithms/IntegratePeaksUsingClusters-v1.rst
index 633e94fc34ce0315166505502806c3f9d49014c4..a57d879043f2b69bf2df86e768dfe0112da0a8cf 100644
--- a/docs/source/algorithms/IntegratePeaksUsingClusters-v1.rst
+++ b/docs/source/algorithms/IntegratePeaksUsingClusters-v1.rst
@@ -95,17 +95,34 @@ Usage
.. testcode:: IntegratePeaksUsingClustersExample
- # Load an MDEventWorkspace (QLab) containing some SC diffration peaks
- mdew = Load("TOPAZ_3680_5_sec_MDEW.nxs")
- # The following algorithms need to know that frame to use, this is an older file. Newer files will automaticall have this.
- SetSpecialCoordinates(InputWorkspace=mdew, SpecialCoordinates='Q (lab frame)')
- # Find the 5 most intense peaks
- peaks = FindPeaksMD(InputWorkspace=mdew, MaxPeaks=5)
- # Bin to a 100 by 100 by 100 image. A 300 by 300 by 300 image is better.
- mdhw = BinMD(InputWorkspace=mdew, AxisAligned=True,AlignedDim0='Q_lab_x,0,8,100', AlignedDim1='Q_lab_y,-10,10,100', AlignedDim2='Q_lab_z,0,10,100')
- # Perform the integration
- integrated_peaks, cluster_image = IntegratePeaksUsingClusters(InputWorkspace=mdhw, PeaksWorkspace=peaks, Threshold=1e7)
-
+ import os
+ def make_input_workspaces():
+ instrument_path = os.path.join(config.getInstrumentDirectory(), 'SXD_Definition.xml')
+ sxd = LoadEmptyInstrument(Filename=instrument_path)
+ # Set lattice parameters
+ SetUB(sxd, 5.6, 5.6, 5.6, 90, 90, 90)
+ # Predict peaks
+ predicted = PredictPeaks(sxd)
+ # Keep every 20th predicted peak for speed
+ rows_to_delete = set(range(predicted.getNumberPeaks())) - set([i for i in range(predicted.getNumberPeaks()) if i % 20 == 0])
+ DeleteTableRows(predicted, Rows=list(rows_to_delete))
+
+ # Set the Frame to QLab
+ mdws = CreateMDWorkspace(Dimensions=3, Extents='-10,10,-10,10,-10,10',
+ Names='Q_lab_x,Q_lab_y,Q_lab_z', Frames = "QLab,QLab,QLab",
+ Units='U,U,U')
+ qlab = predicted.column('QLab')
+ peak_radius = 0.1
+ n_events = 1000
+ for coords in qlab:
+ FakeMDEventData(InputWorkspace=mdws, PeakParams=[n_events, coords.X(), coords.Y(), coords.Z(), peak_radius])
+ # Create MDHisto workspace
+ mdws_binned = BinMD(InputWorkspace=mdws, AlignedDim0='Q_lab_x,-10,10,20', AlignedDim1='Q_lab_y,-10,10,200', AlignedDim2='Q_lab_z,-10,10,200')
+ return (predicted, mdws_binned, peak_radius)
+
+ predicted, mdws_binned, peak_radius = make_input_workspaces()
+ # Perform the integration
+ integrated, clusters = IntegratePeaksUsingClusters(InputWorkspace=mdws_binned, PeaksWorkspace=predicted, Threshold=1e7)
.. categories::
diff --git a/docs/source/algorithms/LoadQKK-v1.rst b/docs/source/algorithms/LoadQKK-v1.rst
index 857c87654c0c654c7be88e6ab2e5f30a16608888..92721016f794a8c96550dfbbab70137c22fc3dcf 100644
--- a/docs/source/algorithms/LoadQKK-v1.rst
+++ b/docs/source/algorithms/LoadQKK-v1.rst
@@ -9,7 +9,8 @@
Description
-----------
-
+Loads a ANSTO QKK file. A usual usage is through the :ref:`algm-Load` algorithm. The input file must have extension
+.nx.hdf.
.. categories::
diff --git a/docs/source/algorithms/SaveISISNexus-v1.rst b/docs/source/algorithms/SaveISISNexus-v1.rst
index 857c87654c0c654c7be88e6ab2e5f30a16608888..484ceecba5da998638867a8e526a8afae042dc6b 100644
--- a/docs/source/algorithms/SaveISISNexus-v1.rst
+++ b/docs/source/algorithms/SaveISISNexus-v1.rst
@@ -9,8 +9,28 @@
Description
-----------
+The algorithm SaveISISNexus will write a Nexus data file from the given RAW file.
+The output file name can be an absolute or relative path and should
+have the extension .nxs, .nx5 or .xml. Warning - using XML format can be
+extremely slow for large data sets and generate very large files. Both
+the extensions nxs and nx5 will generate HDF5 files.
+Usage
+-----
+.. testcode::
+
+ import os
+ # Create a file path in the user home directory
+ filePath = os.path.expanduser('~/SavedISISNexusFile.nxs')
+
+ # Save a RAW file in Nexus format
+ SaveISISNexus('IRS26173.raw',filePath)
+
+.. testcleanup::
+
+ os.remove(filePath)
+
.. categories::
.. sourcelink::
diff --git a/scripts/Interface/ui/reflectometer/refl_gui.py b/scripts/Interface/ui/reflectometer/refl_gui.py
index 8f1a384733c2e605fd61b22f192b30ccc26b3b90..d4e9280b2e16b88e05641c54c51a8f8812407b18 100644
--- a/scripts/Interface/ui/reflectometer/refl_gui.py
+++ b/scripts/Interface/ui/reflectometer/refl_gui.py
@@ -5,7 +5,6 @@ import refl_save
import refl_choose_col
import refl_options
import csv
-import string
import os
import re
from operator import itemgetter
@@ -672,6 +671,8 @@ class ReflGui(QtGui.QMainWindow, ui_refl_window.Ui_windowRefl):
Process has been pressed, check what has been selected then pass the selection (or whole table) to quick
"""
#--------- If "Process" button pressed, convert raw files to IvsLam and IvsQ and combine if checkbox ticked -------------
+ _overallQMin = float("inf")
+ _overallQMax = float("-inf")
try:
willProcess = True
rows = self.tableMain.selectionModel().selectedRows()
@@ -760,7 +761,7 @@ class ReflGui(QtGui.QMainWindow, ui_refl_window.Ui_windowRefl):
# Populate runlist
first_wq = None
- for i in range(len(runno)):
+ for i in range(0,len(runno)):
theta, qmin, qmax, wlam, wq = self._do_run(runno[i], row, i)
if not first_wq:
first_wq = wq # Cache the first Q workspace
@@ -791,32 +792,33 @@ class ReflGui(QtGui.QMainWindow, ui_refl_window.Ui_windowRefl):
#Scale each run
if self.tableMain.item(row, self.scale_col).text():
Scale(InputWorkspace=wksp[i], OutputWorkspace=wksp[i], Factor=1 / float(self.tableMain.item(row, self.scale_col).text()))
-
- if self.__checked_row_stiched(row):
- if len(runno) == 1:
- logger.notice("Nothing to combine for processing row : " + str(row))
- else:
- w1 = getWorkspace(wksp[0])
- w2 = getWorkspace(wksp[-1])
- if len(runno) == 2:
- outputwksp = runno[0] + '_' + runno[1][3:5]
+ if self.__checked_row_stiched(row):
+ if len(runno) == 1:
+ logger.notice("Nothing to combine for processing row : " + str(row))
else:
- outputwksp = runno[0] + '_' + runno[-1][3:5]
- begoverlap = w2.readX(0)[0]
- # get Qmax
- if self.tableMain.item(row, i * 5 + 4).text() == '':
- overlapHigh = 0.3 * max(w1.readX(0))
-
- Qmin = min(w1.readX(0))
- Qmax = max(w2.readX(0))
-
- if len(self.tableMain.item(row, i * 5 + 3).text()) > 0:
- Qmin = float(self.tableMain.item(row, i * 5 + 3).text())
-
- if len(self.tableMain.item(row, i * 5 + 4).text()) > 0:
- Qmax = float(self.tableMain.item(row, i * 5 + 4).text())
-
- wcomb = combineDataMulti(wksp, outputwksp, overlapLow, overlapHigh, Qmin, Qmax, -dqq, 1, keep=True)
+ w1 = getWorkspace(wksp[0])
+ w2 = getWorkspace(wksp[-1])
+ if len(runno) == 2:
+ outputwksp = runno[0] + '_' + runno[1][3:5]
+ else:
+ outputwksp = runno[0] + '_' + runno[-1][3:5]
+ begoverlap = w2.readX(0)[0]
+ # get Qmax
+ if self.tableMain.item(row, i * 5 + 4).text() == '':
+ overlapHigh = 0.3 * max(w1.readX(0))
+
+ Qmin = min(w1.readX(0))
+ Qmax = max(w2.readX(0))
+ if len(self.tableMain.item(row, i * 5 + 3).text()) > 0:
+ Qmin = float(self.tableMain.item(row, i * 5 + 3).text())
+ if len(self.tableMain.item(row, i * 5 + 4).text()) > 0:
+ Qmax = float(self.tableMain.item(row, i * 5 + 4).text())
+ if Qmax > _overallQMax:
+ _overallQMax = Qmax
+ if Qmin < _overallQMin :
+ _overallQMin = Qmin
+
+ _wcomb = combineDataMulti(wksp, outputwksp, overlapLow, overlapHigh, _overallQMin, _overallQMax, -dqq, 1, keep=True)
# Enable the plot button