org.lcsim.recon.cat

Class GarfieldHitConverter

java.lang.Object

org.lcsim.util.Driver

org.lcsim.recon.cat.GarfieldHitConverter

public final class GarfieldHitConverter
extends Driver

This processor converts tracker hits into GarfieldHit objects. It lets the user to specify collections to be included, or ignore the hits picked up by previously run tracking algorithms. It also gets rid of multiple adjacent hits due to delta electrons.

Most of this machinery will become unnecessary once proper digitization packages are available, and standard two-dimensional tracker hit interface is specified.

Version:

$Id: GarfieldHitConverter.java,v 1.1 2007/04/06 21:48:14 onoprien Exp $

Author:

E. von Toerne, D. Onoprienko

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
private double	barrelTiling
(package private) double	distanceCut
private double	endcapTiling
(package private) List<String>	inputCollectionNames
private boolean	modeFromOutsideIn
private boolean	modeUseVXD
(package private) String	outputCollectionName
private double	simpleError

Fields inherited from class org.lcsim.util.Driver

HLEVEL_DEFAULT, HLEVEL_FULL, HLEVEL_HIGH, HLEVEL_NORMAL, HLEVEL_OFF

Constructor Summary

Constructors

Constructor and Description
GarfieldHitConverter()

Method Summary

Methods

Modifier and Type	Method and Description
private double	barrelTrackerZ(double z, int end, int layer) Very black magic
private boolean	findAdjacentHit(SimTrackerHit newHit, ArrayList<GarfieldHit> oldHitList) Returns true if a GarfieldHit exists in the supplied oldHitList that is too close to the newHit, so the two should be merged.
private int	getGarfieldLayerID(SimTrackerHit hit) Garfield-specific tracking layer numbering: from innermost VXD layer to outermost Tracker layer, barrels first.
private boolean	is3D(SimTrackerHit hit) Returns true if hit supplied as an argument has information about all three coordinates (this implementation is very detector and package specific).
private boolean	isEven(int i)
private boolean	isVXD(SimTrackerHit hit) Returns true if the hit is in vertex detector.
void	process(EventHeader event) Process event, and put created list of GarfieldHits into the event.
void	set(String name) Set any boolean parameter to true.
void	set(String name, boolean value) Set any boolean parameter.
void	set(String name, double value) Set any double parameter.
void	set(String name, String value) Set any String parameter.

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

inputCollectionNames

List<String> inputCollectionNames

outputCollectionName

String outputCollectionName

distanceCut

double distanceCut

barrelTiling

private double barrelTiling

endcapTiling

private double endcapTiling

simpleError

private double simpleError

modeFromOutsideIn

private boolean modeFromOutsideIn

modeUseVXD

private boolean modeUseVXD

Constructor Detail

GarfieldHitConverter

public GarfieldHitConverter()

Method Detail

set

public void set(String name,
       String value)

Set any String parameter. The following parameters can be set with this method:
"OUTPUT_COLLECTION_NAME" - name of output TrackerHit collection. Default: "GarfieldHits"
"INCLIDE_HIT_COLLECTION" - name of input SimTrackerHit collection to be included in processing.

Parameters:

name - Name of parameter to be set. Case is ignored.

value - Value to be assigned to the parameter.

Throws:

NoSuchParameterException - Thrown if the supplied parameter name is unknown. Subclasses may catch this exception after a call to super.set() and set their own parameters.

set

public void set(String name,
       boolean value)

Set any boolean parameter. The following parameters can be set with this method:
"INCLUDE_VXD" - Process SimTrackerHits from VXD. Default: true
"OUTSIDE_IN" - sort hits for outside-in processing. Default: true

Parameters:

name - Name of parameter to be set. Case is ignored.

value - Value to be assigned to the parameter.

Throws:

NoSuchParameterException - Thrown if the supplied parameter name is unknown. Subclasses may catch this exception after a call to super.set() and set their own parameters.

set

public void set(String name)

Set any boolean parameter to true. See set(String, boolean) for a list of parameters that can be set with this method.

Parameters:

name - Name of parameter to be set

Throws:

NoSuchParameterException - Thrown if the supplied parameter name is unknown. Subclasses may catch this exception after a call to super.set() and set their own parameters.

set

public void set(String name,
       double value)

Set any double parameter. The following parameters can be set with this method:
"DISTANCE_CUT" - Combine SimTrackerHits that are less than this distance apart. Default: 200 mkm.
"BARREL_TILING" - Default: 10 cm.
"ENDCAP_TILING" - Default: 10 cm.
"SIMPLE_ERROR" - Position error to be assigned to hits. Default: 50 mkm.

Parameters:

name - Name of parameter to be set

value - Value to be assigned to the parameter.

Throws:

NoSuchParameterException - Thrown if the supplied parameter name is unknown. Subclasses may catch this exception after a call to super.set() and set their own parameters.

process

public void process(EventHeader event)

Process event, and put created list of GarfieldHits into the event.

Overrides:

process in class Driver

Parameters:

event - The event to be processed

See Also:

Driver.NextEventException, Driver.AbortRunException

findAdjacentHit

private boolean findAdjacentHit(SimTrackerHit newHit,
                      ArrayList<GarfieldHit> oldHitList)

Returns true if a GarfieldHit exists in the supplied oldHitList that is too close to the newHit, so the two should be merged. newHit is then added to the list of raw hits associated with that GarfieldHit. This is a temporary solution to get rid of multiple adjacent hits due to delta rays - should be replaced by proper digitization later.

getGarfieldLayerID

private int getGarfieldLayerID(SimTrackerHit hit)

Garfield-specific tracking layer numbering: from innermost VXD layer to outermost Tracker layer, barrels first.

barrelTrackerZ

private double barrelTrackerZ(double z,
                    int end,
                    int layer)

Very black magic

is3D

private boolean is3D(SimTrackerHit hit)

Returns true if hit supplied as an argument has information about all three coordinates (this implementation is very detector and package specific).

isEven

private boolean isEven(int i)

isVXD

private boolean isVXD(SimTrackerHit hit)

Returns true if the hit is in vertex detector.