...
Conventions
...
| No Format |
|---|
// Here is the PFA class:
public class TrivialPFA extends Driver
{
public TrivialPFA()
{
// [drivers go here, producing a hitmap called "digi hitmap"]
// Here's the driver to convert the hitmap into something WIRED can display:
HitMapConverter digiConverterDriver = new HitMapConverter();
digiConverterDriver.setInputHitMap("digi hitmap");
digiConverterDriver.setOutputList("digi hits (displayable)");
add(digiConverterDriver);
// [rest of the code goes here]
}
}
// Here is the converter class:
public class HitMapConverter extends Driver
{
// Constructor, setup methods:
public HitMapConverter() {}
public void setInputHitMap(String name) {m_inputHitMapName = name;}
public void setOutputList(String name) {m_outputListName = name;}
// Do the conversion:
public void process(EventHeader event)
{
Map<Long, CalorimeterHit> inputHitMap = (Map<Long, CalorimeterHit>) (event.get(m_inputHitMapName));
List<Cluster> outputClusterList = new Vector<Cluster>();
for (CalorimeterHit hit : inputHitMap.values()) {
BasicCluster clus = new BasicCluster();
clus.addHit(hit);
outputClusterList.add(clus);
}
event.put(m_outputListName, outputClusterList);
}
String m_inputHitMapName;
String m_outputListName;
}
|
Things that need doing
Updates needed in the code:
Outline of a complete PFA
Based on the discussions at Boulder, here is an outline (very abstracted!) of what a real PFA might look like. We don't yet have a full PFA implementation in this framework, though several groups are working to convert their existing code.
| No Format |
|---|
public class CompletePFA extends Driver
{
public CompletePFA()
{
// First, use DigiSim to make more realistic hits
add(new org.lcsim.recon.cluster.util.CalHitMapDriver());
org.lcsim.digisim.DigiSimDriver digi = new org.lcsim.digisim.DigiSimDriver();
add(digi);
add( new org.lcsim.digisim.SimCalorimeterHitsDriver() );
// Produce hitmaps:
HitMapDriver digiHitMap = new HitMapDriver();
digiHitMap.addInputList("EcalBarrDigiHits");
digiHitMap.addInputList("EcalEndcapDigiHits");
digiHitMap.addInputList("HcalBarrDigiHits");
digiHitMap.addInputList("HcalEndcapDigiHits");
digiHitMap.setOutput("digi hitmap");
add(digiHitMap);
// Find tracks with the fast MC (output is a List<Track> saved as EventHeader.TRACKS)
add (new org.lcsim.mc.fast.tracking.MCFastTracking());
// Run a MIP-finder, possibly taking the tracks as input.
// "MipFinder" is a made-up class.
MipFinder exampleMipFinder = new MipFinder();
exampleMipFinder.setInputTrackList(EventHeader.TRACKS);
exampleMipFinder.setInputHitMap("digi hitmap");
exampleMipFinder.setOutputClusterList("mips");
exampleMipFinder.setOutputHitMap("digi hitmap after removing mips");
add(exampleMipFinder);
// Find E/M clusters
// "EMFinder" is a made-up class.
EMFinder exampleEMFinder = new EMFinder();
exampleEMFinder.setInputHitMap("digi hitmap after removing mips");
exampleEMFinder.setOutputClusterList("em showers");
exampleEMFinder.setOutputHitMap("digi hitmap after removing mips and em showers");
add(exampleEMFinder);
// Identify the E/M clusters -- photons? electrons? pi0?
// Output is a List<ReconstructedParticle>.
// In reality we'd probably iterate a little here on the hit assignments,
// and might need to pick up MIP segments for a few electrons, but neglect that for now.
// "EMIdentifier" is a made-up class.
EMIdentifier exampleEMIdentifier = new EMIdentifier();
exampleEMIdentifier.setInputClusterList("em showers");
exampleEMIdentifier.setInputTrackList(EventHeader.TRACKS);
exampleEMIdentifier.setOutputParticleList("identified em particles");
// Now find remaining clusters, which should mostly be from hadrons (and muons)
// after a shower/interaction/scatter. This step is very abstracted and would
// include all kinds of things such as fragment-handling.
// "HADClusterer" is a made-up class.
HADClusterer exampleHADClusterer = new HADClusterer();
exampleHADClusterer.setInputHitMap("digi hitmap after removing mips and em showers");
exampleHADClusterer.setInputMipList("mips");
exampleHADClusterer.setInputTrackList(EventHeader.TRACKS);
exampleHADClusterer.setOutputHitMap("digi hitmap after removing mips, em showers, and had clusters");
exampleHADClusterer.setOutputClusterList("had");
// Identify the hadronic/muon particles found:
// "HADIdentifier" is a made-up class.
HADIdentifier exampleEMIdentifier = new EMIdentifier();
exampleHADIdentifier.setInputClusterList("had");
exampleHADIdentifier.setInputTrackList(EventHeader.TRACKS);
exampleHADIdentifier.setOutputParticleList("identified had particles");
// Then we do something useful with all these ReconstructedParticles.
// [analysis]
}
}
|
Caveat: That is not real, compilable code! The real thing will not look exactly like it, since several problems were quietly swept under the carpet. But it illustrates the general structure.
Things that need doing
Updates needed in the code:
- Standard Drivers for hitmap manipulation: adding, merging, subtracting, filtering, etc
- A real, live PFA in
- Standard Drivers for hitmap manipulation: adding, merging, subtracting, filtering, etc
- A real, live PFA in this format
- Standard routines for telling you how well your PFA did (Ron's?)
- Example(s) in the main org.lcsim tree, probably under org.lcsim.plugin.web.examples
Updates needed on this page:
- Outline of Detail on the various PFA components (MIP finder, photon finder, hadron clusterer, cluster identifier, ...) – probably that belongs in sub-pages.
- Link to relevant things
- More code examples