org.lcsim.recon.tracking.seedtracker.strategybuilder

Interface IStrategyBuilder

All Known Implementing Classes:

AbstractStrategyBuilder, StrategyBuilder

public interface IStrategyBuilder

This interface is mainly written for documentation purposes (since StrategyBuilder is somewhat full of code).

Author:

cozzy

Method Summary

Methods

Modifier and Type	Method and Description
void	setLayerWeight(LayerWeight lw) Sets the LayerWeight object of the strategy builder.
void	setLayerWeight(String layerWeightsFile) Sets the LayerWeight object of the strategy builder.
void	setMinimumUnweightedScore(int score) Set the minimum unweighted score to create a strategy.
void	setMinLayers(int min) Sets the minimum number of layers that an MCParticle must go through to be considered for strategy finidng
void	setNumConfirmLayers(int confirmed) Sets the number of confirmation layers desired
void	setNumSeedLayers(int seed) Sets the number of seed layers desired
void	setOutput(String filename) Sets the location of the output XML file of strategy lists
void	setParticleFilter(IParticleFilter filter) Sets the particle filter applied to MCParticles during the processing step.
void	setParticleFilter(String filterClassName) Sets the particle filter applied to MCParticles during the processing step.
void	setStartingStrategyList(List<SeedStrategy> startList) Set a starting strategy list.
void	setStartingStrategyList(String startingStrategiesFile) Set a starting strategy list.
void	setStrategyPrototype(SeedStrategy strategy) Set the prototype for the generated strategies.
void	setStrategyPrototype(String strategiesFile) Set the prototype for the generated strategies.
void	setStrategyPrototype(String strategiesFile, int strategyNumber) Set the prototype for the generated strategies.
void	setSymmetrize(boolean symmetrize) If symmetrize is true, then the Strategy will be force symmetrized between the two endcaps.
void	setVerbose(boolean verbose) Enables extra output if verbose is true.

Method Detail

setOutput

void setOutput(String filename)

Sets the location of the output XML file of strategy lists

Parameters:

filename -

setSymmetrize

void setSymmetrize(boolean symmetrize)

If symmetrize is true, then the Strategy will be force symmetrized between the two endcaps.

Parameters:

symmetrize -

setMinLayers

void setMinLayers(int min)

Sets the minimum number of layers that an MCParticle must go through to be considered for strategy finidng

Parameters:

min -

setNumConfirmLayers

void setNumConfirmLayers(int confirmed)

Sets the number of confirmation layers desired

Parameters:

confirmed -

setNumSeedLayers

void setNumSeedLayers(int seed)

Sets the number of seed layers desired

Parameters:

seed -

setLayerWeight

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.

Parameters:

lw - The LayerWeight object to use

setLayerWeight

void setLayerWeight(String layerWeightsFile)

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.

Parameters:

layerWeightsFile - A string representing the filename of an XML file representing a LayerWeight object

setStrategyPrototype

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.

Parameters:

strategy - The SeedStrategyObject to use

setStrategyPrototype

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.

Parameters:

strategiesFile - Filename of XML file containing a list of strategies

strategyNumber - The (0-indexed) number of the strategy to use as a prototype

setStrategyPrototype

void setStrategyPrototype(String strategiesFile)

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.

Parameters:

strategiesFile - Filename of XML file containing a list of strategies. The first strategy will be used.

setStartingStrategyList

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.

Parameters:

startList - a List of SeedStrategy's

setStartingStrategyList

void setStartingStrategyList(String startingStrategiesFile)

Set a starting strategy list. New strategies will only be generated for particles not already found by the starting strategy list.

Parameters:

startList - a file containing a number of SeedStrategies

setVerbose

void setVerbose(boolean verbose)

Enables extra output if verbose is true.

Parameters:

verbose -

setMinimumUnweightedScore

void setMinimumUnweightedScore(int score)

Set the minimum unweighted score to create a strategy. This represents the minimum number of additional tracks in the test event that could theoretically be found if the strategy is included.

Parameters:

score -

setParticleFilter

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.

Parameters:

filter - An object implementing the IParticleFilter interface

setParticleFilter

void setParticleFilter(String filterClassName)

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.

Parameters:

filter - Fully qualified class name for an object implementing the IParticleFilter interface