Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
Mantid::Geometry::MDDimensionExtents< T > Class Template Reference

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
 
getCentre () const
 
getGridVertex (const size_t ind) const
 return the vertice in the grid, based on this extent's size More...
 
getMax () const
 
getMin () const
 
getSize () const
 
bool isUndefined () const
 
 MDDimensionExtents ()
 Empty constructor - reset everything. More...
 
bool outside (T x) const
 
void scaleExtents (double scaling, double offset)
 
void setExtents (double dMin, double dMax)
 

Private Attributes

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 More...
 
max
 Extent: maximum value in that dimension. More...
 
min
 Extent: minimum value in that dimension. More...
 

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 40 of file MDDimensionExtents.h.

Constructor & Destructor Documentation

◆ MDDimensionExtents()

template<typename T >
Mantid::Geometry::MDDimensionExtents< T >::MDDimensionExtents ( )
inline

Empty constructor - reset everything.

Definition at line 45 of file MDDimensionExtents.h.

Member Function Documentation

◆ expand()

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

◆ extentsStr()

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

◆ getCentre()

template<typename T >
T Mantid::Geometry::MDDimensionExtents< T >::getCentre ( ) const
inline

◆ 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 57 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

◆ getMin()

template<typename T >
T Mantid::Geometry::MDDimensionExtents< T >::getMin ( ) const
inline

◆ getSize()

template<typename T >
T Mantid::Geometry::MDDimensionExtents< T >::getSize ( ) const
inline

◆ isUndefined()

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

◆ outside()

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

◆ scaleExtents()

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

◆ setExtents()

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

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 98 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

◆ min

template<typename T >
T Mantid::Geometry::MDDimensionExtents< T >::min
private

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