org.lcsim.util

Class MergeEventsDriver

java.lang.Object

org.lcsim.util.Driver

org.lcsim.util.MergeEventsDriver

public class MergeEventsDriver
extends Driver

Driver to merge multiple consecutive events into a single event. No Driver should be run after this one, since it will be seeing partially merged events.

Author:

Christian Grefe

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
protected Map<String,Map<Long,SimCalorimeterHit>>	caloHitMaps
protected EventHeader	currentEvent
protected int	currentEventNumber
protected Collection<String>	ignoreCollections
protected int	nEvts
protected String	outputFile
protected boolean	writeOnlyFullEvents
protected LCIOWriter	writer

Fields inherited from class org.lcsim.util.Driver

HLEVEL_DEFAULT, HLEVEL_FULL, HLEVEL_HIGH, HLEVEL_NORMAL, HLEVEL_OFF

Constructor Summary

Constructors

Constructor and Description
MergeEventsDriver()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	endOfData() Called when all data processing is finished.
protected void	process(EventHeader event) Called by the framework to process an event.
void	setIgnoreCollection(String collectionName)
void	setIgnoreCollections(String[] collectionNames)
void	setNumberOfEvents(int nEvts) Number of events merged into one event.
void	setOutputFile(String outputFile) Defines the output file
void	setWriteOnlyFullEvents(boolean writeOnlyFullEvents) Decides if an event at the end of the sample which has less than the desired number of events is written to the output file
protected void	startOfData() Called before the first event is processed, or after a rewind.
protected void	writeCurrentEvent()

Methods inherited from class org.lcsim.util.Driver

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

Methods inherited from class java.lang.Object

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

Field Detail

nEvts

protected int nEvts

outputFile

protected String outputFile

currentEvent

protected EventHeader currentEvent

currentEventNumber

protected int currentEventNumber

writer

protected LCIOWriter writer

ignoreCollections

protected Collection<String> ignoreCollections

writeOnlyFullEvents

protected boolean writeOnlyFullEvents

caloHitMaps

protected Map<String,Map<Long,SimCalorimeterHit>> caloHitMaps

Constructor Detail

MergeEventsDriver

public MergeEventsDriver()

Method Detail

setNumberOfEvents

public void setNumberOfEvents(int nEvts)

Number of events merged into one event. A negative number will merge all events into a single event.

Parameters:

nEvts - number of events

setWriteOnlyFullEvents

public void setWriteOnlyFullEvents(boolean writeOnlyFullEvents)

Decides if an event at the end of the sample which has less than the desired number of events is written to the output file

Parameters:

writeOnlyFullEvents -

setOutputFile

public void setOutputFile(String outputFile)

Defines the output file

Parameters:

outputFile -

setIgnoreCollection

public void setIgnoreCollection(String collectionName)

setIgnoreCollections

public void setIgnoreCollections(String[] collectionNames)

startOfData

protected void startOfData()

Description copied from class: Driver

Called before the first event is processed, or after a rewind.

Overrides:

startOfData in class Driver

process

protected void process(EventHeader event)

Description copied from class: Driver

Called by the framework to process an event. Don't forget to call super.process(event) to cause the child processes to be executed. In addition the process event call can throw some special exceptions:

• NextEventException - aborts further processing of this event
• StopRunException - causes event processing to be stopped

Overrides:

process in class Driver

Parameters:

event - The event to be processed

See Also:

Driver.NextEventException, Driver.AbortRunException

endOfData

protected void endOfData()

Description copied from class: Driver

Called when all data processing is finished.

Overrides:

endOfData in class Driver

writeCurrentEvent

protected void writeCurrentEvent()