Commit dd751bf9 authored by Mathieu Tillet's avatar Mathieu Tillet
Browse files

Make documentation and tests clearer

parent 02e6ae0d
......@@ -72,7 +72,8 @@ void LoadILLTOF2::init() {
declareProperty(std::make_unique<WorkspaceProperty<>>("OutputWorkspace", "",
Direction::Output),
"The name to use for the output workspace");
declareProperty("ConvertToTOF", false, Direction::Input);
declareProperty("ConvertToTOF", false,
"Convert the bin edges to time-of-flight", Direction::Input);
}
/**
......
......@@ -125,9 +125,10 @@ public:
const size_t channelCount = 512;
const size_t histogramCount = 397;
const size_t monitorCount = 1;
const bool convertToTOF = true;
MatrixWorkspace_sptr ws =
loadDataFile("ILL/IN4/084446.nxs", histogramCount, monitorCount,
channelCount, tofDelay, tofChannelWidth, true);
channelCount, tofDelay, tofChannelWidth, convertToTOF);
const double pulseInterval =
ws->run().getLogAsSingleValue("pulse_interval");
......@@ -141,8 +142,9 @@ public:
const size_t channelCount = 512;
const size_t histogramCount = 98305;
const size_t monitorCount = 1;
const bool convertToTOF = true;
loadDataFile("ILL/IN5/104007.nxs", histogramCount, monitorCount,
channelCount, tofDelay, tofChannelWidth, true);
channelCount, tofDelay, tofChannelWidth, convertToTOF);
}
void test_IN6_load() {
......@@ -152,9 +154,10 @@ public:
const size_t channelCount = 1024;
const size_t histogramCount = 340;
const size_t monitorCount = 3;
const bool convertToTOF = true;
MatrixWorkspace_sptr ws =
loadDataFile("ILL/IN6/164192.nxs", histogramCount, monitorCount,
channelCount, tofDelay, tofChannelWidth, true);
channelCount, tofDelay, tofChannelWidth, convertToTOF);
const double pulseInterval =
ws->run().getLogAsSingleValue("pulse_interval");
......@@ -227,8 +230,9 @@ public:
const size_t channelCount = 512;
const size_t histogramCount = 73729;
const size_t monitorCount = 1;
const bool convertToTOF = false;
loadDataFile("ILL/PANTHER/001723.nxs", histogramCount, monitorCount,
channelCount, tofDelay, tofChannelWidth, false);
channelCount, tofDelay, tofChannelWidth, convertToTOF);
}
void test_convertToTOF() {
......@@ -238,8 +242,9 @@ public:
const size_t channelCount = 512;
const size_t histogramCount = 98305;
const size_t monitorCount = 1;
const bool convertToTOF = false;
loadDataFile("ILL/IN5/104007.nxs", histogramCount, monitorCount,
channelCount, tofDelay, tofChannelWidth, false);
channelCount, tofDelay, tofChannelWidth, convertToTOF);
}
};
......
......@@ -12,6 +12,7 @@ Direct Geometry Changes
Improvements
############
For ILL time-of-flight instruments, :ref:`LoadILLTOF <algm-LoadILLTOF-v2>` now allows bin edges determined by channel number rather than time-of-flight values.
For ILL time-of-flight instruments, :ref:`LoadILLTOF <algm-LoadILLTOF-v2>` now allows bin edges determined by channel
number by default, but you can still convert to time-of-flight using the `ConvertToTOF` property.
:ref:`Release 5.1.0 <v5.1.0>`
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment