JDETECTOR::JHydrophone Struct Reference

Type definition of hydrophone. More...

#include <JHydrophone.hh>

Inheritance diagram for JDETECTOR::JHydrophone:

Public Member Functions
	JHydrophone ()
	Default constructor. More...
	JHydrophone (const JLocation location, const JPosition3D &position)
	Constructor. More...
const JLocation &	getLocation () const
	Get location. More...
JLocation &	getLocation ()
	Get location. More...
void	setLocation (const JLocation &location)
	Set location. More...
std::string	toString () const
	Convert module location to string. More...
std::string	toString (const std::string &fmt, const std::string target="%") const
	Convert module loation to string. More...
int	getString () const
	Get string number. More...
int	getFloor () const
	Get floor number. More...
bool	less (const JLocation &location) const
	Less than method. More...
const JPosition3D &	getPosition () const
	Get position. More...
JPosition3D &	getPosition ()
	Get position. More...
void	setPosition (const JVector3D &pos)
	Set position. More...
	operator JAngle3D () const
	Type conversion operator. More...
	operator JVersor3D () const
	Type conversion operator. More...
JPosition3D &	rotate (const JRotation3D &R)
	Rotate. More...
JPosition3D &	rotate (const JRotation3X &R)
	Rotate around X-axis. More...
JPosition3D &	rotate (const JRotation3Y &R)
	Rotate around Y-axis. More...
JPosition3D &	rotate (const JRotation3Z &R)
	Rotate around Z-axis. More...
JPosition3D &	rotate (const JQuaternion3D &Q)
	Rotate. More...
JPosition3D &	rotate_back (const JRotation3D &R)
	Rotate back. More...
JPosition3D &	rotate_back (const JRotation3X &R)
	Rotate back around X-axis. More...
JPosition3D &	rotate_back (const JRotation3Y &R)
	Rotate back around Y-axis. More...
JPosition3D &	rotate_back (const JRotation3Z &R)
	Rotate back around Z-axis. More...
JPosition3D &	rotate_back (const JQuaternion3D &Q)
	Rotate back. More...
void	transform (const JRotation3D &R, const JVector3D &pos)
	Transform position. More...
JVector3D &	transform (const JMatrix3D &T)
	Transform. More...
void	transform_back (const JRotation3D &R, const JVector3D &pos)
	Transform back position. More...
double	getDot (const JAngle3D &angle) const
	Get dot product. More...
double	getDot (const JVersor3D &dir) const
	Get dot product. More...
double	getDot (const JVersor3Z &dir) const
	Get dot product. More...
double	getDot (const JVector3D &vector) const
	Get dot product. More...
	operator JVector2D () const
	Type conversion operator. More...
double	getX () const
	Get x position. More...
double	getY () const
	Get y position. More...
double	getZ () const
	Get z position. More...
JVector3D &	negate ()
	Negate vector. More...
JVector3D &	add (const JVector3D &vector)
	Add vector. More...
JVector3D &	sub (const JVector3D &vector)
	Subtract vector. More...
JVector3D &	mul (const double factor)
	Scale vector. More...
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...

Protected Attributes
int	string
int	floor
double	__x
double	__y
double	__z

Friends
std::istream &	operator>> (std::istream &in, JHydrophone &hydrophone)
	Read hydrophone from input. More...
std::ostream &	operator<< (std::ostream &out, const JHydrophone &hydrophone)
	Write hydrophone to output. More...

Detailed Description

Type definition of hydrophone.

The position of the hydrophone is defined with respect to the position of the top of the T-bar.

Definition at line 30 of file JHydrophone.hh.

Constructor & Destructor Documentation

JDETECTOR::JHydrophone::JHydrophone ( )

inline

Default constructor.

Definition at line 37 of file JHydrophone.hh.

                  :
      JLocation  (),
      JPosition3D()
    {}

JDETECTOR::JHydrophone::JHydrophone ( const JLocation  location, const JPosition3D &  position  )

inline

Constructor.

Parameters

location	location
position	position

Definition at line 49 of file JHydrophone.hh.

                                             :
      JLocation  (location),
      JPosition3D(position)
    {}

Member Function Documentation

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 JRotation3D &  R )

inlineinherited

Rotate.

Parameters

R	rotation matrix

Returns

this position

Definition at line 186 of file JPosition3D.hh.

    {
      R.rotate(__x, __y, __z);

      return *this;
    }

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

inlineinherited

Rotate around X-axis.

Parameters

R	rotation matrix

Returns

this position

Definition at line 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 ( const JQuaternion3D &  Q )

inlineinherited

Rotate.

Parameters

Q	quaternion

Returns

this position

Definition at line 298 of file JPosition3D.hh.

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

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

inlineinherited

Rotate back.

Parameters

R	rotation matrix

Returns

this position

Definition at line 200 of file JPosition3D.hh.

    {
      R.rotate_back(__x, __y, __z);

      return *this;
    }

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

inlineinherited

Rotate back around X-axis.

Parameters

R	rotation matrix

Returns

this position

Definition at line 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;
    }

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

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

inlineinherited

Transform position.

The final position is obtained as follows:

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

Parameters

R	rotation matrix
pos	position of origin (after rotation)

Definition at line 331 of file JPosition3D.hh.

    {
      // rotate geometry to system with particle direction along z-axis

      rotate(R);

      // offset with respect to origin

      sub(pos);

      // rotate geometry to x-z plane

      __x = sqrt(__x*__x + __y*__y);
      __y = 0.0;
    }

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

inlineinherited

Transform.

Parameters

T

matrix

Returns

this vector

Definition at line 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:

1. offset position with position pos;
2. 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::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;
    }

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

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 357 of file JMath.hh.

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

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

inlineinherited

Scale vector.

Parameters

factor

division factor

Returns

this vector

Definition at line 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;
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JHydrophone &  hydrophone  )

friend

Read hydrophone from input.

Parameters

in	input stream
hydrophone	hydrophone

Returns

input stream

Definition at line 63 of file JHydrophone.hh.

    {
      in >> static_cast<JLocation&>  (hydrophone);
      in >> static_cast<JPosition3D&>(hydrophone);

      return in;
    }

std::ostream& operator<< ( std::ostream &  out, const JHydrophone &  hydrophone  )

friend

Write hydrophone to output.

Parameters

out	output stream
hydrophone	hydrophone

Returns

output stream

Definition at line 79 of file JHydrophone.hh.

    {
      out << static_cast<const JLocation&>  (hydrophone);
      out << ' ';
      out << static_cast<const JPosition3D&>(hydrophone);

      return out;
    }

Member Data Documentation

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.

---

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

• JHydrophone.hh