Mantid: Mantid::Geometry::MDDimensionExtents< T > Class Template Reference

Mantid

Loading...

Searching...

No Matches

Simple class that holds the extents (min/max) of a given dimension in a MD workspace or MDBox. More...

#include <MDDimensionExtents.h>

Public Member Functions
void	expand (MDDimensionExtents &other)

std::string	extentsStr () const

T	getCentre () const

T	getGridVertex (const size_t ind) const
	return the vertice in the grid, based on this extent's size

T	getMax () const

T	getMin () const

T	getSize () const

bool	isUndefined () const

	MDDimensionExtents ()
	Empty constructor - reset everything.

bool	outside (T x) const

void	scaleExtents (double scaling, double offset)

void	setExtents (double dMin, double dMax)

Private Attributes
T	m_size
	the box size; It is important to have box size defined from doubles to avoid accuracy loss when extracting two large float numbers min and max

T	max
	Extent: maximum value in that dimension.

T	min
	Extent: minimum value in that dimension.

Detailed Description

template<typename T>
class Mantid::Geometry::MDDimensionExtents< T >

Simple class that holds the extents (min/max) of a given dimension in a MD workspace or MDBox.

Definition at line 39 of file MDDimensionExtents.h.

Constructor & Destructor Documentation

◆ MDDimensionExtents()

template<typename T >

Mantid::Geometry::MDDimensionExtents< T >::MDDimensionExtents ( )

inline

Empty constructor - reset everything.

Definition at line 44 of file MDDimensionExtents.h.

Member Function Documentation

◆ expand()

template<typename T >

void Mantid::Geometry::MDDimensionExtents< T >::expand ( MDDimensionExtents< T > & other )

inline

Definition at line 70 of file MDDimensionExtents.h.

References Mantid::Geometry::MDDimensionExtents< T >::max, and Mantid::Geometry::MDDimensionExtents< T >::min.

Referenced by Mantid::DataObjects::MDEventWorkspace< MDE, nd >::getMinimumExtents().

◆ extentsStr()

template<typename T >

std::string Mantid::Geometry::MDDimensionExtents< T >::extentsStr ( ) const

inline

Definition at line 50 of file MDDimensionExtents.h.

References Mantid::Geometry::MDDimensionExtents< T >::max, and Mantid::Geometry::MDDimensionExtents< T >::min.

◆ getCentre()

template<typename T >

T Mantid::Geometry::MDDimensionExtents< T >::getCentre ( ) const

inline

Definition at line 46 of file MDDimensionExtents.h.

References Mantid::Geometry::MDDimensionExtents< T >::max, and Mantid::Geometry::MDDimensionExtents< T >::min.

◆ getGridVertex()

template<typename T >

T Mantid::Geometry::MDDimensionExtents< T >::getGridVertex ( const size_t ind ) const

inline

return the vertice in the grid, based on this extent's size

Definition at line 56 of file MDDimensionExtents.h.

References Mantid::Geometry::MDDimensionExtents< T >::m_size, and Mantid::Geometry::MDDimensionExtents< T >::min.

◆ getMax()

template<typename T >

T Mantid::Geometry::MDDimensionExtents< T >::getMax ( ) const

inline

Definition at line 54 of file MDDimensionExtents.h.

References Mantid::Geometry::MDDimensionExtents< T >::max.

Referenced by Mantid::MDAlgorithms::CompareMDWorkspaces::compare2Boxes().

◆ getMin()

template<typename T >

T Mantid::Geometry::MDDimensionExtents< T >::getMin ( ) const

inline

Definition at line 53 of file MDDimensionExtents.h.

References Mantid::Geometry::MDDimensionExtents< T >::min.

Referenced by Mantid::MDAlgorithms::CompareMDWorkspaces::compare2Boxes().

◆ getSize()

template<typename T >

T Mantid::Geometry::MDDimensionExtents< T >::getSize ( ) const

inline

Definition at line 45 of file MDDimensionExtents.h.

References Mantid::Geometry::MDDimensionExtents< T >::m_size.

◆ isUndefined()

template<typename T >

bool Mantid::Geometry::MDDimensionExtents< T >::isUndefined ( ) const

inline

Definition at line 48 of file MDDimensionExtents.h.

References Mantid::Geometry::MDDimensionExtents< T >::max, and Mantid::Geometry::MDDimensionExtents< T >::min.

◆ outside()

template<typename T >

bool Mantid::Geometry::MDDimensionExtents< T >::outside ( T x ) const

inline

Definition at line 47 of file MDDimensionExtents.h.

References Mantid::Geometry::MDDimensionExtents< T >::max, Mantid::Geometry::MDDimensionExtents< T >::min, and Mantid::Geometry::x.

◆ scaleExtents()

template<typename T >

void Mantid::Geometry::MDDimensionExtents< T >::scaleExtents	(	double	scaling,
		double	offset
	)

inline

Definition at line 58 of file MDDimensionExtents.h.

References Mantid::Geometry::MDDimensionExtents< T >::m_size, Mantid::Geometry::MDDimensionExtents< T >::max, Mantid::Geometry::MDDimensionExtents< T >::min, and tmp.

◆ setExtents()

template<typename T >

void Mantid::Geometry::MDDimensionExtents< T >::setExtents	(	double	dMin,
		double	dMax
	)

inline

Definition at line 83 of file MDDimensionExtents.h.

References Mantid::Geometry::MDDimensionExtents< T >::m_size, Mantid::Geometry::MDDimensionExtents< T >::max, and Mantid::Geometry::MDDimensionExtents< T >::min.

Member Data Documentation

◆ m_size

template<typename T >

T Mantid::Geometry::MDDimensionExtents< T >::m_size

private

the box size; It is important to have box size defined from doubles to avoid accuracy loss when extracting two large float numbers min and max

Definition at line 97 of file MDDimensionExtents.h.

Referenced by Mantid::Geometry::MDDimensionExtents< T >::getGridVertex(), Mantid::Geometry::MDDimensionExtents< T >::getSize(), Mantid::Geometry::MDDimensionExtents< T >::scaleExtents(), and Mantid::Geometry::MDDimensionExtents< T >::setExtents().

◆ max

template<typename T >

T Mantid::Geometry::MDDimensionExtents< T >::max

private

Extent: maximum value in that dimension.

Definition at line 93 of file MDDimensionExtents.h.

Referenced by Mantid::Geometry::MDDimensionExtents< T >::expand(), Mantid::Geometry::MDDimensionExtents< T >::extentsStr(), Mantid::Geometry::MDDimensionExtents< T >::getCentre(), Mantid::Geometry::MDDimensionExtents< T >::getMax(), Mantid::Geometry::MDDimensionExtents< T >::isUndefined(), Mantid::Geometry::MDDimensionExtents< T >::outside(), Mantid::Geometry::MDDimensionExtents< T >::scaleExtents(), and Mantid::Geometry::MDDimensionExtents< T >::setExtents().

◆ min

template<typename T >

T Mantid::Geometry::MDDimensionExtents< T >::min

private

Extent: minimum value in that dimension.

Definition at line 91 of file MDDimensionExtents.h.

Referenced by Mantid::Geometry::MDDimensionExtents< T >::expand(), Mantid::Geometry::MDDimensionExtents< T >::extentsStr(), Mantid::Geometry::MDDimensionExtents< T >::getCentre(), Mantid::Geometry::MDDimensionExtents< T >::getGridVertex(), Mantid::Geometry::MDDimensionExtents< T >::getMin(), Mantid::Geometry::MDDimensionExtents< T >::isUndefined(), Mantid::Geometry::MDDimensionExtents< T >::outside(), Mantid::Geometry::MDDimensionExtents< T >::scaleExtents(), and Mantid::Geometry::MDDimensionExtents< T >::setExtents().

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

Framework/API/inc/MantidAPI/IMDNode.h
Framework/Geometry/inc/MantidGeometry/MDGeometry/MDDimensionExtents.h