org.lcsim.recon.tracking.vsegment.geom

Class SegmentationManager

java.lang.Object

org.lcsim.util.Driver

org.lcsim.recon.tracking.vsegment.geom.SegmentationManager

All Implemented Interfaces:

EventListener, ConditionsListener

public class SegmentationManager
extends Driver
implements ConditionsListener

This class handles creation, caching and run-time access to Sensor objects and segmentation information.

Typically, a Driver that controls event reconstruction creates an instance of this class, supplying Segmenter object that defines virtual segmentation of the detector, and adds it to the event processing chain before any drivers that need access to Sensors. See org.lcsim.contrib.onoprien.tracking.ExampleDriver1 or org.lcsim.contrib.onoprien.tracking.ExampleDriver2.

Other drivers that need access to SegmentationManager can fetch it from the event record by calling event.get("SegmentationManager").

By default, Sensor objects are created as needed (that is, when there are hits in those sensors), and are kept in cache unless JVM starts running out of memory. If the user needs Sensor objects corresponding to all virtual segments of the detector to be created before data processing, SegmentationManager can be asked to do so by a call to set("MAKE_SENSORS_ON_DETECTOR_CHANGE", true). It usually makes sense to do this if the user plans to use getSensors() method in the future.

Version:

$Id: SegmentationManager.java,v 1.1 2008/12/06 21:53:43 onoprien Exp $

Author:

D.Onoprienko

Nested Class Summary

Nested classes/interfaces inherited from class org.lcsim.util.Driver

Driver.AbortRunException, Driver.NextEventException

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	_cacheStereoRequests
private boolean	_createSensorsOnDetectorChange
private static SegmentationManager	_defaultSegMan
private Navigator	_navigator
private boolean	_notInitialized
private Segmenter	_segmenter
private HashMap<Integer,Sensor>	_sensorMap
private HashMap<Integer,SoftReference<Sensor>>	_sensorWeakMap
private HashMap<Sensor,List<Sensor>>	_stereoMap

Fields inherited from class org.lcsim.util.Driver

HLEVEL_DEFAULT, HLEVEL_FULL, HLEVEL_HIGH, HLEVEL_NORMAL, HLEVEL_OFF

Constructor Summary

Constructors

Constructor and Description
SegmentationManager(Segmenter segmenter) Constructs a new instance of SegmentationManager.

Method Summary

Methods

Modifier and Type	Method and Description
void	conditionsChanged(ConditionsEvent event) Called by framework whenever ConditionsEvent is dispatched by ConditionsManager.
static SegmentationManager	defaultInstance() Returns segmentation manager that has been previously set with a call to setDefaultInstance(SegmentationManager) method.
private void	detectorChanged() Detector-dependent initialization.
int	getChannelID(int sensorID, Hep3Vector position) Returns channel ID given sensor ID and global position.
int	getChannelID(Sensor sensor, Hep3Vector position) Returns channel ID given sensor and global position.
int	getChannelID(Sensor sensor, SimTrackerHit hit) Returns channel ID given sensor and global position extracted from the supplied SimTrackerHit object.
Navigator	getNavigator() Returns Navigator that provides various convenience methods for use with Sensors created by this SegmentationManager.
Sensor	getSensor(int sensorID) Returns Sensor object corresponding to the given sensor ID.
Sensor	getSensor(SimTrackerHit hit) Converts cell ID and position obtained from SimTrackerHit object to sensor ID, and returns Sensor object corresponding to this ID.
int	getSensorID(SimTrackerHit hit) Converts cell ID and position obtained from SimTrackerHit object to sensor ID.
Collection<Sensor>	getSensors() Returns a collection of Sensors corresponding to all virtual segments of the detector.
List<Sensor>	getStereoPartners(Sensor sensor) Returns a list of Sensors that might contain hits that should be combined with hits in the Sensor supplied as an argument to form stereo pairs.
void	process(EventHeader event) Called by framework to process event.
void	set(String name, boolean value) Set any boolean parameter.
static void	setDefaultInstance(SegmentationManager segMan) Set default segmentation manager.

Methods inherited from class org.lcsim.util.Driver

add, clearStatistics, contains, detectorChanged, drivers, endOfData, getConditionsManager, getHistogramLevel, getLogger, getName, getRandom, printStatistics, processChildren, remove, resume, setHistogramLevel, setLogLevel, setRandom, startOfData, suspend

Methods inherited from class java.lang.Object

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

Field Detail

_defaultSegMan

private static SegmentationManager _defaultSegMan

_notInitialized

private boolean _notInitialized

_sensorWeakMap

private HashMap<Integer,SoftReference<Sensor>> _sensorWeakMap

_sensorMap

private HashMap<Integer,Sensor> _sensorMap

_segmenter

private Segmenter _segmenter

_navigator

private Navigator _navigator

_createSensorsOnDetectorChange

private boolean _createSensorsOnDetectorChange

_cacheStereoRequests

private boolean _cacheStereoRequests

_stereoMap

private HashMap<Sensor,List<Sensor>> _stereoMap

Constructor Detail

SegmentationManager

public SegmentationManager(Segmenter segmenter)

Constructs a new instance of SegmentationManager.

Parameters:

segmenter - Segmenter that defines virtual segmentation of the detector.

Method Detail

conditionsChanged

public void conditionsChanged(ConditionsEvent event)

Called by framework whenever ConditionsEvent is dispatched by ConditionsManager.

Specified by:

conditionsChanged in interface ConditionsListener

Parameters:

event - The event associated with the change.

detectorChanged

private void detectorChanged()

Detector-dependent initialization. Clears sensor map, calls detectorChanged(Detector) methods of all segmenters, then assign prefixes to segmenters.

set

public void set(String name,
       boolean value)

Set any boolean parameter. The following parameters can be set with this method:

"MAKE_SENSORS_ON_DETECTOR_CHANGE"

If set to true, Sensor objects corresponding to all virtual segments are created whenever the detector information becomes available (or changes), and are kept in memory until the end of the job. Default: true.

"CACHE_STEREO_REQUESTS"

If set to true, the output of calls to getStereoPartners(org.lcsim.recon.tracking.vsegment.geom.Sensor) will be cached. Default: true.

Parameters:

name - Name of parameter to be set. Case is ignored.

value - Value to be assigned to the parameter.

Throws:

NoSuchParameterException - Thrown if the supplied parameter name is unknown. Subclasses may catch this exception after a call to super.set() and set their own parameters.

getNavigator

public Navigator getNavigator()

Returns Navigator that provides various convenience methods for use with Sensors created by this SegmentationManager.

process

public void process(EventHeader event)

Called by framework to process event.

Overrides:

process in class Driver

Parameters:

event - The event to be processed

See Also:

Driver.NextEventException, Driver.AbortRunException

getSensors

public Collection<Sensor> getSensors()

Returns a collection of Sensors corresponding to all virtual segments of the detector.

getSensor

public Sensor getSensor(int sensorID)

Returns Sensor object corresponding to the given sensor ID.

getChannelID

public int getChannelID(Sensor sensor,
               Hep3Vector position)

Returns channel ID given sensor and global position. Returns -1 if position does not belong to this sensor.

getChannelID

public int getChannelID(Sensor sensor,
               SimTrackerHit hit)

Returns channel ID given sensor and global position extracted from the supplied SimTrackerHit object. Returns -1 if the position does not belong to this sensor.

getChannelID

public int getChannelID(int sensorID,
               Hep3Vector position)

Returns channel ID given sensor ID and global position. Returns -1 if sensorID is invalid, or position does not belong to this sensor.

getSensor

public Sensor getSensor(SimTrackerHit hit)

Converts cell ID and position obtained from SimTrackerHit object to sensor ID, and returns Sensor object corresponding to this ID.

getSensorID

public int getSensorID(SimTrackerHit hit)

Converts cell ID and position obtained from SimTrackerHit object to sensor ID. FIXME: should be just return _segmenter.getSensorID(hit); The rest is a workaround for Detector being created twice bug.

getStereoPartners

public List<Sensor> getStereoPartners(Sensor sensor)

Returns a list of Sensors that might contain hits that should be combined with hits in the Sensor supplied as an argument to form stereo pairs. If the Segmenter used by this SegmentationManager does not support stereo partner lookup, an empty list is returned.

setDefaultInstance

public static void setDefaultInstance(SegmentationManager segMan)

Set default segmentation manager.

defaultInstance

public static SegmentationManager defaultInstance()

Returns segmentation manager that has been previously set with a call to setDefaultInstance(SegmentationManager) method.