lcsim/src/org/lcsim/contrib/uiowa
diff -u -r1.1 -r1.2
--- ShowerPointFinderDriver.java 13 Oct 2008 07:17:08 -0000 1.1
+++ ShowerPointFinderDriver.java 22 Oct 2008 17:42:44 -0000 1.2
@@ -9,7 +9,13 @@
import org.lcsim.recon.cluster.util.*;
import org.lcsim.util.decision.*;
-// Wrapper for ShowerPointFinder
+/**
+ * Wrapper class for ShowerPointFinder, allowing it to be
+ * run as a Driver. Outputs are written to the event.
+ *
+ * @version $Id: ShowerPointFinderDriver.java,v 1.2 2008/10/22 17:42:44 mcharles Exp $
+ * @author [log in to unmask]
+ */
public class ShowerPointFinderDriver extends Driver {
@@ -22,6 +28,16 @@
protected TrackClusterMatcher m_trackClusterMatcher;
protected boolean m_debug = false;
+ /**
+ * Constructor. Quite a few inputs needed:
+ *
+ * @param findCluster Extrapolator object that should be used to propagate tracks.
+ * @param inputHitMap Name of the input hitmap. Tracks will be matched to MIPs in these hits.
+ * @param inputTrackList Name of the input track list.
+ * @param outputTrackMap Name to write an output Map<Track,BasicCluster> out as, connecting tracks to their MIP stubs.
+ * @param outputHitMap Name to write the remaining, unused hits out as.
+ * @param outputMipClusterList Name to write the MIP stub clusters out as.
+ */
public ShowerPointFinderDriver(HelixExtrapolator findCluster, String inputHitMap, String inputTrackList, String outputTrackMap, String outputHitMap, String outputMipClusterList) {
m_findCluster = findCluster;
m_inputHitMap = inputHitMap;