Class for 3D vectors. More...

#include <Kernel\V3D.h>

Public Member Functions
V3D	absoluteValue () const
	Absolute value. More...

double	angle (const V3D &) const
	Angle between this and another vector. More...

void	azimuth_polar_SNS (const double R, const double azimuth, const double polar) noexcept
	Sets the vector position based on azimuth and polar angle, in RADIANS, in the SNS instrument coordinate system, where +Z = beam direction, +Y = vertical. More...

bool	coLinear (const V3D &, const V3D &) const noexcept
	Determines if this,B,C are colinear. More...

double	cosAngle (const V3D &) const
	cos(Angle) between this and another vector More...

constexpr V3D	cross_prod (const V3D &v) const noexcept
	Cross product (this * argument) More...

V3D	directionAngles (bool inDegrees=true) const
	Direction angles. More...

double	distance (const V3D &v) const noexcept
	Calculates the distance between two vectors. More...

void	fromString (const std::string &str)
	Sets the vector using a string. More...

void	getSpherical (double &R, double &theta, double &phi) const noexcept
	Return the vector's position in spherical coordinates. More...

double	hklError () const
	Calculates the error in hkl. More...

void	loadNexus (::NeXus::File *file, const std::string &name)
	Load the object from an open NeXus file. More...

int	masterDir (const double Tol=1e-3) const noexcept
	Determine if there is a master direction. More...

int	maxCoeff ()
	Maximum absolute integer value. More...

double	norm () const noexcept

constexpr double	norm2 () const noexcept
	Vector length squared. More...

double	normalize ()
	Make a normalized vector (return norm value) More...

bool	nullVector (const double tolerance=1e-3) const noexcept
	Determine if the point is null. More...

	operator std::vector< double > () const

bool	operator!= (const V3D &other) const noexcept
	Not equals operator with tolerance factor. More...

void	operator() (const double xx, const double yy, const double zz) noexcept
	Sets the vector position from a triplet of doubles x,y,z. More...

constexpr V3D	operator* (const double D) const noexcept
	Scalar product. More...

constexpr V3D	operator* (const V3D &v) const noexcept
	Inner product. More...

V3D &	operator*= (const double D) noexcept
	Scalar product. More...

V3D &	operator*= (const V3D &v) noexcept
	Self-Inner product. More...

constexpr V3D	operator+ (const V3D &v) const noexcept
	Addtion operator. More...

V3D &	operator+= (const V3D &v) noexcept
	Self-Addition operator. More...

constexpr V3D	operator- () const noexcept
	Negation. More...

constexpr V3D	operator- (const V3D &v) const noexcept
	Subtraction operator. More...

V3D &	operator-= (const V3D &v) noexcept
	Self-Subtraction operator. More...

constexpr V3D	operator/ (const double D) const noexcept
	Scalar divsion. More...

constexpr V3D	operator/ (const V3D &v) const noexcept
	Inner division. More...

V3D &	operator/= (const double D) noexcept
	Scalar division. More...

V3D &	operator/= (const V3D &v) noexcept
	Self-Inner division. More...

constexpr bool	operator< (const V3D &V) const noexcept
	compare More...

bool	operator== (const V3D &v) const noexcept
	Equals operator with tolerance factor. More...

constexpr bool	operator> (const V3D &rhs) const noexcept
	Comparison operator greater than. More...

constexpr double	operator[] (const size_t index) const noexcept
	Returns the axis value based in the index provided. More...

double &	operator[] (const size_t index) noexcept
	Returns the axis value based in the index provided. More...

void	printSelf (std::ostream &) const
	Prints a text representation of itself in format "[x,y,z]". More...

void	read (std::istream &)
	Read data from a stream. More...

void	readPrinted (std::istream &)
	Read data from a stream in the format returned by printSelf ("[x,y,z]"). More...

int	reBase (const V3D &, const V3D &, const V3D &) noexcept
	rebase to new basis vector More...

void	rotate (const Matrix< double > &) noexcept
	Rotate a point by a matrix. More...

void	round () noexcept
	Round each component to the nearest integer. More...

void	saveNexus (::NeXus::File *file, const std::string &name) const
	Save the object to an open NeXus file. More...

constexpr double	scalar_prod (const V3D &v) const noexcept
	Calculates the cross product. More...

void	setX (const double xx) noexcept
	Set is x position. More...

void	setY (const double yy) noexcept
	Set is y position. More...

void	setZ (const double zz) noexcept
	Set is z position. More...

void	spherical (const double R, const double theta, const double phi) noexcept
	Sets the vector position based on spherical coordinates. More...

void	spherical_rad (const double R, const double polar, const double azimuth) noexcept
	Sets the vector position based on spherical coordinates, in radians. More...

double	toMillerIndexes (double eps=1.e-3)
	transform vector into form, used to describe directions in crystallogaphical coodinate system More...

std::string	toString () const

bool	unitVector (const double tolerance=Kernel::Tolerance) const noexcept

constexpr	V3D () noexcept

constexpr	V3D (double xx, double yy, double zz) noexcept

double	volume () const noexcept
	Calculate the volume of a cube XYZ. More...

void	write (std::ostream &) const
	Write out the point values. More...

constexpr double	X () const noexcept
	Get x. More...

constexpr double	Y () const noexcept
	Get y. More...

constexpr double	Z () const noexcept
	Get z. More...

double	zenith (const V3D &) const noexcept
	Zenith (theta) angle between this and another vector. More...

Static Public Member Functions
static bool	compareMagnitude (const Kernel::V3D &v1, const Kernel::V3D &v2)
	Convenience method for sorting list of V3D objects based on magnitude. More...

static std::vector< V3D >	makeVectorsOrthogonal (const std::vector< V3D > &vectors)
	Take a list of 2 vectors and makes a 3D orthogonal system out of them The first vector i0 is taken as such. More...

Private Attributes
std::array< double, 3 >	m_pt

Detailed Description

Class for 3D vectors.

Author: Laurent C Chapon, ISIS, RAL

Date: 09/10/2007

Definition at line 34 of file V3D.h.

Constructor & Destructor Documentation

◆ V3D() [1/2]

constexpr Mantid::Kernel::V3D::V3D ( )

inlineconstexprnoexcept

Definition at line 36 of file V3D.h.

Referenced by absoluteValue(), and directionAngles().

◆ V3D() [2/2]

constexpr Mantid::Kernel::V3D::V3D	(	double	xx,
		double	yy,
		double	zz
	)

inlineconstexprnoexcept

Definition at line 37 of file V3D.h.

Member Function Documentation

◆ absoluteValue()

V3D Mantid::Kernel::V3D::absoluteValue ( ) const

Absolute value.

Calculates the absolute value.

Returns: The absolute value

Definition at line 524 of file V3D.cpp.

References fabs, m_pt, and V3D().

Referenced by Mantid::Crystal::FindUBUsingIndexedPeaks::exec().

◆ angle()

double Mantid::Kernel::V3D::angle ( const V3D & v ) const

Angle between this and another vector.

Calculates the angle between this and another vector.

Parameters

v	:: The other vector

Returns: The angle between the vectors in radians (0 < theta < pi)

Definition at line 165 of file V3D.cpp.

References cosAngle().

◆ azimuth_polar_SNS()

void Mantid::Kernel::V3D::azimuth_polar_SNS	(	const double	R,
		const double	azimuth,
		const double	polar
	)

noexcept

Sets the vector position based on azimuth and polar angle, in RADIANS, in the SNS instrument coordinate system, where +Z = beam direction, +Y = vertical.

Parameters

R	:: The R value (distance)
azimuth	:: The azimuthal angle (in Radians)
polar	:: The polar value (in Radians)

Definition at line 95 of file V3D.cpp.

References Mantid::Kernel::Tolerance.

Referenced by Mantid::CurveFitting::Algorithms::VesuvioCalculateMS::calculateCounts().

◆ coLinear()

bool Mantid::Kernel::V3D::coLinear	(	const V3D &	Bv,
		const V3D &	Cv
	)		const

noexcept

Determines if this,B,C are colinear.

Parameters

Bv	:: Vector to test
Cv	:: Vector to test

Returns: false if no colinear and true if they are (within Tolerance)

Definition at line 230 of file V3D.cpp.

References norm(), and Mantid::Kernel::Tolerance.

Referenced by Mantid::Crystal::CalculateUMatrix::exec().

◆ compareMagnitude()

bool Mantid::Kernel::V3D::compareMagnitude	(	const Kernel::V3D &	v1,
		const Kernel::V3D &	v2
	)

static

Convenience method for sorting list of V3D objects based on magnitude.

Comparator function for sorting list of 3D vectors based on their magnitude.

Parameters

v1	first vector
v2	seconde vector

Returns: true if v1.norm() < v2.norm().

Definition at line 483 of file V3D.cpp.

Referenced by Mantid::Geometry::IndexingUtils::FFTScanFor_Directions(), Mantid::Geometry::IndexingUtils::Find_UB(), Mantid::Geometry::NiggliCell::MakeNiggliUB(), and Mantid::Geometry::ConventionalCell::SetSidesIncreasing().

◆ cosAngle()

double Mantid::Kernel::V3D::cosAngle ( const V3D & v ) const

cos(Angle) between this and another vector

Calculates the cosine of angle between this and another vector.

Parameters

v	:: The other vector

Returns: cosine of the angle between the vectors

Definition at line 180 of file V3D.cpp.

References norm(), and scalar_prod().

Referenced by angle(), export_V3D(), Mantid::DataObjects::Peak::findDetector(), Mantid::Algorithms::SolidAngleHelpers::Rectangle::solidAngle(), and Mantid::Algorithms::SolidAngleHelpers::Wing::solidAngle().

◆ cross_prod()

constexpr V3D Mantid::Kernel::V3D::cross_prod ( const V3D & v ) const

inlineconstexprnoexcept

Cross product (this * argument)

Definition at line 278 of file V3D.h.

◆ directionAngles()

V3D Mantid::Kernel::V3D::directionAngles ( bool inDegrees = true ) const

Direction angles.

Get direction angles from direction cosines.

Parameters

inDegrees : optional argument for specifying in radians (false). Defaults to true.

Returns: V3D containing anlges.

Definition at line 495 of file V3D.cpp.

References m_pt, norm(), and V3D().

Referenced by export_V3D().

◆ distance()

double Mantid::Kernel::V3D::distance ( const V3D & v ) const

inlinenoexcept

Calculates the distance between two vectors.

Parameters

v	:: The second vector to include in the calculation

Returns: The distance between the two vectors

Definition at line 287 of file V3D.h.

Referenced by Mantid::Geometry::Track::addPoint(), Mantid::CurveFitting::Algorithms::VesuvioCalculateGammaBackground::cacheInstrumentGeometry(), Mantid::Algorithms::Q1DWeighted::calculate(), Mantid::CurveFitting::Algorithms::VesuvioCalculateGammaBackground::calculateBackgroundSingleFoil(), Mantid::CurveFitting::Algorithms::VesuvioCalculateMS::calculateCounts(), Mantid::Algorithms::ModeratorTzeroLinear::calculateTfLi(), Mantid::MDAlgorithms::IntegratePeaksMD2::checkOverlap(), Mantid::Geometry::Cylinder::distance(), Mantid::Geometry::Quadratic::distance(), Mantid::Geometry::MeshObject::distance(), export_V3D(), Mantid::Geometry::Component::getDistance(), Mantid::Algorithms::RadiusSum::getMaxDistance(), Mantid::Geometry::ObjComponent::interceptSurface(), Mantid::Crystal::PeakBackground::isBackground(), Mantid::Geometry::MeshObject::isValid(), Mantid::Geometry::Track::nonComplete(), Mantid::DataObjects::PeaksWorkspace::peakInfo(), Mantid::DataObjects::PeaksWorkspace::peakInfoNumber(), Mantid::MDAlgorithms::IntegratePeaksCWSD::simplePeakIntegration(), and Mantid::Geometry::Sphere::write().

◆ fromString()

void Mantid::Kernel::V3D::fromString ( const std::string & str )

Sets the vector using a string.

Parameters

str	:: the vector as a string "X Y Z"

Definition at line 348 of file V3D.cpp.

References read().

Referenced by Mantid::Geometry::ComponentParser::endElement().

◆ getSpherical()

void Mantid::Kernel::V3D::getSpherical	(	double &	R,
		double &	theta,
		double &	phi
	)		const

noexcept

Return the vector's position in spherical coordinates.

Parameters

R	:: Returns the radial distance
theta	:: Returns the theta angle in degrees
phi	:: Returns the phi (azimuthal) angle in degrees

Definition at line 117 of file V3D.cpp.

References Mantid::DataHandling::rad2deg.

Referenced by Mantid::DataHandling::AvrgDetector::addDetInfo(), Mantid::Algorithms::CalculateDynamicRange::calculateQMinMax(), Mantid::Algorithms::ConvertAxesToRealSpace::exec(), Mantid::Algorithms::ConvertToConstantL2::exec(), Mantid::DataHandling::ModifyDetectorDotDatFile::exec(), Mantid::MDAlgorithms::ConvertCWPDMDToSpectra::findXBoundary(), Mantid::Algorithms::RingProfile::getBinForPixel(), Mantid::Algorithms::RadiusSum::getBinForPixelPos(), Mantid::Geometry::DetectorGroup::getPhi(), Mantid::DataHandling::LoadILLDiffraction::initMovingWorkspace(), Mantid::DataHandling::LoadILLIndirect2::moveComponent(), Mantid::Algorithms::populateTable(), Mantid::Geometry::Instrument::saveDetectorSetInfoToNexus(), and Mantid::DataHandling::SaveNexusProcessed::saveSpectraDetectorMapNexus().

◆ hklError()

double Mantid::Kernel::V3D::hklError ( ) const

Calculates the error in hkl.

Calculates the error of the HKL to compare with tolerance.

Returns: The error

Definition at line 530 of file V3D.cpp.

References fabs, and m_pt.

Referenced by Mantid::Geometry::IndexingUtils::CalculateMillerIndices().

◆ loadNexus()

void Mantid::Kernel::V3D::loadNexus	(	::NeXus::File *	file,
		const std::string &	name
	)

Load the object from an open NeXus file.

Parameters

file	:: open NeXus file
name	:: name of the data to open

Definition at line 423 of file V3D.cpp.

References m_pt.

Referenced by Mantid::Geometry::GoniometerAxis::loadNexus().

◆ makeVectorsOrthogonal()

std::vector< V3D > Mantid::Kernel::V3D::makeVectorsOrthogonal ( const std::vector< V3D > & vectors )

static

Take a list of 2 vectors and makes a 3D orthogonal system out of them The first vector i0 is taken as such.

The second vector is made perpendicular to i0, in the plane of i0-i1 The third vector is made perpendicular to the plane i0-i1 by performing the cross product of 0 and 1

Parameters

vectors :: list of 2 vectors

Returns: list of 3 vectors

Definition at line 298 of file V3D.cpp.

References cross_prod(), Mantid::Kernel::normalize(), Mantid::Kernel::Quat::rotate(), and Mantid::Kernel::Quat::setRotation().

Referenced by Mantid::MDAlgorithms::MDWSTransform::buildQTrahsf(), Mantid::Kernel::VMDBase< TYPE >::makeVectorsOrthogonal(), and Mantid::MDAlgorithms::MDWSTransform::setQ3DDimensionsNames().

◆ masterDir()

int Mantid::Kernel::V3D::masterDir ( const double tolerance = 1e-3 ) const

noexcept

Determine if there is a master direction.

Calculates the index of the primary direction (if there is one)

Parameters

tolerance :: Tolerance accepted

Return values

range	-3,-2,-1 1,2,3 if the vector is orientaged within tolerance on the x,y,z direction (the sign indecates the direction to the +ve side )
0	:: No master direction

Definition at line 264 of file V3D.cpp.

References tolerance.

◆ maxCoeff()

int Mantid::Kernel::V3D::maxCoeff ( )

Maximum absolute integer value.

Vector maximum absolute integer value.

Returns: maxCoeff()

Definition at line 509 of file V3D.cpp.

References m_pt.

Referenced by Mantid::Crystal::FindUBUsingIndexedPeaks::exec().

◆ norm()

double Mantid::Kernel::V3D::norm ( ) const

inlinenoexcept

Definition at line 263 of file V3D.h.

◆ norm2()

constexpr double Mantid::Kernel::V3D::norm2 ( ) const

inlineconstexprnoexcept

Vector length squared.

Definition at line 265 of file V3D.h.

Referenced by Mantid::Geometry::Goniometer::calcFromQSampleAndWavelength(), Mantid::Crystal::PredictPeaks::exec(), export_V3D(), Mantid::Geometry::IsotropicAtomBraggScatterer::getDebyeWallerFactor(), Mantid::Geometry::Line::intersect(), Mantid::Geometry::HKLFilterWavelength::isAllowed(), Mantid::Geometry::MeshObject2D::pointsCoplanar(), Mantid::Geometry::OrientedLattice::setUFromVectors(), and Mantid::Crystal::PeaksOnSurface::validateExtentsInput().

◆ normalize()

double Mantid::Kernel::V3D::normalize ( )

Make a normalized vector (return norm value)

Normalises the vector and returns its original length.

Returns: the norm of the vector before normalization

Definition at line 130 of file V3D.cpp.

References norm(), and operator/=().

◆ nullVector()

bool Mantid::Kernel::V3D::nullVector ( const double tolerance = 1e-3 ) const

noexcept

Determine if the point is null.

Checks the size of the vector.

Parameters

tolerance :: size of the biggest zero vector allowed.

Returns: true if the vector's elements are less in magnitude than tolerance

Definition at line 241 of file V3D.cpp.

References tolerance.

Referenced by Mantid::DataHandling::AvrgDetector::addDetInfo(), Mantid::API::MatrixWorkspace::detectorSignedTwoTheta(), Mantid::API::MatrixWorkspace::detectorTwoTheta(), Mantid::DataHandling::LoadIsawDetCal::doRotation(), Mantid::Crystal::CalculatePeaksHKL::exec(), Mantid::Crystal::CombinePeaksWorkspaces::exec(), Mantid::Crystal::DiffPeaksWorkspaces::exec(), Mantid::API::DetectorSearcher::findDetectorIndex(), Mantid::Kernel::Quat::operator()(), Mantid::Kernel::Quat::Quat(), Mantid::Geometry::CSGObject::rayTraceSolidAngle(), and Mantid::Geometry::Line::setLine().

◆ operator std::vector< double >()

Mantid::Kernel::V3D::operator std::vector< double > ( ) const

inline

Definition at line 43 of file V3D.h.

◆ operator!=()

bool Mantid::Kernel::V3D::operator!= ( const V3D & other ) const

inlinenoexcept

Not equals operator with tolerance factor.

Parameters

other :: The V3D to compare against

Returns: True if the vectors are different

Definition at line 184 of file V3D.h.

References std::operator==().

◆ operator()()

void Mantid::Kernel::V3D::operator()	(	const double	xx,
		const double	yy,
		const double	zz
	)

inlinenoexcept

Sets the vector position from a triplet of doubles x,y,z.

Parameters

xx	:: The X coordinate
yy	:: The Y coordinate
zz	:: The Z coordinate

Definition at line 207 of file V3D.h.

◆ operator*() [1/2]

constexpr V3D Mantid::Kernel::V3D::operator* ( const double D ) const

inlineconstexprnoexcept

Scalar product.

Parameters

D	:: value to scale

Returns: this * D

Definition at line 134 of file V3D.h.

◆ operator*() [2/2]

constexpr V3D Mantid::Kernel::V3D::operator* ( const V3D & v ) const

inlineconstexprnoexcept

Inner product.

Parameters

v	:: Vector to sub.

Returns: *this * v;

Definition at line 68 of file V3D.h.

◆ operator*=() [1/2]

V3D & Mantid::Kernel::V3D::operator*= ( const double D )

inlinenoexcept

Scalar product.

Parameters

D	:: value to scale

Returns: this *= D

Definition at line 148 of file V3D.h.

◆ operator*=() [2/2]

V3D & Mantid::Kernel::V3D::operator*= ( const V3D & v )

inlinenoexcept

Self-Inner product.

Parameters

v	:: Vector to multiply

Returns: this=v;

Definition at line 110 of file V3D.h.

References m_pt.

Referenced by toMillerIndexes().

◆ operator+()

constexpr V3D Mantid::Kernel::V3D::operator+ ( const V3D & v ) const

inlineconstexprnoexcept

Addtion operator.

Parameters

v	:: Vector to add

Returns: *this+v;

Definition at line 50 of file V3D.h.

◆ operator+=()

V3D & Mantid::Kernel::V3D::operator+= ( const V3D & v )

inlinenoexcept

Self-Addition operator.

Parameters

v	:: Vector to add.

Returns: *this+=v;

Definition at line 86 of file V3D.h.

References m_pt.

◆ operator-() [1/2]

constexpr V3D Mantid::Kernel::V3D::operator- ( ) const

inlineconstexprnoexcept

Negation.

Returns: a vector with same magnitude but in opposite direction

Definition at line 168 of file V3D.h.

◆ operator-() [2/2]

constexpr V3D Mantid::Kernel::V3D::operator- ( const V3D & v ) const

inlineconstexprnoexcept

Subtraction operator.

Parameters

v	:: Vector to sub.

Returns: *this-v;

Definition at line 59 of file V3D.h.

◆ operator-=()

V3D & Mantid::Kernel::V3D::operator-= ( const V3D & v )

inlinenoexcept

Self-Subtraction operator.

Parameters

v	:: Vector to sub.

Returns: *this-v;

Definition at line 98 of file V3D.h.

References m_pt.

◆ operator/() [1/2]

constexpr V3D Mantid::Kernel::V3D::operator/ ( const double D ) const

inlineconstexprnoexcept

Scalar divsion.

Parameters

D	:: value to scale

Returns: this / D

Definition at line 141 of file V3D.h.

◆ operator/() [2/2]

constexpr V3D Mantid::Kernel::V3D::operator/ ( const V3D & v ) const

inlineconstexprnoexcept

Inner division.

Parameters

v	:: Vector to divide

Returns: *this * v;

Definition at line 77 of file V3D.h.

◆ operator/=() [1/2]

V3D & Mantid::Kernel::V3D::operator/= ( const double D )

inlinenoexcept

Scalar division.

Parameters

D	:: value to scale

Returns: this /= D

Todo:: ADD TOLERANCE

Definition at line 159 of file V3D.h.

◆ operator/=() [2/2]

V3D & Mantid::Kernel::V3D::operator/= ( const V3D & v )

inlinenoexcept

Self-Inner division.

Parameters

v	:: Vector to divide

Returns: this=v;

Definition at line 122 of file V3D.h.

References m_pt.

Referenced by normalize().

◆ operator<()

constexpr bool Mantid::Kernel::V3D::operator< ( const V3D & V ) const

inlineconstexprnoexcept

compare

Returns: true if V is greater

Definition at line 190 of file V3D.h.

◆ operator==()

bool Mantid::Kernel::V3D::operator== ( const V3D & v ) const

inlinenoexcept

Equals operator with tolerance factor.

Parameters

v	:: V3D for comparison

Returns: true if the items are equal

Definition at line 175 of file V3D.h.

References Mantid::Kernel::Tolerance.

◆ operator>()

constexpr bool Mantid::Kernel::V3D::operator> ( const V3D & rhs ) const

inlineconstexprnoexcept

Comparison operator greater than.

Definition at line 199 of file V3D.h.

References rhs.

◆ operator[]() [1/2]

constexpr double Mantid::Kernel::V3D::operator[] ( const size_t index ) const

inlineconstexprnoexcept

Returns the axis value based in the index provided.

Parameters

index :: 0=x, 1=y, 2=z

Returns: a double value of the requested axis

Definition at line 241 of file V3D.h.

References index.

◆ operator[]() [2/2]

double & Mantid::Kernel::V3D::operator[] ( const size_t index )

inlinenoexcept

Returns the axis value based in the index provided.

Parameters

index :: 0=x, 1=y, 2=z

Returns: a double value of the requested axis

Definition at line 251 of file V3D.h.

References index.

◆ printSelf()

void Mantid::Kernel::V3D::printSelf ( std::ostream & os ) const

Prints a text representation of itself in format "[x,y,z]".

Parameters

os	:: the Stream to output to

Definition at line 357 of file V3D.cpp.

References m_pt.

Referenced by Mantid::MDAlgorithms::IntegratePeaksMD2::calcCovar(), and Mantid::Kernel::operator<<().

◆ read()

void Mantid::Kernel::V3D::read ( std::istream & IX )

Read data from a stream.

Todo:: Check Error handling

Parameters

IX	:: Input Stream

Definition at line 328 of file V3D.cpp.

References m_pt.

Referenced by fromString().

◆ readPrinted()

void Mantid::Kernel::V3D::readPrinted ( std::istream & IX )

Read data from a stream in the format returned by printSelf ("[x,y,z]").

Parameters

IX	:: Input Stream

Exceptions

std::runtime_error if the input is of wrong format

Definition at line 364 of file V3D.cpp.

References m_pt.

Referenced by Mantid::DataHandling::SaveParameterFile::exec(), Mantid::Kernel::operator>>(), and Mantid::DataHandling::LoadAscii2::readTable().

◆ reBase()

int Mantid::Kernel::V3D::reBase	(	const V3D &	A,
		const V3D &	B,
		const V3D &	C
	)

noexcept

rebase to new basis vector

Re-express this point as components of A,B,C.

Assuming that A,B,C form a basis set (which does not have to be orthonormal).

Parameters

A	:: Unit vector in basis
B	:: Unit vector in basis
C	:: Unit vector in basis

Return values

-1	:: The points do not form a basis set.
0	:: Vec3D has successfully been re-expressed.

Definition at line 199 of file V3D.cpp.

References Mantid::Kernel::Matrix< T >::Invert().

◆ rotate()

void Mantid::Kernel::V3D::rotate ( const Matrix< double > & A )

noexcept

Rotate a point by a matrix.

Parameters

A	:: Rotation matrix (needs to be >= 3x3)

Definition at line 217 of file V3D.cpp.

◆ round()

void Mantid::Kernel::V3D::round ( )

noexcept

Round each component to the nearest integer.

Definition at line 140 of file V3D.cpp.

References m_pt.

Referenced by Mantid::Crystal::PeakStatisticsTools::UniqueReflectionCollection::addObservations(), Mantid::Crystal::PeakIntensityVsRadius::exec(), and Mantid::Crystal::PredictPeaks::fillPossibleHKLsUsingPeaksWorkspace().

◆ saveNexus()

void Mantid::Kernel::V3D::saveNexus	(	::NeXus::File *	file,
		const std::string &	name
	)		const

Save the object to an open NeXus file.

Parameters

file	:: open NeXus file
name	:: name of the data to create

Definition at line 412 of file V3D.cpp.

References m_pt.

Referenced by Mantid::Geometry::GoniometerAxis::saveNexus().

◆ scalar_prod()

constexpr double Mantid::Kernel::V3D::scalar_prod ( const V3D & v ) const

inlineconstexprnoexcept

Calculates the cross product.

Returns (this * v).

Parameters

v	:: The second vector to include in the calculation

Returns: The cross product of the two vectors (this * v)

Definition at line 274 of file V3D.h.

◆ setX()

void Mantid::Kernel::V3D::setX ( const double xx )

inlinenoexcept

Set is x position.

Parameters

xx	:: The X coordinate

Definition at line 218 of file V3D.h.

Referenced by Mantid::CurveFitting::Algorithms::VesuvioCalculateGammaBackground::calculateBackgroundSingleFoil(), Mantid::MDAlgorithms::ConvertCWSDMDtoHKL::exec(), Mantid::Crystal::IntegratePeakTimeSlices::FindPlane(), Mantid::CurveFitting::Algorithms::V3DFromHKLColumnExtractor::getHKLFromString(), Mantid::MDAlgorithms::ConvertCWSDExpToMomentum::getInputs(), Mantid::Geometry::RandomPoint::localPointInCylinder(), Mantid::MDAlgorithms::IntegratePeaksCWSD::processInputs(), Mantid::Algorithms::SolidAngleHelpers::AlphaAngleHorizontal::project(), V3DPickleSuite::setstate(), Mantid::Geometry::PeakTransform::transform(), and Mantid::Geometry::PeakTransform::transformBack().

◆ setY()

void Mantid::Kernel::V3D::setY ( const double yy )

inlinenoexcept

Set is y position.

Parameters

yy	:: The Y coordinate

Definition at line 224 of file V3D.h.

Referenced by Mantid::CurveFitting::Algorithms::VesuvioCalculateGammaBackground::calculateBackgroundSingleFoil(), Mantid::MDAlgorithms::ConvertCWSDMDtoHKL::exec(), Mantid::Crystal::IntegratePeakTimeSlices::FindPlane(), Mantid::CurveFitting::Algorithms::V3DFromHKLColumnExtractor::getHKLFromString(), Mantid::MDAlgorithms::ConvertCWSDExpToMomentum::getInputs(), Mantid::Geometry::RandomPoint::localPointInCylinder(), Mantid::MDAlgorithms::IntegratePeaksCWSD::processInputs(), Mantid::Algorithms::SolidAngleHelpers::AlphaAngleVertical::project(), V3DPickleSuite::setstate(), Mantid::Geometry::PeakTransform::transform(), and Mantid::Geometry::PeakTransform::transformBack().

◆ setZ()

void Mantid::Kernel::V3D::setZ ( const double zz )

inlinenoexcept

Set is z position.

Parameters

zz	:: The Z coordinate

Definition at line 230 of file V3D.h.

Referenced by Mantid::CurveFitting::Algorithms::VesuvioCalculateGammaBackground::calculateBackgroundSingleFoil(), Mantid::MDAlgorithms::ConvertCWSDMDtoHKL::exec(), Mantid::Crystal::IntegratePeakTimeSlices::FindPlane(), Mantid::CurveFitting::Algorithms::V3DFromHKLColumnExtractor::getHKLFromString(), Mantid::MDAlgorithms::ConvertCWSDExpToMomentum::getInputs(), Mantid::Geometry::RandomPoint::localPointInCylinder(), Mantid::MDAlgorithms::IntegratePeaksCWSD::processInputs(), V3DPickleSuite::setstate(), Mantid::Geometry::PeakTransform::transform(), and Mantid::Geometry::PeakTransform::transformBack().

◆ spherical()

void Mantid::Kernel::V3D::spherical	(	const double	R,
		const double	theta,
		const double	phi
	)

noexcept

Sets the vector position based on spherical coordinates.

Parameters

R	:: The R value (distance)
theta	:: The theta value (in degrees) = the polar angle away from the +Z axis.
phi	:: The phi value (in degrees) = the azimuthal angle, where 0 points along +X and rotates clockwise in the XY plane

Definition at line 57 of file V3D.cpp.

References Mantid::Geometry::deg2rad.

◆ spherical_rad()

void Mantid::Kernel::V3D::spherical_rad	(	const double	R,
		const double	polar,
		const double	azimuth
	)

noexcept

Sets the vector position based on spherical coordinates, in radians.

Parameters

R	:: The R value (distance)
polar	:: the polar angle (in radians) away from the +Z axis.
azimuth	:: the azimuthal angle (in radians), where 0 points along +X and rotates clockwise in the XY plane

Definition at line 70 of file V3D.cpp.

References Mantid::Kernel::Tolerance.

◆ toMillerIndexes()

double Mantid::Kernel::V3D::toMillerIndexes ( double eps = 1.e-3 )

transform vector into form, used to describe directions in crystallogaphical coodinate system

Definition at line 431 of file V3D.cpp.

References m_pt, and operator*=().

◆ toString()

std::string Mantid::Kernel::V3D::toString ( ) const

Returns: the vector as a string "X Y Z"

Definition at line 340 of file V3D.cpp.

References write().

Referenced by Mantid::MDAlgorithms::ConvertCWSDExpToMomentum::convertSpiceMatrixToMomentumMDEvents(), Mantid::Crystal::PeakIntensityVsRadius::exec(), Mantid::MDAlgorithms::IntegratePeaksCWSD::getPeakInformation(), Mantid::DataObjects::Peak::setQLabFrame(), Mantid::MDAlgorithms::IntegratePeaksCWSD::simplePeakIntegration(), and Mantid::Geometry::Component::writeXML().

◆ unitVector()

bool Mantid::Kernel::V3D::unitVector ( const double tolerance = Kernel::Tolerance ) const

noexcept

Definition at line 251 of file V3D.cpp.

References tolerance.

Referenced by Mantid::Geometry::Track::reset(), and Mantid::Geometry::Track::Track().

◆ volume()

double Mantid::Kernel::V3D::volume ( ) const

inlinenoexcept

Calculate the volume of a cube X*Y*Z.

Definition at line 315 of file V3D.h.

◆ write()

void Mantid::Kernel::V3D::write ( std::ostream & OX ) const

Write out the point values.

Parameters

OX	:: Output stream

Definition at line 330 of file V3D.cpp.

Referenced by Mantid::Geometry::Component::appendXML(), Mantid::Algorithms::DiffractionEventCalibrateDetectors::exec(), and toString().

◆ X()

constexpr double Mantid::Kernel::V3D::X ( ) const

inlineconstexprnoexcept

Get x.

Definition at line 232 of file V3D.h.

◆ Y()

constexpr double Mantid::Kernel::V3D::Y ( ) const

inlineconstexprnoexcept

Get y.

Definition at line 233 of file V3D.h.

◆ Z()

constexpr double Mantid::Kernel::V3D::Z ( ) const

inlineconstexprnoexcept

Get z.

Definition at line 234 of file V3D.h.

◆ zenith()

double Mantid::Kernel::V3D::zenith ( const V3D & v ) const

noexcept

Zenith (theta) angle between this and another vector.

Calculates the zenith angle (theta) of this vector with respect to another.

Parameters

v	:: The other vector

Returns: The azimuthal angle in radians (0 < theta < pi)

Definition at line 150 of file V3D.cpp.

Referenced by export_V3D().

Member Data Documentation

◆ m_pt

std::array<double, 3> Mantid::Kernel::V3D::m_pt

private

Definition at line 329 of file V3D.h.

Referenced by absoluteValue(), directionAngles(), hklError(), loadNexus(), maxCoeff(), operator*=(), operator+=(), operator-=(), operator/=(), printSelf(), read(), readPrinted(), round(), saveNexus(), and toMillerIndexes().

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

Framework/Kernel/inc/MantidKernel/V3D.h
Framework/Kernel/src/V3D.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ V3D() [1/2]

◆ V3D() [2/2]

Member Function Documentation

◆ absoluteValue()

◆ angle()

◆ azimuth_polar_SNS()

◆ coLinear()

◆ compareMagnitude()

◆ cosAngle()

◆ cross_prod()

◆ directionAngles()

◆ distance()

◆ fromString()

◆ getSpherical()

◆ hklError()

◆ loadNexus()

◆ makeVectorsOrthogonal()

◆ masterDir()

◆ maxCoeff()

◆ norm()

◆ norm2()

◆ normalize()

◆ nullVector()

◆ operator std::vector< double >()

◆ operator!=()

◆ operator()()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator<()

◆ operator==()

◆ operator>()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ printSelf()

◆ read()

◆ readPrinted()

◆ reBase()

◆ rotate()

◆ round()

◆ saveNexus()

◆ scalar_prod()

◆ setX()

◆ setY()

◆ setZ()

◆ spherical()

◆ spherical_rad()

◆ toMillerIndexes()

◆ toString()

◆ unitVector()

◆ volume()

◆ write()

◆ X()

◆ Y()

◆ Z()

◆ zenith()

Member Data Documentation

◆ m_pt