IDDecoder (LCSim 3.1.7 API)

All Known Implementing Classes:

AbstractCartesianGrid, BarrelCylinderSegmentationBase, BaseIDDecoder, CartesianGridXY, CartesianGridXY, CartesianGridXZ, CartesianGridXZ, EcalBarrelCartesianGridXY, EcalBarrelCartesianGridXY, GlobalGridXY, GlobalGridXY, GridXYZ, GridXYZ, LCDDSegmentation, MokkaSegmentation, NonprojectiveCylinder, NonprojectiveCylinder, ProjectiveCylinder, ProjectiveCylinder, ProjectiveZPlane, ProjectiveZPlane, RegularNgonCartesianGridXY, RegularNgonCartesianGridXY, RegularNgonCartesianGridXZ, RegularNgonCartesianGridXZ, Segmentation, SegmentationBase
```
public interface IDDecoder
```
The compact detector description's interface for identifier decoding.

Author:

tonyj, jeremym

Field Summary

Fields
Modifier and Type Field and Description

static int INVALID_INDEX
Constant that flags an invalid index, i.e.

Fields
Modifier and Type	Field and Description
`static int`	`INVALID_INDEX` Constant that flags an invalid index, i.e.

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`findCellContainingXYZ(double[] pos)` Locate a cell from a global position.
`long`	`findCellContainingXYZ(Hep3Vector pos)` Locate a cell from a global position.
`BarrelEndcapFlag`	`getBarrelEndcapFlag()` Get the flag that indicates barrel or endcap, i.e.
`int`	`getFieldCount()` Get the number of fields in this id description.
`int`	`getFieldIndex(String name)` Get field index by name.
`String`	`getFieldName(int index)` Get field name by index.
`IDDescriptor`	`getIDDescription()` Get the ID description of this decoder.
`int`	`getLayer()` Get the layer number for the current id.
`long[]`	`getNeighbourIDs()` Get the current cell's neighbors using default neighboring parameters (usually 1,1,1).
`long[]`	`getNeighbourIDs(int deltaLayer, int deltaTheta, int deltaPhi)` Get the current cell's neighbors using fully specified neighboring parameters.
`double`	`getPhi()`
`double[]`	`getPosition()`
`Hep3Vector`	`getPositionVector()`
`Subdetector`	`getSubdetector()` Get the Subdetector associated with this IDDecoder, or null if not applicable.
`int`	`getSystemID()` Get the system ID, i.e.
`int`	`getSystemNumber()` Deprecated. Use `getSystemID()` instead
`double`	`getTheta()` The decoded theta angle of this id.
`int`	`getValue(int index)` Get the value of a field by index.
`int`	`getValue(String field)` Get the value of the given field.
`int[]`	`getValues(int[] buffer)` Get all decoded field values.
`int`	`getVLayer()` Get the layer number, possibly adjusted for topologies such as EcalBarrel.
`double`	`getX()`
`double`	`getY()`
`double`	`getZ()`
`void`	`setID(long id)` Load the decoder with a 64-bit id value from the hit.
`void`	`setIDDescription(IDDescriptor id)` Set the ID description of this decoder.
`boolean`	`supportsNeighbours()` Does this Decoder support cell neighboring?

- Field Detail
  - INVALID_INDEX
```
static final int INVALID_INDEX
```
    Constant that flags an invalid index, i.e. for a field that does not exist.
    
    See Also:
    Constant Field Values
- Method Detail
  - setID
```
void setID(long id)
```
    Load the decoder with a 64-bit id value from the hit.
  - getValue
```
int getValue(String field)
```
    Get the value of the given field.
    
    Parameters:
    field - The name of the field.
    
    Returns:
    The integer value of the field.
  - getValue
```
int getValue(int index)
```
    Get the value of a field by index.
    
    Parameters:
    index - The index into the id.
    
    Returns:
    The integer value of the field.
  - getValues
```
int[] getValues(int[] buffer)
```
    Get all decoded field values.
    
    Parameters:
    buffer - The buffer to receive values.
    
    Returns:
    The buffer with field values.
  - getFieldCount
```
int getFieldCount()
```
    Get the number of fields in this id description.
    
    Returns:
    The number of fields.
  - getFieldName
```
String getFieldName(int index)
```
    Get field name by index.
    
    Parameters:
    index - The index of the field.
    
    Returns:
    The field name.
  - getFieldIndex
```
int getFieldIndex(String name)
```
    Get field index by name.
    
    Parameters:
    name - The name of the field.
    
    Returns:
    The index of the field.
  - setIDDescription
```
void setIDDescription(IDDescriptor id)
```
    Set the ID description of this decoder.
    
    Parameters:
    id - The ID description.
  - getIDDescription
```
IDDescriptor getIDDescription()
```
    Get the ID description of this decoder.
    
    Returns:
    The ID description.
  - getLayer
```
int getLayer()
```
    Get the layer number for the current id.
    
    Returns:
    layer number
  - getVLayer
```
int getVLayer()
```
    Get the layer number, possibly adjusted for topologies such as EcalBarrel. The default implementation returns the value of {getLayer().
    
    Returns:
    The pseudo layer number.
  - getPositionVector
```
Hep3Vector getPositionVector()
```
    Returns:
    Hep3Vector representing the position of the current ID.
  - getPosition
```
double[] getPosition()
```
    Returns:
    position as double array of length 3
  - getX
```
double getX()
```
    Returns:
    X coordinate
  - getY
```
double getY()
```
    Returns:
    Y coordinate
  - getZ
```
double getZ()
```
    Returns:
    Z coordinate
  - getPhi
```
double getPhi()
```
    Returns:
    phi angle
  - getTheta
```
double getTheta()
```
    The decoded theta angle of this id.
    
    Returns:
    The theta angle.
  - findCellContainingXYZ
```
long findCellContainingXYZ(Hep3Vector pos)
```
    Locate a cell from a global position.
    
    Parameters:
    pos - The position.
    
    Returns:
    The cell id.
  - findCellContainingXYZ
```
long findCellContainingXYZ(double[] pos)
```
    Locate a cell from a global position.
    
    Parameters:
    pos - The position.
    
    Returns:
    The cell id.
  - getBarrelEndcapFlag
```
BarrelEndcapFlag getBarrelEndcapFlag()
```
    Get the flag that indicates barrel or endcap, i.e. the "barrel" field.
  - getSystemID
```
int getSystemID()
```
    Get the system ID, i.e. the "system" field.
  - getSystemNumber
```
int getSystemNumber()
```
    Deprecated. Use getSystemID() instead
  - getSubdetector
```
Subdetector getSubdetector()
```
    Get the Subdetector associated with this IDDecoder, or null if not applicable.
  - supportsNeighbours
```
boolean supportsNeighbours()
```
    Does this Decoder support cell neighboring?
    
    Returns:
    True if Decoder supports neighbors; false if not.
  - getNeighbourIDs
```
long[] getNeighbourIDs()
```
    Get the current cell's neighbors using default neighboring parameters (usually 1,1,1).
    
    Returns:
    The cell neighbors.
  - getNeighbourIDs
```
long[] getNeighbourIDs(int deltaLayer,
                     int deltaTheta,
                     int deltaPhi)
```
    Get the current cell's neighbors using fully specified neighboring parameters.
    
    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:

Interface IDDecoder

Field Summary

Method Summary

Field Detail

INVALID_INDEX

Method Detail

setID

getValue

getValue

getValues

getFieldCount

getFieldName

getFieldIndex

setIDDescription

getIDDescription

getLayer

getVLayer

getPositionVector

getPosition

getX

getY

getZ

getPhi

getTheta

findCellContainingXYZ

findCellContainingXYZ

getBarrelEndcapFlag

getSystemID

getSystemNumber

getSubdetector

supportsNeighbours

getNeighbourIDs

getNeighbourIDs