dir_type Struct Reference

Type definition for direction. More...

#include <JAAnetTestkit.hh>

Inheritance diagram for dir_type:

Public Member Functions
double	dot (const Vec &v) const
	Get dot product.
Vec	cross (const Vec r) const
	Get cross product.
Vec &	operator+= (const Vec &v)
	Add vector.
Vec &	operator-= (const Vec &v)
	Subtract vector.
Vec &	operator*= (double d)
	Multiply vector.
Vec &	operator/= (double d)
	Divide vector.
Vec	operator- () const
	Negate vector.
bool	operator== (const Vec &v) const
	Check equality with given vector.
bool	operator!= (const Vec &v) const
	Check in-equality with given vector.
Vec &	set (double xx, double yy, double zz)
	Set vector.
Vec &	set_angles (double theta, double phi)
	Set vector according given zenith and azimuth angles.
double	phi () const
	Get azimuth angle.
double	theta () const
	Get zenith angle.
double	len () const
	Get length.
double	lenxy () const
	Get length of (x,y) component.
Vec &	normalize ()
	Normalise this vector.
void	print (std::ostream &out=std::cout) const
	Print vector.
const char *	__repr__ () const
	Get string representation of this vector.
Vec	__add__ (const Vec &v) const
	Add vector.
Vec	__sub__ (const Vec &v) const
	Subtract vector.
Vec	__mul__ (double d) const
	Multiply vector.
Vec	__rmul__ (double d) const
	Multiply vector.
Vec	__div__ (double d) const
	Divide vector.
Vec &	rotate_z (double ang)
	Rotate around z-axis with given angle.
Vec &	rotate_x (double ang)
	Rotate around x-axis with given angle.
Vec &	rotate_y (double ang)
	Rotate around y-axis with given angle.

Public Attributes
double	x
double	y
double	z

Detailed Description

Type definition for direction.

Definition at line 60 of file JAAnetTestkit.hh.

Member Function Documentation

dot()

double Vec::dot ( const Vec & v ) const

inlineinherited

Get dot product.

Parameters

v

vector

Returns

dot product

Definition at line 36 of file Vec.hh.

{ return v.x*x + v.y*y+ v.z*z;}

cross()

Vec Vec::cross ( const Vec r ) const

inlineinherited

Get cross product.

Parameters

r

vector

Returns

cross product

Definition at line 44 of file Vec.hh.

{ return Vec ( y*r.z-z*r.y, z*r.x-x*r.z, x*r.y-y*r.x);}

operator+=()

Vec & Vec::operator+= ( const Vec & v )

inlineinherited

Add vector.

Parameters

v

vector

Returns

this vector

Definition at line 52 of file Vec.hh.

{ x+=v.x; y+=v.y; z+=v.z; return *this;}

operator-=()

Vec & Vec::operator-= ( const Vec & v )

inlineinherited

Subtract vector.

Parameters

v

vector

Returns

this vector

Definition at line 60 of file Vec.hh.

{ x-=v.x; y-=v.y; z-=v.z; return *this;}

operator*=()

Vec & Vec::operator*= ( double d )

inlineinherited

Multiply vector.

Parameters

d

factor

Returns

this vector

Definition at line 68 of file Vec.hh.

{ x*=d; y*=d; z*=d; return *this;}

operator/=()

Vec & Vec::operator/= ( double d )

inlineinherited

Divide vector.

Parameters

d

factor

Returns

this vector

Definition at line 76 of file Vec.hh.

{ return operator*=( 1.0 / d ); }

operator-()

Vec Vec::operator- ( ) const

inlineinherited

Negate vector.

Returns

vector

Definition at line 83 of file Vec.hh.

{ return Vec(-x,-y,-z); }

operator==()

bool Vec::operator== ( const Vec & v ) const

inlineinherited

Check equality with given vector.

Parameters

v

vector

Returns

true if (x,y,z) positions of two vectors are equal; else false

Definition at line 91 of file Vec.hh.

{ return x==v.x && y==v.y && z==v.z ; }

operator!=()

bool Vec::operator!= ( const Vec & v ) const

inlineinherited

Check in-equality with given vector.

Parameters

v

vector

Returns

true if one of (x,y,z) positions of two vectors are not equal; else false

Definition at line 99 of file Vec.hh.

{ return x!=v.x || y!=v.y || z!=v.z ; }

set()

Vec & Vec::set ( double xx, double yy, double zz )

inlineinherited

Set vector.

Parameters

xx	x position
yy	y position
zz	z position

Returns

this vector

Definition at line 109 of file Vec.hh.

{ x=xx; y=yy; z=zz; return *this;}

set_angles()

Vec & Vec::set_angles ( double theta, double phi )

inlineinherited

Set vector according given zenith and azimuth angles.

Parameters

theta	zenith angle [rad]
phi	azimuth angle [rad]

Returns

this vector

Definition at line 118 of file Vec.hh.

  {
    x = sin ( theta ) * cos( phi );
    y = sin ( theta ) * sin( phi );
    z = cos ( theta );
    return *this;
  }

phi()

double Vec::phi ( ) const

inlineinherited

Get azimuth angle.

Returns

angle [rad]

Definition at line 131 of file Vec.hh.

{ return atan2( y,x ); }

theta()

double Vec::theta ( ) const

inlineinherited

Get zenith angle.

Returns

angle [rad]

Definition at line 138 of file Vec.hh.

{ return acos(z); }

len()

double Vec::len ( ) const

inlineinherited

Get length.

Returns

length

Definition at line 145 of file Vec.hh.

{ double l = dot(*this); return (l > 0)? sqrt(l) : 0; }

lenxy()

double Vec::lenxy ( ) const

inlineinherited

Get length of (x,y) component.

Returns

length

Definition at line 152 of file Vec.hh.

{ const double r2 = x*x + y*y; return (r2>0) ? sqrt(r2) :0; }

normalize()

Vec & Vec::normalize ( )

inlineinherited

Normalise this vector.

Returns

this vector

Definition at line 159 of file Vec.hh.

{ return operator/=( len() ); }

print()

void Vec::print ( std::ostream & out = std::cout ) const

inlineinherited

Print vector.

Parameters

out	output stream

Definition at line 166 of file Vec.hh.

  {
        out << "Vec:" << x << " " << y << " " << z;
  }

__repr__()

const char * Vec::__repr__ ( ) const

inlineinherited

Get string representation of this vector.

Returns

string

Definition at line 176 of file Vec.hh.

  {
    static std::string buffer;
 
    std::ostringstream s; 
  
    print(s);
 
    buffer = s.str();
 
    return buffer.c_str();
  }

__add__()

Vec Vec::__add__ ( const Vec & v ) const

inlineinherited

Add vector.

Parameters

v

vector

Returns

vector

Definition at line 195 of file Vec.hh.

{ Vec r=*this; return r+=v; }

__sub__()

Vec Vec::__sub__ ( const Vec & v ) const

inlineinherited

Subtract vector.

Parameters

v

vector

Returns

vector

Definition at line 203 of file Vec.hh.

{ Vec r=*this; return r-=v; }

__mul__()

Vec Vec::__mul__ ( double d ) const

inlineinherited

Multiply vector.

Parameters

d

factor

Returns

vector

Definition at line 211 of file Vec.hh.

{ Vec r=*this; return r*=d; }

__rmul__()

Vec Vec::__rmul__ ( double d ) const

inlineinherited

Multiply vector.

Parameters

d

factor

Returns

vector

Definition at line 219 of file Vec.hh.

{ return __mul__(d);        } 

__div__()

Vec Vec::__div__ ( double d ) const

inlineinherited

Divide vector.

Parameters

d

factor

Returns

vector

Definition at line 227 of file Vec.hh.

{ Vec r=*this; return r/=d; }

rotate_z()

Vec & Vec::rotate_z ( double ang )

inlineinherited

Rotate around z-axis with given angle.

Parameters

ang	angle [rad]

Returns

this vector

Definition at line 235 of file Vec.hh.

  {
    const Vec o = *this; 
    x = o.x *cos(ang) - o.y * sin(ang);
    y = o.x *sin(ang) + o.y * cos(ang);
    z = o.z;
    return *this;
  }

rotate_x()

Vec & Vec::rotate_x ( double ang )

inlineinherited

Rotate around x-axis with given angle.

Parameters

ang	angle [rad]

Returns

this vector

Definition at line 250 of file Vec.hh.

  {
    const Vec o = *this;
    x = o.x;
    y = o.y *cos(ang) + o.z * -sin(ang);
    z = o.y *sin(ang) + o.z * cos(ang);
    return *this;
  }

rotate_y()

Vec & Vec::rotate_y ( double ang )

inlineinherited

Rotate around y-axis with given angle.

Parameters

ang	angle [rad]

Returns

this vector

Definition at line 265 of file Vec.hh.

  {
    const Vec o = *this;
    x = o.x *cos(ang) + o.z * sin(ang);
    y = o.y;
    z = -o.x *sin(ang) + o.z * cos(ang);
    return *this;
  }

Member Data Documentation

x

double Vec::x

inherited

Definition at line 14 of file Vec.hh.

y

double Vec::y

inherited

Definition at line 14 of file Vec.hh.

z

double Vec::z

inherited

Definition at line 14 of file Vec.hh.

---

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

• JAAnetTestkit.hh