org.lcsim.util

Class MergeEventTools

java.lang.Object

org.lcsim.util.MergeEventTools

public class MergeEventTools
extends Object

Class with helper methods for event merging.

Author:

Christian Grefe

Constructor Summary

Constructors

Constructor and Description
MergeEventTools()

Method Summary

Methods

Modifier and Type	Method and Description
static MCParticle	copyMcParticle(MCParticle mcParticle) Creates a deep copy of an MCParticle.
static SimCalorimeterHit	copySimCalorimeterHit(SimCalorimeterHit hit, EventHeader.LCMetaData metaData, Map<MCParticle,MCParticle> mcParticleMap) Creates a deep copy of a SimCalorimeterHit and assigns the given meta data.
static SimTrackerHit	copySimTrackerHit(SimTrackerHit hit, EventHeader.LCMetaData metaData, Map<MCParticle,MCParticle> mcParticleMap) Creates a deep copy of a SimTrackerHit and assigns the given meta data.
static MCParticle	getMcParticleCopy(MCParticle mcParticle, Map<MCParticle,MCParticle> mcParticleMap) Helper method to make a proper deep copy of an MCParticle and all its ancestors.
static void	mergeEvents(EventHeader event, EventHeader mergeEvent) Merge two events.
static void	mergeEvents(EventHeader event, EventHeader mergeEvent, Collection<String> ignoreCollections) Merge two events.
static void	mergeEvents(EventHeader event, EventHeader mergeEvent, Collection<String> ignoreCollections, Map<String,Map<Long,SimCalorimeterHit>> caloHitMaps) Merge two events.
static void	mergeMCParticleCollections(EventHeader.LCMetaData metaData, EventHeader.LCMetaData mergeMetaData, Map<MCParticle,MCParticle> mcParticleMap) Merge two MCParticle collections.
static void	mergeSimCalorimeterHitCollections(EventHeader.LCMetaData metaData, EventHeader.LCMetaData mergeMetaData, Map<MCParticle,MCParticle> mcParticleMap, Map<Long,SimCalorimeterHit> caloHitMap) Merge two SimCalorimeterHit collections.
static SimCalorimeterHit	mergeSimCalorimeterHits(SimCalorimeterHit hit, SimCalorimeterHit mergeHit) Merges two SimCalorimeterHits that occupy the same cell
static void	mergeSimTrackerHitCollections(EventHeader.LCMetaData metaData, EventHeader.LCMetaData mergeMetaData, Map<MCParticle,MCParticle> mcParticleMap) Merge two SimTrackerHit collections.

Methods inherited from class java.lang.Object

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

Constructor Detail

MergeEventTools

public MergeEventTools()

Method Detail

mergeEvents

public static void mergeEvents(EventHeader event,
               EventHeader mergeEvent)

Merge two events. The first event will contain both events afterwards.

Parameters:

event - the event which have the other event added

mergeEvent - the event to be merged with the first event

mergeEvents

public static void mergeEvents(EventHeader event,
               EventHeader mergeEvent,
               Collection<String> ignoreCollections)

Merge two events. The first event will contain both events afterwards. Collections can be ignored.

Parameters:

event - the event which have the other event added

mergeEvent - the event to be merged with the first event

ignoreCollections - list of collection names that will not be merged

mergeEvents

public static void mergeEvents(EventHeader event,
               EventHeader mergeEvent,
               Collection<String> ignoreCollections,
               Map<String,Map<Long,SimCalorimeterHit>> caloHitMaps)

Merge two events. The first event will contain both events afterwards. Collections can be ignored. A map holding maps of cell IDs to sim calorimeter hits is used to avoid that this information has to be obtained again if this method is called multiple times on the same event.

Parameters:

event - the event which have the other event added

mergeEvent - the event to be merged with the first event

ignoreCollections - list of collection names that will not be merged

caloHitMaps - map of collection names to maps of cell IDs to SimCalorimeterHits used to identify which cells require merging

mergeMCParticleCollections

public static void mergeMCParticleCollections(EventHeader.LCMetaData metaData,
                              EventHeader.LCMetaData mergeMetaData,
                              Map<MCParticle,MCParticle> mcParticleMap)

Merge two MCParticle collections. The first one will contain both collections afterwards. All MCParticles are deep copied to allow for garbage collection.

Parameters:

metaData - meta data of the first collection

mergeMetaData - meta data of the second collection

mcParticleMap - map to store relation between the original MCParticles and their copies required to ensure consistency in relations to that MCParticle

mergeSimTrackerHitCollections

public static void mergeSimTrackerHitCollections(EventHeader.LCMetaData metaData,
                                 EventHeader.LCMetaData mergeMetaData,
                                 Map<MCParticle,MCParticle> mcParticleMap)

Merge two SimTrackerHit collections. The first one will contain both collections afterwards. All SimTrackerHits are deep copied to allow for garbage collection. Similarly, the MCParticles referenced by the SimTrackerHits are copied.

Parameters:

metaData - meta data of the first collection

mergeMetaData - meta data of the second collection

mcParticleMap - map to store relation between the original MCParticles and their copies required to ensure consistency in relations to that MCParticle

mergeSimCalorimeterHitCollections

public static void mergeSimCalorimeterHitCollections(EventHeader.LCMetaData metaData,
                                     EventHeader.LCMetaData mergeMetaData,
                                     Map<MCParticle,MCParticle> mcParticleMap,
                                     Map<Long,SimCalorimeterHit> caloHitMap)

Merge two SimCalorimeterHit collections. The first one will contain both collections afterwards. All SimCalorimeterHits are deep copied to allow for garbage collection. Similarly, the MCParticles referenced by the SimCalorimeterHits are copied.

Parameters:

metaData - meta data of the first collection

mergeMetaData - meta data of the second collection

mcParticleMap - map to store relation between the original MCParticles and their copies required to ensure consistency in relations to that MCParticle

copyMcParticle

public static MCParticle copyMcParticle(MCParticle mcParticle)

Creates a deep copy of an MCParticle.

Parameters:

mcParticle - the particle to be copied

Returns:

the copied MCParticle

getMcParticleCopy

public static MCParticle getMcParticleCopy(MCParticle mcParticle,
                           Map<MCParticle,MCParticle> mcParticleMap)

Helper method to make a proper deep copy of an MCParticle and all its ancestors. A map between the original particle and can be used to ensure that all references to the original particle use the same copy.

Parameters:

mcParticle - the particle to be cpoied

mcParticleMap - map to store relation between the original MCParticles and their copies required to ensure consistency in relations to that MCParticle

Returns:

the copied MCParticle

copySimTrackerHit

public static SimTrackerHit copySimTrackerHit(SimTrackerHit hit,
                              EventHeader.LCMetaData metaData,
                              Map<MCParticle,MCParticle> mcParticleMap)

Creates a deep copy of a SimTrackerHit and assigns the given meta data. The corresponding MCParticles are also copied if they are not present in the map, otherwise the reference is updated to use the copy provided by the map.

Parameters:

hit - the original hit

metaData - the new meta data

mcParticleMap - map to store relation between the original MCParticles and their copies required to ensure consistency in relations to that MCParticle

Returns:

the copied hit

copySimCalorimeterHit

public static SimCalorimeterHit copySimCalorimeterHit(SimCalorimeterHit hit,
                                      EventHeader.LCMetaData metaData,
                                      Map<MCParticle,MCParticle> mcParticleMap)

Creates a deep copy of a SimCalorimeterHit and assigns the given meta data. The corresponding MCParticles are also copied if they are not present in the map, otherwise the reference is updated to use the copy provided by the map.

Parameters:

hit - the original hit

metaData - the new meta data

mcParticleMap - map to store relation between the original MCParticles and their copies required to ensure consistency in relations to that MCParticle

Returns:

the copied hit

mergeSimCalorimeterHits

public static SimCalorimeterHit mergeSimCalorimeterHits(SimCalorimeterHit hit,
                                        SimCalorimeterHit mergeHit)

Merges two SimCalorimeterHits that occupy the same cell

Parameters:

hit - the first hit to be merged

mergeHit - the second hit to be merged

Returns:

the combined calorimeter hit