org.lcsim.geometry.segmentation

Class CartesianGridXY

java.lang.Object

org.lcsim.geometry.util.BaseIDDecoder

org.lcsim.geometry.compact.Segmentation

org.lcsim.geometry.segmentation.SegmentationBase

org.lcsim.geometry.segmentation.AbstractCartesianGrid

org.lcsim.geometry.segmentation.CartesianGridXY

All Implemented Interfaces:

IDDecoder

Direct Known Subclasses:

EcalBarrelCartesianGridXY, RegularNgonCartesianGridXY

public class CartesianGridXY
extends AbstractCartesianGrid

This segmentation represents an XY Cartesian grid. It can be used to segment staves in a calorimeter that have box shaped layers.

Version:

$Id: CartesianGridXY.java,v 1.13 2013/01/24 22:24:20 jeremy Exp $

Author:

Jeremy McCormick

Field Summary

Fields

Modifier and Type	Field and Description
private static String[]	fieldNames
private int	xIndex
private int	yIndex

Fields inherited from class org.lcsim.geometry.segmentation.AbstractCartesianGrid

geomFields, globalPosition, gridSizeX, gridSizeY, gridSizeZ, localPosition, needsCompute, sensitiveSlices, sliceIndex

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
CartesianGridXY(org.jdom.Element node)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	boundsCheck(long rawId) Check if the id is valid, e.g.
protected void	computeLocalPosition() Using the current ID, compute the local position in the readout volume and set the internal localPosition array.
private void	computeLocalX()
private void	computeLocalY()
double	getGridSizeX()
double	getGridSizeY()
long[]	getNeighbourIDs(int layerRange, int xRange, int yRange) Get the current cell's neighbors using fully specified neighboring parameters.
String[]	getSegmentationFieldNames()
int	getXBin(double x)
int	getYBin(double y)
protected void	setSegmentationValues(IExpandedIdentifier geomId, Hep3Vector localPositionVec) Set the segmentation field values on the given IExpandedIdentifier given a local hit position.
void	setupGeomFields(IDDescriptor id) Make a list of fields that are geometric by stripping out this segmentation's fields from the given IDDescriptor.

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

computeCoordinate, computeGlobalPosition, computePosition, findCellContainingXYZ, getBin, getGridSizeZ, getNeighbourIDs, getPosition, getX, getY, getZ, initSensitiveSlices, makeGeometryIdentifier, setID, setIDDescription, supportsNeighbours

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

getCellSizeU, getCellSizeV, useForHitPosition

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

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

Methods inherited from class java.lang.Object

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

Field Detail

xIndex

private int xIndex

yIndex

private int yIndex

fieldNames

private static final String[] fieldNames

Constructor Detail

CartesianGridXY

public CartesianGridXY(org.jdom.Element node)
                throws org.jdom.DataConversionException

Throws:

org.jdom.DataConversionException

Method Detail

getSegmentationFieldNames

public String[] getSegmentationFieldNames()

Specified by:

getSegmentationFieldNames in class SegmentationBase

getGridSizeX

public double getGridSizeX()

Overrides:

getGridSizeX in class AbstractCartesianGrid

getGridSizeY

public double getGridSizeY()

Overrides:

getGridSizeY in class AbstractCartesianGrid

getNeighbourIDs

public long[] getNeighbourIDs(int layerRange,
                     int xRange,
                     int yRange)

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:

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

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

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

Returns:

setSegmentationValues

protected void setSegmentationValues(IExpandedIdentifier geomId,
                         Hep3Vector localPositionVec)

Description copied from class: AbstractCartesianGrid

Set the segmentation field values on the given IExpandedIdentifier given a local hit position.

Specified by:

setSegmentationValues in class AbstractCartesianGrid

Parameters:

geomId - The expanded id.

localPositionVec - The local position of the hit.

getXBin

public int getXBin(double x)

getYBin

public int getYBin(double y)

boundsCheck

public boolean boundsCheck(long rawId)

Description copied from class: AbstractCartesianGrid

Check if the id is valid, e.g. if it is within the corresponding readout volume.

Specified by:

boundsCheck in class AbstractCartesianGrid

Returns:

True if id is valid for this segmentation type; False if not.

setupGeomFields

public void setupGeomFields(IDDescriptor id)

Description copied from class: AbstractCartesianGrid

Make a list of fields that are geometric by stripping out this segmentation's fields from the given IDDescriptor.

Specified by:

setupGeomFields in class AbstractCartesianGrid

Parameters:

id - The description of the Id.

computeLocalX

private void computeLocalX()

computeLocalY

private void computeLocalY()

computeLocalPosition

protected void computeLocalPosition()

Description copied from class: AbstractCartesianGrid

Using the current ID, compute the local position in the readout volume and set the internal localPosition array.

Specified by:

computeLocalPosition in class AbstractCartesianGrid