hep.graphics.heprep
Interface HepRepPoint

All Superinterfaces:

HepRepAttribute, HepRepConstants

public interface HepRepPoint
extends HepRepAttribute

HepRepPoint interface. The HepRepMath class can be used to deal with the conversions.

Author:

Mark Donszelmann

Field Summary

Fields inherited from interface hep.graphics.heprep.HepRepConstants

SHOW_DESC, SHOW_EXTRA, SHOW_NAME, SHOW_NONE, SHOW_VALUE, TYPE_BOOLEAN, TYPE_COLOR, TYPE_DOUBLE, TYPE_INT, TYPE_LONG, TYPE_STRING, TYPE_UNKNOWN

Method Summary

HepRepPoint	copy(HepRepInstance parent) Returns a deep copy of this point.
double	getEta() Returns coordinate with respect to vertex at (0, 0, 0).
double	getEta(double xVertex, double yVertex, double zVertex) Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).
HepRepInstance	getInstance() Returns associated instance (parent).
double	getPhi() Returns coordinate with respect to vertex at (0, 0, 0).
double	getPhi(double xVertex, double yVertex, double zVertex) Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).
double	getR() Returns coordinate with respect to vertex at (0, 0, 0).
double	getR(double xVertex, double yVertex, double zVertex) Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).
double	getRho() Returns coordinate with respect to vertex at (0, 0, 0).
double	getRho(double xVertex, double yVertex, double zVertex) Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).
double	getTheta() Returns coordinate with respect to vertex at (0, 0, 0).
double	getTheta(double xVertex, double yVertex, double zVertex) Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).
double	getX() Returns coordinate with respect to vertex at (0, 0, 0).
double	getX(double xVertex, double yVertex, double zVertex) Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).
double[]	getXYZ(double[] xyz) Returns coordinate with respect to vertex at (0, 0, 0).
double	getY() Returns coordinate with respect to vertex at (0, 0, 0).
double	getY(double xVertex, double yVertex, double zVertex) Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).
double	getZ() Returns coordinate with respect to vertex at (0, 0, 0).
double	getZ(double xVertex, double yVertex, double zVertex) Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).

Methods inherited from interface hep.graphics.heprep.HepRepAttribute

addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, addAttValue, getAttValue, getAttValueFromNode, getAttValuesFromNode, removeAttValue

Method Detail

getX

double getX()

Returns coordinate with respect to vertex at (0, 0, 0).

Returns:

dx-coordinate

getY

double getY()

Returns coordinate with respect to vertex at (0, 0, 0).

Returns:

dy-coordinate

getZ

double getZ()

Returns coordinate with respect to vertex at (0, 0, 0).

Returns:

dz-coordinate

getRho

double getRho()

Returns coordinate with respect to vertex at (0, 0, 0).

Returns:

rho = sqrt(dx2+dy2);

getPhi

double getPhi()

Returns coordinate with respect to vertex at (0, 0, 0).

Returns:

phi = atan2(dy, dx);

getTheta

double getTheta()

Returns coordinate with respect to vertex at (0, 0, 0).

Returns:

theta = atan2(rho, dx);

getR

double getR()

Returns coordinate with respect to vertex at (0, 0, 0).

Returns:

r = sqrt(dx2+dy2+dz2);

getEta

double getEta()

Returns coordinate with respect to vertex at (0, 0, 0).

Returns:

eta = -0.5*clog((1.-ct)/(1.+ct)), where ct = .cos(getTheta(dx, dy, dz));

getX

double getX(double xVertex,
            double yVertex,
            double zVertex)

Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).

Parameters:

xVertex - x-coordinate of vertex

yVertex - y-coordinate of vertex

zVertex - z-coordinate of vertex

Returns:

dx-coordinate

getY

double getY(double xVertex,
            double yVertex,
            double zVertex)

Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).

Parameters:

xVertex - x-coordinate of vertex

yVertex - y-coordinate of vertex

zVertex - z-coordinate of vertex

Returns:

dy-coordinate

getZ

double getZ(double xVertex,
            double yVertex,
            double zVertex)

Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).

Parameters:

xVertex - x-coordinate of vertex

yVertex - y-coordinate of vertex

zVertex - z-coordinate of vertex

Returns:

dz-coordinate

getRho

double getRho(double xVertex,
              double yVertex,
              double zVertex)

Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).

Parameters:

xVertex - x-coordinate of vertex

yVertex - y-coordinate of vertex

zVertex - z-coordinate of vertex

Returns:

rho = sqrt(dx2+dy2);

getPhi

double getPhi(double xVertex,
              double yVertex,
              double zVertex)

Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).

Parameters:

xVertex - x-coordinate of vertex

yVertex - y-coordinate of vertex

zVertex - z-coordinate of vertex

Returns:

phi = atan2(dy, dx);

getTheta

double getTheta(double xVertex,
                double yVertex,
                double zVertex)

Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).

Parameters:

xVertex - x-coordinate of vertex

yVertex - y-coordinate of vertex

zVertex - z-coordinate of vertex

Returns:

theta = atan2(rho, dx);

getR

double getR(double xVertex,
            double yVertex,
            double zVertex)

Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).

Parameters:

xVertex - x-coordinate of vertex

yVertex - y-coordinate of vertex

zVertex - z-coordinate of vertex

Returns:

r = sqrt(dx2+dy2+dz2);

getEta

double getEta(double xVertex,
              double yVertex,
              double zVertex)

Returns coordinate with respect to vertex at (xVertex, yVertex, zVertex).

Parameters:

xVertex - x-coordinate of vertex

yVertex - y-coordinate of vertex

zVertex - z-coordinate of vertex

Returns:

eta = -0.5*clog((1.-ct)/(1.+ct)), where ct = .cos(getTheta(dx, dy, dz));

getXYZ

double[] getXYZ(double[] xyz)

Returns coordinate with respect to vertex at (0, 0, 0).

Parameters:

xyz - list of three coordinates which are filled and returned. If null, a new list of three coordinates is allocated.

Returns:

list of 3 coordinates.

getInstance

HepRepInstance getInstance()

Returns associated instance (parent).

Returns:

HepRepInstance.

copy

HepRepPoint copy(HepRepInstance parent)
                 throws CloneNotSupportedException

Returns a deep copy of this point.

Parameters:

parent - to add the copy to.

Returns:

copy of this point.

Throws:

CloneNotSupportedException - if copying is not possible.