hep.wired.heprep.services
Interface Projection

All Superinterfaces:

Feature, ProjectionFeature, UVWindices, WiredRegistry.ID, org.freehep.xml.io.XMLIO, XYZindices

All Known Subinterfaces:

InverseProjection

All Known Implementing Classes:

AbstractProjection, ClockProjection, CompositeProjection, CylindricalFishEyeProjection, FlatProjection, NullProjection, ParallelProjection, ParallelProjection.XY, ParallelProjection.XZ, ParallelProjection.YZ, ParallelProjection.ZX, ParallelProjection.ZY, PerspectiveProjection, PerspectiveProjection.XY, PerspectiveProjection.XZ, PerspectiveProjection.YZ, PerspectiveProjection.ZX, PerspectiveProjection.ZY, RhoZ, RhoZFishEye, RhoZProjection, VariableProjection, YXClock, YXFishEye

public interface Projection
extends ProjectionFeature, WiredRegistry.ID, XYZindices, UVWindices, org.freehep.xml.io.XMLIO

Transforms coordinates in one system (X, Y, Z) into coordinates of another system (X', Y', Z'). Projections can be cascaded (sequenced).

Version:

$Id: Projection.java 8598 2006-08-14 20:38:02Z duns $

Author:

Mark Donszelmann

Field Summary

Fields inherited from interface hep.wired.util.XYZindices

X, Y, Z

Fields inherited from interface hep.wired.util.UVWindices

U, V, W

Method Summary

Projection	copy() Returns a deep copy of the projection.
double[]	deltaTransform(double[] xyz) Returns an array of length 3: uvw = delta projection(xyz).
Feature	getFeature(Class featureClass) Return Feature if implemented, otherwise null.
String	getFormula() Returns the formula in text readable form
String	getName() Returns the name of the projection.
ViewPort	getViewPort() Returns the associated viewport.
void	setViewPort(ViewPort viewPort) Sets the associated viewport.
boolean	supports(Class featureClass) Return true if this (composite) projection implements this featureClass.
double[]	transform(double[] xyz) Returns an array of length 3: uvw = projection(xyz).
double[][]	transform(double[][] xyz, int n) Returns an array of length 3*n: uvw[][n] = projection(xyz[][n]).
double[]	transform(ViewPort viewPort, double[] xyz) Returns an array of length 3: uvw = viewPort(projection(xyz)).
double[][]	transform(ViewPort viewPort, double[][] xyz, int n) Returns an array of length 3*n: uvw[][n] = viewPort(projection(xyz[][n])).

Methods inherited from interface hep.wired.util.WiredRegistry.ID

getID

Methods inherited from interface org.freehep.xml.io.XMLIO

restore, save

Method Detail

getName

String getName()

Returns the name of the projection.

getFormula

String getFormula()

Returns the formula in text readable form

supports

boolean supports(Class featureClass)

Return true if this (composite) projection implements this featureClass.

getFeature

Feature getFeature(Class featureClass)

Return Feature if implemented, otherwise null.

setViewPort

void setViewPort(ViewPort viewPort)

Sets the associated viewport.

getViewPort

ViewPort getViewPort()

Returns the associated viewport.

transform

double[] transform(ViewPort viewPort,
                   double[] xyz)

Returns an array of length 3: uvw = viewPort(projection(xyz)). The returned array may have a lifetime up to the next call to this method on this object. CoordinateProjection may be null.

transform

double[] transform(double[] xyz)

Returns an array of length 3: uvw = projection(xyz). The returned array may have a lifetime up to the next call to this method on this object.

transform

double[][] transform(ViewPort viewPort,
                     double[][] xyz,
                     int n)

Returns an array of length 3*n: uvw[][n] = viewPort(projection(xyz[][n])). The returned array may have a lifetime up to the next call to this method on this object. The number of "valid" coordinates is given by n. CoordinateProjection may be null.

transform

double[][] transform(double[][] xyz,
                     int n)

Returns an array of length 3*n: uvw[][n] = projection(xyz[][n]). The returned array may have a lifetime up to the next call to this method on this object. The number of "valid" coordinates is given by n.

deltaTransform

double[] deltaTransform(double[] xyz)

Returns an array of length 3: uvw = delta projection(xyz). The returned array may have a lifetime up to the next call to this method on this object.

copy

Projection copy()

Returns a deep copy of the projection.