Type definition of base module. More...

#include <JBase.hh>

Inheritance diagram for JDETECTOR::JBase:

Public Member Functions
	JBase ()
	Default constructor. More...

	JBase (const int id, const JLocation &location, const JPosition3D &position, const JCalibration &calibration=JCalibration())
	Constructor. More...

int	getID () const
	Get identifier. More...

void	setID (const int id)
	Set identifier. More...

bool	less (const JObjectID &object) const
	Less than method. More...

bool	less (const int id) const
	Less than method. More...

bool	more (const int id) const
	More than method. More...

const JLocation &	getLocation () const
	Get location. More...

JLocation &	getLocation ()
	Get location. More...

void	setLocation (const JLocation &location)
	Set location. More...

std::string	toString () const
	Convert module location to string. More...

std::string	toString (const std::string &fmt, const std::string target="%") const
	Convert module loation to string. More...

int	getString () const
	Get string number. More...

int	getFloor () const
	Get floor number. More...

bool	less (const JLocation &location) const
	Less than method. More...

const JPosition3D &	getPosition () const
	Get position. More...

JPosition3D &	getPosition ()
	Get position. More...

void	setPosition (const JVector3D &pos)
	Set position. More...

	operator JAngle3D () const
	Type conversion operator. More...

	operator JVersor3D () const
	Type conversion operator. More...

JPosition3D &	rotate (const JRotation3D &R)
	Rotate. More...

JPosition3D &	rotate (const JRotation3X &R)
	Rotate around X-axis. More...

JPosition3D &	rotate (const JRotation3Y &R)
	Rotate around Y-axis. More...

JPosition3D &	rotate (const JRotation3Z &R)
	Rotate around Z-axis. More...

JPosition3D &	rotate (const JQuaternion3D &Q)
	Rotate. More...

JPosition3D &	rotate_back (const JRotation3D &R)
	Rotate back. More...

JPosition3D &	rotate_back (const JRotation3X &R)
	Rotate back around X-axis. More...

JPosition3D &	rotate_back (const JRotation3Y &R)
	Rotate back around Y-axis. More...

JPosition3D &	rotate_back (const JRotation3Z &R)
	Rotate back around Z-axis. More...

JPosition3D &	rotate_back (const JQuaternion3D &Q)
	Rotate back. More...

void	transform (const JRotation3D &R, const JVector3D &pos)
	Transform position. More...

JVector3D &	transform (const JMatrix3D &T)
	Transform. More...

void	transform_back (const JRotation3D &R, const JVector3D &pos)
	Transform back position. More...

double	getDot (const JAngle3D &angle) const
	Get dot product. More...

double	getDot (const JVersor3D &dir) const
	Get dot product. More...

double	getDot (const JVersor3Z &dir) const
	Get dot product. More...

double	getDot (const JVector3D &vector) const
	Get dot product. More...

	operator JVector2D () const
	Type conversion operator. More...

double	getX () const
	Get x position. More...

double	getY () const
	Get y position. More...

double	getZ () const
	Get z position. More...

JVector3D &	negate ()
	Negate vector. More...

JVector3D &	add (const JVector3D &vector)
	Add vector. More...

JVector3D &	sub (const JVector3D &vector)
	Subtract vector. More...

JVector3D &	mul (const double factor)
	Scale vector. More...

JVector3D &	mul (const JNullType &object)
	Multiply with object. More...

JVector3D &	div (const double factor)
	Scale vector. More...

bool	equals (const JVector3D &vector, const double precision=std::numeric_limits< double >::min()) const
	Check equality. More...

double	getLengthSquared () const
	Get length squared. More...

double	getLength () const
	Get length. More...

double	getDistanceSquared (const JVector3D &pos) const
	Get squared of distance to point. More...

double	getDistance (const JVector3D &pos) const
	Get distance to point. More...

JVector3D &	cross (const JVector3D &first, const JVector3D &second)
	Get cross product. More...

const JCalibration &	getCalibration () const
	Get calibration. More...

void	setCalibration (const JCalibration &cal)
	Set calibration. More...

double	getT0 () const
	Get time offset. More...

void	setT0 (const double t0)
	Set time offset. More...

void	addT0 (const double t0)
	Add time offset. More...

void	subT0 (const double t0)
	Subtract time offset. More...

Static Public Member Functions
static const JBase &	getInstance ()
	Get reference to unique instance of this class object. More...

Protected Attributes
int	__id

int	string

int	floor

double	__x

double	__y

double	__z

double	t0

Friends
std::istream &	operator>> (std::istream &in, JBase &base)
	Read base from input. More...

std::ostream &	operator<< (std::ostream &out, const JBase &base)
	Write base to output. More...

Detailed Description

Type definition of base module.

Definition at line 28 of file JBase.hh.

Constructor & Destructor Documentation

JDETECTOR::JBase::JBase ( )

inline

Default constructor.

Definition at line 38 of file JBase.hh.

39 {}

JDETECTOR::JBase::JBase	(	const int	id,
		const JLocation &	location,
		const JPosition3D &	position,
		const JCalibration &	calibration = `JCalibration()`
	)

inline

Constructor.

Parameters

id	identifier
location	location
position	position
calibration	calibration

Definition at line 50 of file JBase.hh.

     {
       setID(id);
       setLocation(location);
       setPosition(position);
       setCalibration(calibration);
     }

Member Function Documentation

static const JBase& JDETECTOR::JBase::getInstance ( )

inlinestatic

Get reference to unique instance of this class object.

This method returns a base module with the default configuration of the base module.

Returns: reference to this class object

Definition at line 69 of file JBase.hh.

     {
       static JBase base;
 
       return base;
     }

int JLANG::JObjectID::getID ( ) const

inlineinherited

Get identifier.

Returns: identifier

Definition at line 55 of file JObjectID.hh.

     { 
       return __id;
     }

void JLANG::JObjectID::setID ( const int id )

inlineinherited

Set identifier.

Parameters

id	identifier

Definition at line 66 of file JObjectID.hh.

     { 
       this->__id = id;
     }

bool JLANG::JObjectID::less ( const JObjectID & object ) const

inlineinherited

Less than method.

Parameters

object object identifier

Returns: true if this identifier less than given identifier; else false

Definition at line 78 of file JObjectID.hh.

     { 
       return this->getID() < object.getID();
     }

bool JLANG::JObjectID::less ( const int id ) const

inlineinherited

Less than method.

Parameters

id	identifier

Returns: true if this identifier less than given identifier; else false

Definition at line 90 of file JObjectID.hh.

     { 
       return this->getID() < id;
     }

bool JLANG::JObjectID::more ( const int id ) const

inlineinherited

More than method.

Parameters

id	identifier

Returns: true if this identifier greater than given identifier; else false

Definition at line 102 of file JObjectID.hh.

     { 
       return this->getID() > id;
     }

const JLocation& JDETECTOR::JLocation::getLocation ( ) const

inlineinherited

Get location.

Returns: location

Definition at line 69 of file JLocation.hh.

     {
       return static_cast<const JLocation&>(*this);
     }

JLocation& JDETECTOR::JLocation::getLocation ( )

inlineinherited

Get location.

Returns: location

Definition at line 80 of file JLocation.hh.

     {
       return static_cast<JLocation&>(*this);
     }

void JDETECTOR::JLocation::setLocation ( const JLocation & location )

inlineinherited

Set location.

Parameters

location location

Definition at line 91 of file JLocation.hh.

     {
       static_cast<JLocation&>(*this) = location;
     }

std::string JDETECTOR::JLocation::toString ( ) const

inlineinherited

Convert module location to string.

Returns: string

Definition at line 102 of file JLocation.hh.

     {
       return toString("% %");
     }

std::string JDETECTOR::JLocation::toString	(	const std::string &	fmt,
		const std::string	target = `"%"`
	)		const

inlineinherited

Convert module loation to string.

The targets target in the format string fmt are consecutively replaced by floor and string.

Parameters

fmt	format
target	target

Returns: string

Definition at line 118 of file JLocation.hh.

     {
       JLANG::JString buffer(fmt);
 
       buffer.replace(target, string, 1);
       buffer.replace(target, floor,  1);
 
       return buffer;
     }

int JDETECTOR::JLocation::getString ( ) const

inlineinherited

Get string number.

Returns: string number

Definition at line 134 of file JLocation.hh.

     {
       return string;
     }

int JDETECTOR::JLocation::getFloor ( ) const

inlineinherited

Get floor number.

Returns: floor number

Definition at line 145 of file JLocation.hh.

     {
       return floor;
     }

bool JDETECTOR::JLocation::less ( const JLocation & location ) const

inlineinherited

Less than method.

Parameters

location module location

Returns: true if first location before second location; else false

Definition at line 157 of file JLocation.hh.

     {
       if (this->getString() == location.getString())
         return this->getFloor()  < location.getFloor();
       else
         return this->getString() < location.getString();
     }

const JPosition3D& JGEOMETRY3D::JPosition3D::getPosition ( ) const

inlineinherited

Get position.

Returns: position

Definition at line 129 of file JPosition3D.hh.

     {
       return static_cast<const JPosition3D&>(*this);
     }

JPosition3D& JGEOMETRY3D::JPosition3D::getPosition ( )

inlineinherited

Get position.

Returns: position

Definition at line 140 of file JPosition3D.hh.

     {
       return static_cast<JPosition3D&>(*this);
     }

void JGEOMETRY3D::JPosition3D::setPosition ( const JVector3D & pos )

inlineinherited

Set position.

Parameters

pos position

Definition at line 151 of file JPosition3D.hh.

     {
       static_cast<JVector3D&>(*this) = pos;
     }

JGEOMETRY3D::JPosition3D::operator JAngle3D ( ) const

inlineinherited

Type conversion operator.

Returns: angle

Definition at line 162 of file JPosition3D.hh.

     {
       return JAngle3D(getX(), getY(), getZ());
     }

JGEOMETRY3D::JPosition3D::operator JVersor3D ( ) const

inlineinherited

Type conversion operator.

Returns: direction

Definition at line 173 of file JPosition3D.hh.

     {
       return JVersor3D(getX(), getY(), getZ());
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JRotation3D & R )

inlineinherited

Rotate.

Parameters

R	rotation matrix

Returns: this position

Definition at line 185 of file JPosition3D.hh.

     {
       R.rotate(__x, __y, __z);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JRotation3X & R )

inlineinherited

Rotate around X-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 213 of file JPosition3D.hh.

     {
       R.rotate(__y, __z);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JRotation3Y & R )

inlineinherited

Rotate around Y-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 241 of file JPosition3D.hh.

     {
       R.rotate(__x, __z);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JRotation3Z & R )

inlineinherited

Rotate around Z-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 269 of file JPosition3D.hh.

     {
       R.rotate(__x, __y);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate ( const JQuaternion3D & Q )

inlineinherited

Rotate.

Parameters

Q	quaternion

Returns: this position

Definition at line 297 of file JPosition3D.hh.

     {
       Q.rotate(__x, __y, __z);
       
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3D & R )

inlineinherited

Rotate back.

Parameters

R	rotation matrix

Returns: this position

Definition at line 199 of file JPosition3D.hh.

     {
       R.rotate_back(__x, __y, __z);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3X & R )

inlineinherited

Rotate back around X-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 227 of file JPosition3D.hh.

     {
       R.rotate_back(__y, __z);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3Y & R )

inlineinherited

Rotate back around Y-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 255 of file JPosition3D.hh.

     {
       R.rotate_back(__x, __z);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JRotation3Z & R )

inlineinherited

Rotate back around Z-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 283 of file JPosition3D.hh.

     {
       R.rotate_back(__x, __y);
 
       return *this;
     }

JPosition3D& JGEOMETRY3D::JPosition3D::rotate_back ( const JQuaternion3D & Q )

inlineinherited

Rotate back.

Parameters

Q	quaternion

Returns: this position

Definition at line 311 of file JPosition3D.hh.

     {
       Q.rotate_back(__x, __y, __z);
 
       return *this;
     }

void JGEOMETRY3D::JPosition3D::transform	(	const JRotation3D &	R,
		const JVector3D &	pos
	)

inlineinherited

Transform position.

The final position is obtained as follows:

rotation of the position according matrix R;
offset position with pos;
rotation of position around z-axis, such that final position lies in x-z plane;

Parameters

R	rotation matrix
pos	position of origin (after rotation)

Definition at line 330 of file JPosition3D.hh.

     {
       // rotate geometry to system with particle direction along z-axis
 
       rotate(R);
 
       // offset with respect to origin
 
       sub(pos);
 
       // rotate geometry to x-z plane
 
       __x = sqrt(__x*__x + __y*__y);
       __y = 0.0;
     }

JVector3D& JGEOMETRY3D::JVector3D::transform ( const JMatrix3D & T )

inlineinherited

Transform.

Parameters

T matrix

Returns: this vector

Definition at line 205 of file JVector3D.hh.

     {
       T.transform(__x, __y, __z);
 
       return *this;
     }

void JGEOMETRY3D::JPosition3D::transform_back	(	const JRotation3D &	R,
		const JVector3D &	pos
	)

inlineinherited

Transform back position.

The final position is obtained as follows:

offset position with position pos;
rotation of postion according matrix R;

Parameters

R	rotation matrix
pos	position of origin (before rotation)

Definition at line 358 of file JPosition3D.hh.

     {
       // offset with respect to origin
 
       add(pos);
 
       // rotate back geometry to system with particle direction along z-axis
 
       rotate_back(R);
     }

double JGEOMETRY3D::JPosition3D::getDot ( const JAngle3D & angle ) const

inlineinherited

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 377 of file JPosition3D.hh.

     {
       return
         getX() * angle.getDX() +
         getY() * angle.getDY() +
         getZ() * angle.getDZ();
     }

double JGEOMETRY3D::JPosition3D::getDot ( const JVersor3D & dir ) const

inlineinherited

Get dot product.

Parameters

dir direction

Returns: dot product

Definition at line 392 of file JPosition3D.hh.

     {
       return
         getX() * dir.getDX() +
         getY() * dir.getDY() +
         getZ() * dir.getDZ();
     }

double JGEOMETRY3D::JPosition3D::getDot ( const JVersor3Z & dir ) const

inlineinherited

Get dot product.

Parameters

dir direction

Returns: dot product

Definition at line 407 of file JPosition3D.hh.

     {
       return
         getX() * dir.getDX() +
         getY() * dir.getDY() +
         getZ() * dir.getDZ();
     }

double JGEOMETRY3D::JVector3D::getDot ( const JVector3D & vector ) const

inlineinherited

Get dot product.

Parameters

vector vector

Returns: dot product

Definition at line 281 of file JVector3D.hh.

     {
       return
         getX() * vector.getX() +
         getY() * vector.getY() +
         getZ() * vector.getZ();
     }

JGEOMETRY3D::JVector3D::operator JVector2D ( ) const

inlineinherited

Type conversion operator.

Returns: JVector2D

Definition at line 82 of file JVector3D.hh.

     {
       return JVector2D(this->getX(), this->getY());
     }

double JGEOMETRY3D::JVector3D::getX ( ) const

inlineinherited

Get x position.

Returns: x position

Definition at line 93 of file JVector3D.hh.

     { 
       return __x;
     }

double JGEOMETRY3D::JVector3D::getY ( ) const

inlineinherited

Get y position.

Returns: y position

Definition at line 103 of file JVector3D.hh.

     { 
       return __y;
     }

double JGEOMETRY3D::JVector3D::getZ ( ) const

inlineinherited

Get z position.

Returns: z position

Definition at line 114 of file JVector3D.hh.

     { 
       return __z;
     }

JVector3D& JGEOMETRY3D::JVector3D::negate ( )

inlineinherited

Negate vector.

Returns: this vector

Definition at line 125 of file JVector3D.hh.

     {
       __x = -__x;
       __y = -__y;
       __z = -__z;
 
       return *this;
     }

JVector3D& JGEOMETRY3D::JVector3D::add ( const JVector3D & vector )

inlineinherited

Add vector.

Parameters

vector vector

Returns: this vector

Definition at line 141 of file JVector3D.hh.

     {
       __x += vector.getX();
       __y += vector.getY();
       __z += vector.getZ();
 
       return *this;
     }

JVector3D& JGEOMETRY3D::JVector3D::sub ( const JVector3D & vector )

inlineinherited

Subtract vector.

Parameters

vector vector

Returns: this vector

Definition at line 157 of file JVector3D.hh.

     {
       __x -= vector.getX();
       __y -= vector.getY();
       __z -= vector.getZ();
 
       return *this;
     }

JVector3D& JGEOMETRY3D::JVector3D::mul ( const double factor )

inlineinherited

Scale vector.

Parameters

factor multiplication factor

Returns: this vector

Definition at line 173 of file JVector3D.hh.

     {
       __x *= factor;
       __y *= factor;
       __z *= factor;
 
       return *this;
     }

JVector3D & JMATH::JMath< JVector3D , JNullType >::mul ( const JNullType & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 273 of file JMath.hh.

     {
       return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
     }

JVector3D& JGEOMETRY3D::JVector3D::div ( const double factor )

inlineinherited

Scale vector.

Parameters

factor division factor

Returns: this vector

Definition at line 189 of file JVector3D.hh.

     {
       __x /= factor;
       __y /= factor;
       __z /= factor;
 
       return *this;
     }

bool JGEOMETRY3D::JVector3D::equals	(	const JVector3D &	vector,
		const double	precision = `std::numeric_limits<double>::min()`
	)		const

inlineinherited

Check equality.

Parameters

vector	vector
precision	precision

Returns: true if vectors are equal; else false

Definition at line 220 of file JVector3D.hh.

     {
       return (fabs(getX() - vector.getX()) <= precision &&
               fabs(getY() - vector.getY()) <= precision &&
               fabs(getZ() - vector.getZ()) <= precision);
     }

double JGEOMETRY3D::JVector3D::getLengthSquared ( ) const

inlineinherited

Get length squared.

Returns: square of length

Definition at line 234 of file JVector3D.hh.

     { 
       return getX()*getX() + getY()*getY() + getZ()*getZ();
     }

double JGEOMETRY3D::JVector3D::getLength ( ) const

inlineinherited

Get length.

Returns: length

Definition at line 245 of file JVector3D.hh.

     { 
       return sqrt(getLengthSquared());
     }

double JGEOMETRY3D::JVector3D::getDistanceSquared ( const JVector3D & pos ) const

inlineinherited

Get squared of distance to point.

Parameters

pos position

Returns: square of distance

Definition at line 257 of file JVector3D.hh.

     {
       return JVector3D(pos).sub(*this).getLengthSquared();
     }

double JGEOMETRY3D::JVector3D::getDistance ( const JVector3D & pos ) const

inlineinherited

Get distance to point.

Parameters

pos position

Returns: distance

Definition at line 269 of file JVector3D.hh.

     {
       return sqrt(getDistanceSquared(pos));
     }

JVector3D& JGEOMETRY3D::JVector3D::cross	(	const JVector3D &	first,
		const JVector3D &	second
	)

inlineinherited

Get cross product.

Note that this vector should not overlap with the first or second vector,

Parameters

first	first vector
second	second vector

Returns: this vector

Definition at line 298 of file JVector3D.hh.

     {
       __x = first .getY() * second.getZ()  -  second.getY() * first .getZ();
       __y = second.getX() * first .getZ()  -  first .getX() * second.getZ();
       __z = first .getX() * second.getY()  -  second.getX() * first .getY();
 
       return *this;
     }

const JCalibration& JDETECTOR::JCalibration::getCalibration ( ) const

inlineinherited

Get calibration.

Returns: calibration

Definition at line 66 of file JDetector/JCalibration.hh.

     {
       return *this;
     }

void JDETECTOR::JCalibration::setCalibration ( const JCalibration & cal )

inlineinherited

Set calibration.

Parameters

cal	calibration

Definition at line 77 of file JDetector/JCalibration.hh.

     {
       *this = cal;
     }

double JDETECTOR::JCalibration::getT0 ( ) const

inlineinherited

Get time offset.

Returns: time offset [ns]

Definition at line 88 of file JDetector/JCalibration.hh.

     {
       return t0;
     }

void JDETECTOR::JCalibration::setT0 ( const double t0 )

inlineinherited

Set time offset.

Parameters

t0	time offset [ns]

Definition at line 99 of file JDetector/JCalibration.hh.

     {
       this->t0 = t0;
     }

void JDETECTOR::JCalibration::addT0 ( const double t0 )

inlineinherited

Add time offset.

Parameters

t0	time offset [ns]

Definition at line 110 of file JDetector/JCalibration.hh.

     {
       this->t0 += t0;
     }

void JDETECTOR::JCalibration::subT0 ( const double t0 )

inlineinherited

Subtract time offset.

Parameters

t0	time offset [ns]

Definition at line 121 of file JDetector/JCalibration.hh.

     {
       this->t0 -= t0;
     }

Friends And Related Function Documentation

std::istream& operator>>	(	std::istream &	in,
		JBase &	base
	)

friend

Read base from input.

Parameters

in	input stream
base	base

Returns: input stream

Definition at line 84 of file JBase.hh.

     {
       using namespace std;
 
       in >> static_cast<JModuleIdentifier&>(base);
       in >> static_cast<JLocation&>        (base);
       in >> static_cast<JPosition3D&>      (base);
       in >> static_cast<JCalibration&>     (base);
 
       return in;
     }

std::ostream& operator<<	(	std::ostream &	out,
		const JBase &	base
	)

friend

Write base to output.

Parameters

out	output stream
base	base

Returns: output stream

Definition at line 104 of file JBase.hh.

     {
       using namespace std;
 
       out << static_cast<const JModuleIdentifier&>(base);
       out << ' ';
       out << static_cast<const JLocation&>        (base);
       out << ' ';
       out << static_cast<const JPosition3D&>      (base);
       out << ' ';
       out << static_cast<const JCalibration&>     (base);
 
       return out;
     }

Member Data Documentation

int JLANG::JObjectID::__id

protectedinherited

Definition at line 160 of file JObjectID.hh.

int JDETECTOR::JLocation::string

protectedinherited

Definition at line 234 of file JLocation.hh.

int JDETECTOR::JLocation::floor

protectedinherited

Definition at line 235 of file JLocation.hh.

double JGEOMETRY3D::JVector3D::__x

protectedinherited

Definition at line 309 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__y

protectedinherited

Definition at line 310 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__z

protectedinherited

Definition at line 311 of file JVector3D.hh.

double JDETECTOR::JCalibration::t0

protectedinherited

Definition at line 188 of file JDetector/JCalibration.hh.

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

JBase.hh

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation