#include <FakeObjects.h>

Inheritance diagram for MDHistoWorkspaceTester:

Public Member Functions
void	clearMDMasking () override
	Clear existing masks.

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.

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.

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.

const std::string &	getName () const override
	Get the workspace name.

uint64_t	getNEvents () const override

uint64_t	getNPoints () const override
	Get the number of points associated with the workspace.

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

const std::string	id () const override
	A string ID for the class.

	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.

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.

const std::string	toString () const override
	Serializes the object to a string.

Public Member Functions inherited from Mantid::API::IMDHistoWorkspace
IMDHistoWorkspace_uptr	clone () const
	Returns a clone of the workspace.

IMDHistoWorkspace_uptr	cloneEmpty () const
	Returns a default-initialized clone of the workspace.

virtual bool	hasOrientedLattice () const override

	IMDHistoWorkspace ()=default

IMDHistoWorkspace &	operator= (const IMDHistoWorkspace &)=delete

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

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.

std::unique_ptr< IMDWorkspace >	clone () const
	Returns a clone of the workspace.

std::unique_ptr< IMDWorkspace >	cloneEmpty () const
	Returns a default-initialized clone of the workspace.

std::unique_ptr< IMDIterator >	createIterator (Mantid::Geometry::MDImplicitFunction *function=nullptr) const
	Creates a single iterator and returns it.

virtual MDNormalization	displayNormalization () const

virtual MDNormalization	displayNormalizationHisto () const

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.

virtual signal_t	getSignalAtCoord (const coord_t *coords, const Mantid::API::MDNormalization &normalization) const =0
	Returns the (normalized) signal at a given coordinates.

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.

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.

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.

	IMDWorkspace ()
	Default constructor.

virtual bool	isMDHistoWorkspace () const

virtual ITableWorkspace_sptr	makeBoxTable (size_t, size_t)
	this is the method to build table workspace from any workspace.

IMDWorkspace &	operator= (const IMDWorkspace &other)=delete

void	setConvention (std::string convention)
	Sets the convention of the workspace.

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.

Workspace_uptr	cloneEmpty () const
	Returns a default-initialized clone of the workspace.

const std::string &	getComment () const
	Get the workspace comment.

const WorkspaceHistory &	getHistory () const
	Returns a reference to the WorkspaceHistory const.

std::string	getMemorySizeAsStr () const
	Returns the memory footprint in sensible units.

const std::string &	getPythonVariableName () const

virtual const std::string	getTitle () const
	Get the workspace title.

WorkspaceHistory &	history ()
	Returns a reference to the WorkspaceHistory.

bool	isDirty (const int n=1) const
	Check whether other algorithms have been applied to the workspace by checking the history length.

virtual bool	isGroup () const

Workspace &	operator= (const Workspace &other)=delete

void	setComment (const std::string &)
	Set the comment field of the workspace.

void	setPythonVariableName (const std::string &)

virtual void	setTitle (const std::string &)
	Set the title of the workspace.

	Workspace ()

	~Workspace ()

Public Member Functions inherited from Mantid::Kernel::DataItem
	DataItem ()
	Default constructor.

	DataItem (const DataItem &other)
	Copy constructor Always makes a unique lock.

virtual	~DataItem ()
	Destructor.

void	readLock ()
	Acquires a read lock.

void	unlock ()

Public Member Functions inherited from Mantid::API::MDGeometry
void	addDimension (const std::shared_ptr< Mantid::Geometry::IMDDimension > &dim)
	Add a dimension.

void	addDimension (Mantid::Geometry::IMDDimension *dim)
	Add a dimension.

bool	allBasisNormalized () const

void	clearOriginalWorkspaces ()
	Clear original workspaces.

void	clearTransforms ()
	Clear transforms.

virtual std::vector< coord_t >	estimateResolution () const

Mantid::Kernel::VMD &	getBasisVector (size_t index)
	Get the basis vector (in the original workspace) for a dimension of this workspace.

const Mantid::Kernel::VMD &	getBasisVector (size_t index) const
	Get the basis vector (in the original workspace) for a dimension of this workspace.

virtual std::shared_ptr< const Mantid::Geometry::IMDDimension >	getDimension (size_t index) const
	Get a dimension.

size_t	getDimensionIndexById (const std::string &id) const
	Get the index of the dimension that matches the ID given.

size_t	getDimensionIndexByName (const std::string &name) const
	Get the index of the dimension that matches the name given.

virtual std::shared_ptr< const Mantid::Geometry::IMDDimension >	getDimensionWithId (std::string id) const
	Get a dimension.

std::string	getGeometryXML () const

std::vector< std::shared_ptr< const Geometry::IMDDimension > >	getNonIntegratedDimensions () const
	Get non-collapsed dimensions.

size_t	getNumberTransformsFromOriginal () const
	Get the number of transforms defined from the original coordinate system.

size_t	getNumberTransformsToOriginal () const
	Get the number of transforms defined to the original coordinate system.

virtual size_t	getNumDims () const

virtual size_t	getNumNonIntegratedDims () const

Mantid::Kernel::VMD &	getOrigin ()

const Mantid::Kernel::VMD &	getOrigin () const

std::shared_ptr< Workspace >	getOriginalWorkspace (size_t index=0) const
	Get the "original" workspace (the workspace that was the source for a binned MDWorkspace).

std::shared_ptr< const Mantid::Geometry::IMDDimension >	getTDimension () const
	Get the t-dimension mapping.

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.

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.

const Kernel::DblMatrix &	getWTransf () const
	get the transformation from Qin crystal cartezian coordinate system to Q in orthogonal or real HKL coordiate system alined with arbitrary slicing plane

std::shared_ptr< const Mantid::Geometry::IMDDimension >	getXDimension () const
	Get the x-dimension mapping.

std::shared_ptr< const Mantid::Geometry::IMDDimension >	getYDimension () const
	Get the y-dimension mapping.

std::shared_ptr< const Mantid::Geometry::IMDDimension >	getZDimension () const
	Get the z-dimension mapping.

bool	hasOriginalWorkspace (size_t index=0) const

void	initGeometry (const std::vector< std::shared_ptr< Geometry::IMDDimension > > &dimensions)
	Initialize the geometry.

	MDGeometry ()
	Constructor.

	MDGeometry (const MDGeometry &other)
	Copy Constructor.

size_t	numOriginalWorkspaces () const

MDGeometry &	operator= (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.

void	setOrigin (const Mantid::Kernel::VMD &orig)
	Sets the origin of this geometry.

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).

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.

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.

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

void	transformDimensions (std::vector< double > const &scaling, std::vector< double > const &offset)
	Transform the dimensions contained in this geometry x' = x*scaling + offset.

virtual	~MDGeometry ()
	Destructor.

Public Member Functions inherited from Mantid::API::MultipleExperimentInfos
uint16_t	addExperimentInfo (const ExperimentInfo_sptr &ei)
	Add a new ExperimentInfo to this MDEventWorkspace.

void	copyExperimentInfos (const MultipleExperimentInfos &other)
	Copy the experiment infos from another.

ExperimentInfo_sptr	getExperimentInfo (const uint16_t expInfoIndex)
	Get the ExperimentInfo for the given Experiment-Info Index.

ExperimentInfo_const_sptr	getExperimentInfo (const uint16_t expInfoIndex) const
	Get the ExperimentInfo for the given Experiment-Info Index.

uint16_t	getNumExperimentInfo () const

bool	hasOrientedLattice () const

	MultipleExperimentInfos ()=default

	MultipleExperimentInfos (const MultipleExperimentInfos &other)
	Copy constructor.

MultipleExperimentInfos &	operator= (const MultipleExperimentInfos &other)

void	setExperimentInfo (const uint16_t expInfoIndex, ExperimentInfo_sptr ei)
	Replace the ExperimentInfo entry at a given place.

virtual	~MultipleExperimentInfos ()=default

Private Member Functions
IMDHistoWorkspace *	doClone () const override
	Virtual clone method. Not implemented to force implementation in children.

IMDHistoWorkspace *	doCloneEmpty () const override
	Virtual cloneEmpty method.

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.

Protected Member Functions inherited from Mantid::API::IMDWorkspace
	IMDWorkspace (const IMDWorkspace &)=default
	Protected copy constructor. May be used by childs for cloning.

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.

Protected Member Functions inherited from Mantid::API::Workspace
	Workspace (const Workspace &)
	Protected copy constructor. May be used by childs for cloning.

Protected Member Functions inherited from Mantid::Kernel::DataItem
Poco::RWLock *	getLock () const
	Private method to access the RWLock object.

Protected Member Functions inherited from Mantid::API::MDGeometry
void	deleteNotificationReceived (const std::shared_ptr< const Workspace > &replaced)
	Function called when observer objects recieves a notification.

void	replaceNotificationReceived (const std::shared_ptr< const Workspace > &deleted)
	Function called when observer detects a workspace is replaced.

Protected Member Functions inherited from Mantid::API::MultipleExperimentInfos
const std::string	toString () const
	Returns a string description of the object.

Protected Attributes inherited from Mantid::API::MDGeometry
std::vector< Mantid::Kernel::VMD >	m_basisVectors
	Vector of the basis vector (in the original workspace) for each dimension of this workspace.

std::vector< std::shared_ptr< Geometry::IMDDimension > >	m_dimensions
	Vector of the dimensions used, in the order X Y Z t, etc.

std::unique_ptr< MDGeometryNotificationHelper >	m_notificationHelper
	Helper that deals with notifications and observing the ADS.

Mantid::Kernel::VMD	m_origin
	Vector of the origin (in the original workspace) that corresponds to 0,0,0... in this workspace.

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.

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.

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.

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.

Detailed Description

Definition at line 363 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 601 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 395 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 370 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 608 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 609 of file FakeObjects.h.

◆ errorSquaredAt()

signal_t & MDHistoWorkspaceTester::errorSquaredAt ( size_t index )

inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 541 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 420 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 437 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 442 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 448 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 455 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 515 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 520 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 526 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 533 of file FakeObjects.h.

References UNUSED_ARG.

◆ getErrorSquaredArray()

const signal_t * MDHistoWorkspaceTester::getErrorSquaredArray ( ) const

inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 403 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 399 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 551 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 557 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 564 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 572 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 595 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 598 of file FakeObjects.h.

◆ getNEvents()

uint64_t MDHistoWorkspaceTester::getNEvents ( ) const

inlineoverridevirtual

Implements Mantid::API::IMDWorkspace.

Definition at line 367 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 366 of file FakeObjects.h.

◆ getNumEventsArray()

const signal_t * MDHistoWorkspaceTester::getNumEventsArray ( ) const

inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 405 of file FakeObjects.h.

◆ getSignalArray()

const signal_t * MDHistoWorkspaceTester::getSignalArray ( ) const

inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 401 of file FakeObjects.h.

◆ getSignalAt() [1/4]

signal_t MDHistoWorkspaceTester::getSignalAt ( size_t index ) const

inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 463 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 468 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 474 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 481 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 377 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 489 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 494 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 500 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 507 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 383 of file FakeObjects.h.

References UNUSED_ARG.

◆ getSpecialCoordinateSystem()

SpecialCoordinateSystem MDHistoWorkspaceTester::getSpecialCoordinateSystem ( ) const

inlineoverridevirtual

Implements Mantid::API::IMDWorkspace.

Definition at line 397 of file FakeObjects.h.

◆ id()

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

inlineoverridevirtual

A string ID for the class.

Implements Mantid::Kernel::DataItem.

Definition at line 597 of file FakeObjects.h.

◆ mutableErrorSquaredArray()

signal_t * MDHistoWorkspaceTester::mutableErrorSquaredArray ( )

inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 409 of file FakeObjects.h.

◆ mutableNumEventsArray()

signal_t * MDHistoWorkspaceTester::mutableNumEventsArray ( )

inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 411 of file FakeObjects.h.

◆ mutableSignalArray()

signal_t * MDHistoWorkspaceTester::mutableSignalArray ( )

inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 407 of file FakeObjects.h.

◆ operator[]()

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

inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 580 of file FakeObjects.h.

References index, and UNUSED_ARG.

◆ setCoordinateSystem()

void MDHistoWorkspaceTester::setCoordinateSystem ( const SpecialCoordinateSystem coordinateSystem )

inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 585 of file FakeObjects.h.

References UNUSED_ARG.

◆ setDisplayNormalization()

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

inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 590 of file FakeObjects.h.

References UNUSED_ARG.

◆ setErrorSquaredAt()

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

inlineoverride

Definition at line 431 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 390 of file FakeObjects.h.

References UNUSED_ARG.

◆ setSignalAt()

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

inlineoverride

Definition at line 425 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 413 of file FakeObjects.h.

References UNUSED_ARG.

◆ signalAt()

signal_t & MDHistoWorkspaceTester::signalAt ( size_t index )

inlineoverridevirtual

Implements Mantid::API::IMDHistoWorkspace.

Definition at line 546 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 599 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 600 of file FakeObjects.h.

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

Framework/TestHelpers/inc/MantidFrameworkTestHelpers/FakeObjects.h

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MDHistoWorkspaceTester()

Member Function Documentation

◆ clearMDMasking()

◆ createIterators()

◆ doClone()

◆ doCloneEmpty()

◆ errorSquaredAt()

◆ getCenter()

◆ getErrorAt() [1/4]

◆ getErrorAt() [2/4]

◆ getErrorAt() [3/4]

◆ getErrorAt() [4/4]

◆ getErrorNormalizedAt() [1/4]

◆ getErrorNormalizedAt() [2/4]

◆ getErrorNormalizedAt() [3/4]

◆ getErrorNormalizedAt() [4/4]

◆ getErrorSquaredArray()

◆ getInverseVolume()

◆ getLinearIndex() [1/3]

◆ getLinearIndex() [2/3]

◆ getLinearIndex() [3/3]

◆ getLineData()

◆ getMemorySize()

◆ getName()

◆ getNEvents()

◆ getNPoints()

◆ getNumEventsArray()

◆ getSignalArray()

◆ getSignalAt() [1/4]

◆ getSignalAt() [2/4]

◆ getSignalAt() [3/4]

◆ getSignalAt() [4/4]

◆ getSignalAtCoord()

◆ getSignalNormalizedAt() [1/4]

◆ getSignalNormalizedAt() [2/4]

◆ getSignalNormalizedAt() [3/4]

◆ getSignalNormalizedAt() [4/4]

◆ getSignalWithMaskAtCoord()

◆ getSpecialCoordinateSystem()

◆ id()

◆ mutableErrorSquaredArray()

◆ mutableNumEventsArray()

◆ mutableSignalArray()

◆ operator[]()

◆ setCoordinateSystem()

◆ setDisplayNormalization()

◆ setErrorSquaredAt()

◆ setMDMasking()

◆ setSignalAt()

◆ setTo()

◆ signalAt()

◆ threadSafe()

◆ toString()