BaseIDDecoder (LCSim 3.1.7 API)

java.lang.Object
- org.lcsim.geometry.util.BaseIDDecoder

All Implemented Interfaces:

IDDecoder

Direct Known Subclasses:

Segmentation
```
public class BaseIDDecoder
extends Object
implements IDDecoder
```
A basic implementation of org.lcsim.geometry.IDDecoder for others to extend. It uses the org.lcsim.geometry.util classes for functionality.

Version:

$Id: BaseIDDecoder.java,v 1.19 2011/04/28 01:12:32 jeremy Exp $

Author:

jeremym

Field Summary

Fields
Modifier and Type	Field and Description
`protected IDDecoder`	`decoder`
`protected IDDescriptor`	`descriptor`
`protected Subdetector`	`detector`
`protected int`	`layerIndex`
`protected boolean`	`valid`
`protected int[]`	`values`

Fields inherited from interface org.lcsim.geometry.IDDecoder
INVALID_INDEX

Constructor Summary

Constructors
Constructor and Description

BaseIDDecoder()

BaseIDDecoder(IDDescriptor id)

Constructors
Constructor and Description
`BaseIDDecoder()`
`BaseIDDecoder(IDDescriptor id)`

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.
`IDDecoder`	`getDecoder()`
`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()`
`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()`
`boolean`	`isValid()`
`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.
`private void`	`setLayerIndex(IDDescriptor id)`
`void`	`setSubdetector(Subdetector d)`
`boolean`	`supportsNeighbours()` Does this Decoder support cell neighboring?
`String`	`toString()`

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

- Field Detail
  - decoder
```
protected IDDecoder decoder
```
  - descriptor
```
protected IDDescriptor descriptor
```
  - values
```
protected int[] values
```
  - valid
```
protected boolean valid
```
  - detector
```
protected Subdetector detector
```
  - layerIndex
```
protected int layerIndex
```
- Constructor Detail
  - BaseIDDecoder
```
public BaseIDDecoder()
```
  - BaseIDDecoder
```
public BaseIDDecoder(IDDescriptor id)
```
- Method Detail
  - getDecoder
```
public IDDecoder getDecoder()
```
  - getX
```
public double getX()
```
    Specified by:
    
    getX in interface IDDecoder
    
    Returns:
    X coordinate
  - getY
```
public double getY()
```
    Specified by:
    
    getY in interface IDDecoder
    
    Returns:
    Y coordinate
  - getZ
```
public double getZ()
```
    Specified by:
    
    getZ in interface IDDecoder
    
    Returns:
    Z coordinate
  - getPhi
```
public double getPhi()
```
    Specified by:
    
    getPhi in interface IDDecoder
    
    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
    
    Returns:
    The theta angle.
  - getPosition
```
public double[] getPosition()
```
    Specified by:
    
    getPosition in interface IDDecoder
    
    Returns:
    position as double array of length 3
  - setID
```
public void setID(long id)
```
    Description copied from interface: IDDecoder
    
    Load the decoder with a 64-bit id value from the hit.
    
    Specified by:
    
    setID in interface IDDecoder
  - getValue
```
public int getValue(String field)
```
    Description copied from interface: IDDecoder
    
    Get the value of the given field.
    
    Specified by:
    
    getValue in interface IDDecoder
    
    Parameters:
    field - The name of the field.
    
    Returns:
    The integer value of the field.
  - getValue
```
public int getValue(int index)
```
    Description copied from interface: IDDecoder
    
    Get the value of a field by index.
    
    Specified by:
    
    getValue in interface IDDecoder
    
    Parameters:
    index - The index into the id.
    
    Returns:
    The integer value of the field.
  - getValues
```
public int[] getValues(int[] buffer)
```
    Description copied from interface: IDDecoder
    
    Get all decoded field values.
    
    Specified by:
    
    getValues in interface IDDecoder
    
    Parameters:
    buffer - The buffer to receive values.
    
    Returns:
    The buffer with field values.
  - getFieldName
```
public String getFieldName(int index)
```
    Description copied from interface: IDDecoder
    
    Get field name by index.
    
    Specified by:
    
    getFieldName in interface IDDecoder
    
    Parameters:
    index - The index of the field.
    
    Returns:
    The field name.
  - getFieldIndex
```
public int getFieldIndex(String name)
```
    Description copied from interface: IDDecoder
    
    Get field index by name.
    
    Specified by:
    
    getFieldIndex in interface IDDecoder
    
    Parameters:
    name - The name of the field.
    
    Returns:
    The index of the field.
  - getFieldCount
```
public int getFieldCount()
```
    Description copied from interface: IDDecoder
    
    Get the number of fields in this id description.
    
    Specified by:
    
    getFieldCount in interface IDDecoder
    
    Returns:
    The number of fields.
  - setIDDescription
```
public void setIDDescription(IDDescriptor id)
```
    Description copied from interface: IDDecoder
    
    Set the ID description of this decoder.
    
    Specified by:
    
    setIDDescription in interface IDDecoder
    
    Parameters:
    id - The ID description.
  - getIDDescription
```
public IDDescriptor getIDDescription()
```
    Description copied from interface: IDDecoder
    
    Get the ID description of this decoder.
    
    Specified by:
    
    getIDDescription in interface IDDecoder
    
    Returns:
    The ID description.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isValid
```
public boolean isValid()
```
  - getBarrelEndcapFlag
```
public BarrelEndcapFlag getBarrelEndcapFlag()
```
    Description copied from interface: IDDecoder
    
    Get the flag that indicates barrel or endcap, i.e. the "barrel" field.
    
    Specified by:
    
    getBarrelEndcapFlag in interface IDDecoder
  - setSubdetector
```
public void setSubdetector(Subdetector d)
```
  - getSubdetector
```
public Subdetector getSubdetector()
```
    Description copied from interface: IDDecoder
    
    Get the Subdetector associated with this IDDecoder, or null if not applicable.
    
    Specified by:
    
    getSubdetector in interface IDDecoder
  - setLayerIndex
```
private void setLayerIndex(IDDescriptor id)
```
  - getLayer
```
public int getLayer()
```
    Description copied from interface: IDDecoder
    
    Get the layer number for the current id.
    
    Specified by:
    
    getLayer in interface IDDecoder
    
    Returns:
    layer number
  - getVLayer
```
public int getVLayer()
```
    Description copied from interface: IDDecoder
    
    Get the layer number, possibly adjusted for topologies such as EcalBarrel. The default implementation returns the value of {IDDecoder.getLayer().
    
    Specified by:
    
    getVLayer in interface IDDecoder
    
    Returns:
    The pseudo layer number.
  - getSystemID
```
public int getSystemID()
```
    Description copied from interface: IDDecoder
    
    Get the system ID, i.e. the "system" field.
    
    Specified by:
    
    getSystemID in interface IDDecoder
  - getSystemNumber
```
public int getSystemNumber()
```
    Specified by:
    
    getSystemNumber in interface IDDecoder
  - 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
    
    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
    
    Returns:
    True if Decoder supports neighbors; false if not.
  - getNeighbourIDs
```
public long[] getNeighbourIDs()
```
    Description copied from interface: IDDecoder
    
    Get the current cell's neighbors using default neighboring parameters (usually 1,1,1).
    
    Specified by:
    
    getNeighbourIDs in interface IDDecoder
    
    Returns:
    The cell neighbors.
  - findCellContainingXYZ
```
public long findCellContainingXYZ(Hep3Vector pos)
```
    Description copied from interface: IDDecoder
    
    Locate a cell from a global position.
    
    Specified by:
    
    findCellContainingXYZ in interface IDDecoder
    
    Parameters:
    pos - The position.
    
    Returns:
    The cell id.
  - findCellContainingXYZ
```
public long findCellContainingXYZ(double[] pos)
```
    Description copied from interface: IDDecoder
    
    Locate a cell from a global position.
    
    Specified by:
    
    findCellContainingXYZ in interface IDDecoder
    
    Parameters:
    pos - The position.
    
    Returns:
    The cell id.
  - getPositionVector
```
public final Hep3Vector getPositionVector()
```
    Specified by:
    
    getPositionVector in interface IDDecoder
    
    Returns:
    Hep3Vector representing the position of the current ID.

Class BaseIDDecoder

Field Summary

Fields inherited from interface org.lcsim.geometry.IDDecoder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

decoder

descriptor

values

valid

detector

layerIndex

Constructor Detail

BaseIDDecoder

BaseIDDecoder

Method Detail

getDecoder

getX

getY

getZ

getPhi

getTheta

getPosition

setID

getValue

getValue

getValues

getFieldName

getFieldIndex

getFieldCount

setIDDescription

getIDDescription

toString

isValid

getBarrelEndcapFlag

setSubdetector

getSubdetector

setLayerIndex

getLayer

getVLayer

getSystemID

getSystemNumber

getNeighbourIDs

supportsNeighbours

getNeighbourIDs

findCellContainingXYZ

findCellContainingXYZ

getPositionVector