Data structure for a composite optical module. More...

#include <JModule.hh>

Inheritance diagram for JDETECTOR::JModule:

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

	JModule (const int id, const JLocation &location)
	Constructor. More...

const JPMT &	getPMT (const int index) const
	Get PMT. More...

JPMT &	getPMT (const int index)
	Get PMT. More...

void	setPMT (const int index, const JPMT &pmt)
	Set PMT. More...

JVector3D	getCenter () const
	Get center of module based on crossing point of PMT axes. More...

void	compile ()
	Compile module data. More...

void	rotate (const JRotation3D &R)
	Rotate module. More...

void	rotate_back (const JRotation3D &R)
	Rotate back module. More...

void	transform (const JRotation3D &R, const JVector3D &pos)
	Transformation of geometry (see method JGEOMETRY3D::JPosition3D::transform(const JRotation3D&, const JVector3D&)). More...

void	transform (const JTransformation3D &T)
	Transformation of geometry. More...

void	rotate (const JQuaternion3D &Q)
	Rotate module. More...

void	rotate_back (const JQuaternion3D &Q)
	Rotate back module. More...

JModule &	set (const JVector3D &pos)
	Set position. More...

JModule &	add (const JVector3D &pos)
	Add position. More...

JModule &	sub (const JVector3D &pos)
	Subtract position. More...

JModule &	set (const double t0)
	Set time offset. More...

JModule &	add (const double t0)
	Add time offset. More...

JModule &	sub (const double t0)
	Subtract time offset. More...

JModule &	operator+= (const JVector3D &pos)
	Add position. More...

JModule &	operator-= (const JVector3D &pos)
	Subtract position. More...

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

int &	getID ()
	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 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_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...

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 &	mul (const double factor)
	Scale vector. More...

JFirst_t &	mul (const JSecond_t &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 &	getCross (const JVector3D &first, const JVector3D &second)
	Get cross product. More...

const JQuaternion3D &	getQuaternion () const
	Get quaternion. More...

JQuaternion3D &	getQuaternion ()
	Get quaternion. More...

void	setQuaternion (const JQuaternion3D &quaternion)
	Set quaternion. More...

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

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

double	getAngle () const
	Get rotation angle. More...

double	getA () const
	Get a value. More...

double	getB () const
	Get b value. More...

double	getC () const
	Get c value. More...

double	getD () const
	Get d value. More...

JQuaternion3D &	setIdentity ()
	Set to identity quaternion. More...

JQuaternion3D &	conjugate ()
	Conjugate quaternion. More...

JQuaternion3D &	negate ()
	Negate quaternion. More...

JQuaternion3D &	add (const JQuaternion3D &quaternion)
	Add quaternion. More...

JQuaternion3D &	sub (const JQuaternion3D &quaternion)
	Subtract quaternion. More...

JQuaternion3D &	mul (const double factor)
	Scale quaternion. More...

JQuaternion3D &	mul (const JQuaternion3D &first, const JQuaternion3X &second)
	Quaternion multiplication. More...

JQuaternion3D &	mul (const JQuaternion3D &first, const JQuaternion3Y &second)
	Quaternion multiplication. More...

JQuaternion3D &	mul (const JQuaternion3D &first, const JQuaternion3Z &second)
	Quaternion multiplication. More...

JQuaternion3D &	mul (const JQuaternion3D &first, const JQuaternion3D &second)
	Quaternion multiplication. More...

JQuaternion3D &	mul (const JQuaternion3X &qx, const JQuaternion3Y &qy, const JQuaternion3Z &qz)
	Quaternion multiplication. More...

JFirst_t &	mul (const JSecond_t &object)
	Multiply with object. More...

JQuaternion3D &	div (const double factor)
	Scale quaternion. More...

void	rotate (double &__x, double &__y, double &__z) const
	Rotate. More...

void	rotate_back (double &__x, double &__y, double &__z) const
	Rotate back. More...

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

bool	isIdentity (const double precision=std::numeric_limits< double >::min()) const
	Test identity. More...

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

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

double	getDistanceSquared (const JQuaternion3D &quaternion) const
	Get squared of distance to quaternion. More...

double	getDistance (const JQuaternion3D &quaternion) const
	Get distance to quaternion. More...

double	getDot (const JQuaternion3D &quaternion) const
	Get dot product. More...

JQuaternion3D	getConjugate () const
	Get conjugate of this quaternion. More...

JQuaternion3D &	normalise ()
	Normalise quaternion. More...

JQuaternion3D &	pow (const double y)
	Raise quaternion to given power. More...

JQuaternion3D &	interpolate (const JQuaternion3D &object, const double alpha)
	Interpolation between quaternions. More...

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

JCalibration &	getCalibration ()
	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...

int	getStatus () const
	Get status. More...

JStatus &	getStatus ()
	Get status. More...

int	getStatus (const int mask) const
	Get status. More...

void	setStatus (const JStatus &status)
	Set status. More...

bool	equals (const JStatus &status) const
	Equal method. More...

bool	has (const int bit) const
	Test PMT status. More...

void	set (const int bit)
	Set PMT status. More...

void	reset (const int bit)
	Reset PMT status. More...

Static Public Member Functions
static JDetectorVersion &	getVersion ()
	Get detector version. More...

static void	setVersion (const JVersion &version)
	Set detector version. More...

static bool	compare (const JModule &first, const JModule &second, const double precision=1.0e-3)
	Compare modules. More...

static const JQuaternion3D &	getIdentity ()
	Get identity quaternion. More...

Protected Attributes
int	__id

int	string

int	floor

double	__x

double	__y

double	__z

double	__a

double	__b

double	__c

double	__d

double	t0

int	status

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

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

JReader &	operator>> (JReader &in, JModule &module)
	Read module from input. More...

JWriter &	operator<< (JWriter &out, const JModule &module)
	Write module to output. More...

Detailed Description

Data structure for a composite optical module.

A module consists of a set of PMTs. A JPMT object is used for each PMT.
The index of the PMT in the module corresponds to the readout channel (TDC).
The quaternion data and time offset correspond to the calibration of the compass and piezo sensor inside the module, respectively.
There are no PMTs and piezo sensor in the base module. The time offset then corresponds to the hydrophone. Note that the positions of the PMTs are absolute in space (i.e. not relative to the position of the module).

The I/O of the position, quaternion data and time offset of the module depends on the detector version.
The member method JModule::compile is used to set the position, quaternion data and time offset for detector versions for which these are not defined.
In this, the position of the module is determined from the intersection point of the PMT axes.

Note finally that the positions of the reference modules may not exactly be at the origin due to the finite accuracy of the PMT axes.

Definition at line 68 of file JModule.hh.

Constructor & Destructor Documentation

JDETECTOR::JModule::JModule ( )

inline

Default constructor.

Definition at line 86 of file JModule.hh.

               :
       JModuleIdentifier(),
       JLocation(),
       JPosition3D(),
       JQuaternion3D(),
       JCalibration(),
       JStatus(),
       std::vector<JPMT>()
     {}

JDETECTOR::JModule::JModule	(	const int	id,
		const JLocation &	location
	)

inline

Constructor.

Parameters

id	identifier
location	location

Definition at line 103 of file JModule.hh.

                                        :
       JModuleIdentifier(id),
       JLocation(location),
       JPosition3D(),
       JQuaternion3D(),
       JCalibration(),
       JStatus(),
       std::vector<JPMT>()
     {}

Member Function Documentation

static JDetectorVersion& JDETECTOR::JModule::getVersion ( )

inlinestatic

Get detector version.

Definition at line 118 of file JModule.hh.

     {
       static JDetectorVersion version;
 
       return version;
     }

static void JDETECTOR::JModule::setVersion ( const JVersion & version )

inlinestatic

Set detector version.

Parameters

version version

Definition at line 131 of file JModule.hh.

     {
       getVersion() = JDetectorVersion(version);
     }

static bool JDETECTOR::JModule::compare	(	const JModule &	first,
		const JModule &	second,
		const double	precision = `1.0e-3`
	)

inlinestatic

Compare modules.

The comparison only covers the orientations of the modules.

Parameters

first	first module
second	second module
precision	precision

Returns: true if two modules are equal; else false

Definition at line 147 of file JModule.hh.

     {
       if (first.size() == second.size()) {
 
         for (size_t i = 0; i != first.size(); ++i) {
           if (first[i].getDirection().getDot(second[i].getDirection()) < 1.0 - precision) {
             return false;
           }
         }
 
         return true;
       }
 
       return false;
     }

const JPMT& JDETECTOR::JModule::getPMT ( const int index ) const

inline

Get PMT.

Parameters

index readout channel (TDC)

Returns: PMT at given index

Definition at line 173 of file JModule.hh.

     {
       return at(index);
     }

JPMT& JDETECTOR::JModule::getPMT ( const int index )

inline

Get PMT.

Parameters

index readout channel (TDC)

Returns: PMT at given index

Definition at line 185 of file JModule.hh.

     {
       return at(index);
     }

void JDETECTOR::JModule::setPMT	(	const int	index,
		const JPMT &	pmt
	)

inline

Set PMT.

Parameters

index	readout channel (TDC)
pmt	PMT

Definition at line 197 of file JModule.hh.

     {
       if (index >= (int) size()) {
         resize(index + 1);
       }
 
       (*this)[index] = pmt;
     }

JVector3D JDETECTOR::JModule::getCenter ( ) const

inline

Get center of module based on crossing point of PMT axes.

This method perform a fit of the crossing point of the PMT axes.
A general purpose implementation of such a fit is available in JFIT::JEstimator<JPoint3D>.

Returns: center

Definition at line 215 of file JModule.hh.

     {
       using namespace JPP;
 
       if (this->size() > 1u) {
 
         double x = 0;
         double y = 0;
         double z = 0;
 
         JMatrix3S V;
 
         for (const_iterator pmt = this->begin(); pmt != this->end(); ++pmt) {
 
           const double xx = 1.0  -  pmt->getDX() * pmt->getDX();
           const double yy = 1.0  -  pmt->getDY() * pmt->getDY();
           const double zz = 1.0  -  pmt->getDZ() * pmt->getDZ();
 
           const double xy = -pmt->getDX() * pmt->getDY();
           const double xz = -pmt->getDX() * pmt->getDZ();
           const double yz = -pmt->getDY() * pmt->getDZ();
 
           V.a00 += xx;
           V.a01 += xy;
           V.a02 += xz;
 
           V.a11 += yy;
           V.a12 += yz;
 
           V.a22 += zz;
 
           x  +=  xx * pmt->getX()  + xy * pmt->getY()  +  xz * pmt->getZ();
           y  +=  xy * pmt->getX()  + yy * pmt->getY()  +  yz * pmt->getZ();
           z  +=  xz * pmt->getX()  + yz * pmt->getY()  +  zz * pmt->getZ();
         }
 
         V.a10 = V.a01;
         V.a20 = V.a02;
         V.a21 = V.a12;
 
         V.invert();
 
         return JVector3D(V.a00 * x  +  V.a01 * y  +  V.a02 * z,
                          V.a10 * x  +  V.a11 * y  +  V.a12 * z,
                          V.a20 * x  +  V.a21 * y  +  V.a22 * z);
 
       } else {
         throw JValueOutOfRange("JModule::getCenter(): Not enough PMTs.");
       }
     }

void JDETECTOR::JModule::compile ( )

inline

Compile module data.

For detector versions before JDetectorVersion::V4, the position, quaternion data and time offset of the module should be set.
The position is set to the intersection point of the PMT axes (or their average position if this is not possible).
The quaternion data are maintained.
For an optical module (i.e. floor > 0), the time offset is set to the average time offset of the PMTs and for a base module (i.e. floor = 0), the time offset is set to zero.
These time offsets should be corrected for delay in the piezo sensor and hydrophone, respectively.

Definition at line 282 of file JModule.hh.

     {
       using namespace std;
       using namespace JPP;
 
       if (!this->empty()) {
 
         JPosition3D& pos = this->getPosition();
 
         try {
           pos = this->getCenter();
         }
         catch(const exception&) {
 
           pos = JPosition3D(0.0, 0.0, 0.0);
 
           for (iterator i = this->begin(); i != this->end(); ++i) {
             pos.add(i->getPosition());
           }
 
           pos.div(size());
         }
       }
 
       this->setCalibration(getAverage(make_array(this->begin(), this->end(), &JModule::getT0), 0.0));
     }

void JDETECTOR::JModule::rotate ( const JRotation3D & R )

inline

Rotate module.

Parameters

R	rotation matrix

Definition at line 315 of file JModule.hh.

     {
       JPosition3D::rotate(R);
 
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->rotate(R);
       }
     }

void JDETECTOR::JModule::rotate_back ( const JRotation3D & R )

inline

Rotate back module.

Parameters

R	rotation matrix

Definition at line 330 of file JModule.hh.

     {
       JPosition3D::rotate_back(R);
 
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->rotate_back(R);
       }
     }

void JDETECTOR::JModule::transform	(	const JRotation3D &	R,
		const JVector3D &	pos
	)

inline

Transformation of geometry (see method JGEOMETRY3D::JPosition3D::transform(const JRotation3D&, const JVector3D&)).

Parameters

R	rotation matrix
pos	position of origin (after rotation)

Definition at line 346 of file JModule.hh.

     {
       JPosition3D::transform(R, pos);
 
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->transform(R, pos);
       }
     }

void JDETECTOR::JModule::transform ( const JTransformation3D & T )

inline

Transformation of geometry.

Parameters

T	transformation

Definition at line 362 of file JModule.hh.

     {
       JPosition3D::transform(T.getRotation(), T.getPosition());
 
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->transform(T);
       }
     }

void JDETECTOR::JModule::rotate ( const JQuaternion3D & Q )

inline

Rotate module.

Parameters

Q	quaternion

Definition at line 377 of file JModule.hh.

     {
       JPosition3D::rotate(Q);
 
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->rotate(Q);
       }
     }

void JDETECTOR::JModule::rotate_back ( const JQuaternion3D & Q )

inline

Rotate back module.

Parameters

Q	quaternion

Definition at line 392 of file JModule.hh.

     {
       JPosition3D::rotate_back(Q);
 
       for (iterator i = this->begin(); i != this->end(); ++i) {
         i->rotate_back(Q);
       }
     }

JModule& JDETECTOR::JModule::set ( const JVector3D & pos )

inline

Set position.

Parameters

pos position

Returns: this module

Definition at line 408 of file JModule.hh.

     {
       return add(pos - this->getPosition());
     }

JModule& JDETECTOR::JModule::add ( const JVector3D & pos )

inline

Add position.

Parameters

pos position

Returns: this module

Definition at line 420 of file JModule.hh.

     {
       for (iterator i = begin(); i != end(); ++i) {
         i->add(pos);
       }
 
       JPosition3D::add(pos);
 
       return *this;
     }

JModule& JDETECTOR::JModule::sub ( const JVector3D & pos )

inline

Subtract position.

Parameters

pos position

Returns: this module

Definition at line 438 of file JModule.hh.

     {
       for (iterator i = begin(); i != end(); ++i) {
         i->sub(pos);
       }
 
       JPosition3D::sub(pos);
 
       return *this;
     }

JModule& JDETECTOR::JModule::set ( const double t0 )

inline

Set time offset.

Parameters

t0	time offset [ns]

Returns: this module

Definition at line 456 of file JModule.hh.

     {
       for (iterator i = begin(); i != end(); ++i) {
         i->setT0(t0);
       }
 
       return *this;
     }

JModule& JDETECTOR::JModule::add ( const double t0 )

inline

Add time offset.

Parameters

t0	time offset [ns]

Returns: this module

Definition at line 472 of file JModule.hh.

     {
       for (iterator i = begin(); i != end(); ++i) {
         i->addT0(t0);
       }
 
       return *this;
     }

JModule& JDETECTOR::JModule::sub ( const double t0 )

inline

Subtract time offset.

Parameters

t0	time offset [ns]

Returns: this module

Definition at line 488 of file JModule.hh.

     {
       for (iterator i = begin(); i != end(); ++i) {
         i->subT0(t0);
       }
 
       return *this;
     }

JModule& JDETECTOR::JModule::operator+= ( const JVector3D & pos )

inline

Add position.

Parameters

pos position

Returns: this module

Definition at line 504 of file JModule.hh.

     {
       return this->add(pos);
     }

JModule& JDETECTOR::JModule::operator-= ( const JVector3D & pos )

inline

Subtract position.

Parameters

pos position

Returns: this module

Definition at line 516 of file JModule.hh.

     {
       return this->sub(pos);
     }

int JLANG::JObjectID::getID ( ) const

inlineinherited

Get identifier.

Returns: identifier

Definition at line 50 of file JObjectID.hh.

     { 
       return __id;
     }

int& JLANG::JObjectID::getID ( )

inlineinherited

Get identifier.

Returns: identifier

Definition at line 61 of file JObjectID.hh.

     { 
       return __id;
     }

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

inlineinherited

Set identifier.

Parameters

id	identifier

Definition at line 72 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 84 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 96 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 108 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 130 of file JPosition3D.hh.

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

JPosition3D& JGEOMETRY3D::JPosition3D::getPosition ( )

inlineinherited

Get position.

Returns: position

Definition at line 141 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 152 of file JPosition3D.hh.

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

JGEOMETRY3D::JPosition3D::operator JAngle3D ( ) const

inlineinherited

Type conversion operator.

Returns: angle

Definition at line 163 of file JPosition3D.hh.

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

JGEOMETRY3D::JPosition3D::operator JVersor3D ( ) const

inlineinherited

Type conversion operator.

Returns: direction

Definition at line 174 of file JPosition3D.hh.

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

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

inlineinherited

Rotate around X-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 214 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 242 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 270 of file JPosition3D.hh.

     {
       R.rotate(__x, __y);
 
       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 228 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 256 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 284 of file JPosition3D.hh.

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

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

inlineinherited

Transform.

Parameters

T matrix

Returns: this vector

Definition at line 206 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 359 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 378 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 393 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 408 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 282 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 83 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 94 of file JVector3D.hh.

     { 
       return __x;
     }

double JGEOMETRY3D::JVector3D::getY ( ) const

inlineinherited

Get y position.

Returns: y position

Definition at line 104 of file JVector3D.hh.

     { 
       return __y;
     }

double JGEOMETRY3D::JVector3D::getZ ( ) const

inlineinherited

Get z position.

Returns: z position

Definition at line 115 of file JVector3D.hh.

     { 
       return __z;
     }

JVector3D& JGEOMETRY3D::JVector3D::negate ( )

inlineinherited

Negate vector.

Returns: this vector

Definition at line 126 of file JVector3D.hh.

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

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

inlineinherited

Scale vector.

Parameters

factor multiplication factor

Returns: this vector

Definition at line 174 of file JVector3D.hh.

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

template<class JFirst_t, class JSecond_t = JNullType>

JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 354 of file JMath.hh.

     {
       return static_cast<JFirst_t&>(*this) = JFirst_t().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 190 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 221 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 235 of file JVector3D.hh.

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

double JGEOMETRY3D::JVector3D::getLength ( ) const

inlineinherited

Get length.

Returns: length

Definition at line 246 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 258 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 270 of file JVector3D.hh.

     {
       return sqrt(getDistanceSquared(pos));
     }

JVector3D& JGEOMETRY3D::JVector3D::getCross	(	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 299 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;
     }

static const JQuaternion3D& JGEOMETRY3D::JQuaternion3D::getIdentity ( )

inlinestaticinherited

Get identity quaternion.

Returns: identity quaternion

Definition at line 463 of file JQuaternion3D.hh.

     {
       static const JQuaternion3D Q = JQuaternion3D().setIdentity();
 
       return Q;
     }

const JQuaternion3D& JGEOMETRY3D::JQuaternion3D::getQuaternion ( ) const

inlineinherited

Get quaternion.

Returns: quaternion

Definition at line 476 of file JQuaternion3D.hh.

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

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::getQuaternion ( )

inlineinherited

Get quaternion.

Returns: quaternion

Definition at line 487 of file JQuaternion3D.hh.

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

void JGEOMETRY3D::JQuaternion3D::setQuaternion ( const JQuaternion3D & quaternion )

inlineinherited

Set quaternion.

Parameters

quaternion quaternion

Definition at line 498 of file JQuaternion3D.hh.

     {
       static_cast<JQuaternion3D&>(*this) = quaternion;
     }

JGEOMETRY3D::JQuaternion3D::operator JVector3D ( ) const

inlineinherited

Type conversion operator.

Returns: position

Definition at line 509 of file JQuaternion3D.hh.

     {
       return JVector3D(this->getB(), this->getC(), this->getD());
     }

JGEOMETRY3D::JQuaternion3D::operator JVersor3D ( ) const

inlineinherited

Type conversion operator.

Returns: direction

Definition at line 520 of file JQuaternion3D.hh.

     {
       return JVersor3D(this->getB(), this->getC(), this->getD());
     }

double JGEOMETRY3D::JQuaternion3D::getAngle ( ) const

inlineinherited

Get rotation angle.

Returns: angle [rad]

Definition at line 531 of file JQuaternion3D.hh.

     {
       return atan2(sqrt(this->getB()*this->getB() +
                         this->getC()*this->getC() +
                         this->getD()*this->getD()),
                    this->getA()) * 2.0;
     }

double JGEOMETRY3D::JQuaternion3D::getA ( ) const

inlineinherited

Get a value.

Returns: a value

Definition at line 545 of file JQuaternion3D.hh.

     { 
       return __a;
     }

double JGEOMETRY3D::JQuaternion3D::getB ( ) const

inlineinherited

Get b value.

Returns: b value

Definition at line 556 of file JQuaternion3D.hh.

     { 
       return __b;
     }

double JGEOMETRY3D::JQuaternion3D::getC ( ) const

inlineinherited

Get c value.

Returns: c value

Definition at line 567 of file JQuaternion3D.hh.

     { 
       return __c;
     }

double JGEOMETRY3D::JQuaternion3D::getD ( ) const

inlineinherited

Get d value.

Returns: d value

Definition at line 578 of file JQuaternion3D.hh.

     { 
       return __d;
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::setIdentity ( )

inlineinherited

Set to identity quaternion.

Returns: this quaternion

Definition at line 589 of file JQuaternion3D.hh.

     {
       __a = 1.0;
       __b = 0.0;
       __c = 0.0;
       __d = 0.0;
 
       return *this;
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::conjugate ( )

inlineinherited

Conjugate quaternion.

Returns: this quaternion

Definition at line 605 of file JQuaternion3D.hh.

     {
       __b = -__b;
       __c = -__c;
       __d = -__d;
 
       return *this;
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::negate ( )

inlineinherited

Negate quaternion.

Returns: this quaternion

Definition at line 620 of file JQuaternion3D.hh.

     {
       __a = -__a;
       __b = -__b;
       __c = -__c;
       __d = -__d;
 
       return *this;
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::add ( const JQuaternion3D & quaternion )

inlineinherited

Add quaternion.

Parameters

quaternion quaternion

Returns: this quaternion

Definition at line 637 of file JQuaternion3D.hh.

     {
       __a += quaternion.getA();
       __b += quaternion.getB();
       __c += quaternion.getC();
       __d += quaternion.getD();
 
       return *this;
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::sub ( const JQuaternion3D & quaternion )

inlineinherited

Subtract quaternion.

Parameters

quaternion quaternion

Returns: this quaternion

Definition at line 654 of file JQuaternion3D.hh.

     {
       __a -= quaternion.getA();
       __b -= quaternion.getB();
       __c -= quaternion.getC();
       __d -= quaternion.getD();
 
       return *this;
     }

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

inlineinherited

Scale quaternion.

Parameters

factor multiplication factor

Returns: this quaternion

Definition at line 671 of file JQuaternion3D.hh.

     {
       __a *= factor;
       __b *= factor;
       __c *= factor;
       __d *= factor;
 
       return *this;
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::mul	(	const JQuaternion3D &	first,
		const JQuaternion3X &	second
	)

inlineinherited

Quaternion multiplication.

This method evaluates the Hamilton product (also called cross product).

Parameters

first	first quaternion
second	second quaternion

Returns: this quaternion

Definition at line 708 of file JQuaternion3D.hh.

     {
       __a =  first.getA() * second.getA() - first.getB() * second.getB();
       __b =  first.getA() * second.getB() + first.getB() * second.getA();
       __c =  first.getC() * second.getA() + first.getD() * second.getB();
       __d = -first.getC() * second.getB() + first.getD() * second.getA();
       
       return *this;
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::mul	(	const JQuaternion3D &	first,
		const JQuaternion3Y &	second
	)

inlineinherited

Quaternion multiplication.

This method evaluates the Hamilton product (or cross product).

Parameters

first	first quaternion
second	second quaternion

Returns: this quaternion

Definition at line 728 of file JQuaternion3D.hh.

     {
       __a =  first.getA() * second.getA() - first.getC() * second.getC();
       __b =  first.getB() * second.getA() - first.getD() * second.getC();
       __c =  first.getA() * second.getC() + first.getC() * second.getA();
       __d =  first.getB() * second.getC() + first.getD() * second.getA();
       
       return *this;
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::mul	(	const JQuaternion3D &	first,
		const JQuaternion3Z &	second
	)

inlineinherited

Quaternion multiplication.

This method evaluates the Hamilton product (or cross product).

Parameters

first	first quaternion
second	second quaternion

Returns: this quaternion

Definition at line 749 of file JQuaternion3D.hh.

     {
       __a =  first.getA() * second.getA() - first.getD() * second.getD();
       __b =  first.getB() * second.getA() + first.getC() * second.getD();
       __c = -first.getB() * second.getD() + first.getC() * second.getA();
       __d =  first.getA() * second.getD() + first.getD() * second.getA();
       
       return *this;
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::mul	(	const JQuaternion3D &	first,
		const JQuaternion3D &	second
	)

inlineinherited

Quaternion multiplication.

This method evaluates the Hamilton product (or cross product).

Parameters

first	first quaternion
second	second quaternion

Returns: this quaternion

Definition at line 770 of file JQuaternion3D.hh.

     {
       __a = first.getA() * second.getA() - first.getB() * second.getB() - first.getC() * second.getC() - first.getD() * second.getD();
       __b = first.getA() * second.getB() + first.getB() * second.getA() + first.getC() * second.getD() - first.getD() * second.getC();
       __c = first.getA() * second.getC() - first.getB() * second.getD() + first.getC() * second.getA() + first.getD() * second.getB();
       __d = first.getA() * second.getD() + first.getB() * second.getC() - first.getC() * second.getB() + first.getD() * second.getA();
       
       return *this;
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::mul	(	const JQuaternion3X &	qx,
		const JQuaternion3Y &	qy,
		const JQuaternion3Z &	qz
	)

inlineinherited

Quaternion multiplication.

Parameters

qx	rotation around x-axis
qy	rotation around y-axis
qz	rotation around x-axis

Returns: this quaternion

Definition at line 790 of file JQuaternion3D.hh.

     {
       return *this = JQuaternion3D().setIdentity().mul(qz).mul(qy).mul(qx);
     }

template<class JFirst_t, class JSecond_t = JNullType>

JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 354 of file JMath.hh.

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

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

inlineinherited

Scale quaternion.

Parameters

factor division factor

Returns: this quaternion

Definition at line 688 of file JQuaternion3D.hh.

     {
       __a /= factor;
       __b /= factor;
       __c /= factor;
       __d /= factor;
 
       return *this;
     }

void JGEOMETRY3D::JQuaternion3D::rotate	(	double &	__x,
		double &	__y,
		double &	__z
	)		const

inlineinherited

Rotate.

Parameters

__x	x value
__y	y value
__z	z value

Definition at line 805 of file JQuaternion3D.hh.

     {
       const double qx = 2.0 * (__c*__z - __d*__y);
       const double qy = 2.0 * (__d*__x - __b*__z);
       const double qz = 2.0 * (__b*__y - __c*__x);
 
       __x = __x + __c*qz - __d*qy + __a*qx;
       __y = __y - __b*qz + __a*qy + __d*qx;
       __z = __z + __a*qz + __b*qy - __c*qx;
     }

void JGEOMETRY3D::JQuaternion3D::rotate_back	(	double &	__x,
		double &	__y,
		double &	__z
	)		const

inlineinherited

Rotate back.

Parameters

__x	x value
__y	y value
__z	z value

Definition at line 824 of file JQuaternion3D.hh.

     {
       const double qx = 2.0 * (__d*__y - __c*__z);
       const double qy = 2.0 * (__b*__z - __d*__x);
       const double qz = 2.0 * (__c*__x - __b*__y);
 
       __x = __x - __c*qz + __d*qy + __a*qx;
       __y = __y + __b*qz + __a*qy - __d*qx;
       __z = __z + __a*qz - __b*qy + __c*qx;
     }

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

inlineinherited

Check equality.

Parameters

quaternion	quaternion
precision	numerical precision

Returns: true if quaternions are equal; else false

Definition at line 843 of file JQuaternion3D.hh.

     {
       return (fabs(getA() - quaternion.getA()) <= precision && 
               fabs(getB() - quaternion.getB()) <= precision &&
               fabs(getC() - quaternion.getC()) <= precision &&
               fabs(getD() - quaternion.getD()) <= precision);
     }

bool JGEOMETRY3D::JQuaternion3D::isIdentity ( const double precision = std::numeric_limits<double>::min() ) const

inlineinherited

Test identity.

Parameters

precision precision

Returns: true if identity quaternion; else false

Definition at line 859 of file JQuaternion3D.hh.

     {
       if (fabs(getA()) <= precision) {
 
         if (fabs(getB()) <= precision)
           return ((fabs(getC())       <= precision && fabs(fabs(getD()) - 1.0) <= precision)  ||
                   (fabs(fabs(getC()) - 1.0) <= precision && fabs(getD())       <= precision));
         else
           return (fabs(fabs(getB()) - 1.0) <= precision && 
                   fabs(getC())             <= precision &&
                   fabs(getD())             <= precision);
 
       } else {
 
         return (fabs(fabs(getA()) - 1.0) <= precision && 
                 fabs(getB())             <= precision &&
                 fabs(getC())             <= precision &&
                 fabs(getD())             <= precision);
       }
     }

double JGEOMETRY3D::JQuaternion3D::getLengthSquared ( ) const

inlineinherited

Get length squared.

Returns: square of length

Definition at line 886 of file JQuaternion3D.hh.

     { 
       return getA()*getA() + getB()*getB() + getC()*getC() + getD()*getD();
     }

double JGEOMETRY3D::JQuaternion3D::getLength ( ) const

inlineinherited

Get length.

Returns: length

Definition at line 897 of file JQuaternion3D.hh.

     { 
       return sqrt(getLengthSquared());
     }

double JGEOMETRY3D::JQuaternion3D::getDistanceSquared ( const JQuaternion3D & quaternion ) const

inlineinherited

Get squared of distance to quaternion.

Parameters

quaternion quaternion

Returns: square of distance

Definition at line 909 of file JQuaternion3D.hh.

     {
       return JQuaternion3D(quaternion).sub(*this).getLengthSquared();
     }

double JGEOMETRY3D::JQuaternion3D::getDistance ( const JQuaternion3D & quaternion ) const

inlineinherited

Get distance to quaternion.

Parameters

quaternion quaternion

Returns: distance

Definition at line 921 of file JQuaternion3D.hh.

     {
       return sqrt(getDistanceSquared(quaternion));
     }

double JGEOMETRY3D::JQuaternion3D::getDot ( const JQuaternion3D & quaternion ) const

inlineinherited

Get dot product.

Parameters

quaternion quaternion

Returns: dot product

Definition at line 933 of file JQuaternion3D.hh.

     {
       return
         getA() * quaternion.getA() -
         getB() * quaternion.getB() -
         getC() * quaternion.getC() -
         getD() * quaternion.getD();
     }

JQuaternion3D JGEOMETRY3D::JQuaternion3D::getConjugate ( ) const

inlineinherited

Get conjugate of this quaternion.

Returns: conjugate quaternion

Definition at line 948 of file JQuaternion3D.hh.

     {
       return JQuaternion3D(*this).conjugate();
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::normalise ( )

inlineinherited

Normalise quaternion.

Returns: this quaternion

Definition at line 959 of file JQuaternion3D.hh.

     {
       const double v = getLength();
 
       if (v != 0.0) {
         mul(1.0 / v);
       }
 
       return *this;
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::pow ( const double y )

inlineinherited

Raise quaternion to given power.

Parameters

y power

Returns: this object

Definition at line 977 of file JQuaternion3D.hh.

     {
       const double v = sqrt(getB() * getB()  +
                             getC() * getC()  +
                             getD() * getD());
 
       if (v != 0.0) {
 
         const JVersor3D u(getB(), getC(), getD());
 
         const double theta = atan2(v, getA());
 
         *this = JQuaternion3D(2.0 * theta * y, u);
       }
 
       return *this;
     }

JQuaternion3D& JGEOMETRY3D::JQuaternion3D::interpolate	(	const JQuaternion3D &	object,
		const double	alpha
	)

inlineinherited

Interpolation between quaternions.

The result is equal to *this = (1 - alpha) * (*this) + (alpha) * (object).

Parameters

object	object
alpha	interpolation factor `[0, 1]`

Returns: this object

Definition at line 1004 of file JQuaternion3D.hh.

     {
       const double MAXIMAL_DOT_PRODUCT = 0.9995;
       
       JQuaternion3D v0(*this);
       JQuaternion3D v1(object);
 
       v0.normalise();
       v1.normalise();
 
       double dot = v0.getDot(v1);
 
       if (dot < 0.0) {
         v1  = -v1;
         dot = -dot;
       }
 
       double s1 = alpha;
       double s0 = 1.0 - alpha;
 
       if (dot <= MAXIMAL_DOT_PRODUCT) {
 
         const double theta_0 = acos(dot);
         const double theta_1 = theta_0 * alpha;
       
         s1 = sin(theta_1) / sin(theta_0);
         s0 = cos(theta_1) - dot * s1;
       }
 
       *this = (s0 * v0)  +  (s1 * v1);
 
       return normalise();
     }

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

inlineinherited

Get calibration.

Returns: calibration

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

     {
       return *this;
     }

JCalibration& JDETECTOR::JCalibration::getCalibration ( )

inlineinherited

Get calibration.

Returns: calibration

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

     {
       return *this;
     }

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

inlineinherited

Set calibration.

Parameters

cal	calibration

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

     {
       *this = cal;
     }

double JDETECTOR::JCalibration::getT0 ( ) const

inlineinherited

Get time offset.

Returns: time offset [ns]

Definition at line 100 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 111 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 122 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 133 of file JDetector/JCalibration.hh.

     {
       this->t0 -= t0;
     }

int JEEP::JStatus::getStatus ( ) const

inlineinherited

Get status.

Returns: status

Definition at line 63 of file JStatus.hh.

     { 
       return this->status;
     }

JStatus& JEEP::JStatus::getStatus ( )

inlineinherited

Get status.

Returns: status

Definition at line 74 of file JStatus.hh.

     { 
       return *this;
     }

int JEEP::JStatus::getStatus ( const int mask ) const

inlineinherited

Get status.

Parameters

mask mask

Returns: status

Definition at line 86 of file JStatus.hh.

     { 
       return (this->status & mask);
     }

void JEEP::JStatus::setStatus ( const JStatus & status )

inlineinherited

Set status.

Parameters

status status

Definition at line 97 of file JStatus.hh.

     { 
       this->status = status.status;
     }

bool JEEP::JStatus::equals ( const JStatus & status ) const

inlineinherited

Equal method.

Parameters

status status

Returns: true if this status equal to given status; else false

Definition at line 109 of file JStatus.hh.

     {
       return this->status == status.status;
     }

bool JEEP::JStatus::has ( const int bit ) const

inlineinherited

Test PMT status.

Parameters

bit bit

Definition at line 120 of file JStatus.hh.

     {
       return (this->status & (1<<bit)) != 0;
     }

void JEEP::JStatus::set ( const int bit )

inlineinherited

Set PMT status.

Parameters

bit bit

Definition at line 131 of file JStatus.hh.

     {
       this->status |= (1<<bit);
     }

void JEEP::JStatus::reset ( const int bit )

inlineinherited

Reset PMT status.

Parameters

bit bit

Definition at line 142 of file JStatus.hh.

     {
       this->status &= ~(1<<bit);
     }

Friends And Related Function Documentation

std::istream& operator>>	(	std::istream &	in,
		JModule &	module
	)

friend

Read module from input.

Parameters

in	input stream
module	module

Returns: input stream

Definition at line 529 of file JModule.hh.

     {
       module = JModule();
 
       in >> static_cast<JModuleIdentifier&>(module);
       in >> static_cast<JLocation&>        (module);
 
       if (getDetectorVersion(getVersion()) >= JDetectorVersion::V4) {
         in >> static_cast<JPosition3D&>  (module);
         in >> static_cast<JQuaternion3D&>(module);
         in >> static_cast<JCalibration&> (module);
       }
 
       if (getDetectorVersion(getVersion()) >= JDetectorVersion::V5) {
         in >> static_cast<JStatus&>      (module);
       }
 
       unsigned int n;
 
       in >> n;
 
       for (JPMT pmt; n != 0 && in >> pmt; --n) {
         module.push_back(pmt);
       }
 
       if (getDetectorVersion(getVersion()) <  JDetectorVersion::V4) {
         module.compile();
       }
 
       return in;
     }

std::ostream& operator<<	(	std::ostream &	out,
		const JModule &	module
	)

friend

Write module to output.

Parameters

out	output stream
module	module

Returns: output stream

Definition at line 569 of file JModule.hh.

     {
       using namespace std;
 
       out << setw(10);
       out << static_cast<const JModuleIdentifier&>(module);
       out << ' ';
       out << static_cast<const JLocation&>        (module);
 
       if (getDetectorVersion(getVersion()) >= JDetectorVersion::V4) {
         out << ' ';
         out << static_cast<const JPosition3D&>  (module);
         out << ' ';
         out << static_cast<const JQuaternion3D&>(module);
         out << ' ';
         out << static_cast<const JCalibration&> (module);
       }
 
       if (getDetectorVersion(getVersion()) >= JDetectorVersion::V5) {
         out << ' ';
         out << static_cast<const JStatus&>      (module);
       }
 
       out << ' ' << module.size() << endl;
 
       for (const_iterator i = module.begin(); i != module.end(); ++i) {
         out << ' ' << *i << endl;;
       }
 
       return out;
     }

JReader& operator>>	(	JReader &	in,
		JModule &	module
	)

friend

Read module from input.

Parameters

in	reader
module	module

Returns: rrreader

Definition at line 609 of file JModule.hh.

     {
       module = JModule();
 
       in >> static_cast<JModuleIdentifier&>(module);
       in >> static_cast<JLocation&>        (module);
 
       if (getDetectorVersion(getVersion()) >= JDetectorVersion::V4) {
         in >> static_cast<JPosition3D&>  (module);
         in >> static_cast<JQuaternion3D&>(module);
         in >> static_cast<JCalibration&> (module);
       }
 
       if (getDetectorVersion(getVersion()) >= JDetectorVersion::V5) {
         in >> static_cast<JStatus&>      (module);
       }
 
       int n;
 
       in >> n;
 
       module.resize(n);
 
       for (JModule::iterator out = module.begin(); n != 0; --n, ++out) {
         in >> *out;
       }
 
       if (getDetectorVersion(getVersion()) <  JDetectorVersion::V4) {
         module.compile();
       }
 
       return in;
     }

JWriter& operator<<	(	JWriter &	out,
		const JModule &	module
	)

friend

Write module to output.

Parameters

out	writer
module	module

Returns: writer

Definition at line 651 of file JModule.hh.

     {
       out << static_cast<const JModuleIdentifier&>(module);
       out << static_cast<const JLocation&>        (module);
 
       if (getDetectorVersion(getVersion()) >= JDetectorVersion::V4) {
         out << static_cast<const JPosition3D&>  (module);
         out << static_cast<const JQuaternion3D&>(module);
         out << static_cast<const JCalibration&> (module);
       }
 
       if (getDetectorVersion(getVersion()) >= JDetectorVersion::V5) {
         out << static_cast<const JStatus&>      (module);
       }
 
       int n = module.size();
 
       out << n;
 
       for (const_iterator i = module.begin(); i != module.end(); ++i) {
         out << *i;
       }
 
       return out;
     }

Member Data Documentation

int JLANG::JObjectID::__id

protectedinherited

Definition at line 140 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 310 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__y

protectedinherited

Definition at line 311 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__z

protectedinherited

Definition at line 312 of file JVector3D.hh.

double JGEOMETRY3D::JQuaternion3D::__a

protectedinherited

Definition at line 1117 of file JQuaternion3D.hh.

double JGEOMETRY3D::JQuaternion3D::__b

protectedinherited

Definition at line 1118 of file JQuaternion3D.hh.

double JGEOMETRY3D::JQuaternion3D::__c

protectedinherited

Definition at line 1119 of file JQuaternion3D.hh.

double JGEOMETRY3D::JQuaternion3D::__d

protectedinherited

Definition at line 1120 of file JQuaternion3D.hh.

double JDETECTOR::JCalibration::t0

protectedinherited

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

int JEEP::JStatus::status

protectedinherited

Definition at line 200 of file JStatus.hh.

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

JModule.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