An implementation of IMDIterator that iterates through a MDHistoWorkspace. More...

#include <MDHistoWorkspaceIterator.h>

Inheritance diagram for Mantid::DataObjects::MDHistoWorkspaceIterator:

Public Member Functions
std::vector< size_t >	findNeighbourIndexes () const override
	Gets indexes of bins/pixels/boxes neighbouring the present iterator location. More...

std::vector< size_t >	findNeighbourIndexesByWidth (const int &width) const
	Find vertex-touching neighbours. More...

std::vector< size_t >	findNeighbourIndexesByWidth (const std::vector< int > &widths) const
	Find vertex-touching neighbours. More...

std::pair< std::vector< size_t >, std::vector< bool > >	findNeighbourIndexesByWidth1D (const int &width, const int &width_dimension) const
	Find vertex-touching neighbours. More...

std::vector< size_t >	findNeighbourIndexesFaceTouching () const override
	Find neighbor indexes, but only return those that are face-touching. More...

VecMDExtents	getBoxExtents () const
	Get the extents in n-dimensions corresponding to the position of the box of the current iterator. More...

Mantid::Kernel::VMD	getCenter () const override
	Returns the position of the center of the box pointed to. More...

size_t	getDataSize () const override

signal_t	getError () const override
	Returns the error for this box, same as innerError. More...

int32_t	getInnerDetectorID (size_t index) const override
	For a given event/point in this box, return the detector ID. More...

signal_t	getInnerError (size_t index) const override
	Returns the error of a given event. More...

uint16_t	getInnerExpInfoIndex (size_t index) const override
	For a given event/point in this box, return the associated experiment-info index. More...

uint16_t	getInnerGoniometerIndex (size_t index) const override
	For a given event/point in this box, return the goniometer index. More...

coord_t	getInnerPosition (size_t index, size_t dimension) const override
	Returns the position of a given event for a given dimension. More...

signal_t	getInnerSignal (size_t index) const override
	Returns the signal of a given event. More...

bool	getIsMasked () const override
	Returns true if masking is used. More...

size_t	getLinearIndex () const override
	Getter for the linear index. More...

signal_t	getNormalizedError () const override
	Returns the normalized error for this box. More...

signal_t	getNormalizedSignal () const override
	Returns the normalized signal for this box. More...

size_t	getNumEvents () const override
	Returns the number of events/points contained in this box. More...

virtual signal_t	getNumEventsFraction () const
	Returns the number of events/points contained in this box. More...

signal_t	getSignal () const override
	Returns the signal for this box, same as innerSignal. More...

std::unique_ptr< coord_t[]>	getVertexesArray (size_t &numVertices) const override
	Return a list of vertexes defining the volume pointed to. More...

std::unique_ptr< coord_t[]>	getVertexesArray (size_t &numVertices, const size_t outDimensions, const bool *maskDim) const override
	Return a list of vertexes defining the volume pointed to, enable masking of dimensions. More...

void	init (const MDHistoWorkspace workspace, Mantid::Geometry::MDImplicitFunction function, size_t beginPos=0, size_t endPos=size_t(-1))
	Constructor helper. More...

bool	isWithinBounds (size_t index) const override

void	jumpTo (size_t index) override
	Jump to the index^th cell. More...

virtual coord_t	jumpToNearest (const Mantid::Kernel::VMD &fromLocation)
	Jump the iterator to the nearest valid position correspoinding to the centre current position of the desired iterator position. More...

	MDHistoWorkspaceIterator (const MDHistoWorkspace workspace, Mantid::Geometry::MDImplicitFunction function=nullptr, size_t beginPos=0, size_t endPos=size_t(-1))
	Constructor. More...

	MDHistoWorkspaceIterator (const MDHistoWorkspace workspace, SkippingPolicy skippingPolicy, Mantid::Geometry::MDImplicitFunction *function=nullptr, size_t beginPos=0, size_t endPos=size_t(-1))
	Constructor. More...

	MDHistoWorkspaceIterator (const MDHistoWorkspace_const_sptr &workspace, Mantid::Geometry::MDImplicitFunction *function=nullptr, size_t beginPos=0, size_t endPos=size_t(-1))
	Constructor. More...

	MDHistoWorkspaceIterator (const MDHistoWorkspace_const_sptr &workspace, SkippingPolicy skippingPolicy, Mantid::Geometry::MDImplicitFunction function=nullptr, size_t beginPos=0, size_t endPos=size_t(-1))
	Constructor. More...

bool	next () override
	Advance to the next cell. More...

bool	next (size_t skip) override
	Advance, skipping a certain number of cells. More...

size_t	permutationCacheSize () const

bool	valid () const override

	~MDHistoWorkspaceIterator () override
	Destructor. More...

Public Member Functions inherited from Mantid::API::IMDIterator
virtual std::vector< size_t >	findNeighbourIndexes () const =0
	Find neighbouring indexes vertex touching. More...

virtual std::vector< size_t >	findNeighbourIndexesFaceTouching () const =0
	Find neighbouring indexes face touching. More...

virtual Mantid::Kernel::VMD	getCenter () const =0
	Returns the position of the center of the box pointed to. More...

virtual size_t	getDataSize () const =0
	Get the size of the data (number of entries that will be iterated through) More...

virtual signal_t	getError () const =0
	Returns the total error for this box. More...

virtual int32_t	getInnerDetectorID (size_t index) const =0
	For a given event/point in this box, return the detector ID. More...

virtual signal_t	getInnerError (size_t index) const =0
	Returns the error of a given event. More...

virtual uint16_t	getInnerExpInfoIndex (size_t index) const =0
	For a given event/point in this box, return the associated experiment-info index. More...

virtual uint16_t	getInnerGoniometerIndex (size_t index) const =0
	For a given event/point in this box, return the goniometer index. More...

virtual coord_t	getInnerPosition (size_t index, size_t dimension) const =0
	Returns the position of a given event for a given dimension. More...

virtual signal_t	getInnerSignal (size_t index) const =0
	Returns the signal of a given event. More...

virtual bool	getIsMasked () const =0
	Returns true if masking is used. More...

virtual size_t	getLinearIndex () const =0
	Get the linear index. More...

Mantid::API::MDNormalization	getNormalization () const

virtual signal_t	getNormalizedError () const =0
	Returns the normalized error for this box. More...

virtual signal_t	getNormalizedSignal () const =0
	Returns the normalized signal for this box. More...

virtual size_t	getNumEvents () const =0
	Returns the number of events/points contained in this box. More...

virtual signal_t	getSignal () const =0
	Returns the total signal for this box. More...

virtual std::unique_ptr< coord_t[]>	getVertexesArray (size_t &numVertices) const =0
	Return a list of vertexes defining the volume pointed to. More...

virtual std::unique_ptr< coord_t[]>	getVertexesArray (size_t &numVertices, const size_t outDimensions, const bool *maskDim) const =0
	Return a list of vertexes defining the volume pointed to, enable masking of dimensions. More...

	IMDIterator ()
	Default constructor. More...

virtual bool	isWithinBounds (size_t index) const =0
	Is index reachable by the iterator. More...

virtual void	jumpTo (size_t index)=0
	Jump to the index^th cell. More...

virtual bool	next ()=0
	Advance to the next cell. More...

virtual bool	next (size_t skip)=0
	Advance, skipping a certain number of cells. More...

void	setNormalization (Mantid::API::MDNormalization normalization)
	Set how the signal will be normalized when calling getNormalizedSignal() More...

virtual bool	valid () const =0
	Is the current position of the iterator valid? More...

virtual	~IMDIterator ()=default

Protected Member Functions
std::vector< int64_t >	createPermutations (const std::vector< int > &widths) const
	Create or fetch permutations relating to a given neighbour width. More...

Protected Attributes
uint64_t	m_begin
	The beginning linear index in the workspace. More...

coord_t *	m_binWidth
	Width of each bin in each dimension. More...

coord_t *	m_center
	Center of the current box. Not set until getCenter() is called. More...

std::unique_ptr< Mantid::Geometry::MDImplicitFunction >	m_function
	Implicit function to limit volume searched. More...

size_t *	m_index
	Index into each dimension. More...

size_t *	m_indexMaker
	Array to find indices from linear indices. More...

size_t *	m_indexMax
	Index into each dimension. More...

uint64_t	m_max
	The maximum linear index in the workspace. More...

size_t	m_nd
	Number of dimensions. More...

coord_t *	m_origin
	Origin (index 0,0,0) in the space = the minimum of each dimension. More...

std::vector< int64_t >	m_permutationsFaceTouching
	Neigbour finding permutations for face touching neighbours (3 by 3 width). More...

PermutationsMap	m_permutationsVertexTouchingMap
	Neighbour finding permutations map for vertex touching. More...

uint64_t	m_pos
	The linear position/index into the MDHistoWorkspace. More...

SkippingPolicy_scptr	m_skippingPolicy
	Skipping policy. More...

const MDHistoWorkspace *	m_ws
	The MDHistoWorkspace being iterated. More...

Protected Attributes inherited from Mantid::API::IMDIterator
Mantid::API::MDNormalization	m_normalization
	Normalization method for getNormalizedSignal() More...

Detailed Description

An implementation of IMDIterator that iterates through a MDHistoWorkspace.

It treats the bin in the workspace as a box containing a single "event", at the center of each bin and with the proper signal/error.

Author: Janik Zikovsky

Date: 2011-10-06

Definition at line 36 of file MDHistoWorkspaceIterator.h.

Constructor & Destructor Documentation

◆ MDHistoWorkspaceIterator() [1/4]

Mantid::DataObjects::MDHistoWorkspaceIterator::MDHistoWorkspaceIterator	(	const MDHistoWorkspace_const_sptr &	workspace,
		SkippingPolicy *	skippingPolicy,
		Mantid::Geometry::MDImplicitFunction *	function = `nullptr`,
		size_t	beginPos = `0`,
		size_t	endPos = `size_t(-1)`
	)

Constructor.

Parameters

workspace	:: MDHistoWorkspace_sptr being iterated
skippingPolicy	:: The skipping policy to use.
function	:: The implicit function to use. Becomes owned by this object.
beginPos	:: Start position
endPos	:: End position

Definition at line 121 of file MDHistoWorkspaceIterator.cpp.

References init(), and workspace.

◆ MDHistoWorkspaceIterator() [2/4]

Mantid::DataObjects::MDHistoWorkspaceIterator::MDHistoWorkspaceIterator	(	const MDHistoWorkspace *	workspace,
		SkippingPolicy *	skippingPolicy,
		Mantid::Geometry::MDImplicitFunction *	function = `nullptr`,
		size_t	beginPos = `0`,
		size_t	endPos = `size_t(-1)`
	)

Constructor.

Parameters

workspace	:: MDHistoWorkspace_sptr being iterated
function	:: The implicit function to use. Becomes owned by this object.
skippingPolicy	:: The skipping policy to use
beginPos	:: Start position
endPos	:: End position

Returns

Definition at line 140 of file MDHistoWorkspaceIterator.cpp.

References init(), and workspace.

◆ MDHistoWorkspaceIterator() [3/4]

Mantid::DataObjects::MDHistoWorkspaceIterator::MDHistoWorkspaceIterator	(	const MDHistoWorkspace_const_sptr &	workspace,
		Mantid::Geometry::MDImplicitFunction *	function = `nullptr`,
		size_t	beginPos = `0`,
		size_t	endPos = `size_t(-1)`
	)

Constructor.

Parameters

workspace	:: MDHistoWorkspace_sptr being iterated
function	:: The implicit function to use. Becomes owned by this object.

Returns: Constructor

Parameters

workspace	:: MDHistoWorkspace_sptr being iterated
function	:: The implicit function to use. Becomes owned by this object.
beginPos	:: start position
endPos	:: end position

Definition at line 90 of file MDHistoWorkspaceIterator.cpp.

References init(), and workspace.

◆ MDHistoWorkspaceIterator() [4/4]

Mantid::DataObjects::MDHistoWorkspaceIterator::MDHistoWorkspaceIterator	(	const MDHistoWorkspace *	workspace,
		Mantid::Geometry::MDImplicitFunction *	function = `nullptr`,
		size_t	beginPos = `0`,
		size_t	endPos = `size_t(-1)`
	)

Constructor.

Parameters

workspace	:: MDHistoWorkspace_sptr being iterated
function	:: The implicit function to use. Becomes owned by this object.
beginPos
endPos

Definition at line 105 of file MDHistoWorkspaceIterator.cpp.

References init(), and workspace.

◆ ~MDHistoWorkspaceIterator()

Mantid::DataObjects::MDHistoWorkspaceIterator::~MDHistoWorkspaceIterator ( )

override

Destructor.

Definition at line 234 of file MDHistoWorkspaceIterator.cpp.

References m_binWidth, m_center, m_index, m_indexMaker, m_indexMax, and m_origin.

Member Function Documentation

◆ createPermutations()

std::vector< int64_t > Mantid::DataObjects::MDHistoWorkspaceIterator::createPermutations ( const std::vector< int > & widths ) const

protected

Create or fetch permutations relating to a given neighbour width.

This is to create the permutations needed to operate find neighbours in the vertex-touching schenarios Rather than having to fabricate what the possible permutations are each time the iterator is moved and the method is called, we can cache the results, and re-use them as the only factors are the and the dimensionality, the width (n-neighbours).

Parameters

widths : vector of integer widths.

Returns: index permutations

Definition at line 529 of file MDHistoWorkspaceIterator.cpp.

References Mantid::API::MDGeometry::getDimension(), Mantid::Geometry::m, m_nd, m_permutationsVertexTouchingMap, and m_ws.

Referenced by findNeighbourIndexesByWidth(), and findNeighbourIndexesByWidth1D().

◆ findNeighbourIndexes()

std::vector< size_t > Mantid::DataObjects::MDHistoWorkspaceIterator::findNeighbourIndexes ( ) const

overridevirtual

Gets indexes of bins/pixels/boxes neighbouring the present iterator location.

Return all vertex touching neighbours. The number of neighbour indexes returned will depend upon the dimensionality of the workspace as well as the presence of boundaries and edges.

FindNeighbours will return the indexes of neighbours even if they are unreachable from the current iterator. To verify that the indexes are reachable from the current iterator, run isWithinBounds. Note that this is only a concern where the workspace iteration is portioned up amongst >1 iterators.

Returns: vector of linear indexes to neighbour locations.

std::pair< std::vector< size_t >, std::vector< bool > > Mantid::DataObjects::MDHistoWorkspaceIterator::findNeighbourIndexesByWidth1D	(	const int &	width,
		const int &	width_dimension
	)		const

width	: Width in the non-singleton dimension
width_dimension	: The non-singleton dimension of the widths vector

void Mantid::DataObjects::MDHistoWorkspaceIterator::init	(	const MDHistoWorkspace *	workspace,
		Mantid::Geometry::MDImplicitFunction *	function,
		size_t	beginPos = `0`,
		size_t	endPos = `size_t(-1)`
	)

workspace	:: MDWorkspace
function	:: implicit function or NULL for none. Gains ownership of the pointer.
beginPos	:: Start position
endPos	:: End position

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MDHistoWorkspaceIterator() [1/4]

◆ MDHistoWorkspaceIterator() [2/4]

◆ MDHistoWorkspaceIterator() [3/4]

◆ MDHistoWorkspaceIterator() [4/4]

◆ ~MDHistoWorkspaceIterator()

Member Function Documentation

◆ createPermutations()

◆ findNeighbourIndexes()

◆ findNeighbourIndexesByWidth() [1/2]

◆ findNeighbourIndexesByWidth() [2/2]

◆ findNeighbourIndexesByWidth1D()

◆ findNeighbourIndexesFaceTouching()

◆ getBoxExtents()

◆ getCenter()

◆ getDataSize()

◆ getError()

◆ getInnerDetectorID()

◆ getInnerError()

◆ getInnerExpInfoIndex()

◆ getInnerGoniometerIndex()

◆ getInnerPosition()

◆ getInnerSignal()

◆ getIsMasked()

◆ getLinearIndex()

◆ getNormalizedError()

◆ getNormalizedSignal()

◆ getNumEvents()

◆ getNumEventsFraction()

◆ getSignal()

◆ getVertexesArray() [1/2]

◆ getVertexesArray() [2/2]

◆ init()

◆ isWithinBounds()

◆ jumpTo()

◆ jumpToNearest()

◆ next() [1/2]

◆ next() [2/2]

◆ permutationCacheSize()

◆ valid()

Member Data Documentation

◆ m_begin

◆ m_binWidth

◆ m_center

◆ m_function

◆ m_index

◆ m_indexMaker

◆ m_indexMax

◆ m_max

◆ m_nd

◆ m_origin

◆ m_permutationsFaceTouching

◆ m_permutationsVertexTouchingMap

◆ m_pos

◆ m_skippingPolicy

◆ m_ws