hep.lcio.util

Class MergeUtil

java.lang.Object

hep.lcio.util.MergeUtil

public abstract class MergeUtil
extends Object

Utility methods for merging together LCIO files, events, and collections, with optional application of a delta time.

Constructor Summary

Constructors

Constructor and Description
MergeUtil()

Method Summary

Modifier and Type	Method and Description
static void	addMCParticleContributions(ISimCalorimeterHit targetHit, SimCalorimeterHit hit, float dt) Add MCParticle contributions from an overlay hit to a target hit.
static ISimCalorimeterHit	findMatching(LCCollection coll, SimCalorimeterHit hit) Find a SimCalorimeterHit in coll with matching cellId0, cellId1.
static int	getCollectionIdx(String[] collnames, String name) Find the given name in collnames.
static void	mergeCollection(LCCollection targetColl, LCCollection overlayColl, float dt) overlayCollection overlays the overlayColl onto the targetColl applying the delta time, dt.
static void	mergeDefaultCollection(LCCollection targetColl, LCCollection overlayColl) Merge overlayColl into targetColl without applying a delta time.
static int	mergeEvents(LCEvent targetEvent, LCReader overlayEvents, int ntoread, boolean setEventHeader, float startt, float dt) Merge ntoread events from a reader into a single target event, applying time delta dt with starting time of startt.
static int	mergeFiles(File outfile, List mergeFiles) Merge nEventsToRead events from each File in mergeFiles into a single event in outfile, until records in mergeFiles are exhausted.
static int	mergeFiles(File outfile, List mergeFiles, int maxEvents) Merge events from mergeFiles into a single event in outfile, until all the files in mergeFiles are exhausted, or maxevents are created.
static void	mergeMCParticleCollection(LCCollection targetColl, LCCollection overlayColl, float dt) Merge MCParticle collection overlayColl into targetColl.
static void	mergeSimCalorimeterHitCollection(LCCollection targetColl, LCCollection overlayColl, float dt) Merge SimCalorimeterHit collection overlayColl into targetColl.
static void	mergeSimTrackerHitCollection(LCCollection targetColl, LCCollection overlayColl, float dt) Merge SimTrackerHit collection overlayColl into targetColl.
static void	mergeSingleEvent(ILCEvent targetEvent, LCEvent overlayEvent, float dt) Overlay the overlay event onto target event, applying time delta.

Methods inherited from class java.lang.Object

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

Constructor Detail

MergeUtil

public MergeUtil()

Method Detail

mergeFiles

public static int mergeFiles(File outfile,
                             List mergeFiles,
                             int maxEvents)
                      throws IOException

Merge events from mergeFiles into a single event in outfile, until all the files in mergeFiles are exhausted, or maxevents are created.

Parameters:

outfile - Target file that will contain the merged events.

A - list of @see MergeFileOptions objects.

maxEvents - Set the maximum number of merged events.

Returns:

The number of merged events that were created.

Throws:

IOException

mergeFiles

public static int mergeFiles(File outfile,
                             List mergeFiles)
                      throws IOException

Merge nEventsToRead events from each File in mergeFiles into a single event in outfile, until records in mergeFiles are exhausted.

Parameters:

outfile - Output Target file containing the merged events.

A - list of @see MergeFileOptions objects.

Returns:

The number of merged events that were created.

Throws:

IOException

mergeEvents

public static int mergeEvents(LCEvent targetEvent,
                              LCReader overlayEvents,
                              int ntoread,
                              boolean setEventHeader,
                              float startt,
                              float dt)
                       throws IOException

Merge ntoread events from a reader into a single target event, applying time delta dt with starting time of startt.

Parameters:

targetEvent - target LCEvent to merge events into

overlayEvents - LCReader with overlay events to read

ntoread - number of events to overlay from overlayEvents

dt - delta time to be applied to the sim types

Returns:

Number of events overlayed from overlayEvents reader.

Throws:

IOException

mergeSingleEvent

public static void mergeSingleEvent(ILCEvent targetEvent,
                                    LCEvent overlayEvent,
                                    float dt)

Overlay the overlay event onto target event, applying time delta.

Parameters:

targetEvent - The event that will be overlayed onto from overlayEvent.

overlayEvent - An event to be overlayed onto targetEvent.

dt - A delta time to apply to sim types.

mergeCollection

public static void mergeCollection(LCCollection targetColl,
                                   LCCollection overlayColl,
                                   float dt)

overlayCollection overlays the overlayColl onto the targetColl applying the delta time, dt.

Parameters:

targetColl - The target collection to be modified.

overlayColl - The overlay collection containing objects to merge into targetColl.

dt - A delta time parameter applied to sim types of overlayColl before merge-in.

mergeDefaultCollection

public static void mergeDefaultCollection(LCCollection targetColl,
                                          LCCollection overlayColl)

Merge overlayColl into targetColl without applying a delta time. This is used to merge non-simulator collections.

Parameters:

targetColl - The target collection to be modified.

overlayColl - The overlay collection containing objects to merge into targetColl.

mergeMCParticleCollection

public static void mergeMCParticleCollection(LCCollection targetColl,
                                             LCCollection overlayColl,
                                             float dt)

Merge MCParticle collection overlayColl into targetColl.

Parameters:

targetColl - The target collection to be modified.

overlayColl - The overlay collection containing objects to merge into targetColl.

dt - A delta time parameter added to the particle's production time.

mergeSimCalorimeterHitCollection

public static void mergeSimCalorimeterHitCollection(LCCollection targetColl,
                                                    LCCollection overlayColl,
                                                    float dt)

Merge SimCalorimeterHit collection overlayColl into targetColl. Hits with matching cell ID's are combined.

Parameters:

targetColl - The target collection to be modified.

overlayColl - The overlay collection containing objects to merge into targetColl.

dt - A delta time parameter added to MCParticle contributions from overlayColl's hits.

mergeSimTrackerHitCollection

public static void mergeSimTrackerHitCollection(LCCollection targetColl,
                                                LCCollection overlayColl,
                                                float dt)

Merge SimTrackerHit collection overlayColl into targetColl.

Parameters:

targetColl - The target collection to be modified.

overlayColl - The overlay collection containing objects to merge into targetColl.

dt - A delta time parameter added to the time of hits from overlayColl.

findMatching

public static ISimCalorimeterHit findMatching(LCCollection coll,
                                              SimCalorimeterHit hit)

Find a SimCalorimeterHit in coll with matching cellId0, cellId1.

Parameters:

Collection - of type SIMCALORIMETERHIT.

hit - Matching hit to be searched for in coll.

Returns:

The first match of hit in coll.

getCollectionIdx

public static int getCollectionIdx(String[] collnames,
                                   String name)

Find the given name in collnames.

Parameters:

collnames - A list of collection names.

name - A collection name to find in collnames.

Returns:

The index of name in collnames or -1 if not found.

addMCParticleContributions

public static void addMCParticleContributions(ISimCalorimeterHit targetHit,
                                              SimCalorimeterHit hit,
                                              float dt)

Add MCParticle contributions from an overlay hit to a target hit.

Parameters:

target - Hit that receives MCParticle contributions.

hit - Hit containing MCParticle contributions to be copied.

dt - Delta time to apply to contributions.