Mantid
|
Helper class that implements ISpectrum. More...
#include <FakeObjects.h>
Public Member Functions | |
void | clearData () override |
Mask the spectrum to this value. More... | |
void | copyDataFrom (const ISpectrum &other) override |
Copy data from another ISpectrum with double-dynamic dispatch. More... | |
const MantidVec & | dataDx () const override |
MantidVec & | dataDx () override |
const MantidVec & | dataE () const override |
MantidVec & | dataE () override |
const MantidVec & | dataX () const override |
MantidVec & | dataX () override |
const MantidVec & | dataY () const override |
MantidVec & | dataY () override |
size_t | getMemorySize () const override |
Mantid::Kernel::cow_ptr< Mantid::HistogramData::HistogramX > | ptrX () const override |
const MantidVec & | readDx () const override |
const MantidVec & | readX () const override |
void | setX (const Mantid::Kernel::cow_ptr< Mantid::HistogramData::HistogramX > &X) override |
SpectrumTester (const specnum_t specNo, Mantid::HistogramData::Histogram::XMode xmode, Mantid::HistogramData::Histogram::YMode ymode) | |
SpectrumTester (Mantid::HistogramData::Histogram::XMode xmode, Mantid::HistogramData::Histogram::YMode ymode) | |
Public Member Functions inherited from Mantid::API::ISpectrum | |
void | addDetectorID (const detid_t detID) |
Add a detector ID to the set of detector IDs. More... | |
void | addDetectorIDs (const std::set< detid_t > &detIDs) |
Add a set of detector IDs to the set of detector IDs. More... | |
void | addDetectorIDs (const std::vector< detid_t > &detIDs) |
Add a vector of detector IDs to the set of detector IDs. More... | |
HistogramData::BinEdges | binEdges () const |
virtual void | clearData ()=0 |
void | clearDetectorIDs () |
Clear the detector IDs set. More... | |
void | convertToCounts () |
void | convertToFrequencies () |
virtual void | copyDataFrom (const ISpectrum &source)=0 |
Copy data from another ISpectrum with double-dynamic dispatch. More... | |
virtual void | copyDataInto (DataObjects::EventList &) const |
Override in child classes for polymorphic copying of data. More... | |
virtual void | copyDataInto (DataObjects::Histogram1D &) const |
Override in child classes for polymorphic copying of data. More... | |
virtual void | copyDataInto (SpectrumTester &) const |
Override in child classes for polymorphic copying of data. More... | |
void | copyInfoFrom (const ISpectrum &other) |
Copy spectrum number and detector IDs, but not X vector, from another ISpectrum. More... | |
virtual HistogramData::Counts | counts () const |
virtual HistogramData::CountStandardDeviations | countStandardDeviations () const |
virtual HistogramData::CountVariances | countVariances () const |
virtual const MantidVec & | dataDx () const =0 |
virtual MantidVec & | dataDx ()=0 |
virtual const MantidVec & | dataE () const =0 |
virtual MantidVec & | dataE ()=0 |
virtual const MantidVec & | dataX () const =0 |
virtual MantidVec & | dataX ()=0 |
virtual const MantidVec & | dataY () const =0 |
virtual MantidVec & | dataY ()=0 |
const HistogramData::HistogramDx & | dx () const |
virtual const HistogramData::HistogramE & | e () const |
virtual HistogramData::Frequencies | frequencies () const |
virtual HistogramData::FrequencyStandardDeviations | frequencyStandardDeviations () const |
virtual HistogramData::FrequencyVariances | frequencyVariances () const |
const std::set< detid_t > & | getDetectorIDs () const |
Get a const reference to the detector IDs set. More... | |
virtual size_t | getMemorySize () const =0 |
specnum_t | getSpectrumNo () const |
virtual std::pair< double, double > | getXDataRange () const |
Return the min/max X values for this spectrum. More... | |
bool | hasDetectorID (const detid_t detID) const |
Return true if the given detector ID is in the list for this ISpectrum. More... | |
bool | hasDx () const |
Gets the value of the use flag. More... | |
virtual HistogramData::Histogram | histogram () const |
Returns the Histogram associated with this spectrum. More... | |
ISpectrum ()=default | |
ISpectrum (const specnum_t specNo) | |
Constructor with spectrum number. More... | |
HistogramData::HistogramDx & | mutableDx () & |
HistogramData::HistogramE & | mutableE () & |
HistogramData::HistogramX & | mutableX () & |
HistogramData::HistogramY & | mutableY () & |
HistogramData::Points | points () const |
HistogramData::PointStandardDeviations | pointStandardDeviations () const |
virtual Kernel::cow_ptr< HistogramData::HistogramX > | ptrX () const =0 |
virtual const MantidVec & | readDx () const =0 |
virtual const MantidVec & | readE () const |
Deprecated, use e() instead. Returns the y error data const. More... | |
virtual const MantidVec & | readX () const =0 |
virtual const MantidVec & | readY () const |
Deprecated, use y() instead. Returns the y data const. More... | |
void | resetHasDx () |
Resets the hasDx flag. More... | |
template<typename... T> | |
void | setBinEdges (T &&...data) & |
template<typename... T> | |
void | setCounts (T &&...data) & |
template<typename... T> | |
void | setCountStandardDeviations (T &&...data) & |
template<typename... T> | |
void | setCountVariances (T &&...data) & |
void | setDetectorID (const detid_t detID) |
Clear the list of detector IDs, then add one. More... | |
void | setDetectorIDs (const std::set< detid_t > &detIDs) |
Set the detector IDs to be the set given. More... | |
void | setDetectorIDs (std::set< detid_t > &&detIDs) |
Set the detector IDs to be the set given (move version). More... | |
template<typename... T> | |
void | setFrequencies (T &&...data) & |
template<typename... T> | |
void | setFrequencyStandardDeviations (T &&...data) & |
template<typename... T> | |
void | setFrequencyVariances (T &&...data) & |
template<typename... T> | |
void | setHistogram (T &&...data) |
Sets the Histogram associated with this spectrum. More... | |
void | setMatrixWorkspace (MatrixWorkspace *matrixWorkspace, const size_t index) |
Sets the MatrixWorkspace pointer (pointer to the owning workspace). More... | |
template<typename... T> | |
void | setPoints (T &&...data) & |
template<typename... T> | |
void | setPointStandardDeviations (T &&...data) & |
template<typename... T> | |
void | setPointVariances (T &&...data) & |
void | setSharedDx (const Kernel::cow_ptr< HistogramData::HistogramDx > &dx) & |
void | setSharedE (const Kernel::cow_ptr< HistogramData::HistogramE > &e) & |
void | setSharedX (const Kernel::cow_ptr< HistogramData::HistogramX > &x) & |
void | setSharedY (const Kernel::cow_ptr< HistogramData::HistogramY > &y) & |
void | setSpectrumNo (specnum_t num) |
Sets the the spectrum number of this spectrum. More... | |
virtual void | setX (const Kernel::cow_ptr< HistogramData::HistogramX > &X)=0 |
void | setYMode (HistogramData::Histogram::YMode ymode) |
Kernel::cow_ptr< HistogramData::HistogramDx > | sharedDx () const |
virtual Kernel::cow_ptr< HistogramData::HistogramE > | sharedE () const |
Kernel::cow_ptr< HistogramData::HistogramX > | sharedX () const |
virtual Kernel::cow_ptr< HistogramData::HistogramY > | sharedY () const |
const HistogramData::HistogramX & | x () const |
virtual const HistogramData::HistogramY & | y () const |
HistogramData::Histogram::YMode | yMode () const |
virtual | ~ISpectrum ()=default |
Protected Attributes | |
Mantid::HistogramData::Histogram | m_histogram |
Private Member Functions | |
void | copyDataInto (SpectrumTester &other) const override |
Override in child classes for polymorphic copying of data. More... | |
const Mantid::HistogramData::Histogram & | histogramRef () const override |
Mantid::HistogramData::Histogram & | mutableHistogramRef () override |
Additional Inherited Members | |
Protected Member Functions inherited from Mantid::API::ISpectrum | |
virtual void | checkAndSanitizeHistogram (HistogramData::Histogram &) |
virtual void | checkIsYAndEWritable () const |
virtual void | checkWorksWithPoints () const |
ISpectrum (const ISpectrum &other) | |
Copy constructor. More... | |
ISpectrum (ISpectrum &&other) | |
Move constructor. More... | |
ISpectrum & | operator= (const ISpectrum &other) |
Copy assignment. More... | |
ISpectrum & | operator= (ISpectrum &&other) |
Move assignment. More... | |
Helper class that implements ISpectrum.
Definition at line 55 of file FakeObjects.h.
|
inline |
Definition at line 57 of file FakeObjects.h.
References m_histogram.
|
inline |
Definition at line 62 of file FakeObjects.h.
References m_histogram.
|
inlineoverridevirtual |
Mask the spectrum to this value.
Implements Mantid::API::ISpectrum.
Definition at line 90 of file FakeObjects.h.
|
inlineoverridevirtual |
Copy data from another ISpectrum with double-dynamic dispatch.
Implements Mantid::API::ISpectrum.
Definition at line 69 of file FakeObjects.h.
|
inlineoverrideprivatevirtual |
Override in child classes for polymorphic copying of data.
Reimplemented from Mantid::API::ISpectrum.
Definition at line 103 of file FakeObjects.h.
References m_histogram.
|
inlineoverridevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 78 of file FakeObjects.h.
References m_histogram.
|
inlineoverridevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 77 of file FakeObjects.h.
References m_histogram.
|
inlineoverridevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 85 of file FakeObjects.h.
References m_histogram.
|
inlineoverridevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 82 of file FakeObjects.h.
References m_histogram.
Referenced by clearData().
|
inlineoverridevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 73 of file FakeObjects.h.
References m_histogram.
|
inlineoverridevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 72 of file FakeObjects.h.
References m_histogram.
|
inlineoverridevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 84 of file FakeObjects.h.
References m_histogram.
|
inlineoverridevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 81 of file FakeObjects.h.
References m_histogram.
Referenced by clearData().
|
inlineoverridevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 87 of file FakeObjects.h.
References Mantid::API::ISpectrum::readY().
|
inlineoverrideprivatevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 105 of file FakeObjects.h.
References m_histogram.
|
inlineoverrideprivatevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 106 of file FakeObjects.h.
References m_histogram.
|
inlineoverridevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 75 of file FakeObjects.h.
References m_histogram.
|
inlineoverridevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 79 of file FakeObjects.h.
References m_histogram.
|
inlineoverridevirtual |
Implements Mantid::API::ISpectrum.
Definition at line 74 of file FakeObjects.h.
References m_histogram.
|
inlineoverride |
Definition at line 71 of file FakeObjects.h.
References m_histogram, and Mantid::Geometry::X.
|
protected |
Definition at line 99 of file FakeObjects.h.
Referenced by copyDataInto(), dataDx(), dataE(), dataX(), dataY(), histogramRef(), mutableHistogramRef(), ptrX(), readDx(), readX(), setX(), and SpectrumTester().