27#include "tbb/parallel_for.h"
32using namespace boost::posix_time;
33using Mantid::Types::Core::DateAndTime;
38Kernel::Logger
g_log(
"EventWorkspace");
43using Kernel::Exception::NotImplementedError;
52 for (
const auto &el : other.data) {
54 auto newel = std::make_unique<EventList>(*el);
56 newel->setMRU(this->
mru.get());
57 this->
data.emplace_back(std::move(newel));
81void EventWorkspace::init(
const std::size_t &NVectors,
const std::size_t &XLength,
const std::size_t &YLength) {
82 static_cast<void>(XLength);
83 static_cast<void>(YLength);
87 throw std::out_of_range(
"Zero pixels specified to EventWorkspace::init");
93 HistogramData::BinEdges edges{0.0, std::numeric_limits<double>::min()};
96 data.resize(NVectors);
100 for (
size_t i = 0; i < NVectors; i++) {
101 data[i] = std::make_unique<EventList>(el);
108 m_axes[0] = std::make_unique<API::RefAxis>(
this);
109 m_axes[1] = std::make_unique<API::SpectraAxis>(
this);
113 if (
histogram.xMode() != HistogramData::Histogram::XMode::BinEdges)
114 throw std::runtime_error(
"EventWorkspace can only be initialized with XMode::BinEdges");
117 throw std::runtime_error(
"EventWorkspace cannot be initialized non-NULL Y or E data");
122 for (
size_t i = 0; i <
data.size(); i++) {
123 data[i] = std::make_unique<EventList>(el);
129 m_axes[0] = std::make_unique<API::RefAxis>(
this);
130 m_axes[1] = std::make_unique<API::SpectraAxis>(
this);
137 throw std::runtime_error(
"There are no pixels in the event workspace, "
138 "therefore cannot determine if it is ragged.");
140 const auto numberOfBins =
data[0]->histogram_size();
141 return std::any_of(
data.cbegin(),
data.cend(),
142 [&numberOfBins](
const auto &eventList) { return numberOfBins != eventList->histogram_size(); });
149 return std::accumulate(
150 data.begin(),
data.end(),
static_cast<size_t>(0),
151 [](
size_t value,
const std::unique_ptr<EventList> &histo) { return value + histo->histogram_size(); });
158 throw std::range_error(
"EventWorkspace::blocksize, no pixels in workspace, "
159 "therefore cannot determine blocksize (# of bins).");
161 size_t numBins =
data[0]->histogram_size();
162 const auto iterPos = std::find_if_not(
data.cbegin(),
data.cend(),
163 [numBins](
const auto &iter) { return numBins == iter->histogram_size(); });
164 if (iterPos !=
data.cend())
165 throw std::length_error(
"blocksize undefined because size of histograms is not equal");
178 throw std::invalid_argument(
"Could not find number of bins in a histogram at index " +
std::to_string(
index) +
179 ": index is too large.");
189 auto maxNumberOfBins =
data[0]->histogram_size();
190 for (
const auto &iter :
data) {
191 const auto numberOfBins = iter->histogram_size();
192 if (numberOfBins > maxNumberOfBins)
193 maxNumberOfBins = numberOfBins;
195 return maxNumberOfBins;
215 throw std::range_error(
"EventWorkspace::getSpectrum, workspace index out of range");
242 Mantid::Types::Core::DateAndTime tMin = DateAndTime::maximum();
243 size_t numWorkspace = this->
data.size();
245 for (
size_t workspaceIndex = 0; workspaceIndex < numWorkspace; workspaceIndex++) {
260 Mantid::Types::Core::DateAndTime tMax = DateAndTime::minimum();
261 size_t numWorkspace = this->
data.size();
263 for (
size_t workspaceIndex = 0; workspaceIndex < numWorkspace; workspaceIndex++) {
277 Mantid::Types::Core::DateAndTime &Tmax)
const {
279 Tmax = DateAndTime::minimum();
280 Tmin = DateAndTime::maximum();
282 auto numWorkspace =
static_cast<int64_t
>(this->
data.size());
285 DateAndTime tTmax = DateAndTime::minimum();
286 DateAndTime tTmin = DateAndTime::maximum();
287#pragma omp for nowait
288 for (int64_t workspaceIndex = 0; workspaceIndex < numWorkspace; workspaceIndex++) {
290 DateAndTime tempMin, tempMax;
292 tTmin = std::min(tTmin, tempMin);
293 tTmax = std::max(tTmax, tempMax);
297 Tmin = std::min(Tmin, tTmin);
298 Tmax = std::max(Tmax, tTmax);
310 const auto L1 = specInfo.l1();
313 Mantid::Types::Core::DateAndTime tMin = DateAndTime::maximum();
314 size_t numWorkspace = this->
data.size();
317 for (
size_t workspaceIndex = 0; workspaceIndex < numWorkspace; workspaceIndex++) {
318 const auto L2 = specInfo.l2(workspaceIndex);
319 const double tofFactor = L1 / (L1 + L2);
336 const auto L1 = specInfo.l1();
339 Mantid::Types::Core::DateAndTime tMax = DateAndTime::minimum();
340 size_t numWorkspace = this->
data.size();
342 for (
size_t workspaceIndex = 0; workspaceIndex < numWorkspace; workspaceIndex++) {
343 const auto L2 = specInfo.l2(workspaceIndex);
344 const double tofFactor = L1 / (L1 + L2);
366 double xmin = std::numeric_limits<double>::max();
369 size_t numWorkspace = this->
data.size();
370 for (
size_t workspaceIndex = 0; workspaceIndex < numWorkspace; workspaceIndex++) {
391 double xmax = std::numeric_limits<double>::lowest();
394 size_t numWorkspace = this->
data.size();
395 for (
size_t workspaceIndex = 0; workspaceIndex < numWorkspace; workspaceIndex++) {
412 xmin = std::numeric_limits<double>::max();
417 auto numWorkspace =
static_cast<int64_t
>(this->
data.size());
422#pragma omp for nowait
423 for (int64_t workspaceIndex = 0; workspaceIndex < numWorkspace; workspaceIndex++) {
426 tXmin = std::min(temp, tXmin);
428 tXmax = std::max(temp, tXmax);
432 xmin = std::min(xmin, tXmin);
433 xmax = std::max(xmax, tXmax);
441 return std::accumulate(
data.begin(),
data.end(),
size_t{0},
442 [](
size_t total,
auto &list) { return total + list->getNumberEvents(); });
451 for (
auto &list : this->
data) {
453 if (
static_cast<int>(out) <
static_cast<int>(thisType)) {
468 for (
auto &eventList : this->
data)
469 eventList->switchTo(type);
491 size_t total = std::accumulate(
data.begin(),
data.end(),
size_t{0},
492 [](
size_t total,
auto &list) { return total + list->getMemorySize(); });
519 "array: you can't modify the histogrammed data in "
520 "an EventWorkspace!");
528 "array: you can't modify the histogrammed data in "
529 "an EventWorkspace!");
570 bool skipError)
const {
572 throw std::range_error(
"EventWorkspace::generateHistogram, histogram number out of range");
573 this->
data[
index]->generateHistogram(X,
Y, E, skipError);
587 bool skipError)
const {
589 throw std::range_error(
"EventWorkspace::generateHistogramPulseTime, "
590 "histogram number out of range");
591 this->
data[
index]->generateHistogramPulseTime(X,
Y, E, skipError);
602 for (
auto &eventList : this->
data)
603 eventList->setHistogram(
x);
614 double tofmin, tofmax;
619 if (tofmin > tofmax) {
621 tofmax = std::numeric_limits<double>::min();
622 }
else if (tofmin == tofmax) {
623 tofmax += std::numeric_limits<double>::min();
636 void operator()(
const tbb::blocked_range<size_t> &range)
const {
637 for (
size_t wi = range.begin(); wi < range.end(); ++wi) {
661 for (
size_t i = 1; i <
size; i++) {
675 if (prog !=
nullptr) {
683 tbb::parallel_for(tbb::blocked_range<size_t>(0,
data.size()), task);
699 const bool entireRange)
const {
710 out[wksp_index] = el->
integrate(minX, maxX, entireRange);
719IPropertyManager::getValue<Mantid::DataObjects::EventWorkspace_sptr>(
const std::string &name)
const {
724 std::string message =
725 "Attempt to assign property " + name +
" to incorrect type. Expected shared_ptr<EventWorkspace>.";
726 throw std::runtime_error(message);
732IPropertyManager::getValue<Mantid::DataObjects::EventWorkspace_const_sptr>(
const std::string &name)
const {
735 return prop->operator()();
737 std::string message =
738 "Attempt to assign property " + name +
" to incorrect type. Expected const shared_ptr<EventWorkspace>.";
739 throw std::runtime_error(message);
double value
The value of the point.
std::map< DeltaEMode::Type, std::string > index
#define PARALLEL_FOR_NO_WSP_CHECK()
#define DLLExport
Definitions of the DLLImport compiler directives for MSVC.
#define DECLARE_WORKSPACE(classname)
const SpectrumInfo & spectrumInfo() const
Return a reference to the SpectrumInfo object.
size_t numberOfDetectorGroups() const
Returns the number of detector groups.
const Run & run() const
Run details object access.
This class provides an interface to an EventWorkspace.
void setHistogram(T &&...data)
Sets the Histogram associated with this spectrum.
void setMatrixWorkspace(MatrixWorkspace *matrixWorkspace, const size_t index)
Sets the MatrixWorkspace pointer (pointer to the owning workspace).
virtual const MantidVec & readE() const
Deprecated, use e() instead. Returns the y error data const.
virtual const MantidVec & readY() const
Deprecated, use y() instead. Returns the y data const.
std::vector< std::unique_ptr< Axis > > m_axes
A vector of pointers to the axes for this workspace.
virtual size_t getMemorySizeForXAxes() const
Returns the memory used (in bytes) by the X axes, handling ragged bins.
void invalidateCommonBinsFlag()
Invalidates the commons bins flag.
HistogramData::Histogram histogram(const size_t index) const
Returns the Histogram at the given workspace index.
Helper class for reporting progress from algorithms.
size_t getMemorySize() const override
Return an approximate memory size for the object in bytes.
Mantid::Types::Core::DateAndTime getTimeAtSampleMax(const double &tofFactor, const double &tofOffset) const override
Get the maximum time at sample.
double getTofMax() const override
double getTofMin() const override
const MantidVec & readDx() const override
Deprecated, use dx() instead.
void getPulseTimeMinMax(Mantid::Types::Core::DateAndTime &tMin, Mantid::Types::Core::DateAndTime &tM) const
Mantid::Types::Core::DateAndTime getPulseTimeMax() const override
Kernel::cow_ptr< HistogramData::HistogramX > ptrX() const override
Deprecated, use sharedX() instead. Returns a pointer to the x data.
MantidVec & dataX() override
Deprecated, use mutableX() instead.
MantidVec & dataDx() override
Deprecated, use mutableDx() instead.
Mantid::Types::Core::DateAndTime getTimeAtSampleMin(const double &tofFactor, const double &tofOffset) const override
Get the minimum time at sample.
const MantidVec & readX() const override
Deprecated, use x() instead. Returns the x data const.
void integrate(const double minX, const double maxX, const bool entireRange, double &sum, double &error) const
Integrate the events between a range of X values, or all events.
Mantid::Types::Core::DateAndTime getPulseTimeMin() const override
void sort(const EventSortType order) const
Sort events by TOF or Frame.
Task for sorting an event list.
void operator()(const tbb::blocked_range< size_t > &range) const
const EventWorkspace * m_WS
EventWorkspace on which to sort.
EventSortType m_sortType
How to sort.
EventSortingTask(const EventWorkspace *WS, EventSortType sortType, Mantid::API::Progress *prog)
ctor
Mantid::API::Progress * prog
Optional Progress dialog.
This is a container for the MRU (most-recently-used) list of generated histograms.
This class is intended to fulfill the design specified in <https://github.com/mantidproject/documents...
void init(const std::size_t &, const std::size_t &, const std::size_t &) override
Initialize the pixels.
std::vector< std::unique_ptr< EventList > > data
A vector that holds the event list for each spectrum; the key is the workspace index,...
void setAllX(const HistogramData::BinEdges &x) override
Set all histogram X vectors.
double getEventXMax() const
Get them maximum x-value for the events themselves, ignoring the histogram representation.
EventList * getSpectrumUnsafe(const size_t index)
Returns a pointer to the EventList for a given spectrum in a timely manner.
MantidVec & dataY(const std::size_t) override
Deprecated, use mutableY() instead.
std::size_t getNumberBins(const std::size_t &index) const override
Returns the number of bins for a given histogram index.
Kernel::cow_ptr< HistogramData::HistogramX > refX(const std::size_t) const override
Deprecated, use sharedX() instead.
bool isHistogramData() const override
Returns true always - an EventWorkspace always represents histogramm-able data.
Mantid::Types::Core::DateAndTime getPulseTimeMin() const override
Get the minimum pulse time for events accross the entire workspace.
std::size_t getMaxNumberBins() const override
Returns the maximum number of bins in a workspace (works on ragged data).
EventList & getSpectrum(const size_t index) override
Return the underlying ISpectrum ptr at the given workspace index.
std::size_t MRUSize() const
Return how many entries in the Y MRU list are used.
void getEventXMinMax(double &xmin, double &xmax) const
Get them minimum and maximum x-values for the events themselves, ignoring the histogram representatio...
std::size_t getNumberHistograms() const override
Get the number of histograms, usually the same as the number of pixels or detectors.
double getTofMax() const override
void getPulseTimeMinMax(Mantid::Types::Core::DateAndTime &xmin, Mantid::Types::Core::DateAndTime &xmax) const
Get the maximum and mimumum pulse time for events accross the entire workspace.
Mantid::Types::Core::DateAndTime getTimeAtSampleMin(double tofOffset=0) const override
Get the minimum time at sample for events across the entire workspace.
~EventWorkspace() override
EventSortType getSortType() const
double getEventXMin() const
Get them minimum x-value for the events themselves, ignoring the histogram representation.
void switchEventType(const Mantid::API::EventType type)
Switch all event lists to the given event type.
Mantid::Types::Core::DateAndTime getPulseTimeMax() const override
Get the maximum pulse time for events accross the entire workspace.
MantidVec & dataDx(const std::size_t) override
Deprecated, use mutableDx() instead.
void getIntegratedSpectra(std::vector< double > &out, const double minX, const double maxX, const bool entireRange) const override
Integrate all the spectra in the matrix workspace within the range given.
bool threadSafe() const override
Returns true if the EventWorkspace is safe for multithreaded operations.
std::size_t size() const override
The total size of the workspace.
void sortAll(EventSortType sortType, Mantid::API::Progress *prog) const
EventList & getSpectrumWithoutInvalidation(const size_t index) override
Return const reference to EventList at the given workspace index.
void clearMRU() const override
Clears the MRU lists.
Mantid::API::EventType getEventType() const override
Get the EventType of the most-specialized EventList in the workspace.
double getTofMin() const override
bool isRaggedWorkspace() const override
Returns true if the workspace is ragged (has differently sized spectra).
MantidVec & dataX(const std::size_t) override
Deprecated, use mutableX() instead.
Mantid::Types::Core::DateAndTime getTimeAtSampleMax(double tofOffset=0) const override
Get the maximum time at sample for events across the entire workspace.
std::size_t getNumberEvents() const override
The total number of events across all of the spectra.
std::size_t blocksize() const override
Get the blocksize, aka the number of bins in the histogram.
size_t getMemorySize() const override
Returns the amount of memory used in bytes.
void generateHistogram(const std::size_t index, const MantidVec &X, MantidVec &Y, MantidVec &E, bool skipError=false) const override
Generate a new histogram from specified event list at the given index.
void generateHistogramPulseTime(const std::size_t index, const MantidVec &X, MantidVec &Y, MantidVec &E, bool skipError=false) const
Generate a new histogram from specified event list at the given index.
MantidVec & dataE(const std::size_t) override
Deprecated, use mutableE() instead.
EventWorkspace(const Parallel::StorageMode storageMode=Parallel::StorageMode::Cloned)
std::unique_ptr< EventWorkspaceMRU > mru
Container for the MRU lists of the event lists contained.
void resetAllXToSingleBin() override
Set all Histogram X vectors to a single bin with boundaries that fit the TOF of all events across all...
Marks code as not implemented yet.
void reportIncrement(int inc, const std::string &msg="")
Sends the progress notification and increment the loop counter by more than one.
void report()
Increments the loop counter by 1, then sends the progress notification on behalf of its algorithm.
The concrete, templated class for properties.
Implements a copy on write data template.
Kernel::Logger g_log("ExperimentInfo")
static logger object
EventType
What kind of event list is being stored.
std::shared_ptr< const EventWorkspace > EventWorkspace_const_sptr
shared pointer to a const Workspace2D
EventSortType
How the event list is sorted.
std::shared_ptr< EventWorkspace > EventWorkspace_sptr
shared pointer to the EventWorkspace class
std::vector< double > MantidVec
typedef for the data storage used in Mantid matrix workspaces
int32_t specnum_t
Typedef for a spectrum Number.
std::string to_string(const wide_integer< Bits, Signed > &n)