org.lcsim.recon.tracking.vsegment.digitization

Class MergeDriver

java.lang.Object

org.lcsim.util.Driver

org.lcsim.recon.tracking.vsegment.digitization.MergeDriver

public class MergeDriver
extends Driver

Driver that merges several collections of DigiTrackerHit objects into one, combining hits in the same channels.

Input collections (either HashMap<Sensor, ArrayList<DigiTrackerHit>> or Collection<DigiTrackerHit>) are fetched from the event usung name supplied through calls to set("ADD_INPUT_COLLECTION", name), and output collection (type HashMap<Sensor, ArrayList<DigiTrackerHit>>) is attached to the event with the name set by a call to set("OUTPUT_MAP_NAME", name).

Whenever input collections contain hits in the same channels, new DigiTrackerHit objects of type DigiTrackerHitComposite are created and stored in the output map. These new objects reference all the original hits as their constituents.

merge(java.util.Collection<java.util.HashMap<org.lcsim.recon.tracking.vsegment.geom.Sensor, java.util.ArrayList<org.lcsim.recon.tracking.vsegment.hit.DigiTrackerHit>>>) methods can also be called directly by other classes.

Version:

$Id: MergeDriver.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
(package private) ArrayList<String>	_inMapNames
(package private) String	_outMapName

Fields inherited from class org.lcsim.util.Driver

HLEVEL_DEFAULT, HLEVEL_FULL, HLEVEL_HIGH, HLEVEL_NORMAL, HLEVEL_OFF

Constructor Summary

Constructors

Constructor and Description
MergeDriver() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ArrayList<DigiTrackerHit>	merge(ArrayList<DigiTrackerHit> hitList) Returns a list of hits produced by merging hits in the list supplied as an argument.
HashMap<Sensor,ArrayList<DigiTrackerHit>>	merge(Collection<HashMap<Sensor,ArrayList<DigiTrackerHit>>> hitMaps) Returns the result of merging DigiTrackerHits from several maps.
void	process(EventHeader event) Called by framework to process event.
void	set(String name, Object value) Set parameters.

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

_inMapNames

ArrayList<String> _inMapNames

_outMapName

String _outMapName

Constructor Detail

MergeDriver

public MergeDriver()

Default constructor.

Method Detail

set

public void set(String name,
       Object value)

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

"ADD_INPUT_COLLECTION"

Name of input collection of digitized hits (type HashMap>).
No default.

"OUTPUT_MAP_NAME"

Name of output collection of clusters (type HashMap>).
No default.

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.

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

merge

public HashMap<Sensor,ArrayList<DigiTrackerHit>> merge(Collection<HashMap<Sensor,ArrayList<DigiTrackerHit>>> hitMaps)

Returns the result of merging DigiTrackerHits from several maps.

merge

public ArrayList<DigiTrackerHit> merge(ArrayList<DigiTrackerHit> hitList)

Returns a list of hits produced by merging hits in the list supplied as an argument. The output list is sorted by channel ID.