SpacePoint (LCSim 3.1.7 API)

java.lang.Object
- org.lcsim.spacegeom.SpacePoint

All Implemented Interfaces:

Hep3Vector, Serializable, Cloneable

Direct Known Subclasses:

CartesianPoint, CylindricalPoint, SpaceVector, SphericalPoint
```
public class SpacePoint
extends Object
implements Serializable, Cloneable, Hep3Vector
```
A SpacePoint represents a concrete point in 3D Space, much like a coordinate. SpacePoint objects know about their representation in cartesian, spherical and cylindrical coordinates. For interoperability with Freehep classes SpacePoint implements the Hep3Vector interface. In distinction to vectors, two points cannot be added, and multiplication with a scalar is not defined, neither is the addition of two points.

Version:

$Id: SpacePoint.java,v 1.1.1.1 2010/12/01 00:15:57 jeremy Exp $

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) double`	`_phi`
`(package private) Representation`	`_representation`
`(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(Hep3Vector vec)

SpacePoint(SpacePoint spt)
Copy constructor

Constructors
Constructor and Description
`SpacePoint()` Default constructor.
`SpacePoint(Hep3Vector vec)`
`SpacePoint(SpacePoint spt)` Copy constructor

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`cartesianToCylindricalR()`
`private void`	`cartesianToPhi()`
`private void`	`cartesianToTheta()`
`Object`	`clone()` Clone
`double`	`cosPhi()` cos(phi)
`double`	`cosTheta()` cos(theta)
`private void`	`cylindricalToCartesianX()`
`private void`	`cylindricalToCartesianY()`
`private void`	`cylindricalToTheta()`
`static double`	`distance(SpacePoint spt1, SpacePoint spt2)` Return the distance between two space points.
`boolean`	`equals(Hep3Vector spt, double precision)` Tests for equality within errors
`boolean`	`equals(SpacePoint x)` Tests for equality
`boolean`	`equals(SpacePoint spt, double precision)` Tests for equality within errors
`double[]`	`getCartesianArray()`
`Representation`	`getRepresentation()`
`double`	`magnitude()`
`double`	`magnitudeSquared()`
`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)
`private void`	`sphericalToCartesianX()`
`private void`	`sphericalToCartesianY()`
`private void`	`sphericalToCartesianZ()`
`private void`	`sphericalToCylindricalR()`
`double`	`theta()` Spherical theta
`String`	`toString()` Output Stream
`double[]`	`v()`
`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
  - _representation
```
Representation _representation
```
  - _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
  - SpacePoint
```
public SpacePoint(Hep3Vector vec)
```
- Method Detail
  - v
```
public double[] v()
```
    Specified by:
    
    v in interface Hep3Vector
  - cartesianToCylindricalR
```
private void cartesianToCylindricalR()
```
  - cartesianToPhi
```
private void cartesianToPhi()
```
  - cartesianToTheta
```
private void cartesianToTheta()
```
  - magnitude
```
public double magnitude()
```
    Specified by:
    
    magnitude in interface Hep3Vector
  - magnitudeSquared
```
public double magnitudeSquared()
```
    Specified by:
    
    magnitudeSquared in interface Hep3Vector
  - cylindricalToCartesianX
```
private void cylindricalToCartesianX()
```
  - sphericalToCartesianX
```
private void sphericalToCartesianX()
```
  - sphericalToCartesianY
```
private void sphericalToCartesianY()
```
  - sphericalToCartesianZ
```
private void sphericalToCartesianZ()
```
  - x
```
public double x()
```
    Cartesian x
    
    Specified by:
    
    x in interface Hep3Vector
    
    Returns:
    double
  - cylindricalToCartesianY
```
private void cylindricalToCartesianY()
```
  - y
```
public double y()
```
    Cartesian y
    
    Specified by:
    
    y in interface Hep3Vector
    
    Returns:
    double
  - z
```
public double z()
```
    Cartesian z
    
    Specified by:
    
    z in interface Hep3Vector
    
    Returns:
    double
  - sphericalToCylindricalR
```
private void sphericalToCylindricalR()
```
  - 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
  - cylindricalToTheta
```
private void cylindricalToTheta()
```
  - 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,
             double precision)
```
    Tests for equality within errors
    
    Parameters:
    spt - a SpacePoint to compare against
    precision - the precision of the comparison
    
    Returns:
    true if each of the components is within precision of the components of spt
  - equals
```
public boolean equals(Hep3Vector spt,
             double precision)
```
    Tests for equality within errors
    
    Parameters:
    spt - a Hep3Vector to compare against
    precision - the precision of the comparison
    
    Returns:
    true if each of the components is within precision of the components of spt
  - equals
```
public boolean equals(SpacePoint x)
```
    Tests for equality
    
    Parameters:
    x - 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
```
public double[] getCartesianArray()
```
    Returns:
    array of doubles, cartesian representation
  - getRepresentation
```
public Representation getRepresentation()
```
    Returns:
    the representations of the object

Class SpacePoint

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_representation

_x

_y

_z

_xy

_xyz

_phi

_theta

Constructor Detail

SpacePoint

SpacePoint

SpacePoint

Method Detail

v

cartesianToCylindricalR

cartesianToPhi

cartesianToTheta

magnitude

magnitudeSquared

cylindricalToCartesianX

sphericalToCartesianX

sphericalToCartesianY

sphericalToCartesianZ

x

cylindricalToCartesianY

y

z

sphericalToCylindricalR

rxy

phi

rxyz

theta

cylindricalToTheta

cosPhi

sinPhi

sinTheta

cosTheta

toString

equals

equals

equals

notEquals

distance

openingAngle

clone

getCartesianArray

getRepresentation