Mantid
|
Templated class holding data about a neutron detection event in N-dimensions (for example, Qx, Qy, Qz, E). More...
#include <MDEvent.h>
Public Types | |
enum | { is_full_mdevent = true } |
Public Types inherited from Mantid::DataObjects::MDLeanEvent< nd > | |
enum | { is_full_mdevent = false } |
using | IntT = typename morton_index::IndexTypes< nd, coord_t >::IntType |
Additional index type defenitions. More... | |
using | MortonT = typename morton_index::IndexTypes< nd, coord_t >::MortonType |
Public Member Functions | |
int32_t | getDetectorID () const |
uint16_t | getExpInfoIndex () const |
uint16_t | getGoniometerIndex () const |
MDEvent () | |
Empty constructor. More... | |
MDEvent (const double signal, const double errorSquared) | |
Constructor with signal and error. More... | |
MDEvent (const double signal, const double errorSquared, const coord_t *centers) | |
Constructor with signal and error and an array of centers. More... | |
MDEvent (const double signal, const double errorSquared, const uint16_t expInfoIndex, const uint16_t goniometerIndex, const int32_t detectorId) | |
Constructor with signal, error, expInfoIndex and detectorId. More... | |
MDEvent (const double signal, const double errorSquared, const uint16_t expInfoIndex, const uint16_t goniometerIndex, const int32_t detectorId, const coord_t *centers) | |
MDEvent (const float signal, const float errorSquared) | |
Constructor with signal and error. More... | |
MDEvent (const float signal, const float errorSquared, const coord_t *centers) | |
Constructor with signal and error and an array of centers. More... | |
MDEvent (const float signal, const float errorSquared, const uint16_t expInfoIndex, const uint16_t goniometerIndex, const int32_t detectorId) | |
Constructor with signal, error, expInfoIndex and detectorId. More... | |
MDEvent (const float signal, const float errorSquared, const uint16_t expInfoIndex, const uint16_t goniometerIndex, const int32_t detectorId, const coord_t *centers) | |
Constructor with signal and error and an array of centers, and the expInfoIndex and detectorID. More... | |
void | setDetectorId (int32_t id) |
Sets the detectorId of this event. More... | |
void | setExpInfoIndex (uint16_t index) |
Sets the expInfoIndex of this event. More... | |
void | setGoniometerIndex (uint16_t index) |
Sets the expInfoIndex of this event. More... | |
Public Member Functions inherited from Mantid::DataObjects::MDLeanEvent< nd > | |
const coord_t * | getCenter () const |
Returns the array of coordinates. More... | |
coord_t | getCenter (const size_t n) const |
coord_t * | getCenterNonConst () |
Returns the array of coordinates, as a pointer to a non-const array. More... | |
int32_t | getDetectorID () const |
float | getError () const |
Returns the error (not squared) of this event. More... | |
float | getErrorSquared () const |
Returns the error (squared) of this event. More... | |
uint16_t | getExpInfoIndex () const |
uint16_t | getGoniometerIndex () const |
size_t | getNumDims () const |
Returns the number of dimensions in the event. More... | |
float | getSignal () const |
Returns the signal (weight) of this event. More... | |
MDLeanEvent () | |
Empty constructor. More... | |
MDLeanEvent (const double signal, const double errorSquared) | |
Constructor with signal and error. More... | |
MDLeanEvent (const double signal, const double errorSquared, const coord_t *centers) | |
Constructor with signal and error and an array of centers. More... | |
MDLeanEvent (const float signal, const float errorSquared) | |
Constructor with signal and error. More... | |
MDLeanEvent (const float signal, const float errorSquared, const coord_t *centers) | |
Constructor with signal and error and an array of centers. More... | |
MDLeanEvent (const MDLeanEvent &rhs) | |
Copy constructor. More... | |
MDLeanEvent & | operator= (MDLeanEvent other) |
void | setCenter (const size_t n, const coord_t value) |
Sets the n-th coordinate axis value. More... | |
void | setCoords (const coord_t *centers) |
Sets all the coordinates. More... | |
void | setErrorSquared (const float newerrorSquared) |
Set the squared error of the event. More... | |
void | setSignal (const float newSignal) |
Set the signal of the event. More... | |
Static Public Member Functions | |
static void | dataToEvents (const std::vector< coord_t > &data, std::vector< MDEvent< nd > > &events, bool reserveMemory=true) |
static void | eventsToData (const std::vector< MDEvent< nd > > &events, std::vector< coord_t > &data, size_t &ncols, double &totalSignal, double &totalErrSq) |
static std::string | getTypeName () |
Static Public Member Functions inherited from Mantid::DataObjects::MDLeanEvent< nd > | |
static void | dataToEvents (const std::vector< coord_t > &coord, std::vector< MDLeanEvent< nd > > &events, bool reserveMemory=true) |
static void | eventsToData (const std::vector< MDLeanEvent< nd > > &mdLeanEvents, std::vector< coord_t > &data, size_t &ncols, double &totalSignal, double &totalErrSq) |
static std::string | getTypeName () |
Protected Attributes | |
int32_t | detectorId |
Detector ID of the pixel that measured this event. More... | |
uint16_t | expInfoIndex |
0-based index of which run this event belongs to. More... | |
uint16_t | goniometerIndex |
0-based index determines the goniometer settings when this event occurred More... | |
Protected Attributes inherited from Mantid::DataObjects::MDLeanEvent< nd > | |
union { | |
coord_t center [nd] | |
MortonT index = 0 | |
}; | |
The N-dimensional coordinates of the center of the event. More... | |
float | errorSquared |
The square of the error carried in this event. More... | |
float | signal |
The signal (aka weight) from the neutron event. More... | |
Templated class holding data about a neutron detection event in N-dimensions (for example, Qx, Qy, Qz, E).
This is an extension to MDLeanEvent which adds:
nd | :: the number of dimensions that each MDEvent will be tracking. an int > 0. |
anonymous enum |
|
inline |
|
inline |
|
inline |
|
inline |
Constructor with signal, error, expInfoIndex and detectorId.
signal | :: signal (aka weight) |
errorSquared | :: square of the error on the weight |
expInfoIndex | :: 0-based index of which run in the containing MDEventWorkspace |
goniometerIndex | :: 0-based index determines the goniometer settings when this event occurred |
detectorId | :: ID of the detector that measured this event. |
|
inline |
Constructor with signal, error, expInfoIndex and detectorId.
signal | :: signal (aka weight) |
errorSquared | :: square of the error on the weight |
expInfoIndex | :: 0-based index of which run in the containing MDEventWorkspace |
goniometerIndex | :: 0-based index determines the goniometer settings when this event occurred |
detectorId | :: ID of the detector that measured this event. |
|
inline |
|
inline |
|
inline |
Constructor with signal and error and an array of centers, and the expInfoIndex and detectorID.
signal | :: signal (aka weight) |
errorSquared | :: square of the error on the weight |
expInfoIndex | :: 0-based index of which run in the containing MDEventWorkspace |
goniometerIndex | :: 0-based index determines the goniometer settings when this event occurred |
detectorId | :: ID of the detector that measured this event. |
centers | :: pointer to a nd-sized array of values to set for all coordinates. |
|
inline |
|
inlinestatic |
Definition at line 244 of file MDEvent.h.
References Mantid::DataHandling::numEvents().
|
inlinestatic |
Definition at line 211 of file MDEvent.h.
References Mantid::Geometry::d, index, and ncols.
|
inline |
Definition at line 191 of file MDEvent.h.
Referenced by Mantid::MDAlgorithms::copyEvent().
|
inline |
Definition at line 175 of file MDEvent.h.
Referenced by Mantid::MDAlgorithms::copyEvent().
|
inline |
|
inlinestatic |
Definition at line 199 of file MDEvent.h.
Referenced by Mantid::DataObjects::BoxControllerNeXusIO::BoxControllerNeXusIO().
|
inline |
Sets the detectorId of this event.
id | :: new detector ID value. |
Definition at line 195 of file MDEvent.h.
Referenced by Mantid::MDAlgorithms::copyEvent().
|
inline |
Sets the expInfoIndex of this event.
index | :: new expInfoIndex value. |
Definition at line 179 of file MDEvent.h.
References index.
Referenced by Mantid::MDAlgorithms::copyEvent().
|
inline |
|
protected |
|
protected |
0-based index of which run this event belongs to.
This refers to the particular ExperimentInfo that is stored in the MDEventWorkspace
|
protected |