org.lcsim.recon.tracking.spacegeom

Class SpacePoint

java.lang.Object

org.lcsim.recon.tracking.spacegeom.SpacePoint

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

CartesianPoint, CylindricalPoint, SpacePointTensor, SpacePointVector, SphericalPoint

public class SpacePoint
extends Object
implements Serializable, Cloneable

Describes a space point. The default Space point is at the origin. Derived classes can be used to set values in cartesian, cylindrical or spherical coordinates. Point is set in the constructor and cannot be changed. The methods simply return different coordinates. Transformations (translations, rotations, etc) are carried out by external functions which return new SpacePoints.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) double	_phi
(package private) double	_theta
(package private) double	_x
(package private) double	_xy
(package private) double	_xyz
(package private) double	_y
(package private) double	_z

Constructor Summary

Constructors

Constructor and Description
SpacePoint() Default constructor.
SpacePoint(SpacePoint spt) Copy constructor

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Clone
double	cosPhi() cos(phi)
double	cosTheta() cos(theta)
static double	distance(SpacePoint spt1, SpacePoint spt2) Return the distance between two space points.
boolean	equals(SpacePoint spt) Equality
double[]	getCartesianArray() Deprecated.
boolean	notEquals(SpacePoint spt) Inequality
static double	openingAngle(SpacePoint p1, SpacePoint p2) Return the opening angle between two space points, assuming the point of reference is the origin
double	phi() Cylindrical phi
double	rxy() Cylindrical r
double	rxyz() Spherical r
double	sinPhi() sin(phi)
double	sinTheta() sin(theta)
double	theta() Spherical theta
String	toString() Output Stream
double	x() Cartesian x
double	y() Cartesian y
double	z() Cartesian z

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_x

double _x

_y

double _y

_z

double _z

_xy

double _xy

_xyz

double _xyz

_phi

double _phi

_theta

double _theta

Constructor Detail

SpacePoint

public SpacePoint()

Default constructor. Sets point to be the origin.

SpacePoint

public SpacePoint(SpacePoint spt)

Copy constructor

Parameters:

spt - SpacePoint to copy

Method Detail

x

public double x()

Cartesian x

Returns:

double

y

public double y()

Cartesian y

Returns:

double

z

public double z()

Cartesian z

Returns:

double

rxy

public double rxy()

Cylindrical r

Returns:

double

phi

public double phi()

Cylindrical phi

Returns:

double

rxyz

public double rxyz()

Spherical r

Returns:

double

theta

public double theta()

Spherical theta

Returns:

double

cosPhi

public double cosPhi()

cos(phi)

Returns:

double

sinPhi

public double sinPhi()

sin(phi)

Returns:

double

sinTheta

public double sinTheta()

sin(theta)

Returns:

double

cosTheta

public double cosTheta()

cos(theta)

Returns:

double

toString

public String toString()

Output Stream

Overrides:

toString in class Object

Returns:

String representation of object

equals

public boolean equals(SpacePoint spt)

Equality

Parameters:

spt - SpacePoint to compare

Returns:

true if objects are equal

notEquals

public boolean notEquals(SpacePoint spt)

Inequality

Parameters:

spt - SpacePoint to compare

Returns:

true if objects are not equal

distance

public static double distance(SpacePoint spt1,
              SpacePoint spt2)

Return the distance between two space points.

Parameters:

spt1 - SpacePoint 1

spt2 - SpacePoint 2

Returns:

Euclidean distance between points

openingAngle

public static double openingAngle(SpacePoint p1,
                  SpacePoint p2)

Return the opening angle between two space points, assuming the point of reference is the origin

Parameters:

spt1 - SpacePoint 1

spt2 - SpacePoint 2

Returns:

opening angle between points

clone

public Object clone()

Clone

Overrides:

clone in class Object

Returns:

a copy of this object

getCartesianArray

@Deprecated
public double[] getCartesianArray()

Deprecated.

for legacy code