org.lcsim.geometry.segmentation

Class ProjectiveZPlane

java.lang.Object

org.lcsim.geometry.util.BaseIDDecoder

org.lcsim.geometry.compact.Segmentation

org.lcsim.geometry.segmentation.SegmentationBase

org.lcsim.geometry.segmentation.ProjectiveZPlane

All Implemented Interfaces:

IDDecoder

public class ProjectiveZPlane
extends SegmentationBase

This segmentation represents a projective Z plane. It is most appropriately used for cylindrical endcap calorimeter components.

Author:

Tony Johnson

Field Summary

Fields

Modifier and Type	Field and Description
private int	barrelIndex
private static String[]	fieldNames
private int	phiBins
private double	phiDim
private int	phiIndex
private int	systemIndex
private int	thetaBins
private double	thetaDim
private int	thetaIndex

Fields inherited from class org.lcsim.geometry.compact.Segmentation

cellSizes

Fields inherited from class org.lcsim.geometry.util.BaseIDDecoder

decoder, descriptor, detector, layerIndex, valid, values

Fields inherited from interface org.lcsim.geometry.IDDecoder

INVALID_INDEX

Constructor Summary

Constructors

Constructor and Description
ProjectiveZPlane(org.jdom.Element node)

Method Summary

Methods

Modifier and Type	Method and Description
long	findCellContainingXYZ(double x, double y, double z) Return the cell which contains a given point (x,y,z), or zero.
double	getCellSizeU()
double	getCellSizeV()
int	getLayerBin(double z) Return the layer number based on the z-coordinate
long[]	getNeighbourIDs(int deltaLayer, int deltaTheta, int deltaPhi) Get the current cell's neighbors using fully specified neighboring parameters.
double	getPhi()
int	getPhiBins()
String[]	getSegmentationFieldNames()
private double	getSphericalRadius()
double	getTheta() The decoded theta angle of this id.
int	getThetaBins()
double	getX()
double	getY()
double	getZ()
void	setIDDescription(IDDescriptor id) Set the ID description of this decoder.
boolean	supportsNeighbours() Does this Decoder support cell neighboring?

Methods inherited from class org.lcsim.geometry.segmentation.SegmentationBase

findCellContainingXYZ, findCellContainingXYZ, getDistanceToSensitive, getID, getLayering, getNumberOfLayers, getRMax, getRMin, getZMax, getZMin, transformLocalToGlobal

Methods inherited from class org.lcsim.geometry.compact.Segmentation

useForHitPosition

Methods inherited from class org.lcsim.geometry.util.BaseIDDecoder

getBarrelEndcapFlag, getDecoder, getFieldCount, getFieldIndex, getFieldName, getIDDescription, getLayer, getNeighbourIDs, getPosition, getPositionVector, getSubdetector, getSystemID, getSystemNumber, getValue, getValue, getValues, getVLayer, isValid, setID, setSubdetector, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

thetaBins

private int thetaBins

phiBins

private int phiBins

thetaIndex

private int thetaIndex

phiIndex

private int phiIndex

systemIndex

private int systemIndex

barrelIndex

private int barrelIndex

thetaDim

private double thetaDim

phiDim

private double phiDim

fieldNames

private static final String[] fieldNames

Constructor Detail

ProjectiveZPlane

ProjectiveZPlane(org.jdom.Element node)
           throws org.jdom.DataConversionException

Throws:

org.jdom.DataConversionException

Method Detail

getSegmentationFieldNames

public String[] getSegmentationFieldNames()

Specified by:

getSegmentationFieldNames in class SegmentationBase

getCellSizeU

public double getCellSizeU()

Overrides:

getCellSizeU in class Segmentation

getCellSizeV

public double getCellSizeV()

Overrides:

getCellSizeV in class Segmentation

getThetaBins

public int getThetaBins()

getPhiBins

public int getPhiBins()

getPhi

public double getPhi()

Specified by:

getPhi in interface IDDecoder

Overrides:

getPhi in class BaseIDDecoder

Returns:

phi angle

getTheta

public double getTheta()

Description copied from interface: IDDecoder

The decoded theta angle of this id.

Specified by:

getTheta in interface IDDecoder

Overrides:

getTheta in class BaseIDDecoder

Returns:

The theta angle.

getX

public double getX()

Specified by:

getX in interface IDDecoder

Overrides:

getX in class BaseIDDecoder

Returns:

X coordinate

getY

public double getY()

Specified by:

getY in interface IDDecoder

Overrides:

getY in class BaseIDDecoder

Returns:

Y coordinate

getZ

public double getZ()

Specified by:

getZ in interface IDDecoder

Overrides:

getZ in class BaseIDDecoder

Returns:

Z coordinate

getSphericalRadius

private double getSphericalRadius()

setIDDescription

public void setIDDescription(IDDescriptor id)

Description copied from interface: IDDecoder

Set the ID description of this decoder.

Specified by:

setIDDescription in interface IDDecoder

Overrides:

setIDDescription in class BaseIDDecoder

Parameters:

id - The ID description.

getNeighbourIDs

public long[] getNeighbourIDs(int deltaLayer,
                     int deltaTheta,
                     int deltaPhi)

Description copied from interface: IDDecoder

Get the current cell's neighbors using fully specified neighboring parameters.

Specified by:

getNeighbourIDs in interface IDDecoder

Overrides:

getNeighbourIDs in class BaseIDDecoder

Parameters:

deltaLayer - The number of layers to neighbor (plus or minus).

deltaTheta - The number of cells in theta to neighbor (plus or minus).

deltaPhi - The number of cells in phi to neighbor (plus or minus).

Returns:

supportsNeighbours

public boolean supportsNeighbours()

Description copied from interface: IDDecoder

Does this Decoder support cell neighboring?

Specified by:

supportsNeighbours in interface IDDecoder

Overrides:

supportsNeighbours in class SegmentationBase

Returns:

True if Decoder supports neighbors; false if not.

findCellContainingXYZ

public long findCellContainingXYZ(double x,
                         double y,
                         double z)

Return the cell which contains a given point (x,y,z), or zero.

Specified by:

findCellContainingXYZ in class SegmentationBase

Parameters:

x - Cartesian X coordinate.

y - Cartesian Y coordinate.

z - Cartesian Z coordinate.

Returns:

ID of cell containing the point (maybe either in absorber or live material)

getLayerBin

public int getLayerBin(double z)

Return the layer number based on the z-coordinate

Parameters:

z - z-coordinate

Returns:

layer number of layer corresponding to that distance (may be either in absorber or live material)

Throws:

RuntimeException - if abs(z)