Acoustic receiver. More...

#include <JReceiver.hh>

Inheritance diagram for JACOUSTICS::JReceiver:

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

	JReceiver (const int id, const JVector3D &pos, const double t0_s, const double t1_s)
	Constructor. More...

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

double	getDelayTime () const
	Get time delay of sensor. More...

double	getT (const double t_s) const
	Get corrected time. More...

double	putT (const double t_s) const
	Get uncorrected time. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Attributes
double	t0_s

double	t1_s

int	__id

double	__x

double	__y

double	__z

Detailed Description

Acoustic receiver.

Definition at line 27 of file JReceiver.hh.

Constructor & Destructor Documentation

JACOUSTICS::JReceiver::JReceiver ( )

inline

Default constructor.

Definition at line 34 of file JReceiver.hh.

                 :
       t0_s(0.0),
       t1_s(0.0)
     {}

JACOUSTICS::JReceiver::JReceiver	(	const int	id,
		const JVector3D &	pos,
		const double	t0_s,
		const double	t1_s
	)

inline

Constructor.

Parameters

id	identifier
pos	position
t0_s	time offset of clock [s]
t1_s	time delay of sensor [s]

Definition at line 48 of file JReceiver.hh.

                                      :
       JObjectID  (id),
       JPosition3D(pos),
       t0_s       (t0_s),
       t1_s       (t1_s)
     {}

Member Function Documentation

double JACOUSTICS::JReceiver::getT0 ( ) const

inline

Get time offset of clock.

Returns: time offset [s]

Definition at line 64 of file JReceiver.hh.

     {
       return t0_s;
     }

double JACOUSTICS::JReceiver::getDelayTime ( ) const

inline

Get time delay of sensor.

Returns: time delay [s]

Definition at line 75 of file JReceiver.hh.

     {
       return t1_s;
     }

double JACOUSTICS::JReceiver::getT ( const double t_s ) const

inline

Get corrected time.

Parameters

t_s time [s]

Returns: time [s]

Definition at line 87 of file JReceiver.hh.

     {
       return t_s + t0_s - t1_s;
     }

double JACOUSTICS::JReceiver::putT ( const double t_s ) const

inline

Get uncorrected time.

Parameters

t_s time [s]

Returns: time [s]

Definition at line 99 of file JReceiver.hh.

     {
       return t_s - t0_s + t1_s;
     }

int JLANG::JObjectID::getID ( ) const

inlineinherited

Get identifier.

Returns: identifier

Definition at line 55 of file JObjectID.hh.

     { 
       return __id;
     }

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

inlineinherited

Set identifier.

Parameters

id	identifier

Definition at line 66 of file JObjectID.hh.

     { 
       this->__id = id;
     }

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

inlineinherited

Less than method.

Parameters

object object identifier

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

Definition at line 78 of file JObjectID.hh.

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

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

inlineinherited

Less than method.

Parameters

id	identifier

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

Definition at line 90 of file JObjectID.hh.

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

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

inlineinherited

More than method.

Parameters

id	identifier

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

Definition at line 102 of file JObjectID.hh.

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

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

inlineinherited

Get position.

Returns: position

Definition at line 129 of file JPosition3D.hh.

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

JPosition3D& JGEOMETRY3D::JPosition3D::getPosition ( )

inlineinherited

Get position.

Returns: position

Definition at line 140 of file JPosition3D.hh.

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

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

inlineinherited

Set position.

Parameters

pos position

Definition at line 151 of file JPosition3D.hh.

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

JGEOMETRY3D::JPosition3D::operator JAngle3D ( ) const

inlineinherited

Type conversion operator.

Returns: angle

Definition at line 162 of file JPosition3D.hh.

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

JGEOMETRY3D::JPosition3D::operator JVersor3D ( ) const

inlineinherited

Type conversion operator.

Returns: direction

Definition at line 173 of file JPosition3D.hh.

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

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

inlineinherited

Rotate.

Parameters

R	rotation matrix

Returns: this position

Definition at line 185 of file JPosition3D.hh.

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

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

inlineinherited

Rotate around X-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 213 of file JPosition3D.hh.

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

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

inlineinherited

Rotate around Y-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 241 of file JPosition3D.hh.

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

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

inlineinherited

Rotate around Z-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 269 of file JPosition3D.hh.

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

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

inlineinherited

Rotate.

Parameters

Q	quaternion

Returns: this position

Definition at line 297 of file JPosition3D.hh.

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

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

inlineinherited

Rotate back.

Parameters

R	rotation matrix

Returns: this position

Definition at line 199 of file JPosition3D.hh.

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

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

inlineinherited

Rotate back around X-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 227 of file JPosition3D.hh.

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

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

inlineinherited

Rotate back around Y-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 255 of file JPosition3D.hh.

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

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

inlineinherited

Rotate back around Z-axis.

Parameters

R	rotation matrix

Returns: this position

Definition at line 283 of file JPosition3D.hh.

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

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

inlineinherited

Rotate back.

Parameters

Q	quaternion

Returns: this position

Definition at line 311 of file JPosition3D.hh.

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

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

inlineinherited

Transform position.

The final position is obtained as follows:

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

Parameters

R	rotation matrix
pos	position of origin (after rotation)

Definition at line 330 of file JPosition3D.hh.

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

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

inlineinherited

Transform.

Parameters

T matrix

Returns: this vector

Definition at line 205 of file JVector3D.hh.

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

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

inlineinherited

Transform back position.

The final position is obtained as follows:

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

Parameters

R	rotation matrix
pos	position of origin (before rotation)

Definition at line 358 of file JPosition3D.hh.

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

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

inlineinherited

Get dot product.

Parameters

angle angle

Returns: dot product

Definition at line 377 of file JPosition3D.hh.

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

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

inlineinherited

Get dot product.

Parameters

dir direction

Returns: dot product

Definition at line 392 of file JPosition3D.hh.

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

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

inlineinherited

Get dot product.

Parameters

dir direction

Returns: dot product

Definition at line 407 of file JPosition3D.hh.

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

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

inlineinherited

Get dot product.

Parameters

vector vector

Returns: dot product

Definition at line 281 of file JVector3D.hh.

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

JGEOMETRY3D::JVector3D::operator JVector2D ( ) const

inlineinherited

Type conversion operator.

Returns: JVector2D

Definition at line 82 of file JVector3D.hh.

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

double JGEOMETRY3D::JVector3D::getX ( ) const

inlineinherited

Get x position.

Returns: x position

Definition at line 93 of file JVector3D.hh.

     { 
       return __x;
     }

double JGEOMETRY3D::JVector3D::getY ( ) const

inlineinherited

Get y position.

Returns: y position

Definition at line 103 of file JVector3D.hh.

     { 
       return __y;
     }

double JGEOMETRY3D::JVector3D::getZ ( ) const

inlineinherited

Get z position.

Returns: z position

Definition at line 114 of file JVector3D.hh.

     { 
       return __z;
     }

JVector3D& JGEOMETRY3D::JVector3D::negate ( )

inlineinherited

Negate vector.

Returns: this vector

Definition at line 125 of file JVector3D.hh.

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

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

inlineinherited

Add vector.

Parameters

vector vector

Returns: this vector

Definition at line 141 of file JVector3D.hh.

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

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

inlineinherited

Subtract vector.

Parameters

vector vector

Returns: this vector

Definition at line 157 of file JVector3D.hh.

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

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

inlineinherited

Scale vector.

Parameters

factor multiplication factor

Returns: this vector

Definition at line 173 of file JVector3D.hh.

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

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

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 273 of file JMath.hh.

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

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

inlineinherited

Scale vector.

Parameters

factor division factor

Returns: this vector

Definition at line 189 of file JVector3D.hh.

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

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

inlineinherited

Check equality.

Parameters

vector	vector
precision	precision

Returns: true if vectors are equal; else false

Definition at line 220 of file JVector3D.hh.

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

double JGEOMETRY3D::JVector3D::getLengthSquared ( ) const

inlineinherited

Get length squared.

Returns: square of length

Definition at line 234 of file JVector3D.hh.

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

double JGEOMETRY3D::JVector3D::getLength ( ) const

inlineinherited

Get length.

Returns: length

Definition at line 245 of file JVector3D.hh.

     { 
       return sqrt(getLengthSquared());
     }

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

inlineinherited

Get squared of distance to point.

Parameters

pos position

Returns: square of distance

Definition at line 257 of file JVector3D.hh.

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

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

inlineinherited

Get distance to point.

Parameters

pos position

Returns: distance

Definition at line 269 of file JVector3D.hh.

     {
       return sqrt(getDistanceSquared(pos));
     }

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

inlineinherited

Get cross product.

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

Parameters

first	first vector
second	second vector

Returns: this vector

Definition at line 298 of file JVector3D.hh.

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

Member Data Documentation

double JACOUSTICS::JReceiver::t0_s

protected

Definition at line 105 of file JReceiver.hh.

double JACOUSTICS::JReceiver::t1_s

protected

Definition at line 106 of file JReceiver.hh.

int JLANG::JObjectID::__id

protectedinherited

Definition at line 160 of file JObjectID.hh.

double JGEOMETRY3D::JVector3D::__x

protectedinherited

Definition at line 309 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__y

protectedinherited

Definition at line 310 of file JVector3D.hh.

double JGEOMETRY3D::JVector3D::__z

protectedinherited

Definition at line 311 of file JVector3D.hh.

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

JReceiver.hh

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation