org.lcsim.detector

Class DetectorElement

java.lang.Object

org.lcsim.detector.DetectorElement

All Implemented Interfaces:

Identifiable, IDetectorElement

Direct Known Subclasses:

DeDetector, SiSensor, SiTrackerLayer, SiTrackerModule, SubdetectorDetectorElement

public class DetectorElement
extends Object
implements IDetectorElement

Implementation of IDetectorElement.

Version:

$Id: DetectorElement.java,v 1.48 2011/02/25 03:09:38 jeremy Exp $

Author:

Jeremy McCormick

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DetectorElement.TypeSearch<T extends IDetectorElement>

Field Summary

Fields

Modifier and Type	Field and Description
private IDetectorElementContainer	children
private IGeometryInfo	geometry
private IIdentifierHelper	helper
private IIdentifier	id
private String	name
private IParameters	parameters
private IDetectorElement	parent
private IReadout	readout

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DetectorElement() For subclasses.
	DetectorElement(String name) Create a DE with no parent and no support.
	DetectorElement(String name, IDetectorElement parent) Create a DE with a parent but no support in the geometry, e.g.
	DetectorElement(String name, IDetectorElement parent, IIdentifier id) Create with a name, parent, and identifier.
	DetectorElement(String name, IDetectorElement parent, IPhysicalVolumePath support) Create a DE with a parent and support in the geometry tree.
	DetectorElement(String name, IDetectorElement parent, IPhysicalVolumePath support, IIdentifier id) Creates a DetectorElement with complete arguments, including a parent, geometry support as a String, and an org.lcsim.detector.IIdentifier.
	DetectorElement(String name, IDetectorElement parent, String support) Create a DE with complete arguments, including a parent DE, geometry support, and an id.
	DetectorElement(String name, IDetectorElement parent, String support, IIdentifier id) Create a DE with complete arguments, including a parent DE, string of path, and an id.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addChild(IDetectorElement child)
private void	checkName(String name)
void	clearReadouts() Clear the IReadout of this DetectorElement and recursively visit and clear the children..
private void	createGeometryInfo(IPhysicalVolumePath path)
private void	createGeometryInfo(String path)
IReadout	createReadout()
<T extends IDetectorElement> List<T>	findAncestors(Class<T> klass) Find ancestors matching a class.
<T extends IDetectorElement> List<T>	findDescendants(Class<T> klass) Find descendants matching a class.
IDetectorElement	findDetectorElement(Hep3Vector globalPoint) Locate the deepest DetectorElement containing a global point starting with this DetectorElement and traversing into its children.
IDetectorElementContainer	findDetectorElement(IIdentifier id) Default implementation of IDetectorElement.findDetectorElement(IIdentifier).
IDetectorElement	findDetectorElement(String pathString) Locate a child detector element given a slash-separated list of DetectorElement names.
IDetectorElement	findDetectorElement(String[] path) Locate a child detector element given an ordered list of DetectorElement names.
IDetectorElementContainer	getAncestry() A list of parents from the top to this one.
IDetectorElementContainer	getChildren() Get a container with the DetectorElement's children.
IExpandedIdentifier	getExpandedIdentifier() Get the IExpandedIdentifier associated with this object.
IGeometryInfo	getGeometry() Get the geometric information for this node, including the volume center position and global and local transformations.
IIdentifier	getIdentifier() Get the identifier of this DE.
IIdentifierHelper	getIdentifierHelper() Get the IIdentifierHelper associated with this object.
String	getName() Get the name of this DetectorElement.
IParameters	getParameters() The named parameters associated to this instance.
IDetectorElement	getParent() Get the parent element of this node.
IReadout	getReadout() Get the readout associated with this DetectorElement, or null if the DetectorElement has no associated readout.
IDetectorElement	getTop()
boolean	hasChildren() True if the DetectorElement has children.
boolean	hasGeometryInfo()
boolean	hasReadout() True if this DetectorElement has an IReadout; False if the IReadout is null.
void	initialize() This method should be called externally to perform initialization after all child elements have been added.
boolean	isAncestor(IDetectorElement de) True if the DetectorElement is an ancestor of this one.
boolean	isDescendant(IDetectorElement de) True if the DetectorElement is a descendant of this one.
boolean	isSensitive() True if the DetectorElement's PhysicalVolume is flagged as sensitive.
private void	register() Register this IDetectorElement with the DetectorElementStore.
void	setIdentifier(IIdentifier id) Set the identifier of this DE.
void	setIdentifierHelper(IIdentifierHelper helper) Set the IIdentifierHelper for encoding and decoding identifiers of this DetectorElement.
void	setParameters(IParameters parameters)
void	setParent(IDetectorElement parent) Set the parent IDetectorElement.
void	setReadout(IReadout readout)
void	setSupport(IPhysicalVolumePath support)
void	setSupport(String path)
private void	setup(String name, IDetectorElement parent, IPhysicalVolumePath support, IIdentifier id)
private void	setup(String name, IDetectorElement parent, String support, IIdentifier id)
void	traverseAncestors(IDetectorElementVisitor visitor) Visit this and ancestors.
void	traverseDescendantsPostOrder(IDetectorElementVisitor visitor) Recrusive post-order tree traversal of this IDetectorElement.
void	traverseDescendantsPreOrder(IDetectorElementVisitor visitor) Recursive pre-order tree traversal of this IDetectorElement.
private static void	traversePostOrder(IDetectorElement detectorElement, IDetectorElementVisitor visitor)
private static void	traversePreOrder(IDetectorElement detectorElement, IDetectorElementVisitor visitor)

Methods inherited from class java.lang.Object

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

Field Detail

children

private IDetectorElementContainer children

geometry

private IGeometryInfo geometry

parent

private IDetectorElement parent

id

private IIdentifier id

helper

private IIdentifierHelper helper

parameters

private IParameters parameters

readout

private IReadout readout

name

private String name

Constructor Detail

DetectorElement

protected DetectorElement()

For subclasses.

DetectorElement

public DetectorElement(String name,
               IDetectorElement parent,
               IPhysicalVolumePath support,
               IIdentifier id)

Creates a DetectorElement with complete arguments, including a parent, geometry support as a String, and an org.lcsim.detector.IIdentifier.

Parameters:

name - The name of this DetectorElement.

parent - The parent DetectorElement.

support - The geometry support as a "/" delimited String.

id - The DetectorElement's identifier.

DetectorElement

public DetectorElement(String name,
               IDetectorElement parent,
               IPhysicalVolumePath support)

Create a DE with a parent and support in the geometry tree.

Parameters:

name -

parent -

support -

DetectorElement

public DetectorElement(String name,
               IDetectorElement parent,
               String support)

Create a DE with complete arguments, including a parent DE, geometry support, and an id.

Parameters:

name -

parent -

support -

DetectorElement

public DetectorElement(String name,
               IDetectorElement parent,
               String support,
               IIdentifier id)

Create a DE with complete arguments, including a parent DE, string of path, and an id.

Parameters:

name -

parent -

support -

DetectorElement

public DetectorElement(String name,
               IDetectorElement parent)

Create a DE with a parent but no support in the geometry, e.g. a ghost volume.

Parameters:

name -

parent -

DetectorElement

public DetectorElement(String name,
               IDetectorElement parent,
               IIdentifier id)

Create with a name, parent, and identifier.

DetectorElement

public DetectorElement(String name)

Create a DE with no parent and no support. If this constructor is used, then an external routine must setup the parent, support, and/or id later.

Parameters:

name -

Method Detail

getName

public String getName()

Description copied from interface: IDetectorElement

Get the name of this DetectorElement.

Specified by:

getName in interface IDetectorElement

Returns:

The name this DetectorElement.

setParent

public void setParent(IDetectorElement parent)

Set the parent IDetectorElement. Once this has been set, additional calls to this method will cause a RuntimeException.

Specified by:

setParent in interface IDetectorElement

Parameters:

parent - The parent IDetectorElement.

Throws:

RuntimeException - If the parent IDetectorElement is already set.

IllegalArgumentException - If @param parent is null.

register

private void register()

Register this IDetectorElement with the DetectorElementStore.

checkName

private void checkName(String name)

setup

private void setup(String name,
         IDetectorElement parent,
         IPhysicalVolumePath support,
         IIdentifier id)

setup

private void setup(String name,
         IDetectorElement parent,
         String support,
         IIdentifier id)

setSupport

public void setSupport(IPhysicalVolumePath support)

setSupport

public void setSupport(String path)

createGeometryInfo

private void createGeometryInfo(IPhysicalVolumePath path)

createGeometryInfo

private void createGeometryInfo(String path)

addChild

protected void addChild(IDetectorElement child)

getChildren

public IDetectorElementContainer getChildren()

Description copied from interface: IDetectorElement

Get a container with the DetectorElement's children.

Specified by:

getChildren in interface IDetectorElement

Returns:

An IDetectorElementContainer containing this DE's children. This container will be empty if there are no children.

hasChildren

public boolean hasChildren()

Description copied from interface: IDetectorElement

True if the DetectorElement has children.

Specified by:

hasChildren in interface IDetectorElement

Returns:

True if has children, else False.

getGeometry

public IGeometryInfo getGeometry()

Description copied from interface: IDetectorElement

Get the geometric information for this node, including the volume center position and global and local transformations.

Specified by:

getGeometry in interface IDetectorElement

Returns:

An IGeometryInfo object with geometry information.

getParent

public IDetectorElement getParent()

Description copied from interface: IDetectorElement

Get the parent element of this node. The top-level DetectorElement has no parent.

Specified by:

getParent in interface IDetectorElement

Returns:

This node's parent or null if the DetectorElement has no parent.

getExpandedIdentifier

public IExpandedIdentifier getExpandedIdentifier()

Description copied from interface: Identifiable

Get the IExpandedIdentifier associated with this object. Should use IIdentifierHelper to unpack the IIdentifier.

Specified by:

getExpandedIdentifier in interface Identifiable

Returns:

The ExpandedIdentifier.

getIdentifier

public IIdentifier getIdentifier()

Description copied from interface: IDetectorElement

Get the identifier of this DE.

Specified by:

getIdentifier in interface Identifiable

Specified by:

getIdentifier in interface IDetectorElement

Returns:

The unique identifier of this DetectorElement.

setIdentifier

public void setIdentifier(IIdentifier id)

Description copied from interface: IDetectorElement

Set the identifier of this DE.

Specified by:

setIdentifier in interface IDetectorElement

hasGeometryInfo

public boolean hasGeometryInfo()

Specified by:

hasGeometryInfo in interface IDetectorElement

Returns:

True if IGeometryInfo has been created; False if IGeometryInfo is null.

findDetectorElement

public IDetectorElement findDetectorElement(Hep3Vector globalPoint)

Description copied from interface: IDetectorElement

Locate the deepest DetectorElement containing a global point starting with this DetectorElement and traversing into its children. This method can be used from Detector to find the deepest node within the complete detector. This method is not on GeometryInfo, because a DetectorElement is allowed to have a null GeometryInfo if it is a simple container without a geometry path, i.e. a ghost volume.

Specified by:

findDetectorElement in interface IDetectorElement

Returns:

The deepest IDetectorElement containing globalPoint or null if point is not contained within this DetectorElement or its children.

getReadout

public IReadout getReadout()

Description copied from interface: IDetectorElement

Get the readout associated with this DetectorElement, or null if the DetectorElement has no associated readout.

Specified by:

getReadout in interface IDetectorElement

Returns:

Associated IReadout object or null if Readout has been assigned to this DetectorElement.

See Also:

IReadout, Readout

setReadout

public void setReadout(IReadout readout)

createReadout

public IReadout createReadout()

hasReadout

public boolean hasReadout()

Description copied from interface: IDetectorElement

True if this DetectorElement has an IReadout; False if the IReadout is null.

Specified by:

hasReadout in interface IDetectorElement

Returns:

True if this DetectorElement has a Readout; False if there is no Readout.

getParameters

public IParameters getParameters()

Description copied from interface: IDetectorElement

The named parameters associated to this instance.

Specified by:

getParameters in interface IDetectorElement

Returns:

An IParameters object containing the DetectorElement's named parameter set.

See Also:

IParameters

getAncestry

public IDetectorElementContainer getAncestry()

Description copied from interface: IDetectorElement

A list of parents from the top to this one. The first member of the list will be the top IDetectorElement in the hierarchy. The last memory of the list will be this IDetectorElement.

Specified by:

getAncestry in interface IDetectorElement

Returns:

A list of ancestors from the top to this node.

See Also:

IDetectorElementContainer

clearReadouts

public void clearReadouts()

Description copied from interface: IDetectorElement

Clear the IReadout of this DetectorElement and recursively visit and clear the children..

Specified by:

clearReadouts in interface IDetectorElement

See Also:

IReadout, Readout

isDescendant

public boolean isDescendant(IDetectorElement de)

Description copied from interface: IDetectorElement

True if the DetectorElement is a descendant of this one.

Specified by:

isDescendant in interface IDetectorElement

Parameters:

de - A DetectorElement to search for in descendants.

Returns:

True if DetectorElement is a descendant of this one.

See Also:

IDetectorElement, IDetectorElementContainer

setIdentifierHelper

public void setIdentifierHelper(IIdentifierHelper helper)

Set the IIdentifierHelper for encoding and decoding identifiers of this DetectorElement.

Parameters:

helper - The IdentifierHelper to be assigned.

getIdentifierHelper

public IIdentifierHelper getIdentifierHelper()

Description copied from interface: Identifiable

Get the IIdentifierHelper associated with this object.

Specified by:

getIdentifierHelper in interface Identifiable

Specified by:

getIdentifierHelper in interface IDetectorElement

Returns:

The IdentifierHelper.

traverseDescendantsPreOrder

public void traverseDescendantsPreOrder(IDetectorElementVisitor visitor)

Description copied from interface: IDetectorElement

Recursive pre-order tree traversal of this IDetectorElement.

Specified by:

traverseDescendantsPreOrder in interface IDetectorElement

Parameters:

visitor - A visitor interface to perform some action on the node.

traverseDescendantsPostOrder

public void traverseDescendantsPostOrder(IDetectorElementVisitor visitor)

Description copied from interface: IDetectorElement

Recrusive post-order tree traversal of this IDetectorElement.

Specified by:

traverseDescendantsPostOrder in interface IDetectorElement

Parameters:

visitor - A visitor interface to perform some action on the node.

traversePreOrder

private static final void traversePreOrder(IDetectorElement detectorElement,
                    IDetectorElementVisitor visitor)

traversePostOrder

private static final void traversePostOrder(IDetectorElement detectorElement,
                     IDetectorElementVisitor visitor)

traverseAncestors

public void traverseAncestors(IDetectorElementVisitor visitor)

Description copied from interface: IDetectorElement

Visit this and ancestors.

Specified by:

traverseAncestors in interface IDetectorElement

findAncestors

public <T extends IDetectorElement> List<T> findAncestors(Class<T> klass)

Description copied from interface: IDetectorElement

Find ancestors matching a class.

Specified by:

findAncestors in interface IDetectorElement

Parameters:

klass - Class to match.

findDescendants

public <T extends IDetectorElement> List<T> findDescendants(Class<T> klass)

Description copied from interface: IDetectorElement

Find descendants matching a class.

Specified by:

findDescendants in interface IDetectorElement

Parameters:

klass - The class of the descendant DetectorElement.

Returns:

Get a list of descendants with matching class.

isAncestor

public boolean isAncestor(IDetectorElement de)

Description copied from interface: IDetectorElement

True if the DetectorElement is an ancestor of this one.

Specified by:

isAncestor in interface IDetectorElement

setParameters

public void setParameters(IParameters parameters)

findDetectorElement

public IDetectorElementContainer findDetectorElement(IIdentifier id)

Default implementation of IDetectorElement.findDetectorElement(IIdentifier). Specific types of IDetectorElements can override the default scheme.

Specified by:

findDetectorElement in interface IDetectorElement

Parameters:

id - The IIdentifier of the DetectorElement.

Returns:

The matching IDetectorElement to the ID.

findDetectorElement

public IDetectorElement findDetectorElement(String pathString)

Description copied from interface: IDetectorElement

Locate a child detector element given a slash-separated list of DetectorElement names.

Specified by:

findDetectorElement in interface IDetectorElement

Returns:

findDetectorElement

public IDetectorElement findDetectorElement(String[] path)

Description copied from interface: IDetectorElement

Locate a child detector element given an ordered list of DetectorElement names.

Specified by:

findDetectorElement in interface IDetectorElement

Returns:

getTop

public IDetectorElement getTop()

isSensitive

public boolean isSensitive()

Description copied from interface: IDetectorElement

True if the DetectorElement's PhysicalVolume is flagged as sensitive. False if the PhysicalVolume is not sensitive or the DetectorElement has no associated geometry.

Specified by:

isSensitive in interface IDetectorElement

Returns:

True if sensitive; false if not sensitive.

initialize

public void initialize()

Description copied from interface: IDetectorElement

This method should be called externally to perform initialization after all child elements have been added.

Specified by:

initialize in interface IDetectorElement