org.lcsim.detector.tracker.silicon

Class HpsSiSensor

java.lang.Object

org.lcsim.detector.DetectorElement

org.lcsim.detector.tracker.silicon.SiSensor

org.lcsim.detector.tracker.silicon.HpsSiSensor

All Implemented Interfaces:

org.lcsim.detector.identifier.Identifiable, org.lcsim.detector.IDetectorElement

Direct Known Subclasses:

HpsTestRunSiSensor, HpsThinSiSensor

public class HpsSiSensor
extends org.lcsim.detector.tracker.silicon.SiSensor

This class extends SiSensor with conditions specific to HPS SVT half-modules (sensors) used during the engineering run and beyond. Each half-module is uniquely identified by a FEB ID/Hybrid ID pair which is then related to calibration conditions such as baseline, noise, gain etc.

Author:

Omar Moreno, SLAC National Accelerator Laboratory

Field Summary

Fields

Modifier and Type	Field and Description
static int	AMPLITUDE_INDEX
protected Set<Integer>	badChannels
static String	ELECTRON_SIDE
protected int	febHybridID
protected int	febID
protected Map<Integer,Double>	gainMap
protected boolean	isAxial
protected boolean	isStereo
protected double	longSensorLengthThreshold
protected int	millepedeId
protected Map<Integer,double[]>	noiseMap
static int	NUMBER_OF_SAMPLES
private static int	NUMBER_OF_SHAPE_FIT_PARAMETERS
protected Map<Integer,Double>	offsetMap
protected Map<Integer,double[]>	pedestalMap
static String	POSITRON_SIDE
protected double	readoutLongStripCapacitanceSlope
private double	readoutStripCapacitanceIntercept
private double	readoutStripCapacitanceSlope
protected double	senseLongStripCapacitanceSlope
private double	senseStripCapacitanceIntercept
private double	senseStripCapacitanceSlope
protected Map<Integer,double[]>	shapeFitParametersMap
static int	T0_INDEX
protected double	t0Shift
static int	TP_INDEX

Constructor Summary

Constructors

Constructor and Description
HpsSiSensor(int sensorid, String name, org.lcsim.detector.IDetectorElement parent, String support, org.lcsim.detector.identifier.IIdentifier id) This class constructor matches the signature of SiSensor.

Method Summary

Modifier and Type	Method and Description
int	getFebHybridID() Get the FEB hybrid ID of the sensor.
int	getFebID() Get the front end board (FEB) ID associated with this sensor.
Double	getGain(int channel) Get the gain for the given channel.
int	getLayerNumber() Get the layer number of the sensor.
int	getMillepedeId() Get the sensor id used by millepede.
int	getModuleNumber() Get the module number of the sensor.
Double	getNoise(int channel, int sample) Get the noise for the given channel and sample number.
int	getNumberOfChannels() Get the total number of channels in the sensor.
int	getNumberOfSenseStrips()
Double	getOffset(int channel) Get the offset for the given channel.
Double	getPedestal(int channel, int sample) Get the pedestal for the given channel and sample number.
double	getReadoutStripPitch()
double	getReadoutTransferEfficiency()
double	getSenseStripPitch()
double	getSenseTransferEfficiency()
double[]	getShapeFitParameters(int channel) Get the shape fit parameters (amplitude, t0, tp) associated with a given channel.
String	getSide() Get the sensor side (ELECTRON or POSITRON).
protected double	getStripLength() Return the length of an HpsSiSensor strip.
double	getT0Shift() Get the t0 shift for this sensor.
org.lcsim.detector.tracker.silicon.SiTrackerIdentifierHelper	getTrackerIdHelper() Get the specific type of identifier helper for this component.
void	initialize() Setup the geometry and electrical characteristics of an HpsSiSensor
boolean	isAxial() Get whether this sensor is axial.
boolean	isBadChannel(int channel) Get whether the given channel is bad or not.
boolean	isBottomLayer() Get whether this sensor is in the bottom half of the detector.
boolean	isStereo() Get whether this sensor is stereo.
boolean	isTopLayer() Get whether this sensor is in the top half of the detector.
boolean	isValidChannel(int channel) Get whether the given channel number if valid.
long	makeChannelID(int channel) Generate an ID for a channel (strip) on a sensor.
void	reset() Reset the time dependent conditions data of this sensor.
void	setAxial(boolean isAxial) Flag the sensor as being axial.
void	setBadChannel(int channel) Flag the given channel as bad.
void	setFebHybridID(int febHybridID) Set the FEB hybrid ID of the sensor.
void	setFebID(int febID) Set the front end board (FEB) ID of the sensor.
void	setGain(int channel, double gain) Set the gain value for the given channel.
void	setMillepedeId(int id) Set the sensor id used by millepede.
void	setNoise(int channel, double[] noise) Set the noise value for the given channel.
void	setOffset(int channel, double offset) Set the offset for the given channel.
void	setPedestal(int channel, double[] pedestal) Set the pedestal value for all samples for a given channel.
void	setShapeFitParameters(int channel, double[] shapeFitParameters) Set the shape fit results for the given channel.
void	setStereo(boolean isStereo) Flag the sensor as being stereo
void	setT0Shift(double t0Shift) Set the t0 shift for this sensor.
String	toString()

Methods inherited from class org.lcsim.detector.tracker.silicon.SiSensor

distanceFromSide, electricField, getBField, getBiasSurface, getBiasVoltage, getBulk, getDepletionVoltage, getReadoutElectrodes, getReadoutElectrodes, getSenseElectrodes, getSenseElectrodes, getSensorID, getThickness, getTransferEfficiencies, hasElectrodesOnSide, hasPixels, hasStrips, isACCoupled, isDoubleSided, makeStripId, setBiasSurface, setBiasVoltage, setBulk, setDepletionVoltage, setReadoutElectrodes, setSenseElectrodes, setSensorID, setTransferEfficiencies

Methods inherited from class org.lcsim.detector.DetectorElement

addChild, clearReadouts, createReadout, findAncestors, findDescendants, findDetectorElement, findDetectorElement, findDetectorElement, findDetectorElement, getAncestry, getChildren, getExpandedIdentifier, getGeometry, getIdentifier, getIdentifierHelper, getName, getParameters, getParent, getReadout, getTop, hasChildren, hasGeometryInfo, hasReadout, isAncestor, isDescendant, isSensitive, setIdentifier, setIdentifierHelper, setParameters, setParent, setReadout, setSupport, setSupport, traverseAncestors, traverseDescendantsPostOrder, traverseDescendantsPreOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NUMBER_OF_SAMPLES

public static final int NUMBER_OF_SAMPLES

See Also:

Constant Field Values

NUMBER_OF_SHAPE_FIT_PARAMETERS

private static final int NUMBER_OF_SHAPE_FIT_PARAMETERS

See Also:

Constant Field Values

AMPLITUDE_INDEX

public static final int AMPLITUDE_INDEX

See Also:

Constant Field Values

T0_INDEX

public static final int T0_INDEX

See Also:

Constant Field Values

TP_INDEX

public static final int TP_INDEX

See Also:

Constant Field Values

ELECTRON_SIDE

public static final String ELECTRON_SIDE

See Also:

Constant Field Values

POSITRON_SIDE

public static final String POSITRON_SIDE

See Also:

Constant Field Values

febID

protected int febID

febHybridID

protected int febHybridID

t0Shift

protected double t0Shift

isAxial

protected boolean isAxial

isStereo

protected boolean isStereo

readoutStripCapacitanceIntercept

private final double readoutStripCapacitanceIntercept

See Also:

Constant Field Values

readoutStripCapacitanceSlope

private final double readoutStripCapacitanceSlope

See Also:

Constant Field Values

senseStripCapacitanceIntercept

private final double senseStripCapacitanceIntercept

See Also:

Constant Field Values

senseStripCapacitanceSlope

private final double senseStripCapacitanceSlope

See Also:

Constant Field Values

longSensorLengthThreshold

protected double longSensorLengthThreshold

readoutLongStripCapacitanceSlope

protected double readoutLongStripCapacitanceSlope

senseLongStripCapacitanceSlope

protected double senseLongStripCapacitanceSlope

pedestalMap

protected Map<Integer,double[]> pedestalMap

noiseMap

protected Map<Integer,double[]> noiseMap

gainMap

protected Map<Integer,Double> gainMap

offsetMap

protected Map<Integer,Double> offsetMap

shapeFitParametersMap

protected Map<Integer,double[]> shapeFitParametersMap

badChannels

protected Set<Integer> badChannels

millepedeId

protected int millepedeId

Constructor Detail

HpsSiSensor

public HpsSiSensor(int sensorid,
                   String name,
                   org.lcsim.detector.IDetectorElement parent,
                   String support,
                   org.lcsim.detector.identifier.IIdentifier id)

This class constructor matches the signature of SiSensor.

Parameters:

sensorid - The sensor ID.

name - The name of the sensor.

parent - The parent DetectorElement.

support - The physical support path.

id - The identifier of the sensor.

Method Detail

isTopLayer

public boolean isTopLayer()

Get whether this sensor is in the top half of the detector. Modules in the top half have module numbers of 0 or 2.

Returns:

True if sensor is in top layer; false if not.

isBottomLayer

public boolean isBottomLayer()

Get whether this sensor is in the bottom half of the detector. Modules in the bottom half have module numbers of 1 or 3.

Returns:

True if sensor is in bottom layer; false if not.

getModuleNumber

public int getModuleNumber()

Get the module number of the sensor.

Returns:

The module number of the sensor.

getTrackerIdHelper

public org.lcsim.detector.tracker.silicon.SiTrackerIdentifierHelper getTrackerIdHelper()

Get the specific type of identifier helper for this component.

Returns:

The identifier helper.

isAxial

public boolean isAxial()

Get whether this sensor is axial.

Returns:

True if sensor is axial; false if not.

isStereo

public boolean isStereo()

Get whether this sensor is stereo.

Returns:

True is sensor is stereo; false if not.

getPedestal

public Double getPedestal(int channel,
                          int sample)

Get the pedestal for the given channel and sample number.

Parameters:

channel - The channel number.

sample - The sample number.

Returns:

The pedestal value for the given channel and sample or null if not set.

getNoise

public Double getNoise(int channel,
                       int sample)

Get the noise for the given channel and sample number.

Parameters:

channel - The channel number.

sample - The sample number.

Returns:

The noise value for the given channel and sample or null if not set.

getGain

public Double getGain(int channel)

Get the gain for the given channel.

Parameters:

channel - The channel number.

Returns:

The gain value for the channel or null if not set.

getOffset

public Double getOffset(int channel)

Get the offset for the given channel.

Parameters:

channel - The channel number.

Returns:

The offset for the channel or null if not set.

getReadoutTransferEfficiency

public double getReadoutTransferEfficiency()

Returns:

The charge transfer efficiency of the readout strips.

getSenseTransferEfficiency

public double getSenseTransferEfficiency()

Returns:

The charge transfer efficiency of the sense strips.

getShapeFitParameters

public double[] getShapeFitParameters(int channel)

Get the shape fit parameters (amplitude, t0, tp) associated with a given channel.

Parameters:

channel - The channel number.

Returns:

The shape fit results for the channel.

isBadChannel

public boolean isBadChannel(int channel)

Get whether the given channel is bad or not.

Parameters:

channel - The channel number.

Returns:

True if channel is bad; false if not.

getNumberOfChannels

public int getNumberOfChannels()

Get the total number of channels in the sensor.

Returns:

The total number of channels in the sensor.

getNumberOfSenseStrips

public int getNumberOfSenseStrips()

Returns:

The total number of sense strips per sensor.

isValidChannel

public boolean isValidChannel(int channel)

Get whether the given channel number if valid.

Parameters:

channel - The channel number.

Returns:

True if channel number is valid; false if not.

getFebID

public int getFebID()

Get the front end board (FEB) ID associated with this sensor.

Returns:

The FEB ID

getFebHybridID

public int getFebHybridID()

Get the FEB hybrid ID of the sensor.

Returns:

The FEB hybrid number of the sensor.

getLayerNumber

public int getLayerNumber()

Get the layer number of the sensor.

Returns:

The layer number of the sensor.

getT0Shift

public double getT0Shift()

Get the t0 shift for this sensor.

Returns:

The t0 shift for this sensor.

getSide

public String getSide()

Get the sensor side (ELECTRON or POSITRON). For single sensor half-modules, the side will always be ELECTRON.

Returns:

The side the sensor is on (ELECTRON or POSITRON)

getReadoutStripPitch

public double getReadoutStripPitch()

Returns:

The readout strip pitch.

getSenseStripPitch

public double getSenseStripPitch()

Returns:

The sense strip pitch.

makeChannelID

public long makeChannelID(int channel)

Generate an ID for a channel (strip) on a sensor.

Parameters:

channel - : Physical channel number

Returns:

the channel ID

setPedestal

public void setPedestal(int channel,
                        double[] pedestal)

Set the pedestal value for all samples for a given channel.

Parameters:

channel - The channel number.

pedestal - The pedestal values for all samples.

setNoise

public void setNoise(int channel,
                     double[] noise)

Set the noise value for the given channel.

Parameters:

channel - The channel number.

noise - The noise values for all samples.

setGain

public void setGain(int channel,
                    double gain)

Set the gain value for the given channel.

Parameters:

channel - The channel number.

gain - The gain value.

setOffset

public void setOffset(int channel,
                      double offset)

Set the offset for the given channel.

Parameters:

channel - The channel number.

offset - The offset value.

setShapeFitParameters

public void setShapeFitParameters(int channel,
                                  double[] shapeFitParameters)

Set the shape fit results for the given channel.

Parameters:

channel - The channel number.

shapeFitParameters - The shape fit results array (should be length 4).

setBadChannel

public void setBadChannel(int channel)

Flag the given channel as bad.

Parameters:

channel - The channel number.

setFebID

public void setFebID(int febID)

Set the front end board (FEB) ID of the sensor.

Parameters:

febID - FEB ID The FEB ID of the sensor.

setFebHybridID

public void setFebHybridID(int febHybridID)

Set the FEB hybrid ID of the sensor.

Parameters:

febHybridID - FEB hybrid ID The FEB hybrid ID.

setT0Shift

public void setT0Shift(double t0Shift)

Set the t0 shift for this sensor.

Parameters:

t0Shift - The t0 shift for this sensor.

setAxial

public void setAxial(boolean isAxial)

Flag the sensor as being axial.

Parameters:

isAxial - true if the sensor is Axial, false otherwise

setStereo

public void setStereo(boolean isStereo)

Flag the sensor as being stereo

Parameters:

isStereo - true is the sensor is stereo, false otherwise

reset

public void reset()

Reset the time dependent conditions data of this sensor. This does NOT reset the sensor setup information, which is assumed to be fixed once it is setup for a given session.

toString

public String toString()

Overrides:

toString in class org.lcsim.detector.tracker.silicon.SiSensor

initialize

public void initialize()

Setup the geometry and electrical characteristics of an HpsSiSensor

Specified by:

initialize in interface org.lcsim.detector.IDetectorElement

Overrides:

initialize in class org.lcsim.detector.DetectorElement

getStripLength

protected double getStripLength()

Return the length of an HpsSiSensor strip. This is done by getting the face of the HpsSiSensor and returning the length of the longest edge.

Returns:

The length of the longest HpsSiSensor edge

setMillepedeId

public void setMillepedeId(int id)

Set the sensor id used by millepede.

Parameters:

id - - millepede sensor id

getMillepedeId

public int getMillepedeId()

Get the sensor id used by millepede.

Returns:

the millepede sensor id.