org.lcsim.detector

Interface IRotation3D

All Known Implementing Classes:

Rotation3D, RotationGeant, RotationPassiveEuler, RotationPassiveXYZ

public interface IRotation3D

An interface to rotations in 3D space, using interfaces and base classes from freehep physics.

Version:

$Id: IRotation3D.java,v 1.11 2010/04/14 17:52:32 jeremy Exp $

Author:

Tim Nelson , Jeremy McCormick

Field Summary

Fields

Modifier and Type	Field and Description
static int	NCols The number of rows and columns in the matrix.
static int	NRows The number of rows and columns in the matrix.
static int	XCol Numerical constants for the X and Y column indices.
static int	XRow Numerical constants for the X and Y column indices.
static int	YCol Numerical constants for the X and Y column indices.
static int	YRow Numerical constants for the X and Y column indices.
static int	ZCol Numerical constants for the X and Y column indices.
static int	ZRow Numerical constants for the X and Y column indices.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(IRotation3D rotation) Compare this IRotation3D with another.
double	getComponent(int row, int col) Get matrix component by row and column.
Hep3Matrix	getRotationMatrix() The rotation in standard rotation matrix form.
IRotation3D	inverse() Apply inverse transformation, returning a new IRotation3D, not altering this matrix.
void	invert() Apply inverse transformation in place.
boolean	isIdentity() True if this IRotation3D is equivalent to the identity matrix.
void	multiplyBy(IRotation3D rotation) Multiply this rotation in place with another IRotation3D, modifying this IRotation3D in place.
void	printOut(PrintStream ps) Print out rotation
void	resetToIdentity() Reset this IRotation3D to the identity matrix.
void	rotate(Hep3Vector coordinates) Rotate a Hep3Vector in place
void	rotate(SymmetricMatrix matrix) Rotate a SymmetricMatrix in place (e.g.
Hep3Vector	rotated(Hep3Vector coordinates) Rotate a Hep3Vector
SymmetricMatrix	rotated(SymmetricMatrix matrix) Rotate a SymmetricMatrix (e.g.
void	setRotationMatrix(Hep3Matrix matrix) Set the matrix from a Hep3Matrix interface.

Field Detail

XCol

static final int XCol

Numerical constants for the X and Y column indices.

See Also:

Constant Field Values

YCol

static final int YCol

Numerical constants for the X and Y column indices.

See Also:

Constant Field Values

ZCol

static final int ZCol

Numerical constants for the X and Y column indices.

See Also:

Constant Field Values

XRow

static final int XRow

Numerical constants for the X and Y column indices.

See Also:

Constant Field Values

YRow

static final int YRow

Numerical constants for the X and Y column indices.

See Also:

Constant Field Values

ZRow

static final int ZRow

Numerical constants for the X and Y column indices.

See Also:

Constant Field Values

NRows

static final int NRows

The number of rows and columns in the matrix.

See Also:

Constant Field Values

NCols

static final int NCols

The number of rows and columns in the matrix.

See Also:

Constant Field Values

Method Detail

getRotationMatrix

Hep3Matrix getRotationMatrix()

The rotation in standard rotation matrix form.

Returns:

The BasicHep3Matrix representing this rotation.

setRotationMatrix

void setRotationMatrix(Hep3Matrix matrix)

Set the matrix from a Hep3Matrix interface.

Parameters:

matrix -

multiplyBy

void multiplyBy(IRotation3D rotation)

Multiply this rotation in place with another IRotation3D, modifying this IRotation3D in place.

Parameters:

rotation -

rotate

void rotate(Hep3Vector coordinates)

Rotate a Hep3Vector in place

Parameters:

coordinates -

rotated

Hep3Vector rotated(Hep3Vector coordinates)

Rotate a Hep3Vector

Parameters:

coordinates -

Returns:

rotated Hep3Vector

rotate

void rotate(SymmetricMatrix matrix)

Rotate a SymmetricMatrix in place (e.g. covariance matrix)

Parameters:

matrix -

rotated

SymmetricMatrix rotated(SymmetricMatrix matrix)

Rotate a SymmetricMatrix (e.g. covariance matrix)

Parameters:

matrix -

Returns:

rotated SymmetricMatrix

equals

boolean equals(IRotation3D rotation)

Compare this IRotation3D with another.

Parameters:

rotation -

Returns:

True if all components of the matrices are equal.

invert

void invert()

Apply inverse transformation in place.

inverse

IRotation3D inverse()

Apply inverse transformation, returning a new IRotation3D, not altering this matrix.

Returns:

A new matrix which is the inverse of this one.

getComponent

double getComponent(int row,
                  int col)

Get matrix component by row and column.

Parameters:

row -

col -

Returns:

Matrix component at row and col.

resetToIdentity

void resetToIdentity()

Reset this IRotation3D to the identity matrix.

isIdentity

boolean isIdentity()

True if this IRotation3D is equivalent to the identity matrix.

Returns:

True if this rotation is equal to identity.

printOut

void printOut(PrintStream ps)

Print out rotation

Parameters:

PrintStream - for output