GarfieldTrackFinder (LCSim 3.1.7 API)

java.lang.Object
- org.lcsim.util.Driver
- - org.lcsim.recon.cat.GarfieldTrackFinder

```
public final class GarfieldTrackFinder
extends Driver
```
Calorimeter-assisted tracking algorithm for the SiD. This processor finds track with outside-to-inside pattern recognition. Starting from Ecal clusters and their pointing direction, hits are associated to a track.
See ExampleDriver.java on how to use it

This org.lcsim version is based on a previous hep.lcd version. known dependencies on org.lcsim:
a few parameters are tuned specifically to SiD in org.lcsim, lines with such dependencies are labeled with "FixMe".

Version:

$Id: GarfieldTrackFinder.java,v 1.2 2007/12/08 02:39:11 jeremy Exp $

Author:

E. von Toerne, D. Onoprienko

See Also:
MipStub, GarfieldTrack, GarfieldHit

Nested Class Summary
- Nested classes/interfaces inherited from class org.lcsim.util.Driver
  Driver.AbortRunException, Driver.NextEventException

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static int`	`APPEND`
`private double`	`bestGrade`
`private GarfieldHit`	`bestHit`
`private int`	`bestTrackID`
`(package private) static double`	`bfield`
`private int`	`debugLevel` Level of verbosity: 0 no output, 1 some, 3 lot, 5 lots and lots
`private double`	`garfieldChi2ContribCut`
`private double`	`garfieldChi2Cut`
`private double`	`garfieldChi2Cut3Ndf`
`private double`	`garfieldKappaCut3Ndf`
`private int`	`garfieldnTRKHitMin`
`private GarfieldHitConverter`	`hitConverter`
`private int`	`issuedTrackIDValue`
`(package private) static double`	`k_cm`
`private List<GarfieldHit>`	`listOfHits`
`private int`	`listOfHitsHighestLayer`
`private int`	`listOfHitsLowestLayer`
`private double`	`maxDistanceFirstHitToBase`
`(package private) static int`	`maxTrkNmbr`
`private double`	`minDistanceInHits`
`private boolean`	`modeBestTrackOnly`
`private boolean`	`modeFromOutsideIn`
`private int`	`modeModifyTracklist`
`private boolean`	`modeUseAllMipStubs`
`private boolean`	`modeUseVXD`
`private int`	`nFitIterations`
`private int`	`nNewHitsMax`
`(package private) static int`	`NO`
`(package private) static int`	`NONE`
`(package private) static int`	`OVERWRITE`
`private int`	`pickEventNo`
`private double`	`pickMipStubAngle`
`private int`	`pickMipStubNo`
`private boolean`	`refitDuringPatternReco`
`private double`	`scaleSearchRegion`
`private List<GarfieldHit>`	`selectedHits`
`(package private) static int`	`YES`

Fields inherited from class org.lcsim.util.Driver
HLEVEL_DEFAULT, HLEVEL_FULL, HLEVEL_HIGH, HLEVEL_NORMAL, HLEVEL_OFF

Constructor Summary

Constructors
Constructor and Description
`GarfieldTrackFinder()` Construct `GarfieldTrackFinder` with default parameters and no debugging output requested.
`GarfieldTrackFinder(int debugLevel)` Construct `GarfieldTrackFinder` with default parameters.

Method Summary

Methods
Modifier and Type	Method and Description
`private boolean`	`addHit(GarfieldTrack g, GarfieldHit h)` Add a hit to an existing track including decisions on how to update helix paramters.
`private void`	`getNextHits(GarfieldTrack g, double scale)` Compile a list of eligible hits in the next layer and put it into `selectedHits` for pattern recognition code to use.
`private boolean`	`isEven(int i)`
`private int`	`issueTrackID()`
`private double`	`overlapRatio(GarfieldTrack g1, GarfieldTrack g2)`
`private void`	`panicPurge(List lst, int ntrMax)`
`void`	`process(EventHeader event)` Process event (called by the framework).
`void`	`setChi2ContribCut(double d)`
`void`	`setChi2Cut(double d)`
`void`	`setDebugLevel(int i)` Set desired amount of debugging output and test histograms, =0 no output, > 0 debug output
`void`	`setMode(String category, int mode)` Set track finder's mode of operation.
`void`	`setNFitIterations(int i)`
`void`	`setNNewHitsMax(int i)`
`void`	`setNTrkHitMin(int i)`
`void`	`setPickEventNo(int i)` allows processing of a single event.
`void`	`setPickMipStubAngle(double a)` allows processing of a phi-region.
`void`	`setPickMipStubNo(int i)` allows processing of a single MipStub.
`void`	`setScaleSearchRegion(double d)`
`void`	`testEv5(EventHeader event)` another example on how to fit a track
`void`	`testEvent(EventHeader event)`
`void`	`testGenericTrackFit(EventHeader event)` example for stand-alone tracking for Wolfgang M.

Methods inherited from class org.lcsim.util.Driver
add, clearStatistics, contains, detectorChanged, drivers, endOfData, getConditionsManager, getHistogramLevel, getLogger, getName, getRandom, printStatistics, processChildren, remove, resume, setHistogramLevel, setLogLevel, setRandom, startOfData, suspend

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - APPEND
```
static final int APPEND
```
    See Also:
    Constant Field Values
  - OVERWRITE
```
static final int OVERWRITE
```
    See Also:
    Constant Field Values
  - NONE
```
static final int NONE
```
    See Also:
    Constant Field Values
  - YES
```
static final int YES
```
    See Also:
    Constant Field Values
  - NO
```
static final int NO
```
    See Also:
    Constant Field Values
  - listOfHits
```
private List<GarfieldHit> listOfHits
```
  - listOfHitsLowestLayer
```
private int listOfHitsLowestLayer
```
  - listOfHitsHighestLayer
```
private int listOfHitsHighestLayer
```
  - selectedHits
```
private List<GarfieldHit> selectedHits
```
  - hitConverter
```
private GarfieldHitConverter hitConverter
```
  - k_cm
```
static double k_cm
```
  - garfieldnTRKHitMin
```
private int garfieldnTRKHitMin
```
  - refitDuringPatternReco
```
private boolean refitDuringPatternReco
```
  - garfieldChi2ContribCut
```
private double garfieldChi2ContribCut
```
  - garfieldChi2Cut
```
private double garfieldChi2Cut
```
  - garfieldChi2Cut3Ndf
```
private double garfieldChi2Cut3Ndf
```
  - garfieldKappaCut3Ndf
```
private double garfieldKappaCut3Ndf
```
  - scaleSearchRegion
```
private double scaleSearchRegion
```
  - maxDistanceFirstHitToBase
```
private double maxDistanceFirstHitToBase
```
  - nNewHitsMax
```
private int nNewHitsMax
```
  - nFitIterations
```
private int nFitIterations
```
  - modeModifyTracklist
```
private int modeModifyTracklist
```
  - modeUseVXD
```
private boolean modeUseVXD
```
  - modeBestTrackOnly
```
private boolean modeBestTrackOnly
```
  - modeFromOutsideIn
```
private boolean modeFromOutsideIn
```
  - modeUseAllMipStubs
```
private boolean modeUseAllMipStubs
```
  - pickEventNo
```
private int pickEventNo
```
  - pickMipStubNo
```
private int pickMipStubNo
```
  - pickMipStubAngle
```
private double pickMipStubAngle
```
  - debugLevel
```
private int debugLevel
```
    Level of verbosity: 0 no output, 1 some, 3 lot, 5 lots and lots
  - issuedTrackIDValue
```
private int issuedTrackIDValue
```
  - minDistanceInHits
```
private double minDistanceInHits
```
  - bestHit
```
private GarfieldHit bestHit
```
  - bestTrackID
```
private int bestTrackID
```
  - bestGrade
```
private double bestGrade
```
  - maxTrkNmbr
```
static int maxTrkNmbr
```
  - bfield
```
static double bfield
```
- Constructor Detail
  - GarfieldTrackFinder
```
public GarfieldTrackFinder()
```
    Construct GarfieldTrackFinder with default parameters and no debugging output requested.
  - GarfieldTrackFinder
```
public GarfieldTrackFinder(int debugLevel)
```
    Construct GarfieldTrackFinder with default parameters.
    
    Parameters:
    debugLevel - The higher the debugLeve, the more debugging output and test histograms are produced.
- Method Detail
  - setDebugLevel
```
public void setDebugLevel(int i)
```
    Set desired amount of debugging output and test histograms, =0 no output, > 0 debug output
  - setMode
```
public void setMode(String category,
           int mode)
```
    Set track finder's mode of operation.
    Parameters:
    category - Mode category (what to set)
    mode - Requested mode List of categories and correspondin mode choices (default mode is listed first) :
    "Modify Event TrackList"
    
    APPEND : Append found tracks to the event's tracklist.
    OVERWRITE : Replace the event's tracklist with the list of found tracks.
    NONE : Do not modify event's tracklist.
    "Use VXD Hits"
    
    YES : Extrapolate Garfield Tracks into VXD if qualifying hits are found there.
    NO : Do not use VXD hits.
    "Best Track Only"
    
    YES : Accept only one track per MipStub.
    NO : Accept all tracks that pass the cuts.
    "From Outside In"
    
    YES : Add hits to the track starting from outer layers and moving in.
    NO : Add hits to the track starting with inner layers and moving out.
  - setNNewHitsMax
```
public void setNNewHitsMax(int i)
```
  - setNTrkHitMin
```
public void setNTrkHitMin(int i)
```
  - setNFitIterations
```
public void setNFitIterations(int i)
```
  - setChi2ContribCut
```
public void setChi2ContribCut(double d)
```
  - setChi2Cut
```
public void setChi2Cut(double d)
```
  - setScaleSearchRegion
```
public void setScaleSearchRegion(double d)
```
  - setPickEventNo
```
public void setPickEventNo(int i)
```
    allows processing of a single event.
  - setPickMipStubNo
```
public void setPickMipStubNo(int i)
```
    allows processing of a single MipStub.
  - setPickMipStubAngle
```
public void setPickMipStubAngle(double a)
```
    allows processing of a phi-region.
  - process
```
public void process(EventHeader event)
```
    Process event (called by the framework).
    
    Overrides:
    
    process in class Driver
    
    Parameters:
    event - The event to be processed
    See Also:
    Driver.NextEventException, Driver.AbortRunException
  - getNextHits
```
private void getNextHits(GarfieldTrack g,
               double scale)
```
    Compile a list of eligible hits in the next layer and put it into selectedHits for pattern recognition code to use.
  - addHit
```
private boolean addHit(GarfieldTrack g,
             GarfieldHit h)
```
    Add a hit to an existing track including decisions on how to update helix paramters. Returns true if the hit is successfully added, false if the hit has too large chi^2.
  - issueTrackID
```
private int issueTrackID()
```
  - isEven
```
private boolean isEven(int i)
```
  - overlapRatio
```
private double overlapRatio(GarfieldTrack g1,
                  GarfieldTrack g2)
```
  - panicPurge
```
private void panicPurge(List lst,
              int ntrMax)
```
  - testEvent
```
public void testEvent(EventHeader event)
```
  - testGenericTrackFit
```
public void testGenericTrackFit(EventHeader event)
```
    example for stand-alone tracking for Wolfgang M.
  - testEv5
```
public void testEv5(EventHeader event)
```
    another example on how to fit a track

Class GarfieldTrackFinder

Nested Class Summary

Nested classes/interfaces inherited from class org.lcsim.util.Driver

Field Summary

Fields inherited from class org.lcsim.util.Driver

Constructor Summary

Method Summary

Methods inherited from class org.lcsim.util.Driver

Methods inherited from class java.lang.Object

Field Detail

APPEND

OVERWRITE

NONE

YES

NO

listOfHits

listOfHitsLowestLayer

listOfHitsHighestLayer

selectedHits

hitConverter

k_cm

garfieldnTRKHitMin

refitDuringPatternReco

garfieldChi2ContribCut

garfieldChi2Cut

garfieldChi2Cut3Ndf

garfieldKappaCut3Ndf

scaleSearchRegion

maxDistanceFirstHitToBase

nNewHitsMax

nFitIterations

modeModifyTracklist

modeUseVXD

modeBestTrackOnly

modeFromOutsideIn

modeUseAllMipStubs

pickEventNo

pickMipStubNo

pickMipStubAngle

debugLevel

issuedTrackIDValue

minDistanceInHits

bestHit

bestTrackID

bestGrade

maxTrkNmbr

bfield

Constructor Detail

GarfieldTrackFinder

GarfieldTrackFinder

Method Detail

setDebugLevel

setMode

setNNewHitsMax

setNTrkHitMin

setNFitIterations

setChi2ContribCut

setChi2Cut

setScaleSearchRegion

setPickEventNo

setPickMipStubNo

setPickMipStubAngle

process

getNextHits

addHit

issueTrackID

isEven

overlapRatio

panicPurge

testEvent

testGenericTrackFit

testEv5