lcsim/src/org/lcsim/contrib/uiowa
diff -u -r1.3 -r1.4
--- RemoveHitsFromClusters.java 21 Oct 2008 23:02:24 -0000 1.3
+++ RemoveHitsFromClusters.java 22 Oct 2008 17:42:22 -0000 1.4
@@ -8,12 +8,33 @@
import org.lcsim.event.*;
import org.lcsim.recon.cluster.util.BasicCluster;
+/**
+ * Utility class to scan a list of clusters and remove any hits which
+ * match those in a specified HitMap. After removing the hits, all
+ * clusters which have at least one hit left are written out.
+ *
+ * Clusters which have not had any hits removed will be written out
+ * unedited. If a cluster has had some but not all of its hits removed,
+ * the original will be left unedited and a copy (BasicCluster) with
+ * the hits removed will be written out.
+ *
+ * @version $Id: RemoveHitsFromClusters.java,v 1.4 2008/10/22 17:42:22 mcharles Exp $
+ * @author [log in to unmask]
+ */
+
public class RemoveHitsFromClusters 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. These hits will be removed from clusters if any contain them.
+ * @param outputClusterList Output clusters will be written out under this name.
+ */
public RemoveHitsFromClusters(String inputClusterList, String inputMap, String outputClusterList) {
m_inputClusterListName = inputClusterList;
m_inputMapName = inputMap;