Commit in lcsim/src/org/lcsim/contrib/uiowa on MAIN
TrackToClusterMapMaker.java+271.1 -> 1.2
TrackToElectronMapMaker.java+81.1 -> 1.2
VetoHitsFromClusters.java+161.1 -> 1.2
+51
3 modified files
MJC: (contrib) Documentation

lcsim/src/org/lcsim/contrib/uiowa
TrackToClusterMapMaker.java 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- TrackToClusterMapMaker.java	15 Oct 2008 22:15:03 -0000	1.1
+++ TrackToClusterMapMaker.java	22 Oct 2008 17:43:40 -0000	1.2
@@ -5,6 +5,24 @@
 import org.lcsim.event.*;
 import org.lcsim.event.util.*;
 
+/**
+ * Abstract class with several implementations, used for
+ * matching tracks to clusters. The rules are:
+ *   1) The input tracks are supplied as a named List from the event.
+ *   2) Matched tracks are written out to the event as a Map<Track,Cluster>
+ *   3) Unmatched tracks are written out to the event as a List<Track>
+ *   4) The output tracks MAY be altered copies of the input tracks.
+ *      For example, if two tracks enter the calorimeter in the same
+ *      cell, they may get bundled into a single track. So the user
+ *      should not re-use the input track list.
+ *   5) There should be no overlap between the matched tracks and the
+ *      unmatched tracks.
+ *   6) Implementing classes MAY write out additional output.
+ *
+ * @version $Id: TrackToClusterMapMaker.java,v 1.2 2008/10/22 17:43:40 mcharles Exp $
+ * @author [log in to unmask]
+ */
+
 public abstract class TrackToClusterMapMaker extends Driver {
 
     abstract protected Map<Track,Cluster> makeMap(EventHeader event);
@@ -12,6 +30,15 @@
     String m_inputTrackListName;
     String m_outputMapName;
     String m_outputUnmatchedTrackListName;
+
+    /**
+     * General-purpose constructor. Implementing classes may make their
+     * own constructor with additional arguments.
+     *
+     * @param inputTrackList The name of the input List of Tracks to read in from the event and match to clusters.
+     * @param outputMap The name to write out the output Map<Track,Cluster> of matched tracks as.
+     * @param outputUnmatchedTrackList The name to write unmatched/unused tracks out as.
+     */
     public TrackToClusterMapMaker(String inputTrackList, String outputMap, String outputUnmatchedTrackList) {
 	super();
 	m_inputTrackListName = inputTrackList;

lcsim/src/org/lcsim/contrib/uiowa
TrackToElectronMapMaker.java 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- TrackToElectronMapMaker.java	15 Oct 2008 22:15:03 -0000	1.1
+++ TrackToElectronMapMaker.java	22 Oct 2008 17:43:40 -0000	1.2
@@ -9,12 +9,20 @@
 import org.lcsim.recon.cluster.util.*;
 import org.lcsim.util.swim.Line;
 
+/** 
+ * Try to make electrons. 
+ *
+ * @version $Id: TrackToElectronMapMaker.java,v 1.2 2008/10/22 17:43:40 mcharles Exp $
+ * @author [log in to unmask]
+ */
+
 public class TrackToElectronMapMaker extends TrackToClusterMapMaker {
 
     protected String m_outputElectronClusterListName;
     protected String m_inputPhotonListName;
     protected ClusterEnergyCalculator m_photonCalib;
     protected HelixExtrapolator m_findCluster;
+
     public TrackToElectronMapMaker(HelixExtrapolator findCluster, String inputPhotonList, String inputTrackList, String outputTrackClusterMap, String outputUnmatchedTrackList, String outputElectronClusterList) {
 	super(inputTrackList, outputTrackClusterMap, outputUnmatchedTrackList);
 	m_outputElectronClusterListName = outputElectronClusterList;

lcsim/src/org/lcsim/contrib/uiowa
VetoHitsFromClusters.java 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- VetoHitsFromClusters.java	13 Oct 2008 07:16:38 -0000	1.1
+++ VetoHitsFromClusters.java	22 Oct 2008 17:43:40 -0000	1.2
@@ -7,12 +7,28 @@
 import org.lcsim.event.*;
 import org.lcsim.recon.cluster.util.BasicCluster;
 
+/**
+ * Utility class to scan a list of clusters and veto any which
+ * contain hits from a specified HitMap. Only those clusters
+ * which don't contain any of these hits are written out.
+ *
+ * @version $Id: VetoHitsFromClusters.java,v 1.2 2008/10/22 17:43:40 mcharles Exp $
+ * @author [log in to unmask]
+ */
+
 public class VetoHitsFromClusters extends Driver 
 {
     protected String m_inputClusterListName;
     protected String m_inputMapName;
     protected String m_outputClusterListName;
 
+    /**
+     * Constructor.
+     *
+     * @param inputClusterList Named list of clusters to read in and scan.
+     * @param inputMap Named HitMap to read in. Any clusters containing hits in this HitMap will be vetoed.
+     * @param outputClusterList After the vetoing process, a list of remaining clusters will be written out under this name.
+     */
     public VetoHitsFromClusters(String inputClusterList, String inputMap, String outputClusterList) {
 	m_inputClusterListName = inputClusterList;
 	m_inputMapName = inputMap;
CVSspam 0.2.8