lcsim/src/org/lcsim/recon/tracking/seedtracker/strategybuilder
diff -u -r1.1 -r1.2
--- AbstractStrategyBuilder.java 26 Sep 2008 23:36:07 -0000 1.1
+++ AbstractStrategyBuilder.java 3 Oct 2008 18:28:10 -0000 1.2
@@ -22,6 +22,10 @@
public void setStrategyPrototype(String strategiesFile, int strategyNumber) {
setStrategyPrototype(StrategyXMLUtils.getStrategyListFromFile(new File(strategiesFile)).get(strategyNumber));
}
+
+ public void setStrategyPrototype(String strategiesFile) {
+ setStrategyPrototype(strategiesFile,0);
+ }
public void setLayerWeight(String layerWeightsFile){
setLayerWeight(LayerWeight.getLayerWeightFromFile(new File(layerWeightsFile)));
lcsim/src/org/lcsim/recon/tracking/seedtracker/strategybuilder
diff -u -r1.2 -r1.3
--- IStrategyBuilder.java 26 Sep 2008 23:36:07 -0000 1.2
+++ IStrategyBuilder.java 3 Oct 2008 18:28:10 -0000 1.3
@@ -51,26 +51,55 @@
* Sets the LayerWeight object of the strategy builder. A layer weight is
* used to treat certain layers preferentially. If no layer weight specified,
* the default layer weight will be used.
- * @param lw
+ * @param lw The LayerWeight object to use
*/
public void setLayerWeight(LayerWeight lw);
+
+ /**
+ * Sets the LayerWeight object of the strategy builder. A layer weight is
+ * used to treat certain layers preferentially. If no layer weight specified,
+ * the default layer weight will be used.
+ * @param layerWeightsFile A string representing the filename of an XML file representing a LayerWeight object
+ */
public void setLayerWeight(String layerWeightsFile);
/**
* Set the prototype for the generated strategies. The values for cutoffs
* and such will be copied from the prototype. If not prototype is specified,
* the default values for SeedStrategy will be used.
- * @param strategy
+ * @param strategy The SeedStrategyObject to use
*/
public void setStrategyPrototype(SeedStrategy strategy);
+
+ /**
+ * Set the prototype for the generated strategies. The values for cutoffs
+ * and such will be copied from the prototype. If not prototype is specified,
+ * the default values for SeedStrategy will be used.
+ * @param strategiesFile Filename of XML file containing a list of strategies
+ * @param strategyNumber The (0-indexed) number of the strategy to use as a prototype
+ */
public void setStrategyPrototype(String strategiesFile, int strategyNumber);
/**
+ * Set the prototype for the generated strategies. The values for cutoffs
+ * and such will be copied from the prototype. If not prototype is specified,
+ * the default values for SeedStrategy will be used.
+ * @param strategiesFile Filename of XML file containing a list of strategies. The first strategy will be used.
+ */
+
+ public void setStrategyPrototype(String strategiesFile);
+ /**
* Set a starting strategy list. New strategies will only be generated for
* particles not already found by the starting strategy list.
- * @param startList
+ * @param startList a List of SeedStrategy's
*/
public void setStartingStrategyList(List<SeedStrategy> startList);
+
+ /**
+ * Set a starting strategy list. New strategies will only be generated for
+ * particles not already found by the starting strategy list.
+ * @param startList a file containing a number of SeedStrategies
+ */
public void setStartingStrategyList(String startingStrategiesFile);
/**
@@ -98,8 +127,22 @@
*
* If no filter is desired, AllPassFilter may be used.
*
- * @param filter
+ * @param filter An object implementing the IParticleFilter interface
*/
public void setParticleFilter(IParticleFilter filter);
+
+ /**
+ * Sets the particle filter applied to MCParticles during the processing step.
+ * MCParticles which do not pass this filter will not be considered for
+ * strategy finding. Note that MCParticles must also pass the MinLayers
+ * requirement regardless of the filter.
+ *
+ * If no filter is specified, a filter will be generated from dca, z0 and
+ * pt cutoffs present in the prototype SeedStrategy.
+ *
+ * If no filter is desired, AllPassFilter may be used.
+ *
+ * @param filter Fully qualified class name for an object implementing the IParticleFilter interface
+ */
public void setParticleFilter(String filterClassName);
}