Detector (LCSim 3.1.7 API)

java.lang.Object
- org.lcsim.geometry.compact.Detector

Direct Known Subclasses:

Detector, LCDDDetector
```
public class Detector
extends Object
```
Default class created to represent the parsed detector.

Author:

tonyj, jeremym

Field Summary

Fields
Modifier and Type	Field and Description
`private Map<String,Constant>`	`constants`
`private IDetectorElement`	`de`
`private Map<String,VisAttributes>`	`display`
`private Map<String,Field>`	`fields`
`private List<URL>`	`gdmlReferences`
`private Header`	`header`
`private SystemIDMap`	`idmap`
`private Map<String,LimitSet>`	`limits`
`private XMLMaterialManager`	`materialMgr`
`private Map<String,Matrix>`	`matrices`
`(package private) String`	`name`
`private IPhysicalVolumeNavigator`	`navigator`
`private Map<String,Readout>`	`readouts`
`private Map<String,Region>`	`regions`
`private Map<String,Subdetector>`	`subdetectors`
`private IPhysicalVolume`	`trackingVolume`
`private IPhysicalVolume`	`worldVolume`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Detector(org.jdom.Element element)
Called by the reader to create a new Detector

Constructors
Modifier	Constructor and Description
`protected`	`Detector(org.jdom.Element element)` Called by the reader to create a new Detector

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addConstant(Constant c)` Called by the reader to add a constant to this detector.
`protected void`	`addField(Field field)`
`void`	`addGDMLReference(URL url)`
`void`	`addLimitSet(LimitSet limitset)`
`void`	`addMatrix(String name, Matrix matrix)` Add a matrix associated with this Detector, e.g.
`protected void`	`addReadout(Readout r)` Called by the reader to add a new Readout to this detector.
`void`	`addRegion(Region region)`
`protected void`	`addSubdetector(Subdetector sub)` Called by the reader to add a sub-detector to this detector.
`void`	`addVisAttributes(VisAttributes vis)`
`Calorimeter`	`getCalorimeterByType(Calorimeter.CalorimeterType calType)`
`Map<String,Constant>`	`getConstants()` Get the constants associated with this detector.
`IDetectorElement`	`getDetectorElement()`
`String`	`getDetectorName()` Get the detector name from the header.
`Map<String,Field>`	`getFields()`
`List<URL>`	`getGDMLReferences()`
`Header`	`getHeader()` Get the header associated with this detector.
`Map<String,LimitSet>`	`getLimits()`
`LimitSet`	`getLimitSet(String name)`
`MaterialManager`	`getMaterialManager()`
`Map<String,Matrix>`	`getMatrices()` Get the map of named matrices.
`Matrix`	`getMatrix(String name)` Get a matrix associated with this Detector.
`String`	`getName()`
`IPhysicalVolumeNavigator`	`getNavigator()`
`Readout`	`getReadout(String rn)` Convenience method to get readout by name.
`Map<String,Readout>`	`getReadouts()` Get the readouts associated with this detector.
`Region`	`getRegion(String name)`
`Map<String,Region>`	`getRegions()`
`Subdetector`	`getSubdetector(int sysid)` Get a Subdetector by system ID.
`Subdetector`	`getSubdetector(String name)` Convenience method to retrieve subdetector by name.
`List<Subdetector>`	`getSubdetectorList()`
`Set<String>`	`getSubdetectorNames()` Convenience method to retrieve set of detector names.
`Map<String,Subdetector>`	`getSubdetectors()` Get the sub-detectors associated with this detector.
`IPhysicalVolume`	`getTrackingVolume()`
`Map<String,VisAttributes>`	`getVisAttributes()`
`IPhysicalVolume`	`getWorldVolume()`
`XMLMaterialManager`	`getXMLMaterialManager()`
`void`	`setDetectorElement(IDetectorElement de)`
`protected void`	`setHeader(Header header)` Called by the reader to associate a header with this detector
`void`	`setWorldVolume(IPhysicalVolume worldVolume)`
`protected void`	`setXMLMaterialManager(XMLMaterialManager xmat)`

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

Field Detail

header
```
private Header header
```

constants
```
private Map<String,Constant> constants
```

subdetectors

private Map<String,Subdetector> subdetectors

readouts
```
private Map<String,Readout> readouts
```

fields
```
private Map<String,Field> fields
```

limits
```
private Map<String,LimitSet> limits
```

regions
```
private Map<String,Region> regions
```

display

private Map<String,VisAttributes> display

matrices
```
private Map<String,Matrix> matrices
```

materialMgr
```
private XMLMaterialManager materialMgr
```

gdmlReferences
```
private List<URL> gdmlReferences
```

idmap
```
private SystemIDMap idmap
```

worldVolume
```
private IPhysicalVolume worldVolume
```

trackingVolume
```
private IPhysicalVolume trackingVolume
```

navigator

private IPhysicalVolumeNavigator navigator

de
```
private IDetectorElement de
```

name
```
String name
```

Constructor Detail
- Detector
```
protected Detector(org.jdom.Element element)
```
  Called by the reader to create a new Detector
  
  Parameters:
  element - The JDOM element corresponding to the detector definition in the XML file.

Method Detail
- setXMLMaterialManager
```
protected void setXMLMaterialManager(XMLMaterialManager xmat)
```
- getName
```
public String getName()
```
- getWorldVolume
```
public IPhysicalVolume getWorldVolume()
```
- setWorldVolume
```
public void setWorldVolume(IPhysicalVolume worldVolume)
```
- getTrackingVolume
```
public IPhysicalVolume getTrackingVolume()
```
- getNavigator
```
public IPhysicalVolumeNavigator getNavigator()
```
- setHeader
```
protected void setHeader(Header header)
```
  Called by the reader to associate a header with this detector
  
  Parameters:
  header - The header.
- getHeader
```
public Header getHeader()
```
  Get the header associated with this detector.
  
  Returns:
  The header
- getDetectorName
```
public String getDetectorName()
```
  Get the detector name from the header.
  
  Returns:
  the detector name
- addConstant
```
protected void addConstant(Constant c)
```
  Called by the reader to add a constant to this detector.
  
  Parameters:
  c - The constant to add.
- getConstants
```
public Map<String,Constant> getConstants()
```
  Get the constants associated with this detector.
  
  Returns:
  A map of containing all of the constants, indexed by name.
- addMatrix
```
public void addMatrix(String name,
             Matrix matrix)
```
  Add a matrix associated with this Detector, e.g. for material properties.
  
  Parameters:
  name - The name of the matrix.
  matrix - The matrix object.
- getMatrix
```
public Matrix getMatrix(String name)
```
  Get a matrix associated with this Detector.
  
  Parameters:
  name - The name of the matrix.
  
  Returns:
  The matrix or null if it does not exist.
- getMatrices
```
public Map<String,Matrix> getMatrices()
```
  Get the map of named matrices.
  
  Returns:
  The map of matrices for this detector.
- addReadout
```
protected void addReadout(Readout r)
```
  Called by the reader to add a new Readout to this detector.
  
  Parameters:
  r - The readout to add.
- getReadouts
```
public Map<String,Readout> getReadouts()
```
  Get the readouts associated with this detector.
  
  Returns:
  A map of containing all of the readouts, indexed by name.
- getReadout
```
public Readout getReadout(String rn)
```
  Convenience method to get readout by name.
- addSubdetector
```
protected void addSubdetector(Subdetector sub)
```
  Called by the reader to add a sub-detector to this detector.
  
  Parameters:
  sub - The sub-detector to add.
- getSubdetector
```
public Subdetector getSubdetector(int sysid)
```
  Get a Subdetector by system ID.
  
  Parameters:
  sysid - The system identifier.
- getSubdetector
```
public Subdetector getSubdetector(String name)
```
  Convenience method to retrieve subdetector by name.
  
  Parameters:
  subdetector - with this name (null if doesn't exist)
- getSubdetectorNames
```
public Set<String> getSubdetectorNames()
```
  Convenience method to retrieve set of detector names.
  
  Returns:
  set of subdetector name strings
- getSubdetectors
```
public Map<String,Subdetector> getSubdetectors()
```
  Get the sub-detectors associated with this detector.
  
  Returns:
  A map of containing all of the sub-detectors, indexed by name.
- addField
```
protected void addField(Field field)
```
- getFields
```
public Map<String,Field> getFields()
```
- getXMLMaterialManager
```
public final XMLMaterialManager getXMLMaterialManager()
```
- getMaterialManager
```
public MaterialManager getMaterialManager()
```
- addLimitSet
```
public void addLimitSet(LimitSet limitset)
```
- getLimitSet
```
public LimitSet getLimitSet(String name)
```
- getLimits
```
public Map<String,LimitSet> getLimits()
```
- addRegion
```
public void addRegion(Region region)
```
- getRegion
```
public Region getRegion(String name)
```
- getRegions
```
public Map<String,Region> getRegions()
```
- addVisAttributes
```
public void addVisAttributes(VisAttributes vis)
```
- getVisAttributes
```
public Map<String,VisAttributes> getVisAttributes()
```
- getDetectorElement
```
public IDetectorElement getDetectorElement()
```
- setDetectorElement
```
public void setDetectorElement(IDetectorElement de)
```
- addGDMLReference
```
public void addGDMLReference(URL url)
```
- getGDMLReferences
```
public List<URL> getGDMLReferences()
```
- getCalorimeterByType
```
public Calorimeter getCalorimeterByType(Calorimeter.CalorimeterType calType)
```
- getSubdetectorList
```
public List<Subdetector> getSubdetectorList()
```

Class Detector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

header

constants

subdetectors

readouts

fields

limits

regions

display

matrices

materialMgr

gdmlReferences

idmap

worldVolume

trackingVolume

navigator

de

name

Constructor Detail

Detector

Method Detail

setXMLMaterialManager

getName

getWorldVolume

setWorldVolume

getTrackingVolume

getNavigator

setHeader

getHeader

getDetectorName

addConstant

getConstants

addMatrix

getMatrix

getMatrices

addReadout

getReadouts

getReadout

addSubdetector

getSubdetector

getSubdetector

getSubdetectorNames

getSubdetectors

addField

getFields

getXMLMaterialManager

getMaterialManager

addLimitSet

getLimitSet

getLimits

addRegion

getRegion

getRegions

addVisAttributes

getVisAttributes

getDetectorElement

setDetectorElement

addGDMLReference

getGDMLReferences

getCalorimeterByType

getSubdetectorList