org.lcsim.geometry

Interface FieldMap

All Known Implementing Classes:

AbstractFieldMap, BoxDipole, Dipole, FieldMap3D, FieldOverlay, HepRepOnlyDetector.SolenoidalField, RZFieldMap, Solenoid

public interface FieldMap

A field map, allows getting the field at a given point

Author:

tonyj

Method Summary

Methods

Modifier and Type	Method and Description
double[]	getField(double[] position) Deprecated. @use getField(double[], double[])
void	getField(double[] position, double[] b) Get the field magnitude and direction at a particular point.
Hep3Vector	getField(Hep3Vector position) Get the field magnitude and direction at a particular point.
Hep3Vector	getField(Hep3Vector position, BasicHep3Vector field) Get the field magnitude and direction at a particular point.

Method Detail

getField

void getField(double[] position,
            double[] b)

Get the field magnitude and direction at a particular point.

Parameters:

position - The position at which the field is requested

b - The field (the object is passed by reference and set to the correct field)

getField

double[] getField(double[] position)

Deprecated. @use getField(double[], double[])

Get the field magnitude and direction at a particular point. This method requires allocation of a new object on each call, and should therefore not be used if it may be called many times.

Parameters:

position - The position at which the field is requested

Returns:

The field.

getField

Hep3Vector getField(Hep3Vector position,
                  BasicHep3Vector field)

Get the field magnitude and direction at a particular point.

Parameters:

position - The position at which the field is requested.

field - The field. If not null this is passed by reference and set to the correct field

Returns:

The field. This will be the same object passed as field, unless field was null

getField

Hep3Vector getField(Hep3Vector position)

Get the field magnitude and direction at a particular point. Equivalent to getField(position,null).