Class describing a 3 dimensional translation.

It can be combined (using the operator *) with the ROOT::Math::Rotation3D classes and ROOT::Math::Transform3D to obtained combined transformations and to operate on points and vectors. Note that a the translation applied to a Vector object (DisplacementVector3D and LorentzVector classes) performes a noop, i.e. it returns the same vector. A translation can be applied only to the Point objects (PositionVector3D classes).

Definition at line 57 of file Translation3D.h.

Public Types
typedef DisplacementVector3D< Cartesian3D< double >, DefaultCoordinateSystemTag >	Vector

Public Member Functions
	Translation3D ()
	Default constructor ( zero translation ) More...

template<class IT >
	Translation3D (IT begin, IT end)
	Construct given a pair of pointers or iterators defining the beginning and end of an array of 3 Scalars representing the z,y,z of the translation vector. More...

	Translation3D (double dx, double dy, double dz)
	Construct from x,y,z values representing the translation. More...

template<class CoordSystem , class Tag >
	Translation3D (const DisplacementVector3D< CoordSystem, Tag > &v)
	Construct from any Displacement vector in ant tag and coordinate system. More...

template<class CoordSystem , class Tag >
	Translation3D (const PositionVector3D< CoordSystem, Tag > &p1, const PositionVector3D< CoordSystem, Tag > &p2)
	Construct transformation from one coordinate system defined one point (the origin) to a new coordinate system defined by other point (origin ) More...

const Vector &	Vect () const
	return a const reference to the underline vector representing the translation More...

template<class IT >
void	SetComponents (IT begin, IT end)
	Set the 3 components given an iterator to the start of the desired data, and another to the end (3 past start). More...

template<class IT >
void	GetComponents (IT begin, IT end) const
	Get the 3 components into data specified by an iterator begin and another to the end of the desired data (12 past start). More...

template<class IT >
void	GetComponents (IT begin) const
	Get the 3 matrix components into data specified by an iterator begin. More...

void	SetComponents (double dx, double dy, double dz)
	Set the components from 3 scalars. More...

void	GetComponents (double &dx, double &dy, double &dz) const
	Get the components into 3 scalars. More...

void	SetXYZ (double dx, double dy, double dz)
	Set the XYZ vector components from 3 scalars. More...

template<class CoordSystem , class Tag >
PositionVector3D< CoordSystem, Tag >	operator() (const PositionVector3D< CoordSystem, Tag > &p) const
	Transformation operation for Position Vector in any coordinate system and default tag. More...

template<class CoordSystem , class Tag >
DisplacementVector3D< CoordSystem, Tag >	operator() (const DisplacementVector3D< CoordSystem, Tag > &v) const
	Transformation operation for Displacement Vector in any coordinate system and default tag For the Displacement Vectors no translation apply so return the vector itself. More...

template<class CoordSystem , class Tag1 , class Tag2 >
void	Transform (const PositionVector3D< CoordSystem, Tag1 > &p1, PositionVector3D< CoordSystem, Tag2 > &p2) const
	Transformation operation for points between different coordinate system tags. More...

template<class CoordSystem , class Tag1 , class Tag2 >
void	Transform (const DisplacementVector3D< CoordSystem, Tag1 > &v1, DisplacementVector3D< CoordSystem, Tag2 > &v2) const
	Transformation operation for Displacement Vector of different coordinate systems. More...

template<class CoordSystem >
LorentzVector< CoordSystem >	operator() (const LorentzVector< CoordSystem > &q) const
	Transformation operation for a Lorentz Vector in any coordinate system A LorentzVector contains a displacement vector so no translation applies as well. More...

Plane3D	operator() (const Plane3D &plane) const
	Transformation on a 3D plane. More...

template<class AVector >
AVector	operator* (const AVector &v) const
	Transformation operation for Vectors. More...

Translation3D &	operator*= (const Translation3D &t)
	multiply (combine) with another transformation in place More...

Translation3D	operator* (const Translation3D &t) const
	multiply (combine) two transformations More...

void	Invert ()
	Invert the transformation in place. More...

Translation3D	Inverse () const
	Return the inverse of the transformation. More...

bool	operator== (const Translation3D &rhs) const
	Equality/inequality operators. More...

bool	operator!= (const Translation3D &rhs) const

Private Attributes
Vector	fVect

#include <Math/GenVector/Translation3D.h>

Collaboration diagram for ROOT::Math::Translation3D:

Member Typedef Documentation

typedef DisplacementVector3D<Cartesian3D<double>, DefaultCoordinateSystemTag > ROOT::Math::Translation3D::Vector

Definition at line 62 of file Translation3D.h.

Constructor & Destructor Documentation

ROOT::Math::Translation3D::Translation3D ( )

inline

Default constructor ( zero translation )

Definition at line 70 of file Translation3D.h.

Referenced by Inverse(), and operator*().

template<class IT >

ROOT::Math::Translation3D::Translation3D	(	IT	begin,
		IT	end
	)

inline

Construct given a pair of pointers or iterators defining the beginning and end of an array of 3 Scalars representing the z,y,z of the translation vector.

Definition at line 77 of file Translation3D.h.

ROOT::Math::Translation3D::Translation3D	(	double	dx,
		double	dy,
		double	dz
	)

inline

Construct from x,y,z values representing the translation.

Definition at line 85 of file Translation3D.h.

template<class CoordSystem , class Tag >

ROOT::Math::Translation3D::Translation3D ( const DisplacementVector3D< CoordSystem, Tag > & v )

inlineexplicit

Construct from any Displacement vector in ant tag and coordinate system.

Definition at line 94 of file Translation3D.h.

template<class CoordSystem , class Tag >

ROOT::Math::Translation3D::Translation3D	(	const PositionVector3D< CoordSystem, Tag > &	p1,
		const PositionVector3D< CoordSystem, Tag > &	p2
	)

inline

Construct transformation from one coordinate system defined one point (the origin) to a new coordinate system defined by other point (origin )

Parameters

p1	point defining origin of original reference system
p2	point defining origin of transformed reference system

Definition at line 107 of file Translation3D.h.

Member Function Documentation

template<class IT >

void ROOT::Math::Translation3D::GetComponents	(	IT	begin,
		IT	end
	)		const

inline

Get the 3 components into data specified by an iterator begin and another to the end of the desired data (12 past start).

Definition at line 136 of file Translation3D.h.

Referenced by ROOT::Math::operator<<().

template<class IT >

void ROOT::Math::Translation3D::GetComponents ( IT begin ) const

inline

Get the 3 matrix components into data specified by an iterator begin.

Definition at line 144 of file Translation3D.h.

void ROOT::Math::Translation3D::GetComponents	(	double &	dx,
		double &	dy,
		double &	dz
	)		const

inline

Get the components into 3 scalars.

Definition at line 161 of file Translation3D.h.

Translation3D ROOT::Math::Translation3D::Inverse ( ) const

inline

Return the inverse of the transformation.

Definition at line 271 of file Translation3D.h.

Referenced by testTransform3D().

void ROOT::Math::Translation3D::Invert ( )

inline

Invert the transformation in place.

Definition at line 264 of file Translation3D.h.

bool ROOT::Math::Translation3D::operator!= ( const Translation3D & rhs ) const

inline

Definition at line 284 of file Translation3D.h.

template<class CoordSystem , class Tag >

PositionVector3D<CoordSystem,Tag> ROOT::Math::Translation3D::operator() ( const PositionVector3D< CoordSystem, Tag > & p ) const

inline

Transformation operation for Position Vector in any coordinate system and default tag.

Definition at line 182 of file Translation3D.h.

Referenced by operator*(), and Transform().

template<class CoordSystem , class Tag >

DisplacementVector3D<CoordSystem,Tag> ROOT::Math::Translation3D::operator() ( const DisplacementVector3D< CoordSystem, Tag > & v ) const

inline

Transformation operation for Displacement Vector in any coordinate system and default tag For the Displacement Vectors no translation apply so return the vector itself.

Definition at line 195 of file Translation3D.h.

template<class CoordSystem >

LorentzVector<CoordSystem> ROOT::Math::Translation3D::operator() ( const LorentzVector< CoordSystem > & q ) const

inline

Transformation operation for a Lorentz Vector in any coordinate system A LorentzVector contains a displacement vector so no translation applies as well.

Definition at line 224 of file Translation3D.h.

Plane3D ROOT::Math::Translation3D::operator() ( const Plane3D & plane ) const

Transformation on a 3D plane.

Definition at line 39 of file Translation3D.cxx.

template<class AVector >

AVector ROOT::Math::Translation3D::operator* ( const AVector & v ) const

inline

Transformation operation for Vectors.

Apply same rules as operator() depending on type of vector. Will work only for DisplacementVector3D, PositionVector3D and LorentzVector

Definition at line 240 of file Translation3D.h.

Translation3D ROOT::Math::Translation3D::operator* ( const Translation3D & t ) const

inline

multiply (combine) two transformations

Definition at line 257 of file Translation3D.h.

Translation3D& ROOT::Math::Translation3D::operator*= ( const Translation3D & t )

inline

multiply (combine) with another transformation in place

Definition at line 249 of file Translation3D.h.

bool ROOT::Math::Translation3D::operator== ( const Translation3D & rhs ) const

inline

Equality/inequality operators.

Definition at line 279 of file Translation3D.h.

Referenced by operator!=().

template<class IT >

void ROOT::Math::Translation3D::SetComponents	(	IT	begin,
		IT	end
	)

inline

Set the 3 components given an iterator to the start of the desired data, and another to the end (3 past start).

Definition at line 127 of file Translation3D.h.

Referenced by Invert().

void ROOT::Math::Translation3D::SetComponents	(	double	dx,
		double	dy,
		double	dz
	)

inline

Set the components from 3 scalars.

Definition at line 153 of file Translation3D.h.

void ROOT::Math::Translation3D::SetXYZ	(	double	dx,
		double	dy,
		double	dz
	)

inline

Set the XYZ vector components from 3 scalars.

Definition at line 170 of file Translation3D.h.

template<class CoordSystem , class Tag1 , class Tag2 >

void ROOT::Math::Translation3D::Transform	(	const PositionVector3D< CoordSystem, Tag1 > &	p1,
		PositionVector3D< CoordSystem, Tag2 > &	p2
	)		const

inline

Transformation operation for points between different coordinate system tags.

Definition at line 203 of file Translation3D.h.

template<class CoordSystem , class Tag1 , class Tag2 >

void ROOT::Math::Translation3D::Transform	(	const DisplacementVector3D< CoordSystem, Tag1 > &	v1,
		DisplacementVector3D< CoordSystem, Tag2 > &	v2
	)		const

inline

Transformation operation for Displacement Vector of different coordinate systems.

Definition at line 214 of file Translation3D.h.

const Vector& ROOT::Math::Translation3D::Vect ( ) const

inline

return a const reference to the underline vector representing the translation

Definition at line 120 of file Translation3D.h.

Referenced by operator*(), ROOT::Math::operator*(), operator*=(), testTransform3D(), and ROOT::Math::Transform3D::Transform3D().

Member Data Documentation

Vector ROOT::Math::Translation3D::fVect

private

Definition at line 292 of file Translation3D.h.

Referenced by GetComponents(), Inverse(), Invert(), operator()(), operator*(), operator*=(), operator==(), SetComponents(), SetXYZ(), Translation3D(), and Vect().

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

math/genvector/inc/Math/GenVector/Translation3D.h
math/genvector/src/Translation3D.cxx

Public Types

Public Member Functions

Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation