#include <MDEventFactory.h>
|
template<size_t nd> |
static API::IMDNode * | createMDBoxFat (API::BoxController *splitter, const std::vector< Mantid::Geometry::MDDimensionExtents< coord_t > > &extentsVector, const uint32_t depth, const size_t nBoxEvents, const size_t boxID) |
| Method to create MDBox for events (Constructor wrapper) with given number of dimensions. More...
|
|
template<size_t nd> |
static API::IMDNode * | createMDBoxLean (API::BoxController *splitter, const std::vector< Mantid::Geometry::MDDimensionExtents< coord_t > > &extentsVector, const uint32_t depth, const size_t nBoxEvents, const size_t boxID) |
| Method to create MDBox for lean events (Constructor wrapper) with given number of dimensions. More...
|
|
static API::IMDNode * | createMDBoxWrong (API::BoxController *, const std::vector< Mantid::Geometry::MDDimensionExtents< coord_t > > &, const uint32_t, const size_t, const size_t) |
| Method to create any MDBox type with 0 number of dimensions. More...
|
|
template<size_t nd> |
static API::IMDNode * | createMDGridBoxFat (API::BoxController *splitter, const std::vector< Mantid::Geometry::MDDimensionExtents< coord_t > > &extentsVector, const uint32_t depth, const size_t nBoxEvents=0, const size_t boxID=0) |
| Method to create MDGridBox for events (Constructor wrapper) with given number of dimensions. More...
|
|
template<size_t nd> |
static API::IMDNode * | createMDGridBoxLean (API::BoxController *splitter, const std::vector< Mantid::Geometry::MDDimensionExtents< coord_t > > &extentsVector, const uint32_t depth, const size_t nBoxEvents=0, const size_t boxID=0) |
| Method to create MDGridBox for lean events (Constructor wrapper) with given number of dimensions. More...
|
|
template<size_t nd> |
static API::IMDEventWorkspace * | createMDWorkspaceND (const std::string &eventType, const Mantid::API::MDNormalization &preferredNormalization, const Mantid::API::MDNormalization &preferredNormalizationHisto) |
| Template to create md workspace with specific number of dimensions. More...
|
|
template<> |
API::IMDEventWorkspace * | createMDWorkspaceND (const std::string &eventType, const Mantid::API::MDNormalization &preferredNormalization, const Mantid::API::MDNormalization &preferredNormalizationHisto) |
| Template to create md workspace w ith 0 number of dimentisons. More...
|
|
|
template<size_t nd> |
class | LOOP |
|
Definition at line 32 of file MDEventFactory.h.
◆ fpCreateBox
◆ fpCreateMDWS
◆ anonymous enum
◆ BoxType
enum defines fifferent box types generated by createBox factory We will use typecast from integer to these types so it is important to define consisten numbers to these types
Enumerator |
---|
MDBoxWithLean | |
MDGridBoxWithLean | |
MDBoxWithFat | |
MDGridBoxWithFat | |
NumBoxTypes | |
Definition at line 44 of file MDEventFactory.h.
◆ createBox()
Create a MDBox or MDGridBoxof the given type.
- Parameters
-
nDimensions | :: number of dimensions |
Type | :: enum descibing the box (MDBox or MDGridBox) and the event type (MDEvent or MDLeanEvent) |
splitter | :: shared pointer to the box controller responsible for splitting boxes. The BC is not incremented as boxes take usual pointer from this pointer |
extentsVector,: | box extents in all n-dimensions (min-max) |
depth | :: the depth of the box within the box tree |
nBoxEvents | :: if defined, specify the memory the box should allocate to accept events – not used for MDGridBox |
boxID | :: the unique identifier, referencing location of the box in 1D linked list of boxes. – not used for MDGridBox |
- Returns
- pointer to the IMDNode with proper box created.
Definition at line 225 of file MDEventFactory.cpp.
References boxCreatorFP, MAX_MD_DIMENSIONS_NUM, and NumBoxTypes.
Referenced by Mantid::DataObjects::MDBoxFlatTree::restoreBoxTree().
◆ createMDBoxFat()
Method to create MDBox for events (Constructor wrapper) with given number of dimensions.
- Parameters
-
splitter | :: BoxController that controls how boxes split |
extentsVector | :: vector defining the extents of the box in all n-dimensions |
depth | :: splitting depth of the new box. |
nBoxEvents | :: number of events to reserve memory for (if needed). |
boxID | :: id for the given box |
Definition at line 338 of file MDEventFactory.cpp.
◆ createMDBoxLean()
Method to create MDBox for lean events (Constructor wrapper) with given number of dimensions.
- Parameters
-
splitter | :: BoxController that controls how boxes split |
extentsVector | :: vector defining the extents of the box in all n-dimensions |
depth | :: splitting depth of the new box. |
nBoxEvents | :: number of events to reserve memory for (if needed). |
boxID | :: id for the given box |
Definition at line 322 of file MDEventFactory.cpp.
◆ createMDBoxWrong()
◆ createMDGridBoxFat()
Method to create MDGridBox for events (Constructor wrapper) with given number of dimensions.
- Parameters
-
splitter | :: BoxController that controls how boxes split |
extentsVector | :: vector defining the extents of the box in all n-dimensions |
depth | :: splitting depth of the new box. |
nBoxEvents | – not used |
boxID | :: — not used |
Definition at line 370 of file MDEventFactory.cpp.
◆ createMDGridBoxLean()
Method to create MDGridBox for lean events (Constructor wrapper) with given number of dimensions.
- Parameters
-
splitter | :: BoxController that controls how boxes split |
extentsVector | :: vector defining the extents of the box in all n-dimensions |
depth | :: splitting depth of the new box. |
nBoxEvents | – not used |
boxID | :: — not used |
Definition at line 354 of file MDEventFactory.cpp.
◆ CreateMDWorkspace()
Create a MDEventWorkspace of the given type.
- Parameters
-
nd | :: number of dimensions |
eventType | :: string describing the event type (MDEvent or MDLeanEvent) |
preferredNormalization | the preferred normalization for the event workspace |
preferredNormalizationHisto | preferred normalization for histo workspaces which derive from this event workspace |
- Returns
- shared pointer to the MDEventWorkspace created (as a IMDEventWorkspace).
Definition at line 199 of file MDEventFactory.cpp.
References MAX_MD_DIMENSIONS_NUM, and wsCreatorFP.
Referenced by Mantid::MDAlgorithms::ConvertSpiceDataToRealSpace::createDataMDWorkspace(), Mantid::MDAlgorithms::FitMD::createEventOutputWorkspace(), Mantid::MDAlgorithms::ConvertCWSDExpToMomentum::createExperimentMDWorkspace(), Mantid::MDAlgorithms::ConvertCWSDMDtoHKL::createHKLMDWorkspace(), Mantid::MDAlgorithms::ConvertSpiceDataToRealSpace::createMonitorMDWorkspace(), Mantid::MDAlgorithms::MergeMD::createOutputWorkspace(), Mantid::MDAlgorithms::ConvertHFIRSCDtoMDE::exec(), Mantid::MDAlgorithms::ConvertToDetectorFaceMD::exec(), Mantid::MDAlgorithms::ConvertToDiffractionMDWorkspace::exec(), Mantid::MDAlgorithms::CreateMDWorkspace::exec(), Mantid::MDAlgorithms::ImportMDEventWorkspace::exec(), Mantid::MDAlgorithms::LoadDNSSCD::exec(), and Mantid::MDAlgorithms::LoadMD::execLoader().
◆ createMDWorkspaceND() [1/2]
Template to create md workspace with specific number of dimensions.
- Parameters
-
eventType | – type of event (lean or full) to generate workspace for |
preferredNormalization | the preferred normalization for the event workspace |
preferredNormalizationHisto | the preferred normalization for a derived histo workspace |
Definition at line 271 of file MDEventFactory.cpp.
◆ createMDWorkspaceND() [2/2]
Template to create md workspace w ith 0 number of dimentisons.
As this is wrong, just throws. Used as terminator and check for the wrong dimensions number
- Parameters
-
eventType | – type of event (lean or full) to generate workspace for - -does not actually used. |
preferredNormalization | the preferred normalization of the workspace |
preferredNormalizationHisto | the preferred normalization of the derived histo workspace |
Definition at line 291 of file MDEventFactory.cpp.
References UNUSED_ARG.
◆ getMaxNumDim()
static size_t Mantid::DataObjects::MDEventFactory::getMaxNumDim |
( |
| ) |
|
|
inlinestatic |
◆ LOOP
◆ boxCreatorFP
◆ CODE_GENERATOR
◆ wsCreatorFP
The documentation for this class was generated from the following files: