Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | List of all members
MDHistoWorkspaceTester Class Reference

#include <FakeObjects.h>

Inheritance diagram for MDHistoWorkspaceTester:
Mantid::API::IMDHistoWorkspace Mantid::API::IMDWorkspace Mantid::API::MultipleExperimentInfos Mantid::API::Workspace Mantid::API::MDGeometry Mantid::Kernel::DataItem

Public Member Functions

void clearMDMasking () override
 Clear existing masks. More...
 
std::vector< std::unique_ptr< IMDIterator > > createIterators (size_t suggestedNumCores=1, Mantid::Geometry::MDImplicitFunction *function=nullptr) const override
 Creates a new iterator pointing to the first cell in the workspace. More...
 
signal_t & errorSquaredAt (size_t index) override
 
Mantid::Kernel::VMD getCenter (size_t linearIndex) const override
 
signal_t getErrorAt (size_t index) const override
 
signal_t getErrorAt (size_t index1, size_t index2) const override
 
signal_t getErrorAt (size_t index1, size_t index2, size_t index3) const override
 
signal_t getErrorAt (size_t index1, size_t index2, size_t index3, size_t index4) const override
 
signal_t getErrorNormalizedAt (size_t index) const override
 
signal_t getErrorNormalizedAt (size_t index1, size_t index2) const override
 
signal_t getErrorNormalizedAt (size_t index1, size_t index2, size_t index3) const override
 
signal_t getErrorNormalizedAt (size_t index1, size_t index2, size_t index3, size_t index4) const override
 
const signal_t * getErrorSquaredArray () const override
 
coord_t getInverseVolume () const override
 See the MDHistoWorkspace definition for descriptions of these. More...
 
size_t getLinearIndex (size_t index1, size_t index2) const override
 
size_t getLinearIndex (size_t index1, size_t index2, size_t index3) const override
 
size_t getLinearIndex (size_t index1, size_t index2, size_t index3, size_t index4) const override
 
LinePlot getLineData (const Mantid::Kernel::VMD &start, const Mantid::Kernel::VMD &end, Mantid::API::MDNormalization normalize) const override
 
size_t getMemorySize () const override
 Get the footprint in memory in bytes. More...
 
const std::string & getName () const override
 Get the workspace name. More...
 
uint64_t getNEvents () const override
 
uint64_t getNPoints () const override
 Get the number of points associated with the workspace. More...
 
const signal_t * getNumEventsArray () const override
 
const signal_t * getSignalArray () const override
 
signal_t getSignalAt (size_t index) const override
 
signal_t getSignalAt (size_t index1, size_t index2) const override
 
signal_t getSignalAt (size_t index1, size_t index2, size_t index3) const override
 
signal_t getSignalAt (size_t index1, size_t index2, size_t index3, size_t index4) const override
 
signal_t getSignalAtCoord (const coord_t *coords, const Mantid::API::MDNormalization &normalization) const override
 
signal_t getSignalNormalizedAt (size_t index) const override
 
signal_t getSignalNormalizedAt (size_t index1, size_t index2) const override
 
signal_t getSignalNormalizedAt (size_t index1, size_t index2, size_t index3) const override
 
signal_t getSignalNormalizedAt (size_t index1, size_t index2, size_t index3, size_t index4) const override
 
signal_t getSignalWithMaskAtCoord (const coord_t *coords, const Mantid::API::MDNormalization &normalization) const override
 
SpecialCoordinateSystem getSpecialCoordinateSystem () const override
 
bool hasOrientedLattice () const override
 
const std::string id () const override
 A string ID for the class. More...
 
 MDHistoWorkspaceTester (const MDHistoDimension_sptr &dimX, const MDHistoDimension_sptr &dimY, const MDHistoDimension_sptr &dimZ)
 
signal_t * mutableErrorSquaredArray () override
 
signal_t * mutableNumEventsArray () override
 
signal_t * mutableSignalArray () override
 
double & operator[] (const size_t &index) override
 
void setCoordinateSystem (const SpecialCoordinateSystem coordinateSystem) override
 
void setDisplayNormalization (const Mantid::API::MDNormalization &preferredNormalization) override
 
void setErrorSquaredAt (size_t index, signal_t value) override
 
void setMDMasking (std::unique_ptr< Mantid::Geometry::MDImplicitFunction > maskingRegion) override
 Setter for the masking region. More...
 
void setSignalAt (size_t index, signal_t value) override
 
void setTo (signal_t signal, signal_t errorSquared, signal_t numEvents) override
 
signal_t & signalAt (size_t index) override
 
bool threadSafe () const override
 Marks the workspace as safe for multiple threads to edit data simutaneously. More...
 
const std::string toString () const override
 Serializes the object to a string. More...
 
- Public Member Functions inherited from Mantid::API::IMDHistoWorkspace
IMDHistoWorkspace_uptr clone () const
 Returns a clone of the workspace. More...
 
IMDHistoWorkspace_uptr cloneEmpty () const
 Returns a default-initialized clone of the workspace. More...
 
virtual signal_terrorSquaredAt (size_t index)=0
 
virtual Mantid::Kernel::VMD getCenter (size_t linearIndex) const =0
 
virtual signal_t getErrorAt (size_t index) const =0
 
virtual signal_t getErrorAt (size_t index1, size_t index2) const =0
 
virtual signal_t getErrorAt (size_t index1, size_t index2, size_t index3) const =0
 
virtual signal_t getErrorAt (size_t index1, size_t index2, size_t index3, size_t index4) const =0
 
virtual signal_t getErrorNormalizedAt (size_t index) const =0
 
virtual signal_t getErrorNormalizedAt (size_t index1, size_t index2) const =0
 
virtual signal_t getErrorNormalizedAt (size_t index1, size_t index2, size_t index3) const =0
 
virtual signal_t getErrorNormalizedAt (size_t index1, size_t index2, size_t index3, size_t index4) const =0
 
virtual const signal_tgetErrorSquaredArray () const =0
 
virtual coord_t getInverseVolume () const =0
 See the MDHistoWorkspace definition for descriptions of these. More...
 
virtual size_t getLinearIndex (size_t index1, size_t index2) const =0
 
virtual size_t getLinearIndex (size_t index1, size_t index2, size_t index3) const =0
 
virtual size_t getLinearIndex (size_t index1, size_t index2, size_t index3, size_t index4) const =0
 
virtual LinePlot getLineData (const Mantid::Kernel::VMD &start, const Mantid::Kernel::VMD &end, Mantid::API::MDNormalization normalize) const =0
 
virtual const signal_tgetNumEventsArray () const =0
 
virtual const signal_tgetSignalArray () const =0
 
virtual signal_t getSignalAt (size_t index) const =0
 
virtual signal_t getSignalAt (size_t index1, size_t index2) const =0
 
virtual signal_t getSignalAt (size_t index1, size_t index2, size_t index3) const =0
 
virtual signal_t getSignalAt (size_t index1, size_t index2, size_t index3, size_t index4) const =0
 
virtual signal_t getSignalNormalizedAt (size_t index) const =0
 
virtual signal_t getSignalNormalizedAt (size_t index1, size_t index2) const =0
 
virtual signal_t getSignalNormalizedAt (size_t index1, size_t index2, size_t index3) const =0
 
virtual signal_t getSignalNormalizedAt (size_t index1, size_t index2, size_t index3, size_t index4) const =0
 
virtual bool hasOrientedLattice () const override
 
 IMDHistoWorkspace ()=default
 
virtual signal_tmutableErrorSquaredArray ()=0
 
virtual signal_tmutableNumEventsArray ()=0
 
virtual signal_tmutableSignalArray ()=0
 
IMDHistoWorkspaceoperator= (const IMDHistoWorkspace &)=delete
 
virtual double & operator[] (const size_t &index)=0
 
virtual void setCoordinateSystem (const Kernel::SpecialCoordinateSystem coordinateSystem)=0
 
virtual void setDisplayNormalization (const Mantid::API::MDNormalization &preferredNormalization)=0
 
virtual void setErrorSquaredAt (size_t index, signal_t value)=0
 
virtual void setSignalAt (size_t index, signal_t value)=0
 
virtual void setTo (signal_t signal, signal_t errorSquared, signal_t numEvents)=0
 
virtual signal_tsignalAt (size_t index)=0
 
- Public Member Functions inherited from Mantid::API::IMDWorkspace
std::string changeQConvention ()
 
virtual void clearFileBacked (bool)
 if a workspace was filebacked, this should clear file-based status, delete file-based information and close related files. More...
 
virtual void clearMDMasking ()=0
 Clear existing masks. More...
 
std::unique_ptr< IMDWorkspaceclone () const
 Returns a clone of the workspace. More...
 
std::unique_ptr< IMDWorkspacecloneEmpty () const
 Returns a default-initialized clone of the workspace. More...
 
std::unique_ptr< IMDIteratorcreateIterator (Mantid::Geometry::MDImplicitFunction *function=nullptr) const
 Creates a single iterator and returns it. More...
 
virtual std::vector< std::unique_ptr< IMDIterator > > createIterators (size_t suggestedNumCores=1, Mantid::Geometry::MDImplicitFunction *function=nullptr) const =0
 Creates a new iterator pointing to the first cell in the workspace. More...
 
virtual MDNormalization displayNormalization () const
 
virtual MDNormalization displayNormalizationHisto () const
 
std::string getConvention () const
 
virtual LinePlot getLinePlot (const Mantid::Kernel::VMD &start, const Mantid::Kernel::VMD &end, Mantid::API::MDNormalization normalize) const
 Method to generate a line plot through a MD-workspace. More...
 
virtual uint64_t getNEvents () const =0
 
virtual uint64_t getNPoints () const =0
 Get the number of points associated with the workspace. More...
 
virtual signal_t getSignalAtCoord (const coord_t *coords, const Mantid::API::MDNormalization &normalization) const =0
 Returns the (normalized) signal at a given coordinates. More...
 
signal_t getSignalAtVMD (const Mantid::Kernel::VMD &coords, const Mantid::API::MDNormalization &normalization=Mantid::API::VolumeNormalization) const
 Returns the signal (normalized by volume) at a given coordinates. More...
 
virtual signal_t getSignalWithMaskAtCoord (const coord_t *coords, const Mantid::API::MDNormalization &normalization) const =0
 Returns the (normalized) signal at a given coordinates or 0 if the value. More...
 
signal_t getSignalWithMaskAtVMD (const Mantid::Kernel::VMD &coords, const Mantid::API::MDNormalization &normalization=Mantid::API::VolumeNormalization) const
 Returns the signal (normalized by volume) at a given coordinates or 0 if masked. More...
 
virtual Kernel::SpecialCoordinateSystem getSpecialCoordinateSystem () const =0
 
virtual bool hasOrientedLattice () const =0
 
 IMDWorkspace (const Parallel::StorageMode storageMode=Parallel::StorageMode::Cloned)
 Default constructor. More...
 
virtual bool isMDHistoWorkspace () const
 
virtual ITableWorkspace_sptr makeBoxTable (size_t, size_t)
 this is the method to build table workspace from any workspace. More...
 
IMDWorkspaceoperator= (const IMDWorkspace &other)=delete
 
void setConvention (std::string convention)
 
virtual void setMDMasking (std::unique_ptr< Mantid::Geometry::MDImplicitFunction > maskingRegion)=0
 Setter for the masking region. More...
 
- Public Member Functions inherited from Mantid::API::Workspace
Workspace_uptr clone () const
 Returns a clone (copy) of the workspace with covariant return type in all derived classes. More...
 
Workspace_uptr cloneEmpty () const
 Returns a default-initialized clone of the workspace. More...
 
const std::string & getComment () const
 Get the workspace comment. More...
 
const WorkspaceHistorygetHistory () const
 Returns a reference to the WorkspaceHistory const. More...
 
virtual size_t getMemorySize () const =0
 Get the footprint in memory in bytes. More...
 
std::string getMemorySizeAsStr () const
 Returns the memory footprint in sensible units. More...
 
const std::string & getName () const override
 Get the workspace name. More...
 
virtual const std::string getTitle () const
 Get the workspace title. More...
 
WorkspaceHistoryhistory ()
 Returns a reference to the WorkspaceHistory. More...
 
bool isDirty (const int n=1) const
 Check whether other algorithms have been applied to the workspace by checking the history length. More...
 
virtual bool isGroup () const
 
Workspaceoperator= (const Workspace &other)=delete
 
void setComment (const std::string &)
 Set the comment field of the workspace. More...
 
virtual void setTitle (const std::string &)
 Set the title of the workspace. More...
 
Parallel::StorageMode storageMode () const
 Returns the storage mode (used for MPI runs) More...
 
bool threadSafe () const override
 Marks the workspace as safe for multiple threads to edit data simutaneously. More...
 
 Workspace (const Parallel::StorageMode storageMode=Parallel::StorageMode::Cloned)
 
 ~Workspace ()
 
- Public Member Functions inherited from Mantid::Kernel::DataItem
 DataItem ()
 Default constructor. More...
 
 DataItem (const DataItem &other)
 Copy constructor Always makes a unique lock. More...
 
virtual ~DataItem ()
 Destructor. More...
 
void readLock ()
 Acquires a read lock. More...
 
void unlock ()
 
- Public Member Functions inherited from Mantid::API::MDGeometry
void addDimension (const std::shared_ptr< Mantid::Geometry::IMDDimension > &dim)
 Add a dimension. More...
 
void addDimension (Mantid::Geometry::IMDDimension *dim)
 Add a dimension. More...
 
bool allBasisNormalized () const
 
void clearOriginalWorkspaces ()
 Clear original workspaces. More...
 
void clearTransforms ()
 Clear transforms. More...
 
virtual std::vector< coord_testimateResolution () const
 
Mantid::Kernel::VMDgetBasisVector (size_t index)
 Get the basis vector (in the original workspace) for a dimension of this workspace. More...
 
const Mantid::Kernel::VMDgetBasisVector (size_t index) const
 Get the basis vector (in the original workspace) for a dimension of this workspace. More...
 
virtual std::shared_ptr< const Mantid::Geometry::IMDDimensiongetDimension (size_t index) const
 Get a dimension. More...
 
size_t getDimensionIndexById (const std::string &id) const
 Get the index of the dimension that matches the ID given. More...
 
size_t getDimensionIndexByName (const std::string &name) const
 Get the index of the dimension that matches the name given. More...
 
virtual std::shared_ptr< const Mantid::Geometry::IMDDimensiongetDimensionWithId (std::string id) const
 Get a dimension. More...
 
std::string getGeometryXML () const
 
std::vector< std::shared_ptr< const Geometry::IMDDimension > > getNonIntegratedDimensions () const
 Get non-collapsed dimensions. More...
 
size_t getNumberTransformsFromOriginal () const
 Get the number of transforms defined from the original coordinate system. More...
 
size_t getNumberTransformsToOriginal () const
 Get the number of transforms defined to the original coordinate system. More...
 
virtual size_t getNumDims () const
 
virtual size_t getNumNonIntegratedDims () const
 
Mantid::Kernel::VMDgetOrigin ()
 
const Mantid::Kernel::VMDgetOrigin () const
 
std::shared_ptr< WorkspacegetOriginalWorkspace (size_t index=0) const
 Get the "original" workspace (the workspace that was the source for a binned MDWorkspace). More...
 
std::shared_ptr< const Mantid::Geometry::IMDDimensiongetTDimension () const
 Get the t-dimension mapping. More...
 
Mantid::API::CoordTransform const * getTransformFromOriginal (size_t index=0) const
 Get the Coordinate Transformation that goes from the original workspace to this workspace's coordinates. More...
 
Mantid::API::CoordTransform const * getTransformToOriginal (size_t index=0) const
 Get the Coordinate Transformation that goes from THIS workspace's coordinates to the ORIGINAL workspace's coordinates. More...
 
const Kernel::DblMatrixgetWTransf () const
 get the transformation from Qin crystal cartezian coordinate system to Q in orthogonal or real HKL coordiate system alined with arbitrary slicing plane More...
 
std::shared_ptr< const Mantid::Geometry::IMDDimensiongetXDimension () const
 Get the x-dimension mapping. More...
 
std::shared_ptr< const Mantid::Geometry::IMDDimensiongetYDimension () const
 Get the y-dimension mapping. More...
 
std::shared_ptr< const Mantid::Geometry::IMDDimensiongetZDimension () const
 Get the z-dimension mapping. More...
 
bool hasOriginalWorkspace (size_t index=0) const
 
void initGeometry (const std::vector< std::shared_ptr< Geometry::IMDDimension > > &dimensions)
 Initialize the geometry. More...
 
 MDGeometry ()
 Constructor. More...
 
 MDGeometry (const MDGeometry &other)
 Copy Constructor. More...
 
size_t numOriginalWorkspaces () const
 
MDGeometryoperator= (const MDGeometry &other)
 
void setBasisVector (size_t index, const Mantid::Kernel::VMD &vec)
 Set the basis vector (in the original workspace) for a dimension of this workspace. More...
 
void setOrigin (const Mantid::Kernel::VMD &orig)
 Sets the origin of this geometry. More...
 
void setOriginalWorkspace (std::shared_ptr< Workspace > ws, size_t index=0)
 Set the "original" workspace (the workspace that was the source for a binned MDWorkspace). More...
 
void setTransformFromOriginal (Mantid::API::CoordTransform *transform, size_t index=0)
 Sets the Coordinate Transformation that goes from the original workspace to this workspace's coordinates. More...
 
void setTransformToOriginal (Mantid::API::CoordTransform *transform, size_t index=0)
 Sets the Coordinate Transformation that goes from THIS workspace's coordinates to the ORIGINAL workspace's coordinates. More...
 
void setWTransf (const Kernel::DblMatrix &WTransf)
 set the transformation from Q in crystal cartezian coordinate system to Q in orthogonal or real HKL coordiate system alined with arbitrary slicing plane More...
 
void transformDimensions (std::vector< double > &scaling, std::vector< double > &offset)
 Transform the dimensions contained in this geometry x' = x*scaling + offset. More...
 
virtual ~MDGeometry ()
 Destructor. More...
 
- Public Member Functions inherited from Mantid::API::MultipleExperimentInfos
uint16_t addExperimentInfo (const ExperimentInfo_sptr &ei)
 Add a new ExperimentInfo to this MDEventWorkspace. More...
 
void copyExperimentInfos (const MultipleExperimentInfos &other)
 Copy the experiment infos from another. More...
 
ExperimentInfo_sptr getExperimentInfo (const uint16_t expInfoIndex)
 Get the ExperimentInfo for the given Experiment-Info Index. More...
 
ExperimentInfo_const_sptr getExperimentInfo (const uint16_t expInfoIndex) const
 Get the ExperimentInfo for the given Experiment-Info Index. More...
 
uint16_t getNumExperimentInfo () const
 
bool hasOrientedLattice () const
 
 MultipleExperimentInfos ()=default
 
 MultipleExperimentInfos (const MultipleExperimentInfos &other)
 Copy constructor. More...
 
MultipleExperimentInfosoperator= (const MultipleExperimentInfos &other)
 
void setExperimentInfo (const uint16_t expInfoIndex, ExperimentInfo_sptr ei)
 Replace the ExperimentInfo entry at a given place. More...
 
virtual ~MultipleExperimentInfos ()=default
 

Private Member Functions

IMDHistoWorkspacedoClone () const override
 Virtual clone method. Not implemented to force implementation in children. More...
 
IMDHistoWorkspacedoCloneEmpty () const override
 Virtual cloneEmpty method. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Mantid::API::IMDHistoWorkspace
 IMDHistoWorkspace (const IMDHistoWorkspace &)=default
 Protected copy constructor. May be used by childs for cloning. More...
 
const std::string toString () const override
 Serializes the object to a string. More...
 
- Protected Member Functions inherited from Mantid::API::IMDWorkspace
 IMDWorkspace (const IMDWorkspace &)=default
 Protected copy constructor. May be used by childs for cloning. More...
 
void makeSinglePointWithNaN (std::vector< coord_t > &x, std::vector< signal_t > &y, std::vector< signal_t > &e) const
 Make a single point with NaN as the signal and error This can be returned when there would otherwise be nothing to plot. More...
 
const std::string toString () const override
 Serializes the object to a string. More...
 
- Protected Member Functions inherited from Mantid::API::Workspace
void setStorageMode (Parallel::StorageMode mode)
 Sets the storage mode (used for MPI runs) More...
 
 Workspace (const Workspace &)
 Protected copy constructor. May be used by childs for cloning. More...
 
- Protected Member Functions inherited from Mantid::Kernel::DataItem
Poco::RWLock * getLock () const
 Private method to access the RWLock object. More...
 
- Protected Member Functions inherited from Mantid::API::MDGeometry
void deleteNotificationReceived (const std::shared_ptr< const Workspace > &deleted)
 Function called when observer objects recieves a notification. More...
 
- Protected Member Functions inherited from Mantid::API::MultipleExperimentInfos
const std::string toString () const
 Returns a string description of the object. More...
 
- Protected Attributes inherited from Mantid::API::MDGeometry
std::vector< Mantid::Kernel::VMDm_basisVectors
 Vector of the basis vector (in the original workspace) for each dimension of this workspace. More...
 
std::vector< std::shared_ptr< Geometry::IMDDimension > > m_dimensions
 Vector of the dimensions used, in the order X Y Z t, etc. More...
 
std::unique_ptr< MDGeometryNotificationHelperm_notificationHelper
 Helper that deals with notifications and observing the ADS. More...
 
Mantid::Kernel::VMD m_origin
 Vector of the origin (in the original workspace) that corresponds to 0,0,0... in this workspace. More...
 
std::vector< std::shared_ptr< Workspace > > m_originalWorkspaces
 Pointer to the original workspace(s), if this workspace is a coordinate transformation from an original workspace. More...
 
std::vector< std::shared_ptr< const Mantid::API::CoordTransform > > m_transforms_FromOriginal
 Coordinate Transformation that goes from the original workspace to this workspace's coordinates. More...
 
std::vector< std::shared_ptr< const Mantid::API::CoordTransform > > m_transforms_ToOriginal
 Coordinate Transformation that goes from this workspace's coordinates to the original workspace coordinates. More...
 
Kernel::DblMatrix m_Wtransf
 the matrix which transforms momentums from orthogonal Q-system to Orthogonal HKL or non-orthogonal HKL system alighned WRT to arbitrary coordinate system requested See the UB matrix formalizm, pg 7 for further details on implementation. More...
 

Detailed Description

Definition at line 367 of file FakeObjects.h.

Constructor & Destructor Documentation

◆ MDHistoWorkspaceTester()

MDHistoWorkspaceTester::MDHistoWorkspaceTester ( const MDHistoDimension_sptr dimX,
const MDHistoDimension_sptr dimY,
const MDHistoDimension_sptr dimZ 
)
inline

Definition at line 608 of file FakeObjects.h.

References Mantid::API::MDGeometry::initGeometry().

Member Function Documentation

◆ clearMDMasking()

void MDHistoWorkspaceTester::clearMDMasking ( )
inlineoverridevirtual

Clear existing masks.

Implements Mantid::API::IMDWorkspace.

Definition at line 399 of file FakeObjects.h.

◆ createIterators()

std::vector< std::unique_ptr< IMDIterator > > MDHistoWorkspaceTester::createIterators ( size_t  suggestedNumCores = 1,
Mantid::Geometry::MDImplicitFunction function = nullptr 
) const
inlineoverridevirtual

Creates a new iterator pointing to the first cell in the workspace.

Implements Mantid::API::IMDWorkspace.

Definition at line 374 of file FakeObjects.h.

References UNUSED_ARG.

◆ doClone()

IMDHistoWorkspace * MDHistoWorkspaceTester::doClone ( ) const
inlineoverrideprivatevirtual

Virtual clone method. Not implemented to force implementation in children.

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 615 of file FakeObjects.h.

◆ doCloneEmpty()

IMDHistoWorkspace * MDHistoWorkspaceTester::doCloneEmpty ( ) const
inlineoverrideprivatevirtual

Virtual cloneEmpty method.

Not implemented to force implementation in children.

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 616 of file FakeObjects.h.

◆ errorSquaredAt()

signal_t & MDHistoWorkspaceTester::errorSquaredAt ( size_t  index)
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 545 of file FakeObjects.h.

References index, and UNUSED_ARG.

◆ getCenter()

Mantid::Kernel::VMD MDHistoWorkspaceTester::getCenter ( size_t  linearIndex) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 424 of file FakeObjects.h.

References UNUSED_ARG.

◆ getErrorAt() [1/4]

signal_t MDHistoWorkspaceTester::getErrorAt ( size_t  index) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 441 of file FakeObjects.h.

References index, and UNUSED_ARG.

◆ getErrorAt() [2/4]

signal_t MDHistoWorkspaceTester::getErrorAt ( size_t  index1,
size_t  index2 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 446 of file FakeObjects.h.

References UNUSED_ARG.

◆ getErrorAt() [3/4]

signal_t MDHistoWorkspaceTester::getErrorAt ( size_t  index1,
size_t  index2,
size_t  index3 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 452 of file FakeObjects.h.

References UNUSED_ARG.

◆ getErrorAt() [4/4]

signal_t MDHistoWorkspaceTester::getErrorAt ( size_t  index1,
size_t  index2,
size_t  index3,
size_t  index4 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 459 of file FakeObjects.h.

References UNUSED_ARG.

◆ getErrorNormalizedAt() [1/4]

signal_t MDHistoWorkspaceTester::getErrorNormalizedAt ( size_t  index) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 519 of file FakeObjects.h.

References index, and UNUSED_ARG.

◆ getErrorNormalizedAt() [2/4]

signal_t MDHistoWorkspaceTester::getErrorNormalizedAt ( size_t  index1,
size_t  index2 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 524 of file FakeObjects.h.

References UNUSED_ARG.

◆ getErrorNormalizedAt() [3/4]

signal_t MDHistoWorkspaceTester::getErrorNormalizedAt ( size_t  index1,
size_t  index2,
size_t  index3 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 530 of file FakeObjects.h.

References UNUSED_ARG.

◆ getErrorNormalizedAt() [4/4]

signal_t MDHistoWorkspaceTester::getErrorNormalizedAt ( size_t  index1,
size_t  index2,
size_t  index3,
size_t  index4 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 537 of file FakeObjects.h.

References UNUSED_ARG.

◆ getErrorSquaredArray()

const signal_t * MDHistoWorkspaceTester::getErrorSquaredArray ( ) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 407 of file FakeObjects.h.

◆ getInverseVolume()

coord_t MDHistoWorkspaceTester::getInverseVolume ( ) const
inlineoverridevirtual

See the MDHistoWorkspace definition for descriptions of these.

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 403 of file FakeObjects.h.

◆ getLinearIndex() [1/3]

size_t MDHistoWorkspaceTester::getLinearIndex ( size_t  index1,
size_t  index2 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 555 of file FakeObjects.h.

References UNUSED_ARG.

◆ getLinearIndex() [2/3]

size_t MDHistoWorkspaceTester::getLinearIndex ( size_t  index1,
size_t  index2,
size_t  index3 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 561 of file FakeObjects.h.

References UNUSED_ARG.

◆ getLinearIndex() [3/3]

size_t MDHistoWorkspaceTester::getLinearIndex ( size_t  index1,
size_t  index2,
size_t  index3,
size_t  index4 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 568 of file FakeObjects.h.

References UNUSED_ARG.

◆ getLineData()

LinePlot MDHistoWorkspaceTester::getLineData ( const Mantid::Kernel::VMD start,
const Mantid::Kernel::VMD end,
Mantid::API::MDNormalization  normalize 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 576 of file FakeObjects.h.

References Mantid::Kernel::normalize(), and UNUSED_ARG.

◆ getMemorySize()

size_t MDHistoWorkspaceTester::getMemorySize ( ) const
inlineoverridevirtual

Get the footprint in memory in bytes.

Implements Mantid::API::Workspace.

Definition at line 602 of file FakeObjects.h.

◆ getName()

const std::string & MDHistoWorkspaceTester::getName ( ) const
inlineoverridevirtual

Get the workspace name.

Returns
The name

Reimplemented from Mantid::API::Workspace.

Definition at line 605 of file FakeObjects.h.

◆ getNEvents()

uint64_t MDHistoWorkspaceTester::getNEvents ( ) const
inlineoverridevirtual

Implements Mantid::API::IMDWorkspace.

Definition at line 371 of file FakeObjects.h.

◆ getNPoints()

uint64_t MDHistoWorkspaceTester::getNPoints ( ) const
inlineoverridevirtual

Get the number of points associated with the workspace.

For MDEvenWorkspace it is the number of events contributing into the workspace For regularly gridded workspace (MDHistoWorkspace and MatrixWorkspace), it is the number of bins.

Implements Mantid::API::IMDWorkspace.

Definition at line 370 of file FakeObjects.h.

◆ getNumEventsArray()

const signal_t * MDHistoWorkspaceTester::getNumEventsArray ( ) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 409 of file FakeObjects.h.

◆ getSignalArray()

const signal_t * MDHistoWorkspaceTester::getSignalArray ( ) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 405 of file FakeObjects.h.

◆ getSignalAt() [1/4]

signal_t MDHistoWorkspaceTester::getSignalAt ( size_t  index) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 467 of file FakeObjects.h.

References index, and UNUSED_ARG.

◆ getSignalAt() [2/4]

signal_t MDHistoWorkspaceTester::getSignalAt ( size_t  index1,
size_t  index2 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 472 of file FakeObjects.h.

References UNUSED_ARG.

◆ getSignalAt() [3/4]

signal_t MDHistoWorkspaceTester::getSignalAt ( size_t  index1,
size_t  index2,
size_t  index3 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 478 of file FakeObjects.h.

References UNUSED_ARG.

◆ getSignalAt() [4/4]

signal_t MDHistoWorkspaceTester::getSignalAt ( size_t  index1,
size_t  index2,
size_t  index3,
size_t  index4 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 485 of file FakeObjects.h.

References UNUSED_ARG.

◆ getSignalAtCoord()

signal_t MDHistoWorkspaceTester::getSignalAtCoord ( const coord_t *  coords,
const Mantid::API::MDNormalization normalization 
) const
inlineoverride

Definition at line 381 of file FakeObjects.h.

References UNUSED_ARG.

◆ getSignalNormalizedAt() [1/4]

signal_t MDHistoWorkspaceTester::getSignalNormalizedAt ( size_t  index) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 493 of file FakeObjects.h.

References index, and UNUSED_ARG.

◆ getSignalNormalizedAt() [2/4]

signal_t MDHistoWorkspaceTester::getSignalNormalizedAt ( size_t  index1,
size_t  index2 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 498 of file FakeObjects.h.

References UNUSED_ARG.

◆ getSignalNormalizedAt() [3/4]

signal_t MDHistoWorkspaceTester::getSignalNormalizedAt ( size_t  index1,
size_t  index2,
size_t  index3 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 504 of file FakeObjects.h.

References UNUSED_ARG.

◆ getSignalNormalizedAt() [4/4]

signal_t MDHistoWorkspaceTester::getSignalNormalizedAt ( size_t  index1,
size_t  index2,
size_t  index3,
size_t  index4 
) const
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 511 of file FakeObjects.h.

References UNUSED_ARG.

◆ getSignalWithMaskAtCoord()

signal_t MDHistoWorkspaceTester::getSignalWithMaskAtCoord ( const coord_t *  coords,
const Mantid::API::MDNormalization normalization 
) const
inlineoverride

Definition at line 387 of file FakeObjects.h.

References UNUSED_ARG.

◆ getSpecialCoordinateSystem()

SpecialCoordinateSystem MDHistoWorkspaceTester::getSpecialCoordinateSystem ( ) const
inlineoverridevirtual

Implements Mantid::API::IMDWorkspace.

Definition at line 401 of file FakeObjects.h.

◆ hasOrientedLattice()

bool MDHistoWorkspaceTester::hasOrientedLattice ( ) const
inlineoverridevirtual

◆ id()

const std::string MDHistoWorkspaceTester::id ( ) const
inlineoverridevirtual

A string ID for the class.

Implements Mantid::Kernel::DataItem.

Definition at line 604 of file FakeObjects.h.

◆ mutableErrorSquaredArray()

signal_t * MDHistoWorkspaceTester::mutableErrorSquaredArray ( )
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 413 of file FakeObjects.h.

◆ mutableNumEventsArray()

signal_t * MDHistoWorkspaceTester::mutableNumEventsArray ( )
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 415 of file FakeObjects.h.

◆ mutableSignalArray()

signal_t * MDHistoWorkspaceTester::mutableSignalArray ( )
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 411 of file FakeObjects.h.

◆ operator[]()

double & MDHistoWorkspaceTester::operator[] ( const size_t &  index)
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 584 of file FakeObjects.h.

References index, and UNUSED_ARG.

◆ setCoordinateSystem()

void MDHistoWorkspaceTester::setCoordinateSystem ( const SpecialCoordinateSystem  coordinateSystem)
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 589 of file FakeObjects.h.

References UNUSED_ARG.

◆ setDisplayNormalization()

void MDHistoWorkspaceTester::setDisplayNormalization ( const Mantid::API::MDNormalization preferredNormalization)
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 594 of file FakeObjects.h.

References UNUSED_ARG.

◆ setErrorSquaredAt()

void MDHistoWorkspaceTester::setErrorSquaredAt ( size_t  index,
signal_t  value 
)
inlineoverride

Definition at line 435 of file FakeObjects.h.

References index, UNUSED_ARG, and value.

◆ setMDMasking()

void MDHistoWorkspaceTester::setMDMasking ( std::unique_ptr< Mantid::Geometry::MDImplicitFunction maskingRegion)
inlineoverridevirtual

Setter for the masking region.

Implements Mantid::API::IMDWorkspace.

Definition at line 394 of file FakeObjects.h.

References UNUSED_ARG.

◆ setSignalAt()

void MDHistoWorkspaceTester::setSignalAt ( size_t  index,
signal_t  value 
)
inlineoverride

Definition at line 429 of file FakeObjects.h.

References index, UNUSED_ARG, and value.

◆ setTo()

void MDHistoWorkspaceTester::setTo ( signal_t  signal,
signal_t  errorSquared,
signal_t  numEvents 
)
inlineoverride

Definition at line 417 of file FakeObjects.h.

References UNUSED_ARG.

◆ signalAt()

signal_t & MDHistoWorkspaceTester::signalAt ( size_t  index)
inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 550 of file FakeObjects.h.

References index, and UNUSED_ARG.

◆ threadSafe()

bool MDHistoWorkspaceTester::threadSafe ( ) const
inlineoverridevirtual

Marks the workspace as safe for multiple threads to edit data simutaneously.

Workspace creation is always considered to be a single threaded operation.

Returns
true if the workspace is suitable for multithreaded operations, otherwise false.

Reimplemented from Mantid::API::Workspace.

Definition at line 606 of file FakeObjects.h.

◆ toString()

const std::string MDHistoWorkspaceTester::toString ( ) const
inlineoverridevirtual

Serializes the object to a string.

Reimplemented from Mantid::API::IMDHistoWorkspace.

Definition at line 607 of file FakeObjects.h.


The documentation for this class was generated from the following file: