Commit in lcsim/src/org/lcsim/recon on MAIN
cluster/cheat/PerfectClusterer.java+1-31.3 -> 1.4
cluster/clumpfinder/ClumpFinder.java+4-41.2 -> 1.3
cluster/structural/CheatFragmentIdentifier.java+3-31.1 -> 1.2
                  /CheatLikelihoodLinkDriver.java+2-61.1 -> 1.2
                  /LikelihoodLinkDriver.java+2-21.4 -> 1.5
pfa/identifier/TrackClusterMatcher.java+1-31.1 -> 1.2
pfa/output/CorrectedEnergySumPlotter.java+5-31.1 -> 1.2
+18-24
7 modified files
MJC: Javadoc fixes

lcsim/src/org/lcsim/recon/cluster/cheat
PerfectClusterer.java 1.3 -> 1.4
diff -u -r1.3 -r1.4
--- PerfectClusterer.java	18 Jul 2006 00:48:24 -0000	1.3
+++ PerfectClusterer.java	21 Sep 2007 20:21:01 -0000	1.4
@@ -14,7 +14,7 @@
 /**
  * A clusterer with perfect pattern recognition
  *
- * @version $Id: PerfectClusterer.java,v 1.3 2006/07/18 00:48:24 mcharles Exp $
+ * @version $Id: PerfectClusterer.java,v 1.4 2007/09/21 20:21:01 mcharles Exp $
  */
 
 public class PerfectClusterer extends Driver
@@ -32,8 +32,6 @@
      *
      * Optionally, clusters may share a hit if more than one
      * particle contributed to it.
-     *
-     * @version $Id: PerfectClusterer.java,v 1.3 2006/07/18 00:48:24 mcharles Exp $
      */
     public void process(EventHeader event) 
     {

lcsim/src/org/lcsim/recon/cluster/clumpfinder
ClumpFinder.java 1.2 -> 1.3
diff -u -r1.2 -r1.3
--- ClumpFinder.java	17 Feb 2006 00:46:57 -0000	1.2
+++ ClumpFinder.java	21 Sep 2007 20:21:01 -0000	1.3
@@ -27,7 +27,7 @@
  * or more for each hit. This is hard-coded at the moment, but
  * should become a user-definable in a later version.
  * 
- * @version $Id: ClumpFinder.java,v 1.2 2006/02/17 00:46:57 mcharles Exp $
+ * @version $Id: ClumpFinder.java,v 1.3 2007/09/21 20:21:01 mcharles Exp $
  */
 
 public class ClumpFinder extends Driver
@@ -41,9 +41,9 @@
 
     /**
      * Constructor.
-     * @param clustersName Name of the input List<Cluster> in the event
-     * @param trackSegmentsName Name of the map which gives a list of track segments for each Cluster. These will not be used in clump-finding.
-     * @param outputName Name to use for the output map which will give a list of clumps for each Cluster.
+     * @param inputHitMap       Make clusters from the hits in this HitMap
+     * @param outputClusterList Write the clumps made to this list
+     * @param outputHitMap      Write unused hits out to this HitMap
      */
     public ClumpFinder(String inputHitMap, String outputClusterList, String outputHitMap)
     {

lcsim/src/org/lcsim/recon/cluster/structural
CheatFragmentIdentifier.java 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- CheatFragmentIdentifier.java	2 Mar 2006 20:51:54 -0000	1.1
+++ CheatFragmentIdentifier.java	21 Sep 2007 20:21:01 -0000	1.2
@@ -8,7 +8,7 @@
 /**
   * A cheating class to determine whether a given cluster is a fragment.
   *
-  * @version $Id: CheatFragmentIdentifier.java,v 1.1 2006/03/02 20:51:54 mcharles Exp $
+  * @version $Id: CheatFragmentIdentifier.java,v 1.2 2007/09/21 20:21:01 mcharles Exp $
   */
 public class CheatFragmentIdentifier implements FragmentIdentifier
 {
@@ -38,8 +38,8 @@
       * The cluster [clus] MUST be a member of the named list(s)
       * of clusters supplied in the constructor.
       *
-      * @parameter clus  Cluster to test
-      * @parameter event EventHeader
+      * @param clus  Cluster to test
+      * @param event EventHeader
       */
     public boolean isFragment(Cluster clus, EventHeader event)
     {

lcsim/src/org/lcsim/recon/cluster/structural
CheatLikelihoodLinkDriver.java 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- CheatLikelihoodLinkDriver.java	21 Mar 2007 00:51:09 -0000	1.1
+++ CheatLikelihoodLinkDriver.java	21 Sep 2007 20:21:01 -0000	1.2
@@ -20,7 +20,7 @@
  * truth information.
  *
  * @author Mat Charles <[log in to unmask]>
- * @version $Id: CheatLikelihoodLinkDriver.java,v 1.1 2007/03/21 00:51:09 mcharles Exp $
+ * @version $Id: CheatLikelihoodLinkDriver.java,v 1.2 2007/09/21 20:21:01 mcharles Exp $
  */
 
 public class CheatLikelihoodLinkDriver extends LikelihoodLinkDriver
@@ -28,11 +28,7 @@
     /**
      * Constructor.
      *
-     * @param eval                   The LikelihoodEvaluator which contains the likelihood PDFs
-     * @param cutTrackToTrack        To make a track-track link, the likelihood must be greater than this (e.g. 0.5)
-     * @param cutTrackToClump        To make a track-clump link, the likelihood must be greater than this (e.g. 0.5)
-     * @param cutClumpToClump        To make a clump-clump link, the likelihood must be greater than this (e.g. 0.5)
-     * @param listOfBigClustersThe   The List<Cluster> of large-scale clusters to grab from each event
+     * @param listOfBigCluster       The List<Cluster> of large-scale clusters to grab from each event
      * @param listOfTrackSegments    The List<Cluster> of track segments to grab from each event
      * @param listOfClumps           The List<Cluster> of clumps to grab from each event
      * @param outputListOfSkeletons  The List<Cluster> of linked clusters to write to the event when finished

lcsim/src/org/lcsim/recon/cluster/structural
LikelihoodLinkDriver.java 1.4 -> 1.5
diff -u -r1.4 -r1.5
--- LikelihoodLinkDriver.java	26 Apr 2007 17:17:52 -0000	1.4
+++ LikelihoodLinkDriver.java	21 Sep 2007 20:21:01 -0000	1.5
@@ -22,7 +22,7 @@
  * LikelihoodEvaluator.
  *
  * @author Mat Charles <[log in to unmask]>
- * @version $Id: LikelihoodLinkDriver.java,v 1.4 2007/04/26 17:17:52 mcharles Exp $
+ * @version $Id: LikelihoodLinkDriver.java,v 1.5 2007/09/21 20:21:01 mcharles Exp $
  */
 
 public class LikelihoodLinkDriver extends GenericStructuralDriver 
@@ -47,7 +47,7 @@
      * @param cutTrackToTrack        To make a track-track link, the likelihood must be greater than this (e.g. 0.5)
      * @param cutTrackToClump        To make a track-clump link, the likelihood must be greater than this (e.g. 0.5)
      * @param cutClumpToClump        To make a clump-clump link, the likelihood must be greater than this (e.g. 0.5)
-     * @param listOfBigClustersThe   The List<Cluster> of large-scale clusters to grab from each event
+     * @param listOfBigClusters      The List<Cluster> of large-scale clusters to grab from each event
      * @param listOfTrackSegments    The List<Cluster> of track segments to grab from each event
      * @param listOfClumps           The List<Cluster> of clumps to grab from each event
      * @param outputListOfSkeletons  The List<Cluster> of linked clusters to write to the event when finished

lcsim/src/org/lcsim/recon/pfa/identifier
TrackClusterMatcher.java 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- TrackClusterMatcher.java	10 Aug 2006 22:57:02 -0000	1.1
+++ TrackClusterMatcher.java	21 Sep 2007 20:21:01 -0000	1.2
@@ -7,7 +7,7 @@
 /**
   * Interface for matching Tracks to Clusters
   *
-  * @version $Id: TrackClusterMatcher.java,v 1.1 2006/08/10 22:57:02 mcharles Exp $
+  * @version $Id: TrackClusterMatcher.java,v 1.2 2007/09/21 20:21:01 mcharles Exp $
   */
 
 public interface TrackClusterMatcher
@@ -21,8 +21,6 @@
      * Implementations typically return a cluster from the list supplied.
      * They may also return a new cluster which contains clusters 
      * (via Cluster.getClusters()) from this list (and no other hits/clusters). 
-     *
-     * @version $Id: TrackClusterMatcher.java,v 1.1 2006/08/10 22:57:02 mcharles Exp $
      */
     public Cluster matchTrackToCluster(Track tr, List<Cluster> clusters);
 }

lcsim/src/org/lcsim/recon/pfa/output
CorrectedEnergySumPlotter.java 1.1 -> 1.2
diff -u -r1.1 -r1.2
--- CorrectedEnergySumPlotter.java	22 Jun 2006 01:50:28 -0000	1.1
+++ CorrectedEnergySumPlotter.java	21 Sep 2007 20:21:01 -0000	1.2
@@ -33,7 +33,7 @@
  * not seen by the calorimeter.
  * Write the plot out to a file when done.
  *
- * @version $Id: CorrectedEnergySumPlotter.java,v 1.1 2006/06/22 01:50:28 mcharles Exp $
+ * @version $Id: CorrectedEnergySumPlotter.java,v 1.2 2007/09/21 20:21:01 mcharles Exp $
  */
 
 public class CorrectedEnergySumPlotter extends Driver
@@ -41,8 +41,10 @@
     /**
      * Constructor.
      *
-     * @param inputParticleListName   Read in a List from the event under this name. The List may contain ReconstructedParticle or Particle objects (but not a mixture)
-     * @param filename               Write the plots to this file
+     * @param inputHitMap         Input: All CalorimeterHits in the event
+     * @param inputParticleList   Input: List of reconstructed particles
+     * @param inputTruthList      Input: Truth information for the event
+     * @param filename            Write the plots to this file
      */
     public CorrectedEnergySumPlotter(String inputHitMap, String inputParticleList, String inputTruthList, String filename)
     {
CVSspam 0.2.8