#include <MDBoxMaskFunction.h>

Inheritance diagram for Mantid::Geometry::MDAlgorithms::MDBoxMaskFunction:

Public Member Functions
virtual bool	isPointContained (const coord_t *coords)
	Is a point in MDimensions contained by this ImplicitFunction? If the point is bounded by ALL planes contained, then this returns true.

bool	isPointContained (const coord_t *coords) override
	Is a point in MDimensions contained by this ImplicitFunction? If the point is bounded by ALL planes contained, then this returns true.

virtual bool	isPointContained (const Mantid::Kernel::VMD &coords)
	Is a point in MDimensions contained by this ImplicitFunction? If the point is bounded by ALL planes contained, then this returns true.

virtual bool	isPointContained (const std::vector< coord_t > &coords)
	Is a point in MDimensions contained by this ImplicitFunction? If the point is bounded by ALL planes contained, then this returns true.

	MDBoxMaskFunction (const Mantid::Kernel::V3D &pos, const double &radiusSquared)

Public Member Functions inherited from Mantid::Geometry::MDImplicitFunction
void	addPlane (const MDPlane &plane)
	Add a bounded plane to this implicit function.

eContact	boxContact (const coord_t *vertexes, const size_t numPoints) const
	Determine how a box (consisting of a number of vertexes) is in contact with the implicit function.

virtual std::string	getName () const

size_t	getNumDims () const

size_t	getNumPlanes () const

const MDPlane &	getPlane (size_t index) const

bool	isBoxTouching (const coord_t *vertexes, const size_t numPoints)
	Same as isBoxTouching(vector), except that it takes a bare array of coordinates.

bool	isBoxTouching (const std::vector< std::vector< coord_t > > &vertexes)
	Is there a chance that the box defined by these vertexes touches the implicit function volume?

	MDImplicitFunction ()
	Constructor.

virtual std::string	toXMLString () const

virtual	~MDImplicitFunction ()=default

Private Attributes
Mantid::Kernel::V3D	m_pos

double	m_radiusSquared

Additional Inherited Members
Public Types inherited from Mantid::Geometry::MDImplicitFunction
enum	eContact { NOT_TOUCHING = 0 , TOUCHING = 1 , CONTAINED = 2 }
	Enum for describing the contact between a box and an implicit function. More...

Protected Attributes inherited from Mantid::Geometry::MDImplicitFunction
size_t	m_nd
	number of dimensions for which this object can be applied

size_t	m_numPlanes
	Cached number of planes (for a sligh speed-up)

std::vector< MDPlane >	m_planes
	Vector of all the planes applying for this implict function.

Detailed Description

Definition at line 16 of file MDBoxMaskFunction.h.

Constructor & Destructor Documentation

◆ MDBoxMaskFunction()

Mantid::Geometry::MDAlgorithms::MDBoxMaskFunction::MDBoxMaskFunction	(	const Mantid::Kernel::V3D &	pos,
		const double &	radiusSquared
	)

inline

Definition at line 23 of file MDBoxMaskFunction.h.

Member Function Documentation

◆ isPointContained() [1/4]

virtual bool Mantid::Geometry::MDImplicitFunction::isPointContained ( const coord_t * coords )

inlinevirtual

Is a point in MDimensions contained by this ImplicitFunction? If the point is bounded by ALL planes contained, then this returns true.

Parameters

coords :: nd-sized array of coordinates

Returns: true if it is contained in the implicit function.

Reimplemented from Mantid::Geometry::MDImplicitFunction.

Definition at line 94 of file MDImplicitFunction.h.

◆ isPointContained() [2/4]

bool Mantid::Geometry::MDAlgorithms::MDBoxMaskFunction::isPointContained ( const coord_t * coords )

inlineoverridevirtual

Is a point in MDimensions contained by this ImplicitFunction? If the point is bounded by ALL planes contained, then this returns true.

Parameters

coords :: nd-sized array of coordinates

Returns: true if it is contained in the implicit function.

Reimplemented from Mantid::Geometry::MDImplicitFunction.

Definition at line 28 of file MDBoxMaskFunction.h.

References m_pos, and m_radiusSquared.

◆ isPointContained() [3/4]

virtual bool Mantid::Geometry::MDImplicitFunction::isPointContained ( const Mantid::Kernel::VMD & coords )

inlinevirtual

Is a point in MDimensions contained by this ImplicitFunction? If the point is bounded by ALL planes contained, then this returns true.

Parameters

coords :: nd-sized array of coordinates

Returns: true if it is contained in the implicit function.

Reimplemented from Mantid::Geometry::MDImplicitFunction.

Definition at line 110 of file MDImplicitFunction.h.

◆ isPointContained() [4/4]

virtual bool Mantid::Geometry::MDImplicitFunction::isPointContained ( const std::vector< coord_t > & coords )

inlinevirtual

Is a point in MDimensions contained by this ImplicitFunction? If the point is bounded by ALL planes contained, then this returns true.

Parameters

coords :: nd-sized vector of coordinates. No size-check is made!

Returns: true if it is contained in the implicit function.

Reimplemented from Mantid::Geometry::MDImplicitFunction.

Definition at line 126 of file MDImplicitFunction.h.

Member Data Documentation

◆ m_pos

Mantid::Kernel::V3D Mantid::Geometry::MDAlgorithms::MDBoxMaskFunction::m_pos

private

Definition at line 18 of file MDBoxMaskFunction.h.

Referenced by isPointContained().

◆ m_radiusSquared

double Mantid::Geometry::MDAlgorithms::MDBoxMaskFunction::m_radiusSquared

private

Definition at line 19 of file MDBoxMaskFunction.h.

Referenced by isPointContained().

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

Framework/MDAlgorithms/inc/MantidMDAlgorithms/MDBoxMaskFunction.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MDBoxMaskFunction()

Member Function Documentation

◆ isPointContained() [1/4]

◆ isPointContained() [2/4]

◆ isPointContained() [3/4]

◆ isPointContained() [4/4]

Member Data Documentation

◆ m_pos

◆ m_radiusSquared