diff --git a/Framework/DataHandling/inc/MantidDataHandling/LoadAscii2.h b/Framework/DataHandling/inc/MantidDataHandling/LoadAscii2.h
index 561ff25566b17da2ee974d01b3877a4e7bce8288..df4771a4f6a17577b9718e31bbeb5ef7532ae010 100644
--- a/Framework/DataHandling/inc/MantidDataHandling/LoadAscii2.h
+++ b/Framework/DataHandling/inc/MantidDataHandling/LoadAscii2.h
@@ -40,7 +40,7 @@ public:
/// Summary of algorithms purpose
const std::string summary() const override {
return "Loads data from a text file and stores it in a 2D workspace "
- "(Workspace2D class).";
+ "or Table Workspace.";
}
/// The version number
@@ -56,6 +56,8 @@ public:
protected:
/// Read the data from the file
virtual API::Workspace_sptr readData(std::ifstream &file);
+ /// Read the data from the file into a table workspace
+ virtual API::Workspace_sptr readTable(std::ifstream &file);
/// Return true if the line is to be skipped
bool skipLine(const std::string &line, bool header = false) const;
/// Return true if the line doesn't start with a valid character
diff --git a/Framework/DataHandling/src/LoadAscii2.cpp b/Framework/DataHandling/src/LoadAscii2.cpp
index afdc839a0cc1f2f2c304946fda6ad88a73f76f38..e69ad84bd4c41cf83d2799901a3b8575ae3ab555 100644
--- a/Framework/DataHandling/src/LoadAscii2.cpp
+++ b/Framework/DataHandling/src/LoadAscii2.cpp
@@ -10,7 +10,9 @@
#include "MantidAPI/NumericAxis.h"
#include "MantidAPI/RegisterFileLoader.h"
#include "MantidAPI/Run.h"
+#include "MantidAPI/TableRow.h"
#include "MantidAPI/WorkspaceFactory.h"
+#include "MantidDataObjects/TableWorkspace.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidHistogramData/HistogramMath.h"
#include "MantidKernel/BoundedValidator.h"
@@ -83,6 +85,12 @@ API::Workspace_sptr LoadAscii2::readData(std::ifstream &file) {
// there is still flexibility, but the format should just make more sense in
// general
+ // if the file appears to be a table workspace then read it as such
+ auto ws = readTable(file);
+ if (ws) {
+ return ws;
+ }
+
m_baseCols = 0;
m_specNo = 0;
m_lastBins = 0;
@@ -139,6 +147,140 @@ API::Workspace_sptr LoadAscii2::readData(std::ifstream &file) {
return localWorkspace;
}
+/// Attempts to read a table workspace from the file.
+/// Failing early if the format does not match.
+/// @param file the file handle to load from
+/// @returns a populated table workspace or an empty shared pointer
+API::Workspace_sptr LoadAscii2::readTable(std::ifstream &file) {
+
+ DataObjects::TableWorkspace_sptr ws;
+ // We need to see two rows commented out
+ // the first with column names
+ // the second with column types
+ // Then we need data, with the same number of columns as the first two lines
+ size_t colNames = 0;
+ size_t colTypes = 0;
+ size_t colData = 0;
+ std::string line;
+ std::list<std::string> names;
+ std::list<std::string> types;
+ std::list<std::string> data;
+ try {
+
+ while (getline(file, line)) {
+ boost::trim(line);
+
+ std::list<std::string> columns;
+ size_t lineCols = 0;
+
+ if (!line.empty()) {
+ // if line starts with a comment
+ if (line.at(0) == m_comment.at(0)) {
+ // remove the comment character
+ line.erase(0, 1);
+ lineCols = this->splitIntoColumns(columns, line);
+ if (colNames == 0) {
+ colNames = lineCols;
+ names = columns;
+ continue;
+ }
+ if (colTypes == 0) {
+ colTypes = lineCols;
+ types = columns;
+ continue;
+ }
+ }
+
+ if (colTypes != colNames) {
+ // no point going further, the types and names differ in quantity
+ break;
+ }
+
+ colData = this->splitIntoColumns(data, line);
+ if (colNames > 0 && colNames == colTypes && colTypes == colData) {
+ // we seem to have a table workspace
+ // if we have no already created a workspace
+ if (!ws) {
+ ws = boost::make_shared<DataObjects::TableWorkspace>();
+ // create the columns
+ auto itName = names.begin();
+ auto itTypes = types.begin();
+ for (size_t i = 0; i < colNames; i++) {
+ std::string name = *itName;
+ std::string type = *itTypes;
+ // trim the strings
+ boost::trim(name);
+ boost::trim(type);
+ ws->addColumn(std::move(type), std::move(name));
+ itName++;
+ itTypes++;
+ }
+ }
+ // add the data
+ TableRow row = ws->appendRow();
+ auto itTypes = types.begin();
+ for (auto itData = data.begin(); itData != data.end(); itData++) {
+ // direct assignment only works for strings, we ill need to handle
+ // the other data types here
+ std::string type = *itTypes;
+ boost::trim(type);
+ if (type == "str") {
+ row << *itData;
+ } else if (type == "int") {
+ int num = boost::lexical_cast<int>(*itData);
+ row << std::move(num);
+ } else if (type == "uint") {
+ uint32_t num = boost::lexical_cast<uint32_t>(*itData);
+ row << std::move(num);
+ } else if (type == "long64") {
+ long long num = boost::lexical_cast<long long>(*itData);
+ row << std::move(num);
+ } else if (type == "size_t") {
+ size_t num = boost::lexical_cast<size_t>(*itData);
+ row << std::move(num);
+ } else if (type == "float") {
+ float num = boost::lexical_cast<float>(*itData);
+ row << std::move(num);
+ } else if (type == "double") {
+ double num = boost::lexical_cast<double>(*itData);
+ row << std::move(num);
+ } else if (type == "bool") {
+ bool val = (itData->at(0) == 't');
+ row << std::move(val);
+ } else if (type == "V3D") {
+ V3D val;
+ std::stringstream ss(*itData);
+ val.readPrinted(ss);
+ row << std::move(val);
+ } else {
+ throw std::runtime_error("unknown column data type " + type);
+ }
+ itTypes++;
+ }
+ }
+ }
+ }
+ // if the file does not have more than rowsToCheck, it will
+ // stop
+ // and raise the EndOfFile, this may cause problems for small workspaces.
+ // In this case clear the flag
+ if (file.eof()) {
+ file.clear(file.eofbit);
+ }
+ } catch (std::exception &ex) {
+ // log and squash the error, so we can still try to load the file as a matrix workspace
+ g_log.warning() <<
+ "Error while trying to read ascii file as table, continuing to load as matrix workspace.\n"
+ << ex.what() << "\n";
+ // clear any workspace that we started loading
+ ws.reset();
+ }
+
+ // Seek the file pointer back to the start.
+ file.seekg(0, std::ios::beg);
+ return ws;
+}
+
/**
* Check the start of the file for the first data set, then set the number of
* columns that hsould be expected thereafter
diff --git a/Framework/DataHandling/test/LoadAscii2Test.h b/Framework/DataHandling/test/LoadAscii2Test.h
index 862d32c4f0589a4fedee888962ffb82b45127019..87a164de51f768fec2e4c7dfac30cc632d9593cf 100644
--- a/Framework/DataHandling/test/LoadAscii2Test.h
+++ b/Framework/DataHandling/test/LoadAscii2Test.h
@@ -8,6 +8,7 @@
#define LOADASCIITEST_H_
#include "MantidDataHandling/LoadAscii2.h"
+#include "SaveAscii2Test.h"
#include "cxxtest/TestSuite.h"
#include "MantidAPI/AnalysisDataService.h"
@@ -16,6 +17,7 @@
#include "MantidAPI/WorkspaceFactory.h"
#include "MantidDataHandling/SaveAscii2.h"
#include "MantidDataObjects/Workspace2D.h"
+#include "MantidDataObjects/TableWorkspace.h"
#include "MantidKernel/Unit.h"
#include <Poco/File.h>
@@ -154,8 +156,8 @@ public:
void test_fail_five_columns() {
m_testno++;
- std::ofstream file(getTestFileName().c_str());
m_abspath = getAbsPath();
+ std::ofstream file(m_abspath.c_str());
file << std::scientific;
file << "# X , Y, E, DX, Z\n";
for (int i = 0; i < 5; i++) {
@@ -174,8 +176,8 @@ public:
void test_fail_one_column() {
m_testno++;
- std::ofstream file(getTestFileName().c_str());
m_abspath = getAbsPath();
+ std::ofstream file(m_abspath.c_str());
file << std::scientific;
file << "# X\n";
for (int i = 0; i < 5; i++) {
@@ -192,8 +194,8 @@ public:
void test_fail_mismatching_bins() {
m_testno++;
- std::ofstream file(getTestFileName().c_str());
m_abspath = getAbsPath();
+ std::ofstream file(m_abspath.c_str());
file << std::scientific;
file << "# X , Y, E, DX\n";
for (int i = 0; i < 5; i++) {
@@ -213,8 +215,8 @@ public:
void test_fail_mismatching_columns() {
m_testno++;
- std::ofstream file(getTestFileName().c_str());
m_abspath = getAbsPath();
+ std::ofstream file(m_abspath.c_str());
file << std::scientific;
file << "# X , Y, E, DX\n";
for (int i = 0; i < 5; i++) {
@@ -237,8 +239,8 @@ public:
void test_fail_line_start_letter() {
m_testno++;
- std::ofstream file(getTestFileName().c_str());
m_abspath = getAbsPath();
+ std::ofstream file(m_abspath.c_str());
file << std::scientific;
file << "# X , Y, E, DX\n";
for (int i = 0; i < 5; i++) {
@@ -263,8 +265,8 @@ public:
void test_fail_line_start_noncomment_symbol() {
m_testno++;
- std::ofstream file(getTestFileName().c_str());
m_abspath = getAbsPath();
+ std::ofstream file(m_abspath.c_str());
file << std::scientific;
file << "# X , Y, E, DX\n";
for (int i = 0; i < 5; i++) {
@@ -288,8 +290,8 @@ public:
void test_fail_line_mixed_letter_number() {
m_testno++;
- std::ofstream file(getTestFileName().c_str());
m_abspath = getAbsPath();
+ std::ofstream file(m_abspath.c_str());
file << std::scientific;
file << "# X , Y, E, DX\n";
for (int i = 0; i < 5; i++) {
@@ -314,8 +316,8 @@ public:
void test_fail_line_mixed_symbol_number() {
m_testno++;
- std::ofstream file(getTestFileName().c_str());
m_abspath = getAbsPath();
+ std::ofstream file(m_abspath.c_str());
file << std::scientific;
file << "# X , Y, E, DX\n";
for (int i = 0; i < 5; i++) {
@@ -339,8 +341,8 @@ public:
void test_fail_spectra_ID_inclusion_inconisitant() {
m_testno++;
- std::ofstream file(getTestFileName().c_str());
m_abspath = getAbsPath();
+ std::ofstream file(m_abspath.c_str());
file << std::scientific;
file << "# X , Y, E, DX\n";
@@ -361,6 +363,46 @@ public:
TS_ASSERT_THROWS_NOTHING(Poco::File(m_abspath).remove());
}
+ void test_tableworkspace() {
+ m_testno++;
+ m_abspath = writeTableTestFile("Tab");
+
+ LoadAscii2 loader;
+ loader.initialize();
+ loader.setRethrows(true);
+
+ const std::string outputName(getTestFileName());
+ TS_ASSERT_THROWS_NOTHING(loader.setPropertyValue("Filename", m_abspath));
+ TS_ASSERT_THROWS_NOTHING(
+ loader.setPropertyValue("OutputWorkspace", outputName));
+ TS_ASSERT_THROWS_NOTHING(loader.setPropertyValue("Separator", "Tab"));
+ TS_ASSERT_THROWS_NOTHING(
+ loader.setPropertyValue("CustomSeparator", ""));
+
+ TS_ASSERT_THROWS_NOTHING(loader.execute());
+
+ TS_ASSERT_EQUALS(loader.isExecuted(), true);
+
+ // Check the workspace
+ AnalysisDataServiceImpl &dataStore = AnalysisDataService::Instance();
+ if (dataStore.doesExist(outputName)) {
+ TS_ASSERT_EQUALS(dataStore.doesExist(outputName), true);
+ Workspace_sptr output;
+ TS_ASSERT_THROWS_NOTHING(output = dataStore.retrieve(outputName));
+ TableWorkspace_sptr outputWS =
+ boost::dynamic_pointer_cast<TableWorkspace>(output);
+ if (outputWS) {
+ checkTableData(outputWS);
+ } else {
+ TS_FAIL("Workspace is not a table workspace");
+ }
+ } else {
+ TS_FAIL(outputName + " does not exist.");
+ }
+ dataStore.remove(outputName);
+ TS_ASSERT_THROWS_NOTHING(Poco::File(m_abspath).remove());
+ }
+
private:
const std::string getTestFileName() const {
return m_filename + boost::lexical_cast<std::string>(m_testno) + m_ext;
@@ -371,6 +413,54 @@ private:
save.setPropertyValue("Filename", getTestFileName());
return save.getPropertyValue("Filename");
}
+
+ // Write the test file for a table workspace
+ std::string writeTableTestFile(const std::string &sep = "CSV",
+ const std::string &custsep = "") {
+ SaveAscii2 save;
+ save.initialize();
+ save.setPropertyValue("Filename", getTestFileName());
+
+ const std::string name = "SaveTableAsciiWS";
+ auto wsToSave = SaveAscii2Test::writeTableWS(name);
+
+ save.initialize();
+ save.isInitialized();
+ save.setPropertyValue("InputWorkspace", name);
+ save.setPropertyValue("Separator", sep);
+ save.setPropertyValue("CustomSeparator", custsep);
+ save.execute();
+
+ AnalysisDataService::Instance().remove(name);
+
+ return save.getPropertyValue("Filename");
+ }
+
+ void checkTableData(const Mantid::API::ITableWorkspace_sptr outputWS) {
+
+ const std::string name = "Compare_SaveAsciiWS";
+ auto wsToCompare = SaveAscii2Test::writeTableWS(name);
+ TS_ASSERT_EQUALS(outputWS->columnCount(), wsToCompare->columnCount());
+ TS_ASSERT_EQUALS(outputWS->rowCount(), wsToCompare->rowCount());
+
+ for (auto colIndex = 0; colIndex < outputWS->columnCount(); colIndex++) {
+ auto outputCol = outputWS->getColumn(colIndex);
+ auto compareCol = wsToCompare->getColumn(colIndex);
+ TS_ASSERT_EQUALS(outputCol->name(), compareCol->name());
+ TS_ASSERT_EQUALS(outputCol->type(), compareCol->type());
+ for (auto rowIndex = 0; rowIndex < outputWS->rowCount(); rowIndex++) {
+
+ std::stringstream ssOutput;
+ std::stringstream ssCompare;
+ outputCol->print(rowIndex, ssOutput);
+ compareCol->print(rowIndex, ssCompare);
+ TS_ASSERT_EQUALS(ssOutput.str(), ssCompare.str());
+ }
+ }
+
+ AnalysisDataService::Instance().remove(name);
+ }
+
// Write the test file
std::string writeTestFile(const int cols, const bool header = true,
const std::string &comment = "#",
@@ -381,9 +471,10 @@ private:
SaveAscii2 save;
save.initialize();
save.setPropertyValue("Filename", getTestFileName());
+ std::string filePath = save.getPropertyValue("Filename");
if (cols < 3) {
// saveascii2 doens't save 2 column files it has to be made manually
- std::ofstream file(getTestFileName().c_str());
+ std::ofstream file(filePath.c_str());
if (scientific) {
file << std::scientific;
}
@@ -435,10 +526,11 @@ private:
save.setPropertyValue("Separator", sep);
save.setPropertyValue("CustomSeparator", custsep);
save.execute();
-
+ TSM_ASSERT("Failed to save test data using SaveAscii2.",save.isExecuted());
AnalysisDataService::Instance().remove(name);
}
- return save.getPropertyValue("Filename");
+
+ return filePath;
}
Mantid::API::MatrixWorkspace_sptr
diff --git a/Framework/DataHandling/test/SaveAscii2Test.h b/Framework/DataHandling/test/SaveAscii2Test.h
index 0daf327632d942e8b799daaae51063ec67721c74..4a3e351c25e0e4b8c5748ad90ba9458ba014b31a 100644
--- a/Framework/DataHandling/test/SaveAscii2Test.h
+++ b/Framework/DataHandling/test/SaveAscii2Test.h
@@ -866,7 +866,7 @@ public:
}
void test_TableWorkspace() {
- Workspace_sptr wsToSave = writeTableWS();
+ Workspace_sptr wsToSave = writeTableWS(m_name);
SaveAscii2 save;
std::string filename = initSaveAscii2(save);
@@ -908,33 +908,8 @@ public:
AnalysisDataService::Instance().remove(m_name);
}
-private:
- void writeSampleWS(Mantid::DataObjects::Workspace2D_sptr &wsToSave,
- const bool &isSpectra = true) {
- wsToSave = boost::dynamic_pointer_cast<Mantid::DataObjects::Workspace2D>(
- WorkspaceFactory::Instance().create("Workspace2D", 2, 3, 3));
- for (int i = 0; i < 2; i++) {
- auto &X = wsToSave->mutableX(i);
- auto &Y = wsToSave->mutableY(i);
- auto &E = wsToSave->mutableE(i);
- for (int j = 0; j < 3; j++) {
- X[j] = 1.5 * j / 0.9;
- Y[j] = (i + 1) * (2. + 4. * X[j]);
- E[j] = 1.;
- }
- }
-
- if (!isSpectra) {
- auto textAxis = std::make_unique<TextAxis>(2);
- textAxis->setLabel(0, "Test Axis 1");
- textAxis->setLabel(1, "Test Axis 2");
- wsToSave->replaceAxis(1, std::move(textAxis));
- }
-
- AnalysisDataService::Instance().add(m_name, wsToSave);
- }
-
- ITableWorkspace_sptr writeTableWS() {
+ //public as it is used in LoadAsciiTest as well.
+ static ITableWorkspace_sptr writeTableWS(const std::string &name) {
auto table = WorkspaceFactory::Instance().createTable();
// One column of each type
table->addColumn("int", "int");
@@ -961,10 +936,38 @@ private:
<< static_cast<size_t>(0) << -99.0f << 0.0 << false << "!"
<< Mantid::Kernel::V3D(1, 6, 10);
- AnalysisDataService::Instance().add(m_name, table);
+ AnalysisDataService::Instance().add(name, table);
return table;
}
+private:
+ void writeSampleWS(Mantid::DataObjects::Workspace2D_sptr &wsToSave,
+ const bool &isSpectra = true) {
+ wsToSave = boost::dynamic_pointer_cast<Mantid::DataObjects::Workspace2D>(
+ WorkspaceFactory::Instance().create("Workspace2D", 2, 3, 3));
+ for (int i = 0; i < 2; i++) {
+ auto &X = wsToSave->mutableX(i);
+ auto &Y = wsToSave->mutableY(i);
+ auto &E = wsToSave->mutableE(i);
+ for (int j = 0; j < 3; j++) {
+ X[j] = 1.5 * j / 0.9;
+ Y[j] = (i + 1) * (2. + 4. * X[j]);
+ E[j] = 1.;
+ }
+ }
+
+ if (!isSpectra) {
+ auto textAxis = std::make_unique<TextAxis>(2);
+ textAxis->setLabel(0, "Test Axis 1");
+ textAxis->setLabel(1, "Test Axis 2");
+ wsToSave->replaceAxis(1, std::move(textAxis));
+ }
+
+ AnalysisDataService::Instance().add(m_name, wsToSave);
+ }
+
+
+
void writeInelasticWS(MatrixWorkspace_sptr &wsToSave) {
const std::vector<double> l2{1, 2, 3, 4, 5};
const std::vector<double> polar{1, 2, 3, 4, 5};
diff --git a/docs/source/algorithms/LoadAscii-v2.rst b/docs/source/algorithms/LoadAscii-v2.rst
index 5ec7650188e4269482534ff5ce3d6d54d794af57..263b65da527fe885f0ade4e0e3c24a3af96dbdc4 100644
--- a/docs/source/algorithms/LoadAscii-v2.rst
+++ b/docs/source/algorithms/LoadAscii-v2.rst
@@ -10,14 +10,14 @@ Description
-----------
The LoadAscii2 algorithm reads in spectra data from a text file and
-stores it in a :ref:`Workspace2D <Workspace2D>` as data points. The data in
+stores it in a :ref:`Workspace2D <Workspace2D>` as data points, or a Table Workspace if it is table data. The data in
the file must be organized in columns separated by commas, tabs, spaces,
colons or semicolons. Only one separator type can be used throughout the
file; use the "Separator" property to tell the algorithm which to use.
The algorithm :ref:`SaveAscii2 <algm-SaveAscii-v2>` is normally able to produce
such a file.
-The format must be:
+The format must be (Workspace 2D):
- A single integer or blank line to denote a new spectra
- For each bin, between two and four columns of delimited data in the
@@ -39,6 +39,21 @@ no X error::
2.00000000,3.00000000,1.00000000 4.00000000,0.00000000,0.00000000 4
2.00000000,0.00000000,0.00000000 4.00000000,0.00000000,0.00000000
+The format must be (Table Workspace):
+
+- Two commented header lines
+- The first containing the column names
+- The second containing the column types (str, int, unit, long64, size_t, float, double, bool, V3D)
+- The number of column names, types and data items must match
+
+
+The following is an example valid file of two columns::
+
+ # Instrument Name , Run Number
+ # str , int
+ MUSR,10245
+ IRIS,8465
+ SANS2D,20462
Usage
-----
diff --git a/docs/source/release/v4.3.0/framework.rst b/docs/source/release/v4.3.0/framework.rst
index e6003f1df887c5be845b94c78ea722f4a8046a80..7252e38040659deeb85dff94b82cec45e41dfc84 100644
--- a/docs/source/release/v4.3.0/framework.rst
+++ b/docs/source/release/v4.3.0/framework.rst
@@ -20,6 +20,12 @@ Improvements
Algorithms
----------
+Improvements
+############
+
+- :ref:`SaveAscii <algm-SaveAscii>` can now save table workspaces, and :ref:`LoadAscii <algm-LoadAscii>` can load them again.
+
+
Data Objects
------------