org.lcsim.recon.tracking.trflayer

Class Layer

java.lang.Object

org.lcsim.recon.tracking.trflayer.Layer

Direct Known Subclasses:

InteractingLayer, LayerCylinder, LayerTest, LayerZPlane, TLayer

public abstract class Layer
extends Object

Layers describe the geometry of the detector. Each layer is composed of surfaces. The composition may be direct or via other layers. The layer provides the methods propagate which propagate a track to the next of its constituent surfaces. The propagate methods are passed a propagator which carries out the action and determines the direction. Propagation returns a list of layer tracks. A layer track is a kinematic track plus a layer status. The layer status may also contain a miss and a cluster finder. It is expected that each of the returned tracks will be updated with the miss and clusters and then propagated through the layer again until the status indicates the track has reached a layer exit. There are two methods of propagation: both are passed the track and the propagator but in the second the track is wrapped in the layer track. The first is used when entering the layer and the second for all calls within the layer. Both of these propagate methods are implemented here. Subclasses do not override these but must provide the method _propagate which is used by these. Its interface is described below. If there are a lists of clusters associated layer, the method get_clusters may be used to access them. NOTICE for subclass developers: The major method that subclasses must implement is LTracklist _propagate(const LTrack& trl, const Propagator& prop) const . The input is a layer track and a propagator and the output is a list of layer tracks. The output layer tracks would typically be created by copying from the input layer track and then modifying it two components: the kinematic track and the layer status chain. The layer chain includes a list of layer status objects and two pointers to this list: one for the current layer postion and one for the status which contains the list of clusters and the miss. When a layer is nested (i.e. composed of other layers), the chain must be advanced to that layer before calling the propagate method of a sublayer. The current status should be set to that same position when layer when returning from propagation. The cluster pointer is not set automatically. The layer class contributing the status containing a cluster list or miss should call LTrack::set_cluster_status() to set this pointer. still needs work to implement multiple surface layers...

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static boolean	ADD_CLUSTER_HAS_NO_CLUSTERS
(package private) static boolean	ADD_CLUSTER_SURFACE_HAS_NO_CLUSTERS
(package private) static boolean	DROP_CLUSTERS_HAS_NO_CLUSTERS
(package private) static boolean	GET_CLUSTERS_HAS_NO_CLUSTERS
(package private) static boolean	GET_CLUSTERS_SURFACE_HAS_NO_CLUSTERS

Constructor Summary

Constructors

Constructor and Description
Layer() constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract List	_propagate(LTrack trl, Propagator prop)
int	addCluster(Cluster clu) Add a cluster to the layer.
int	addCluster(Cluster clu, Surface srf) Add a cluster to a particular surface in the layer.
List	clusters() Return all the clusters associated with the current layer or its descendants.
List	clusters(Surface srf) Return all the clusters associated with a particular surface in this layer.
List	clusterSurfaces() Return the list of active surfaces -- i.e.
void	dropClusters() Drop all clusters from this layer.
String	genericType() Return the generic type of this class.
boolean	hasClusters() Return whether this layer or its descendants contains clusters.
List	propagate(ETrack tre, Propagator prop) Propagate a track to the first surface in this layer.
List	propagate(LTrack trl, Propagator prop) Propagate a track to the next surface in this layer.
protected void	reportInvalidSurface(Surface srf)
static String	staticType() Return the type.
static String	typeName() Return the type name.

Methods inherited from class java.lang.Object

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

Field Detail

GET_CLUSTERS_HAS_NO_CLUSTERS

static boolean GET_CLUSTERS_HAS_NO_CLUSTERS

GET_CLUSTERS_SURFACE_HAS_NO_CLUSTERS

static boolean GET_CLUSTERS_SURFACE_HAS_NO_CLUSTERS

ADD_CLUSTER_HAS_NO_CLUSTERS

static boolean ADD_CLUSTER_HAS_NO_CLUSTERS

ADD_CLUSTER_SURFACE_HAS_NO_CLUSTERS

static boolean ADD_CLUSTER_SURFACE_HAS_NO_CLUSTERS

DROP_CLUSTERS_HAS_NO_CLUSTERS

static boolean DROP_CLUSTERS_HAS_NO_CLUSTERS

Constructor Detail

Layer

public Layer()

constructor

Method Detail

typeName

public static String typeName()

Return the type name.

Returns:

String representation of this class type Included for completeness with C++ version

staticType

public static String staticType()

Return the type.

Returns:

String representation of this class type Included for completeness with C++ version

reportInvalidSurface

protected void reportInvalidSurface(Surface srf)

genericType

public String genericType()

Return the generic type of this class. Subclasses must not override.

Returns:

String representation of this class type Included for completeness with C++ version

propagate

public List propagate(ETrack tre,
             Propagator prop)

Propagate a track to the first surface in this layer. This simply constructs a status and calls the virtual method.

Parameters:

tre - ETrack

prop - Propagator

Returns:

List of LayerStats

propagate

public List propagate(LTrack trl,
             Propagator prop)

Propagate a track to the next surface in this layer. The status is that from the previous surface in the layer.

Parameters:

trl - LTrack

prop - Propagator

Returns:

List of LayerStats

hasClusters

public boolean hasClusters()

Return whether this layer or its descendants contains clusters. Returns false if get_cluster_surfaces() returns an empty list.

Returns:

true if surface has clusters

_propagate

protected abstract List _propagate(LTrack trl,
              Propagator prop)

clusterSurfaces

public List clusterSurfaces()

Return the list of active surfaces -- i.e. surfaces associated with clusters. These should include surfaces in sublayers. Default method reports no surfaces.

Returns:

List of surfaces

clusters

public List clusters()

Return all the clusters associated with the current layer or its descendants. Default here is to return an empty list.

Returns:

list of clusters

clusters

public List clusters(Surface srf)

Return all the clusters associated with a particular surface in this layer. This method should call report_invalid_surface(SurfacePtr) if it does not recognize the argument. Default is to return an empty list.

Parameters:

srf - Surface

Returns:

List of clusters associated with Surface srf

addCluster

public int addCluster(Cluster clu)

Add a cluster to the layer. Default here is to return an error.

Parameters:

clu - Cluster to add

Returns:

0 if successful

addCluster

public int addCluster(Cluster clu,
             Surface srf)

Add a cluster to a particular surface in the layer. Default here is to return an error.

Parameters:

clu - Cluster to add

srf - Surface to which to add

Returns:

0 if successful

dropClusters

public void dropClusters()

Drop all clusters from this layer. // Default here is to return an error.