JDETECTOR::JPMT Class Reference

Data structure for PMT geometry, calibration and status. More...

#include <JPMT.hh>

Inheritance diagram for JDETECTOR::JPMT:

Public Member Functions
	JPMT ()
	Default constructor.
	JPMT (const int id, const JAxis3D &axis, const JStatus &status=JStatus())
	Constructor.
	JPMT (const int id, const JAxis3D &axis, const JCalibration &cal, const JStatus &status=JStatus())
	Constructor.
double	getDot (const JPMT &pmt) const
	Dot product.
int	getID () const
	Get identifier.
int &	getID ()
	Get identifier.
void	setID (const int id)
	Set identifier.
bool	less (const JObjectID &object) const
	Less than method.
bool	less (const int id) const
	Less than method.
bool	more (const int id) const
	More than method.
const JAxis3D &	getAxis () const
	Get axis.
void	setAxis (const JAxis3D &axis)
	Set axis.
JAxis3D &	negate ()
	Negate axis.
void	move (const double step)
	Move vertex along this axis.
double	getIntersection (const JVector3D &pos) const
	Get longitudinal position along axis of position of closest approach with given position.
double	getIntersection (const JAxis3D &axis, const double precision=1.0e-8) const
	Get longitudinal position along axis of position of closest approach with given axis.
double	getDistanceSquared (const JVector3D &pos) const
	Get distance squared.
double	getDistance (const JVector3D &pos) const
	Get distance.
JAxis3D &	rotate (const JRotation3D &R)
	Rotate axis.
JAxis3D &	rotate (const JRotation3X &R)
	Rotate around X-axis.
JAxis3D &	rotate (const JRotation3Y &R)
	Rotate around Y-axis.
JAxis3D &	rotate (const JRotation3Z &R)
	Rotate around Z-axis.
JAxis3D &	rotate (const JQuaternion3D &Q)
	Rotate axis.
JAxis3D &	rotate_back (const JRotation3D &R)
	Rotate back axis.
JAxis3D &	rotate_back (const JRotation3X &R)
	Rotate back around X-axis.
JAxis3D &	rotate_back (const JRotation3Y &R)
	Rotate back around Y-axis.
JAxis3D &	rotate_back (const JRotation3Z &R)
	Rotate back around Z-axis.
JPosition3D &	rotate_back (const JQuaternion3D &Q)
	Rotate back.
JDirection3D &	rotate_back (const JQuaternion3D &Q)
	Rotate back.
void	transform (const JAxis3D &axis)
	Transform axis to reference frame of given axis.
void	transform (const JRotation3D &R, const JVector3D &pos)
	Transform axis.
void	transform (const JTransformation3D &T)
	Transform axis.
JVector3D &	transform (const JMatrix3D &T)
	Transform.
JDirection3D &	transform (const JMatrix3D &T)
	Transform.
void	transform_back (const JRotation3D &R, const JVector3D &pos)
	Transform back axis.
void	transform_back (const JTransformation3D &T)
	Transform back axis.
double	getDot (const JAngle3D &angle) const
	Get dot product.
double	getDot (const JVector3D &pos) const
	Get dot product.
double	getDot (const JVersor3Z &dir) const
	Get dot product.
double	getDot (const JVersor3D &dir) const
	Get dot product.
double	getDot (const JVersor3D &versor) const
	Get dot product.
const JPosition3D &	getPosition () const
	Get position.
JPosition3D &	getPosition ()
	Get position.
void	setPosition (const JVector3D &pos)
	Set position.
	operator JAngle3D () const
	Type conversion operator.
	operator JAngle3D () const
	Type conversion operator.
	operator JVersor3D () const
	Type conversion operator.
	operator JVector2D () const
	Type conversion operator.
double	getX () const
	Get x position.
double	getY () const
	Get y position.
double	getZ () const
	Get z position.
JVector3D &	add (const JVector3D &vector)
	Add vector.
JVector3D &	sub (const JVector3D &vector)
	Subtract vector.
JVector3D &	mul (const double factor)
	Scale vector.
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.
JVector3D &	div (const double factor)
	Scale vector.
bool	equals (const JVector3D &vector, const double precision=std::numeric_limits< double >::min()) const
	Check equality.
bool	equals (const JVersor3D &versor, const double precision=std::numeric_limits< double >::min()) const
	Check equality.
double	getLengthSquared () const
	Get length squared.
double	getLength () const
	Get length.
JVector3D &	getCross (const JVector3D &first, const JVector3D &second)
	Get cross product.
JVersor3D &	getCross (const JVersor3D &first, const JVersor3D &second)
	Get cross product.
const JDirection3D &	getDirection () const
	Get direction.
JDirection3D &	getDirection ()
	Get direction.
void	setDirection (const JDirection3D &dir)
	Set direction.
	operator JVector3D () const
	Type conversion operator.
double	getDX () const
	Get x direction.
double	getDY () const
	Get y direction.
double	getDZ () const
	Get z direction.
double	getTheta () const
	Get theta angle.
double	getPhi () const
	Get phi angle.
JVersor3D &	normalise ()
	Normalise versor.
const JCalibration &	getCalibration () const
	Get calibration.
JCalibration &	getCalibration ()
	Get calibration.
void	setCalibration (const JCalibration &cal)
	Set calibration.
double	getT0 () const
	Get time offset.
void	setT0 (const double t0)
	Set time offset.
void	addT0 (const double t0)
	Add time offset.
void	subT0 (const double t0)
	Subtract time offset.
int	getStatus () const
	Get status.
JStatus &	getStatus ()
	Get status.
int	getStatus (const int mask) const
	Get status.
void	setStatus (const JStatus &status)
	Set status.
bool	equals (const JStatus &status) const
	Equal method.
bool	has (const int bit) const
	Test PMT status.
void	set (const int bit)
	Set PMT status.
void	reset (const int bit)
	Reset PMT status.

Static Public Member Functions
static JDetectorVersion &	getVersion ()
	Get detector version.
static void	setVersion (const JVersion &version)
	Set detector version.

Protected Attributes
int	__id
double	__x
double	__y
double	__z
double	__dx
double	__dy
double	__dz
double	t0
int	status

Friends
std::istream &	operator>> (std::istream &in, JPMT &pmt)
	Read PMT from input.
std::ostream &	operator<< (std::ostream &out, const JPMT &pmt)
	Write PMT to output.
JReader &	operator>> (JReader &in, JPMT &pmt)
	Read PMT from input.
JWriter &	operator<< (JWriter &out, const JPMT &pmt)
	Write PMT to output.

Detailed Description

Data structure for PMT geometry, calibration and status.

The I/O of the status of the PMT depends on the detector version.
Note that the axis of the PMT points in the direction of the field of view of the photo-cathode.
Note also that the comparison between PMTs is based on the identifier only.

Definition at line 43 of file JPMT.hh.

Constructor & Destructor Documentation

JPMT() [1/3]

JDETECTOR::JPMT::JPMT ( )

inline

Default constructor.

Definition at line 54 of file JPMT.hh.

           :
      JObjectID(),
      JAxis3D(),
      JCalibration(),
      JStatus()
    {}

JPMT() [2/3]

JDETECTOR::JPMT::JPMT ( const int id, const JAxis3D & axis, const JStatus & status = JStatus() )

inline

Constructor.

Parameters

id	identifier
axis	axis
status	status

Definition at line 69 of file JPMT.hh.

                                            : 
      JObjectID(id),
      JAxis3D(axis),
      JCalibration(),
      JStatus(status)
    {}

JPMT() [3/3]

JDETECTOR::JPMT::JPMT ( const int id, const JAxis3D & axis, const JCalibration & cal, const JStatus & status = JStatus() )

inline

Constructor.

Parameters

id	identifier
axis	axis
cal	calibration
status	status

Definition at line 87 of file JPMT.hh.

                                                 : 
      JObjectID(id),
      JAxis3D(axis),
      JCalibration(cal),
      JStatus(status)
    {}

Member Function Documentation

getVersion()

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

inlinestatic

Get detector version.

Definition at line 101 of file JPMT.hh.

    {
      static JDetectorVersion version;
 
      return version;
    }

setVersion()

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

inlinestatic

Set detector version.

Parameters

version

version

Definition at line 114 of file JPMT.hh.

    {
      getVersion() = JDetectorVersion(version);
    }

getDot() [1/6]

double JDETECTOR::JPMT::getDot ( const JPMT & pmt ) const

inline

Dot product.

The dot product is evaluated for the PMT orientation.

Parameters

pmt

PMT

Returns

dot product

Definition at line 128 of file JPMT.hh.

    {
      return this->getDirection().getDot(pmt.getDirection());
    }

getID() [1/2]

int JLANG::JObjectID::getID ( ) const

inlineinherited

Get identifier.

Returns

identifier

Definition at line 50 of file JObjectID.hh.

    { 
      return __id;
    }

getID() [2/2]

int & JLANG::JObjectID::getID ( )

inlineinherited

Get identifier.

Returns

identifier

Definition at line 61 of file JObjectID.hh.

    { 
      return __id;
    }

setID()

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

inlineinherited

Set identifier.

Parameters

id	identifier

Definition at line 72 of file JObjectID.hh.

    { 
      this->__id = id;
    }

less() [1/2]

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();
    }

less() [2/2]

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;
    }

more()

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;
    }

getAxis()

const JAxis3D & JGEOMETRY3D::JAxis3D::getAxis ( ) const

inlineinherited

Get axis.

Returns

axis

Definition at line 98 of file JAxis3D.hh.

    { 
      return *this; 
    }

setAxis()

void JGEOMETRY3D::JAxis3D::setAxis ( const JAxis3D & axis )

inlineinherited

Set axis.

Parameters

axis

axis

Definition at line 109 of file JAxis3D.hh.

    { 
      *this = axis; 
    }

negate()

JAxis3D & JGEOMETRY3D::JAxis3D::negate ( )

inlineinherited

Negate axis.

Returns

this axis

Definition at line 120 of file JAxis3D.hh.

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

move()

void JGEOMETRY3D::JAxis3D::move ( const double step )

inlineinherited

Move vertex along this axis.

Parameters

step

step

Definition at line 134 of file JAxis3D.hh.

    {
      getPosition() += step * JPosition3D(getDirection());    
    }

getIntersection() [1/2]

double JGEOMETRY3D::JAxis3D::getIntersection ( const JVector3D & pos ) const

inlineinherited

Get longitudinal position along axis of position of closest approach with given position.

Parameters

pos

position

Returns

longitudinal position

Definition at line 146 of file JAxis3D.hh.

    {
      JPosition3D D(pos);
 
      D.sub(this->getPosition());
 
      return D.getDot(this->getDirection());
    }

getIntersection() [2/2]

double JGEOMETRY3D::JAxis3D::getIntersection ( const JAxis3D & axis, const double precision = 1.0e-8 ) const

inlineinherited

Get longitudinal position along axis of position of closest approach with given axis.

If the axes are paralel, this position corresponds to the vertex of the given axis.

Parameters

axis	axis
precision	precision

Returns

longitudinal position

Definition at line 164 of file JAxis3D.hh.

    {
      JPosition3D  pos(getPosition ());
      JDirection3D dir(getDirection());
      
      const JRotation3D R(axis.getDirection());
     
      // offset this position with position of given axis
 
      pos.sub(axis.getPosition());
 
      // rotate along given axis
      
      pos.rotate(R);
      dir.rotate(R);
      
      // longitudinal position at minimal distance of approach
      
      const double alpha = pos.getX()  * dir.getDX()  +  pos.getY()  * dir.getDY();
      const double beta  = dir.getDX() * dir.getDX()  +  dir.getDY() * dir.getDY();
      
      return (fabs(beta) > precision ? -alpha/beta : -pos.getZ());
    }

getDistanceSquared()

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

inlineinherited

Get distance squared.

Parameters

pos

position

Returns

square of distance

Definition at line 195 of file JAxis3D.hh.

    {
      JPosition3D D(pos);
 
      D.sub(this->getPosition());
 
      const double dz = D.getDot(this->getDirection());
 
      return D.getLengthSquared() - dz*dz;
    }

getDistance()

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

inlineinherited

Get distance.

Parameters

pos

osition

Returns

distance

Definition at line 213 of file JAxis3D.hh.

    {
      return sqrt(this->getDistanceSquared(pos));
    }

rotate() [1/5]

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

inlineinherited

Rotate axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 225 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate(R);
      static_cast<JDirection3D&>(*this).rotate(R);
 
      return *this;
    }

rotate() [2/5]

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

inlineinherited

Rotate around X-axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 255 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate(R);
      static_cast<JDirection3D&>(*this).rotate(R);
 
      return *this;
    }

rotate() [3/5]

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

inlineinherited

Rotate around Y-axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 285 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate(R);
      static_cast<JDirection3D&>(*this).rotate(R);
 
      return *this;
    }

rotate() [4/5]

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

inlineinherited

Rotate around Z-axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 315 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate(R);
      static_cast<JDirection3D&>(*this).rotate(R);
 
      return *this;
    }

rotate() [5/5]

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

inlineinherited

Rotate axis.

Parameters

Q	quaternion

Returns

this axis

Definition at line 345 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate(Q);
      static_cast<JDirection3D&>(*this).rotate(Q);
 
      return *this;
    }

rotate_back() [1/6]

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

inlineinherited

Rotate back axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 240 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate_back(R);
      static_cast<JDirection3D&>(*this).rotate_back(R);
 
      return *this;
    }

rotate_back() [2/6]

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

inlineinherited

Rotate back around X-axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 270 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate_back(R);
      static_cast<JDirection3D&>(*this).rotate_back(R);
 
      return *this;
    }

rotate_back() [3/6]

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

inlineinherited

Rotate back around Y-axis.

Parameters

R	rotation matrix

Returns

this axis

Definition at line 300 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate_back(R);
      static_cast<JDirection3D&>(*this).rotate_back(R);
 
      return *this;
    }

rotate_back() [4/6]

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

inlineinherited

Rotate back around Z-axis.

Parameters

R	rotation matrix

Returns

his axis

Definition at line 330 of file JAxis3D.hh.

    {
      static_cast<JPosition3D&> (*this).rotate_back(R);
      static_cast<JDirection3D&>(*this).rotate_back(R);
 
      return *this;
    }

rotate_back() [5/6]

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

inlineinherited

Rotate back.

Parameters

Q	quaternion

Returns

this position

Definition at line 312 of file JPosition3D.hh.

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

rotate_back() [6/6]

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

inlineinherited

Rotate back.

Parameters

Q	quaternion

Returns

this position

Definition at line 321 of file JDirection3D.hh.

    {
      Q.rotate_back(__dx, __dy, __dz);
 
      return *this;
    }

transform() [1/5]

void JGEOMETRY3D::JAxis3D::transform ( const JAxis3D & axis )

inlineinherited

Transform axis to reference frame of given axis.

Parameters

axis

axis

Definition at line 359 of file JAxis3D.hh.

    {
      JRotation3D R  (axis.getDirection());
      JPosition3D pos(axis.getPosition ());
 
      transform(R, pos.rotate(R));
    }

transform() [2/5]

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

inlineinherited

Transform axis.

The final position and direction are obtained as follows:

1. rotation of the position and the direction according rotation matrix (R);
2. offset position with position of origin in rotated system (pos);
3. rotation of position and direction around z-axis, such that final position is in x-z plane;

Parameters

R	rotation matrix
pos	position of origin

Definition at line 379 of file JAxis3D.hh.

    {
      JPosition3D&  u = getPosition ();
      JDirection3D& v = getDirection();
 
      // rotate axis to system such that direction is along z-axis
 
      u.rotate(R);
      v.rotate(R);
 
      // offset with respect to origin
 
      u.sub(pos);
 
      // rotate axis to x-z plane such that position is in x-z plane
 
      const double phi = atan2(u.getY(), u.getX());
 
      const JRotation3Z r(-phi);
 
      u.rotate(r);
      v.rotate(r);
    }

transform() [3/5]

void JGEOMETRY3D::JAxis3D::transform ( const JTransformation3D & T )

inlineinherited

Transform axis.

Parameters

T	transformation

Definition at line 437 of file JAxis3D.hh.

    {
      transform(T.getRotation(), T.getPosition());
    }

transform() [4/5]

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;
    }

transform() [5/5]

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

inlineinherited

Transform.

Parameters

T

matrix

Returns

this direction

Definition at line 163 of file JDirection3D.hh.

    {
      T.transform(__dx, __dy, __dz);
 
      normalise();
 
      return *this;
    }

transform_back() [1/2]

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

inlineinherited

Transform back axis.

The final position and direction are obtained as follows:

1. offset position with position pos;
2. rotation of position and direction according matrix R;

Parameters

R	rotation matrix
pos	position of origin (before rotation)

Definition at line 415 of file JAxis3D.hh.

    {
      JPosition3D&  u = getPosition ();
      JDirection3D& v = getDirection();
 
      // offset with respect to origin
 
      u.add(pos);
 
      // rotate back axis to system with original particle direction
 
      u.rotate_back(R);
      v.rotate_back(R);
    }

transform_back() [2/2]

void JGEOMETRY3D::JAxis3D::transform_back ( const JTransformation3D & T )

inlineinherited

Transform back axis.

Parameters

T	transformation

Definition at line 448 of file JAxis3D.hh.

    {
      transform_back(T.getRotation(), T.getPosition());
    }

getDot() [2/6]

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

inlineinherited

Get dot product.

Parameters

angle

angle

Returns

dot product

Definition at line 335 of file JDirection3D.hh.

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

getDot() [3/6]

double JGEOMETRY3D::JDirection3D::getDot ( const JVector3D & pos ) const

inlineinherited

Get dot product.

Parameters

pos

position

Returns

dot product

Definition at line 350 of file JDirection3D.hh.

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

getDot() [4/6]

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

inlineinherited

Get dot product.

Parameters

dir

direction

Returns

dot product

Definition at line 365 of file JDirection3D.hh.

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

getDot() [5/6]

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();
    }

getDot() [6/6]

double JGEOMETRY3D::JVersor3D::getDot ( const JVersor3D & versor ) const

inlineinherited

Get dot product.

Parameters

versor

versor

Returns

dot product

Definition at line 156 of file JVersor3D.hh.

    {
      return
        getDX() * versor.getDX() + 
        getDY() * versor.getDY() +
        getDZ() * versor.getDZ();
    }

getPosition() [1/2]

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);
    }

getPosition() [2/2]

JPosition3D & JGEOMETRY3D::JPosition3D::getPosition ( )

inlineinherited

Get position.

Returns

position

Definition at line 141 of file JPosition3D.hh.

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

setPosition()

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;
    }

operator JAngle3D() [1/2]

JGEOMETRY3D::JPosition3D::operator JAngle3D ( ) const

inlineinherited

Type conversion operator.

Returns

angle

Definition at line 163 of file JPosition3D.hh.

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

operator JAngle3D() [2/2]

JGEOMETRY3D::JDirection3D::operator JAngle3D ( ) const

inlineinherited

Type conversion operator.

Returns

angle

Definition at line 140 of file JDirection3D.hh.

    {
      return JAngle3D(getDX(), getDY(), getDZ());
    }

operator JVersor3D()

JGEOMETRY3D::JPosition3D::operator JVersor3D ( ) const

inlineinherited

Type conversion operator.

Returns

direction

Definition at line 174 of file JPosition3D.hh.

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

operator JVector2D()

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());
    }

getX()

double JGEOMETRY3D::JVector3D::getX ( ) const

inlineinherited

Get x position.

Returns

x position

Definition at line 94 of file JVector3D.hh.

    { 
      return __x;
    }

getY()

double JGEOMETRY3D::JVector3D::getY ( ) const

inlineinherited

Get y position.

Returns

y position

Definition at line 104 of file JVector3D.hh.

    { 
      return __y;
    }

getZ()

double JGEOMETRY3D::JVector3D::getZ ( ) const

inlineinherited

Get z position.

Returns

z position

Definition at line 115 of file JVector3D.hh.

    { 
      return __z;
    }

add()

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

inlineinherited

Add vector.

Parameters

vector

vector

Returns

this vector

Definition at line 142 of file JVector3D.hh.

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

sub()

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

inlineinherited

Subtract vector.

Parameters

vector

vector

Returns

this vector

Definition at line 158 of file JVector3D.hh.

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

mul() [1/3]

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;
    }

mul() [2/3]

template<class JFirst_t , class JSecond_t >

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);
    }

mul() [3/3]

template<class JFirst_t , class JSecond_t >

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);
    }

div()

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;
    }

equals() [1/3]

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);
    }

equals() [2/3]

bool JGEOMETRY3D::JVersor3D::equals ( const JVersor3D & versor, const double precision = std::numeric_limits<double>::min() ) const

inlineinherited

Check equality.

Parameters

versor	versor
precision	precision

Returns

true if versors are equal; else false

Definition at line 81 of file JVersor3D.hh.

    {
      return (fabs(getDX() - versor.getDX()) <= precision &&
              fabs(getDY() - versor.getDY()) <= precision &&
              fabs(getDZ() - versor.getDZ()) <= precision);
    }

getLengthSquared()

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();
    }

getLength()

double JGEOMETRY3D::JVector3D::getLength ( ) const

inlineinherited

Get length.

Returns

length

Definition at line 246 of file JVector3D.hh.

    { 
      return sqrt(getLengthSquared());
    }

getCross() [1/2]

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;
    }

getCross() [2/2]

JVersor3D & JGEOMETRY3D::JVersor3D::getCross ( const JVersor3D & first, const JVersor3D & second )

inlineinherited

Get cross product.

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

Parameters

first	first versor
second	second versor

Returns

this versor

Definition at line 173 of file JVersor3D.hh.

    {
      __dx = first .getDY() * second.getDZ()  -  second.getDY() * first .getDZ();
      __dy = second.getDX() * first .getDZ()  -  first .getDX() * second.getDZ();
      __dz = first .getDX() * second.getDY()  -  second.getDX() * first .getDY();
 
      normalise();
 
      return *this;
    }

getDirection() [1/2]

const JDirection3D & JGEOMETRY3D::JDirection3D::getDirection ( ) const

inlineinherited

Get direction.

Returns

direction

Definition at line 107 of file JDirection3D.hh.

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

getDirection() [2/2]

JDirection3D & JGEOMETRY3D::JDirection3D::getDirection ( )

inlineinherited

Get direction.

Returns

direction

Definition at line 118 of file JDirection3D.hh.

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

setDirection()

void JGEOMETRY3D::JDirection3D::setDirection ( const JDirection3D & dir )

inlineinherited

Set direction.

Parameters

dir

direction

Definition at line 129 of file JDirection3D.hh.

    {
      static_cast<JDirection3D&>(*this) = dir;
    }

operator JVector3D()

JGEOMETRY3D::JDirection3D::operator JVector3D ( ) const

inlineinherited

Type conversion operator.

Returns

position

Definition at line 151 of file JDirection3D.hh.

    {
      return JVector3D(getDX(), getDY(), getDZ());
    }

getDX()

double JGEOMETRY3D::JVersor3D::getDX ( ) const

inlineinherited

Get x direction.

Returns

x direction

Definition at line 95 of file JVersor3D.hh.

    {
      return __dx;
    }

getDY()

double JGEOMETRY3D::JVersor3D::getDY ( ) const

inlineinherited

Get y direction.

Returns

y direction

Definition at line 106 of file JVersor3D.hh.

    {
      return __dy;
    }

getDZ()

double JGEOMETRY3D::JVersor3D::getDZ ( ) const

inlineinherited

Get z direction.

Returns

z direction

Definition at line 117 of file JVersor3D.hh.

    {
      return __dz;
    }

getTheta()

double JGEOMETRY3D::JVersor3D::getTheta ( ) const

inlineinherited

Get theta angle.

Returns

theta angle [rad]

Definition at line 128 of file JVersor3D.hh.

    {
      if      (__dz > +1.0)
        return 0.0;
      else if (__dz < -1.0)
        return JMATH::PI;
      else
        return acos(__dz);
    }

getPhi()

double JGEOMETRY3D::JVersor3D::getPhi ( ) const

inlineinherited

Get phi angle.

Returns

phi angle [rad]

Definition at line 144 of file JVersor3D.hh.

    { 
      return atan2(__dy, __dx);
    }

normalise()

JVersor3D & JGEOMETRY3D::JVersor3D::normalise ( )

inlineinherited

Normalise versor.

This operation may set the result to the unit z-vector.

Returns

this versor

Definition at line 192 of file JVersor3D.hh.

    {
      const double v = sqrt(getDX()*getDX() + getDY()*getDY() + getDZ()*getDZ());
 
      if (v != 0.0) {
        __dx /= v;
        __dy /= v;
        __dz /= v;
      }
 
      return *this;
    }

getCalibration() [1/2]

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

inlineinherited

Get calibration.

Returns

calibration

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

    {
      return *this;
    }

getCalibration() [2/2]

JCalibration & JDETECTOR::JCalibration::getCalibration ( )

inlineinherited

Get calibration.

Returns

calibration

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

    {
      return *this;
    }

setCalibration()

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

inlineinherited

Set calibration.

Parameters

cal	calibration

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

    {
      *this = cal;
    }

getT0()

double JDETECTOR::JCalibration::getT0 ( ) const

inlineinherited

Get time offset.

Returns

time offset [ns]

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

    {
      return t0;
    }

setT0()

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;
    }

addT0()

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;
    }

subT0()

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;
    }

getStatus() [1/3]

int JEEP::JStatus::getStatus ( ) const

inlineinherited

Get status.

Returns

status

Definition at line 63 of file JStatus.hh.

    { 
      return this->status;
    }

getStatus() [2/3]

JStatus & JEEP::JStatus::getStatus ( )

inlineinherited

Get status.

Returns

status

Definition at line 74 of file JStatus.hh.

    { 
      return *this;
    }

getStatus() [3/3]

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);
    }

setStatus()

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;
    }

equals() [3/3]

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;
    }

has()

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;
    }

set()

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);
    }

reset()

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 Symbol Documentation

operator>> [1/2]

std::istream & operator>> ( std::istream & in, JPMT & pmt )

friend

Read PMT from input.

Parameters

in	input stream
pmt	PMT

Returns

input stream

Definition at line 141 of file JPMT.hh.

    {
      in >> static_cast<JObjectID&>   (pmt);
      in >> static_cast<JAxis3D&>     (pmt);
      in >> static_cast<JCalibration&>(pmt);
 
      if (getDetectorVersion(getVersion()) >= JDetectorVersion::V3) {
        in >> static_cast<JStatus&>(pmt);
      }
 
      return in;
    }

operator<< [1/2]

std::ostream & operator<< ( std::ostream & out, const JPMT & pmt )

friend

Write PMT to output.

Parameters

out	output stream
pmt	PMT

Returns

output stream

Definition at line 162 of file JPMT.hh.

    {
      using namespace std;
      
      out << setw(8);
      out << static_cast<const JObjectID&>   (pmt);
      out << ' ';
      out << static_cast<const JAxis3D&>     (pmt);
      out << ' ';
      out << static_cast<const JCalibration&>(pmt);
 
      if (getDetectorVersion(getVersion()) >= JDetectorVersion::V3) {
        out << ' ';
        out << static_cast<const JStatus&>(pmt);
      }
 
      return out;
    }

operator>> [2/2]

JReader & operator>> ( JReader & in, JPMT & pmt )

friend

Read PMT from input.

Parameters

in	reader
pmt	PMT

Returns

reader

Definition at line 189 of file JPMT.hh.

    {
      in >> static_cast<JObjectID&>   (pmt);
      in >> static_cast<JAxis3D&>     (pmt);
      in >> static_cast<JCalibration&>(pmt);
 
      if (getDetectorVersion(getVersion()) >= JDetectorVersion::V3) {
        in >> static_cast<JStatus&>(pmt);
      }
 
      return in;
    }

operator<< [2/2]

JWriter & operator<< ( JWriter & out, const JPMT & pmt )

friend

Write PMT to output.

Parameters

out	writer
pmt	PMT

Returns

writer

Definition at line 210 of file JPMT.hh.

    {
      out << static_cast<const JObjectID&>   (pmt);
      out << static_cast<const JAxis3D&>     (pmt);
      out << static_cast<const JCalibration&>(pmt);
 
      if (getDetectorVersion(getVersion()) >= JDetectorVersion::V3) {
        out << static_cast<const JStatus&>(pmt);
      }
 
      return out;
    }

Member Data Documentation

__id

int JLANG::JObjectID::__id

protectedinherited

Definition at line 140 of file JObjectID.hh.

__x

double JGEOMETRY3D::JVector3D::__x

protectedinherited

Definition at line 310 of file JVector3D.hh.

__y

double JGEOMETRY3D::JVector3D::__y

protectedinherited

Definition at line 311 of file JVector3D.hh.

__z

double JGEOMETRY3D::JVector3D::__z

protectedinherited

Definition at line 312 of file JVector3D.hh.

__dx

double JGEOMETRY3D::JVersor3D::__dx

protectedinherited

Definition at line 206 of file JVersor3D.hh.

__dy

double JGEOMETRY3D::JVersor3D::__dy

protectedinherited

Definition at line 207 of file JVersor3D.hh.

__dz

double JGEOMETRY3D::JVersor3D::__dz

protectedinherited

Definition at line 208 of file JVersor3D.hh.

t0

double JDETECTOR::JCalibration::t0

protectedinherited

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

status

int JEEP::JStatus::status

protectedinherited

Definition at line 200 of file JStatus.hh.

---

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

• JPMT.hh