GarfieldTrack (LCSim 3.1.7 API)

java.lang.Object
- org.lcsim.recon.cat.GarfieldTrack

All Implemented Interfaces:

Track
```
public class GarfieldTrack
extends Object
implements Track
```
Simple track format for linear collider detector. Used for calorimeter assisted tracking with the SiD. An example on how to create a track from 3D position measurements, please see GarfieldTrackFinder::testGenericTrackFit()

Version:

$Id: GarfieldTrack.java,v 1.4 2012/07/30 15:35:34 grefe Exp $

Author:

E. von Toerne, D. Onoprienko

See Also:
GarfieldHit, GarfieldHelix

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static ConditionsListener`	`_conListener`
`private List<TrackState>`	`_trackStates`
`private double`	`chi2`
`(package private) static double`	`chi2NdfFitEnd`
`int`	`debugLevel`
`(package private) static double`	`emCalZ`
`private double`	`grade`
`private boolean`	`hasZ`
`GarfieldHelix`	`hel`
`ArrayList`	`hits`
`private int`	`ID`
`private boolean`	`isEndcap`
`int`	`lastLayer`
`(package private) static int`	`maxBarrelLayer`
`(package private) static int`	`maxEndcapLayer`
`private double`	`maxRadius`
`private MCParticle`	`mcParticle`
`private boolean`	`mcParticleIsKnown`
`private double`	`minRadius`
`int`	`ndf`
`int`	`nHits`
`int`	`nLayerMissed`
`(package private) static int`	`PARA_d0`
`(package private) static int`	`PARA_kappa`
`(package private) static int`	`PARA_lambda`
`(package private) static int`	`PARA_phi0`
`(package private) static int`	`PARA_z0`
`(package private) static double`	`speedOfLight`
`private String`	`status`
`private MipStub`	`stub`
`private boolean`	`trackDone`
`private double[]`	`trackPara`

Constructor Summary

Constructors
Constructor and Description
`GarfieldTrack()` Default constructor.
`GarfieldTrack(GarfieldTrack g)` Copy constructor.
`GarfieldTrack(MipStub mStub, int debugL)` Construct GarfieldTrack from a `MipStub`.
`GarfieldTrack(Track standardTrack, EventHeader event, int debugLevel)` Construct GarfieldTrack from a standard hep.lcd Track. Since `hep.lcd.event.Track` is not linked to hits, and lacks other information used by K0S finder, Monte Carlo pointers are used to construct a list of hits, and a fake MipStub created to support fitting.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addHit(GarfieldHit h)` Add a new hit to this track. Helix parameters are not changed, Chi2 is recalculated.
`void`	`calculateChi2()` Chi-square from hits and - if MipStub exists - from mipstub to track matching.
`void`	`calculateHelixFromHits()` updated 03/23/05 to remove vcreation of new double, and call to CircleFromPoints to calculate helix parameters for barrel tracks
`double`	`chi2Contrib(int i)` hit chiSquare contribution
`void`	`chi2FitIteration(double range, int mode)`
`void`	`debug()`
`double`	`distanceCutValue()`
`void`	`dropHit(int i)` Drop a hit from this track. Helix parameters are not changed, Chi2 is recalculated.
`boolean`	`fastChi2Fit(int scale)`
`private void`	`findMCParticle()`
`boolean`	`fitSuccess()` Returns true if the track has been successfully fitted
`boolean`	`fullChi2Fit(double rangeMax, int nIter)`
`int`	`getCharge()`
`double`	`getChi2()` Get the Chi Squared for the track fit
`double`	`getdEdx()`
`double`	`getdEdxError()`
`int`	`getEquivnHits()`
`SymmetricMatrix`	`getErrorMatrix()` Get the error matrix
`double`	`getGrade()`
`int`	`getHitID(int i)`
`int`	`getHitLayer(int i)`
`double[]`	`getHitPoint(int i)`
`int`	`getID()`
`double`	`getMaxR()`
`MCParticle`	`getMCParticle()` Returns MCParticle that produced tracker hits that are associated with this track.
`double`	`getMinR()`
`double[]`	`getMipStubBase()`
`double`	`getMipStubBase(int i)`
`double`	`getMipStubKappa()`
`double[]`	`getMomentum()`
`int`	`getNdf()`
`int`	`getNDF()` Get the numbers of degrees of freedom for the fit
`int`	`getnHits()`
`int`	`getNumberOfStepovers()`
`double`	`getP(double bField)`
`double`	`getPara(String name)` gets track parameters parameters refer to point of closest approach (pca) in the xy plane magnetic field points along z direction - getPara("kappa") gives curvature - d0: impact parameter in xy plane - z0: impact parameter in z direction - lambda: tan lambda (dip angle) - phi0: phi direction at point of closest approach
`double`	`getPoint(int i, int j)`
`double`	`getPt(double bField)` transverse momentum Pt in GeV = 0.299..
`double`	`getPX()`
`double`	`getPY()`
`double`	`getPZ()`
`double`	`getRadiusOfInnermostHit()`
`double[]`	`getReferencePoint()`
`double`	`getReferencePointX()`
`double`	`getReferencePointY()`
`double`	`getReferencePointZ()`
`String`	`getStatus()`
`int`	`getStubMinLayer()`
`int`	`getStubNHits()`
`int[]`	`getSubdetectorHitNumbers()`
`List<TrackerHit>`	`getTrackerHits()`
`double`	`getTrackParameter(int param)` Get an individual track parameter The track parameters for LCD are defined as follows Index Meaning 0 d0 = XY impact parameter 1 phi0 2 omega = 1/curv.radius (negative for negative tracks) 3 z0 = z of track origin (z impact parameter) 4 s = tan lambda Parameters according to the L3 conventions
`double[]`	`getTrackParameters()` Get the track parameters as an array
`List<Track>`	`getTracks()`
`List<TrackState>`	`getTrackStates()`
`int`	`getType()`
`boolean`	`hasZMeasurement()`
`static void`	`initialize(Detector detector)` Initialization of static members.
`boolean`	`isDone()`
`boolean`	`isEndcap()`
`boolean`	`isPurged()`
`boolean`	`isReferencePointPCA()`
`boolean`	`isRejected()`
`private double`	`kappaError()`
`void`	`newCalculateHelixFromHits()`
`boolean`	`oldFullChi2Fit(double rangeMax, int nIter)`
`void`	`purgeHits(double cutValue, int nHitMin, int nIter)` Throw avay hits that have worst chi2 until there are no hits left with contribution to Chi2 above `cutValue`, or until the number of hits on the track falls below `nHitMin`.
`void`	`purgeTrack()`
`int`	`q()`
`void`	`rejectTrack()`
`void`	`setDebugLevel(int i)` controls amount of debug text output and test histograms, =0 not output, >0 debug output
`void`	`setDone()`
`double`	`setGrade(double chi2Weight)` calculate grade of track
`void`	`setHasZ(boolean val)`
`void`	`setHelix(double[] pbase, double[] p2)`
`void`	`setHelixBaseToPCA()`
`void`	`setID(int id)`
`void`	`setLastLayer(int i)`
`void`	`setRadii()`
`void`	`setStatus(String stat)`
`void`	`setTrackParameters()` finds point of closest approach in x,y plane with respect to 0,0,0 see also getPara()

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

Field Detail

hits
```
public ArrayList hits
```

hel
```
public GarfieldHelix hel
```

trackPara
```
private double[] trackPara
```

minRadius
```
private double minRadius
```

maxRadius
```
private double maxRadius
```

status
```
private String status
```

stub
```
private MipStub stub
```

ID
```
private int ID
```

ndf
```
public int ndf
```

chi2
```
private double chi2
```

grade
```
private double grade
```

lastLayer
```
public int lastLayer
```

nLayerMissed
```
public int nLayerMissed
```

isEndcap
```
private boolean isEndcap
```

hasZ
```
private boolean hasZ
```

nHits
```
public int nHits
```

debugLevel
```
public int debugLevel
```

trackDone
```
private boolean trackDone
```

mcParticle
```
private MCParticle mcParticle
```

mcParticleIsKnown
```
private boolean mcParticleIsKnown
```

_trackStates
```
private List<TrackState> _trackStates
```

PARA_d0
```
static int PARA_d0
```

PARA_phi0
```
static int PARA_phi0
```

PARA_kappa
```
static int PARA_kappa
```

PARA_z0
```
static int PARA_z0
```

PARA_lambda
```
static int PARA_lambda
```

maxEndcapLayer
```
static int maxEndcapLayer
```

maxBarrelLayer
```
static int maxBarrelLayer
```

chi2NdfFitEnd
```
static double chi2NdfFitEnd
```

speedOfLight
```
static double speedOfLight
```

emCalZ
```
static double emCalZ
```

_conListener
```
static ConditionsListener _conListener
```

Constructor Detail
- GarfieldTrack
```
GarfieldTrack()
```
  Default constructor.
- GarfieldTrack
```
GarfieldTrack(MipStub mStub,
             int debugL)
```
  Construct GarfieldTrack from a MipStub.
- GarfieldTrack
```
GarfieldTrack(Track standardTrack,
             EventHeader event,
             int debugLevel)
```
  Construct GarfieldTrack from a standard hep.lcd Track.
  Since hep.lcd.event.Track is not linked to hits, and lacks other information used by K0S finder, Monte Carlo pointers are used to construct a list of hits, and a fake MipStub created to support fitting. This needs to be done better to fully integrate garfield tracking into the full tracking algorithm - plan to do it later, and hopefully with a better framework (org.lcsim ?). For now, any methods requiring access to individual hits might not work correctly if called for GarfieldTrack object created with this constructor.
- GarfieldTrack
```
GarfieldTrack(GarfieldTrack g)
```
  Copy constructor.

Method Detail

initialize
```
public static void initialize(Detector detector)
```
Initialization of static members. Runs automatically once org.lcsim.contrib.garfield.util.Const has been initialized.

getID
```
public int getID()
```

getGrade
```
public double getGrade()
```

getHitID
```
public int getHitID(int i)
```

getHitPoint
```
public double[] getHitPoint(int i)
```

getNumberOfStepovers
```
public int getNumberOfStepovers()
```

getHitLayer
```
public int getHitLayer(int i)
```

getPara
```
public double getPara(String name)
```
gets track parameters parameters refer to point of closest approach (pca) in the xy plane magnetic field points along z direction - getPara("kappa") gives curvature
- d0: impact parameter in xy plane
- z0: impact parameter in z direction
- lambda: tan lambda (dip angle)
- phi0: phi direction at point of closest approach

how to get pca from track parameter
x-coordinate pca_x = -d0 * sin(phi0)
// see also contrib/timb/mc/fast/tracking/DocaTrackParameters.java x-coordinate pca_y = d0 * cos(phi0)
z-coordinate pca_z = z0
how to get helix direction at pca
dir-x =cos(phi0)
dir-y =sin(phi0)
dir-z =lambda

getStatus
```
public String getStatus()
```

getnHits
```
public int getnHits()
```

getStubMinLayer
```
public int getStubMinLayer()
```

getEquivnHits
```
public int getEquivnHits()
```

getMinR
```
public double getMinR()
```

getMaxR
```
public double getMaxR()
```

getChi2
```
public double getChi2()
```
Description copied from interface: Track

Get the Chi Squared for the track fit

Specified by:

getChi2 in interface Track

Returns:
Chi Squared
See Also:
Track.getNDF()

getNdf
```
public int getNdf()
```

getPt
```
public double getPt(double bField)
```
transverse momentum Pt in GeV = 0.299.. * B (in Tesla) * R (in Meter)

Parameters:
bField - B field in Tesla

getP
```
public double getP(double bField)
```

hasZMeasurement
```
public boolean hasZMeasurement()
```

isPurged
```
public boolean isPurged()
```

isRejected
```
public boolean isRejected()
```

isDone
```
public boolean isDone()
```

isEndcap
```
public boolean isEndcap()
```

q
```
public int q()
```

getMipStubBase
```
public double getMipStubBase(int i)
```

getMipStubBase
```
public double[] getMipStubBase()
```

getMipStubKappa
```
public double getMipStubKappa()
```

getStubNHits
```
public int getStubNHits()
```

setID
```
public void setID(int id)
```

setHasZ
```
public void setHasZ(boolean val)
```

setDebugLevel
```
public void setDebugLevel(int i)
```
controls amount of debug text output and test histograms, =0 not output, >0 debug output

setLastLayer
```
public void setLastLayer(int i)
```

setDone
```
public void setDone()
```

setStatus
```
public void setStatus(String stat)
```

setHelix

public void setHelix(double[] pbase,
            double[] p2)

rejectTrack
```
public void rejectTrack()
```

purgeTrack
```
public void purgeTrack()
```

setRadii
```
public void setRadii()
```

setGrade

public double setGrade(double chi2Weight)

calculate grade of track

setTrackParameters
```
public void setTrackParameters()
```
finds point of closest approach in x,y plane with respect to 0,0,0
see also getPara()

purgeHits
```
public void purgeHits(double cutValue,
             int nHitMin,
             int nIter)
```
Throw avay hits that have worst chi2 until there are no hits left with contribution to Chi2 above cutValue, or until the number of hits on the track falls below nHitMin. Track is re-fit after removing each hit.

addHit
```
public void addHit(GarfieldHit h)
```
Add a new hit to this track.
Helix parameters are not changed, Chi2 is recalculated.

dropHit
```
public void dropHit(int i)
```
Drop a hit from this track.
Helix parameters are not changed, Chi2 is recalculated.

setHelixBaseToPCA
```
public void setHelixBaseToPCA()
```

distanceCutValue
```
public double distanceCutValue()
```

calculateHelixFromHits
```
public void calculateHelixFromHits()
```
updated 03/23/05 to remove vcreation of new double, and call to CircleFromPoints to calculate helix parameters for barrel tracks

newCalculateHelixFromHits

public void newCalculateHelixFromHits()

getPoint

public double getPoint(int i,
              int j)

calculateChi2
```
public void calculateChi2()
```
Chi-square from hits and - if MipStub exists - from mipstub to track matching.

chi2Contrib
```
public double chi2Contrib(int i)
```
hit chiSquare contribution

Parameters:
i - hit number from 0 to nHits-1

fullChi2Fit

public boolean fullChi2Fit(double rangeMax,
                  int nIter)

oldFullChi2Fit

public boolean oldFullChi2Fit(double rangeMax,
                     int nIter)

fastChi2Fit

public boolean fastChi2Fit(int scale)

chi2FitIteration

public void chi2FitIteration(double range,
                    int mode)

kappaError
```
private double kappaError()
```

debug
```
public void debug()
```

getMCParticle
```
public MCParticle getMCParticle()
```
Returns MCParticle that produced tracker hits that are associated with this track. Returns null if more than one MCParticle was involved.

findMCParticle
```
private void findMCParticle()
```

getTrackParameters
```
public double[] getTrackParameters()
```
Description copied from interface: Track

Get the track parameters as an array

Specified by:

getTrackParameters in interface Track

See Also:
Track.getTrackParameter(int)

getTrackParameter

public double getTrackParameter(int param)

Description copied from interface: Track

Get an individual track parameter The track parameters for LCD are defined as follows

Index	Meaning
0	d0 = XY impact parameter
1	phi0
2	omega = 1/curv.radius (negative for negative tracks)
3	z0 = z of track origin (z impact parameter)
4	s = tan lambda

Parameters according to the L3 conventions

Specified by:: getTrackParameter in interface Track
Parameters:: param - The index of the track parameter
Returns:: The track parameter with the specified index

getdEdxError
```
public double getdEdxError()
```
Specified by:

getdEdxError in interface Track

getdEdx
```
public double getdEdx()
```
Specified by:

getdEdx in interface Track

getType
```
public int getType()
```
Specified by:

getType in interface Track

getTracks
```
public List<Track> getTracks()
```
Specified by:

getTracks in interface Track

getTrackerHits
```
public List<TrackerHit> getTrackerHits()
```
Specified by:

getTrackerHits in interface Track

getSubdetectorHitNumbers
```
public int[] getSubdetectorHitNumbers()
```
Specified by:

getSubdetectorHitNumbers in interface Track

fitSuccess
```
public boolean fitSuccess()
```
Description copied from interface: Track

Returns true if the track has been successfully fitted

Specified by:

fitSuccess in interface Track

getCharge
```
public int getCharge()
```
Specified by:

getCharge in interface Track

getErrorMatrix
```
public SymmetricMatrix getErrorMatrix()
```
Description copied from interface: Track

Get the error matrix

Specified by:

getErrorMatrix in interface Track

See Also:
Track.getTrackParameter(int)

getMomentum
```
public double[] getMomentum()
```
Specified by:

getMomentum in interface Track

Returns:

getNDF
```
public int getNDF()
```
Description copied from interface: Track

Get the numbers of degrees of freedom for the fit

Specified by:

getNDF in interface Track

Returns:
The number of degrees of freedom
See Also:
Track.getChi2()

getPX
```
public double getPX()
```
Specified by:

getPX in interface Track

Returns:

getPY
```
public double getPY()
```
Specified by:

getPY in interface Track

Returns:

getPZ
```
public double getPZ()
```
Specified by:

getPZ in interface Track

Returns:

getRadiusOfInnermostHit
```
public double getRadiusOfInnermostHit()
```
Specified by:

getRadiusOfInnermostHit in interface Track

isReferencePointPCA
```
public boolean isReferencePointPCA()
```
Specified by:

isReferencePointPCA in interface Track

getReferencePoint
```
public double[] getReferencePoint()
```
Specified by:

getReferencePoint in interface Track

Returns:

getReferencePointX
```
public double getReferencePointX()
```
Specified by:

getReferencePointX in interface Track

Returns:

getReferencePointY
```
public double getReferencePointY()
```
Specified by:

getReferencePointY in interface Track

Returns:

getReferencePointZ
```
public double getReferencePointZ()
```
Specified by:

getReferencePointZ in interface Track

Returns:

getTrackStates
```
public List<TrackState> getTrackStates()
```
Specified by:

getTrackStates in interface Track

Class GarfieldTrack

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

hits

hel

trackPara

minRadius

maxRadius

status

stub

ID

ndf

chi2

grade

lastLayer

nLayerMissed

isEndcap

hasZ

nHits

debugLevel

trackDone

mcParticle

mcParticleIsKnown

_trackStates

PARA_d0

PARA_phi0

PARA_kappa

PARA_z0

PARA_lambda

maxEndcapLayer

maxBarrelLayer

chi2NdfFitEnd

speedOfLight

emCalZ

_conListener

Constructor Detail

GarfieldTrack

GarfieldTrack

GarfieldTrack

GarfieldTrack

Method Detail

initialize

getID

getGrade

getHitID

getHitPoint

getNumberOfStepovers

getHitLayer

getPara

getStatus

getnHits

getStubMinLayer

getEquivnHits

getMinR

getMaxR

getChi2

getNdf

getPt

getP

hasZMeasurement

isPurged

isRejected

isDone

isEndcap

q

getMipStubBase

getMipStubBase

getMipStubKappa

getStubNHits

setID

setHasZ

setDebugLevel

setLastLayer

setDone

setStatus

setHelix

rejectTrack