GridXYZ (LCSim 3.1.7 API)

java.lang.Object
- org.lcsim.geometry.util.BaseIDDecoder
- - org.lcsim.geometry.compact.Segmentation
  - - org.lcsim.geometry.segmentation.SegmentationBase
    - - org.lcsim.geometry.segmentation.GridXYZ

All Implemented Interfaces:

IDDecoder
```
public class GridXYZ
extends SegmentationBase
```
Cartesian XYZ grid segmentation, primarily used for readout of planes like those in a Polyhedra Calorimeter with Trapezoidal staves. This segmentation is based on a local coordinate system.

Version:

$Id: GridXYZ.java,v 1.32 2013/01/24 22:24:20 jeremy Exp $

Author:

Jeremy McCormick , Guilherme Lima

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`barrelIndex`
`private static String[]`	`fieldNames`
`(package private) List<Integer>`	`geomFields`
`private double[]`	`globalPosition`
`private double`	`gridSizeX`
`private double`	`gridSizeY`
`private double`	`gridSizeZ`
`(package private) IIdentifierHelper`	`helper`
`(package private) IIdentifierDictionary`	`iddict`
`private double[]`	`localPosition`
`private int`	`systemIndex`
`private int`	`xIndex`
`private int`	`yIndex`
`private int`	`zIndex`

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

GridXYZ(org.jdom.Element node)
Creates a new instance of GridXYZ

Constructors
Constructor and Description
`GridXYZ(org.jdom.Element node)` Creates a new instance of GridXYZ

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`computeGlobalPosition()`
`private void`	`computeLocalPosition()`
`private void`	`computeLocalX()`
`private void`	`computeLocalY()`
`private void`	`computeLocalZ()`
`private void`	`computePosition()`
`long`	`findCellContainingXYZ(double x, double y, double z)` Return the cell which contains a given point (x,y,z).
`int`	`getBin(double u, double gridSizeU)`
`double`	`getCylindricalRadiusFromPosition()`
`private double`	`getDepthSensitiveMid(int ilay)` Returns positive distance from IR to center of sensitive slice of any layer
`double`	`getGridSizeX()`
`double`	`getGridSizeY()`
`double`	`getGridSizeZ()`
`int`	`getLayerBin(double z)`
`long[]`	`getNeighbourIDs(int layerRange, int xRange, int yRange)` Find neighbouring cells to the current cell.
`double`	`getPhi()`
`double[]`	`getPosition()`
`double`	`getRMax()`
`double`	`getRMin()`
`String[]`	`getSegmentationFieldNames()`
`double`	`getTheta()` The decoded theta angle of this id.
`double`	`getX()`
`int`	`getXBin(double x)`
`double`	`getY()`
`int`	`getYBin(double y)`
`double`	`getZ()`
`double`	`getZMax()`
`double`	`getZMin()`
`void`	`setID(long id)` Overridden to cache the global position.
`void`	`setIDDescription(IDDescriptor id)` Check for a valid grid size for each of XYZ.
`void`	`setSubdetector(Subdetector subdet)`
`boolean`	`supportsNeighbours()` Does this Decoder support cell neighboring?

Methods inherited from class org.lcsim.geometry.segmentation.SegmentationBase
findCellContainingXYZ, findCellContainingXYZ, getDistanceToSensitive, getID, getLayering, getNumberOfLayers, 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, getPositionVector, getSubdetector, getSystemID, getSystemNumber, getValue, getValue, getValues, getVLayer, isValid, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - gridSizeX
```
private double gridSizeX
```
  - gridSizeY
```
private double gridSizeY
```
  - gridSizeZ
```
private double gridSizeZ
```
  - xIndex
```
private int xIndex
```
  - yIndex
```
private int yIndex
```
  - zIndex
```
private int zIndex
```
  - barrelIndex
```
private int barrelIndex
```
  - systemIndex
```
private int systemIndex
```
  - localPosition
```
private double[] localPosition
```
  - globalPosition
```
private double[] globalPosition
```
  - fieldNames
```
private static final String[] fieldNames
```
  - geomFields
```
List<Integer> geomFields
```
  - helper
```
IIdentifierHelper helper
```
  - iddict
```
IIdentifierDictionary iddict
```
- Constructor Detail
  - GridXYZ
```
public GridXYZ(org.jdom.Element node)
        throws org.jdom.DataConversionException
```
    Creates a new instance of GridXYZ
    
    Throws:
    
    org.jdom.DataConversionException
- Method Detail
  - getSegmentationFieldNames
```
public String[] getSegmentationFieldNames()
```
    Specified by:
    
    getSegmentationFieldNames in class SegmentationBase
  - 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.
  - getNeighbourIDs
```
public long[] getNeighbourIDs(int layerRange,
                     int xRange,
                     int yRange)
```
    Find neighbouring cells to the current cell. Cell neighbors are found based on the direction (theta,phi) of the reference cell w.r.t the origin.
    
    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:
    array of cellIDs for the neighbouring cells
  - getZMin
```
public double getZMin()
```
    Overrides:
    
    getZMin in class SegmentationBase
  - getZMax
```
public double getZMax()
```
    Overrides:
    
    getZMax in class SegmentationBase
  - getRMin
```
public double getRMin()
```
    Overrides:
    
    getRMin in class SegmentationBase
  - getRMax
```
public double getRMax()
```
    Overrides:
    
    getRMax in class SegmentationBase
  - 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
  - getPosition
```
public double[] getPosition()
```
    Specified by:
    
    getPosition in interface IDDecoder
    
    Overrides:
    
    getPosition in class BaseIDDecoder
    
    Returns:
    position as double array of length 3
  - computePosition
```
private void computePosition()
```
  - computeLocalPosition
```
private void computeLocalPosition()
```
  - computeGlobalPosition
```
private void computeGlobalPosition()
```
  - setSubdetector
```
public void setSubdetector(Subdetector subdet)
```
    Overrides:
    
    setSubdetector in class BaseIDDecoder
  - computeLocalX
```
private void computeLocalX()
```
  - computeLocalY
```
private void computeLocalY()
```
  - computeLocalZ
```
private void computeLocalZ()
```
  - setID
```
public void setID(long id)
```
    Overridden to cache the global position.
    
    Specified by:
    
    setID in interface IDDecoder
    
    Overrides:
    
    setID in class BaseIDDecoder
  - getCylindricalRadiusFromPosition
```
public double getCylindricalRadiusFromPosition()
```
  - setIDDescription
```
public void setIDDescription(IDDescriptor id)
```
    Check for a valid grid size for each of XYZ. If the grid is not valid, then leave those indices flagged with invalid values. It is actually okay to have all 0's, because this will return the center of the volume, at least in analogous Geant4 impl of this class.
    
    Specified by:
    
    setIDDescription in interface IDDecoder
    
    Overrides:
    
    setIDDescription in class BaseIDDecoder
    
    Parameters:
    id - The ID description.
  - getDepthSensitiveMid
```
private double getDepthSensitiveMid(int ilay)
```
    Returns positive distance from IR to center of sensitive slice of any layer
    
    Parameters:
    layer - The layer index.
  - findCellContainingXYZ
```
public long findCellContainingXYZ(double x,
                         double y,
                         double z)
```
    Return the cell which contains a given point (x,y,z). If point is not contained in this component, zero is returned.
    
    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)
```
  - getXBin
```
public int getXBin(double x)
```
  - getYBin
```
public int getYBin(double y)
```
  - getBin
```
public int getBin(double u,
         double gridSizeU)
```
  - getGridSizeX
```
public double getGridSizeX()
```
  - getGridSizeY
```
public double getGridSizeY()
```
  - getGridSizeZ
```
public double getGridSizeZ()
```

Class GridXYZ

Field Summary

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

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

Fields inherited from interface org.lcsim.geometry.IDDecoder

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Detail

gridSizeX

gridSizeY

gridSizeZ

xIndex

yIndex

zIndex

barrelIndex

systemIndex

localPosition

globalPosition

fieldNames

geomFields

helper

iddict

Constructor Detail

GridXYZ

Method Detail

getSegmentationFieldNames

supportsNeighbours

getNeighbourIDs

getZMin

getZMax

getRMin

getRMax

getPhi

getTheta

getX

getY

getZ

getPosition

computePosition

computeLocalPosition

computeGlobalPosition

setSubdetector

computeLocalX

computeLocalY

computeLocalZ

setID

getCylindricalRadiusFromPosition

setIDDescription

getDepthSensitiveMid

findCellContainingXYZ

getLayerBin

getXBin

getYBin

getBin

getGridSizeX

getGridSizeY

getGridSizeZ