EcalRawConverterDriver (HPS Java 4.3-SNAPSHOT API)

java.lang.Object
- org.lcsim.util.Driver
- - org.hps.recon.ecal.EcalRawConverterDriver

```
public class EcalRawConverterDriver
extends org.lcsim.util.Driver
```
This Driver converts raw ECal data collections to CalorimeterHit collections with energy and time information. The EcalRawConverter does most of the low-level work.
The following input collections are used:
- EcalReadoutHits
- EcalReadoutExtraDataRelations
- EcalRunningPedestals
The results are by default written to the EcalCalHits output collection.

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

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`applyBadCrystalMap` Whether to reject bad crystals.
`private EcalRawConverter`	`converter`
`private boolean`	`debug`
`private boolean`	`display`
`private boolean`	`dropBadFADC` Whether to reject bad FADC channels.
`private String`	`ecalCollectionName` Output collection name (unless runBackwards=true, then it's input).
`private EcalConditions`	`ecalConditions`
`private String`	`ecalReadoutName` ecalCollectionName "type" (must match detector-data)
`private boolean`	`emulateFirmware` Whether to perform "firmware algorithm" on Mode-1 data.
`private static String`	`extraDataRelationsName`
`private String`	`rawCollectionName` Input collection name (unless runBackwards=true, then it's output).
`private boolean`	`runBackwards` If true, convert ecalCollectionName to rawCollectionName (GeV to ADC).
`private double`	`threshold` Hit threshold in GeV.
`private boolean`	`useDAQConfig` Whether to use DAQ config read from EVIO for EcalRawConverter parameters.
`private boolean`	`useTimestamps`
`private boolean`	`useTruthTime`

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

Constructor Summary

Constructors
Constructor and Description

EcalRawConverterDriver()

Constructors
Constructor and Description
`EcalRawConverterDriver()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`detectorChanged(org.lcsim.geometry.Detector detector)`
`private EcalChannelConstants`	`findChannel(long cellID)` Convert physical ID to gain value.
`private int`	`getCrate(long cellID)` Return crate number from cellID
`private int`	`getSlot(long cellID)` Return slot number from cellID
`private static double`	`getTimestamp(int system, org.lcsim.event.EventHeader event)`
`boolean`	`isBadCrystal(org.lcsim.event.CalorimeterHit hit)`
`boolean`	`isBadFADC(org.lcsim.event.CalorimeterHit hit)`
`void`	`process(org.lcsim.event.EventHeader event)`
`void`	`setApplyBadCrystalMap(boolean apply)` Set to `true` to ignore data from channels that are flagged as "bad" in the conditions system.
`void`	`setDebug(boolean debug)` Set to `true` to turn on debug output.
`void`	`setDisplay(boolean display)`
`void`	`setDropBadFADC(boolean dropBadFADC)` Set to `true` to drop hits that are mapped to a hard-coded bad FADC configuration from the Test Run.
`void`	`setEcalCollectionName(String ecalCollectionName)` Set the `CalorimeterHit` collection name, which is used as input in "normal" mode and output when running "backwards".
`void`	`setEmulateFirmware(boolean emulateFirmware)` Set to `true` to emulate firmware conversion of Mode-1 to Mode-3/7 data.
`void`	`setEmulateMode7(boolean mode7)` Set to `true` to use Mode-7 emulation in calculations.
`void`	`setFitLimitTimeHi(int sample)`
`void`	`setFitLimitTimeLo(int sample)` Constrain pulse fit time0 parameter.
`void`	`setFitThresholdTimeHi(int sample)`
`void`	`setFitThresholdTimeLo(int sample)` Limit threshold crossing range that is candidate for pulse-fitting.
`void`	`setFixedWidth(boolean fixedWidth)`
`void`	`setFixShapeParameter(boolean fix)` Set to `true` to fix fitted pulse widths to their channel's mean value:
`void`	`setGain(double gain)` Set a constant gain factor in the converter for all channels.
`void`	`setGlobalFixedPulseWidth(double width)` Fix 3-pole function width to be the same for all 442 ECal channels.
`void`	`setLeadingEdgeThreshold(double threshold)` Set the leading-edge threshold in ADC counts, relative to pedestal, for pulse-finding and time determination.
`void`	`setNPeak(int nPeak)` Set the maximum number of peaks to search for in the signal, which must be between 1 and 3, inclusive.
`void`	`setNsa(int nsa)` Set the integration range in nanoseconds after the threshold crossing.
`void`	`setNsb(int nsb)` Set the integration range in nanoseconds before the threshold crossing.
`void`	`setRawCollectionName(String rawCollectionName)` Set the raw collection name which is used as output in "normal" mode and input when running "backwards".
`void`	`setRunBackwards(boolean runBackwards)` Set to `true` to generate a `CalorimeterHit` collection which is a conversion from energy to raw signals.
`void`	`setThreshold(double threshold)` Set a minimum energy threshold in GeV for created `CalorimeterHit` objects to be written into the output collection.
`void`	`setUse2014Gain(boolean use2014Gain)` Set to `true` to use the "2014" gain formula:
`void`	`setUseDAQConfig(boolean state)` Sets whether the driver should use the DAQ configuration from EvIO file for its parameters.
`void`	`setUseFit(boolean useFit)` Set to `true` to use pulse fitting instead of arithmetic integration:
`void`	`setUseRunningPedestal(boolean useRunningPedestal)` Set to `true` to use a running pedestal calibration from mode 7 data.
`void`	`setUseTimestamps(boolean useTimestamps)` Set to `true` to use timestamp information from the ECal or trigger.
`void`	`setUseTimeWalkCorrection(boolean useTimeWalkCorrection)` Set to `true` to apply time walk correction from `EcalTimeWalk.correctTimeWalk(double, double)`.
`void`	`setUseTruthTime(boolean useTruthTime)` Set to `true` to use MC truth information.
`void`	`setWindowSamples(int windowSamples)` Set the number of samples in the FADC readout window.
`void`	`startOfData()`

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

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

- Field Detail
  - ecalConditions
```
private EcalConditions ecalConditions
```
  - converter
```
private EcalRawConverter converter
```
  - rawCollectionName
```
private String rawCollectionName
```
    Input collection name (unless runBackwards=true, then it's output). Can be a RawTrackerHit or RawCalorimeterHit These have ADC and sample time information.
  - ecalCollectionName
```
private String ecalCollectionName
```
    Output collection name (unless runBackwards=true, then it's input). Always a CalorimeterHit This has energy (GeV) and ns time information.
  - ecalReadoutName
```
private final String ecalReadoutName
```
    ecalCollectionName "type" (must match detector-data)
    
    See Also:
    
    Constant Field Values
  - extraDataRelationsName
```
private static final String extraDataRelationsName
```
    See Also:
    
    Constant Field Values
  - debug
```
private boolean debug
```
  - threshold
```
private double threshold
```
    Hit threshold in GeV. Anything less will not be put into LCIO.
  - applyBadCrystalMap
```
private boolean applyBadCrystalMap
```
    Whether to reject bad crystals.
  - dropBadFADC
```
private boolean dropBadFADC
```
    Whether to reject bad FADC channels.
  - runBackwards
```
private boolean runBackwards
```
    If true, convert ecalCollectionName to rawCollectionName (GeV to ADC). Else, convert rawCollectionName to ecalCollectionName (ADC to GeV).
  - useTimestamps
```
private boolean useTimestamps
```
  - useTruthTime
```
private boolean useTruthTime
```
  - useDAQConfig
```
private boolean useDAQConfig
```
    Whether to use DAQ config read from EVIO for EcalRawConverter parameters. Should be completely removed to a standalone class soilely for trigger emulation.
  - emulateFirmware
```
private boolean emulateFirmware
```
    Whether to perform "firmware algorithm" on Mode-1 data. If so, this includes finding a threshold crossing, extracting a pulse time, and integrating over some configurable sample range inside the window to extract pulse integral. If not, it simply integrates the entire window and makes no attempt at extracting pulse time. This is poorly named.
  - display
```
private boolean display
```
- Constructor Detail
  - EcalRawConverterDriver
```
public EcalRawConverterDriver()
```
- Method Detail
  - setUseFit
```
public void setUseFit(boolean useFit)
```
    Set to true to use pulse fitting instead of arithmetic integration:
  - setGlobalFixedPulseWidth
```
public void setGlobalFixedPulseWidth(double width)
```
    Fix 3-pole function width to be the same for all 442 ECal channels. Units=samples.
  - setFixShapeParameter
```
public void setFixShapeParameter(boolean fix)
```
    Set to true to fix fitted pulse widths to their channel's mean value:
  - setFitThresholdTimeLo
```
public void setFitThresholdTimeLo(int sample)
```
    Limit threshold crossing range that is candidate for pulse-fitting. Units=samples.
  - setFitThresholdTimeHi
```
public void setFitThresholdTimeHi(int sample)
```
  - setFitLimitTimeLo
```
public void setFitLimitTimeLo(int sample)
```
    Constrain pulse fit time0 parameter. Units=samples.
  - setFitLimitTimeHi
```
public void setFitLimitTimeHi(int sample)
```
  - setUse2014Gain
```
public void setUse2014Gain(boolean use2014Gain)
```
    Set to true to use the "2014" gain formula:
```
channelGain * adcSum * gainFactor * readoutPeriod
```
    Set to false to use the gain formula for the Test Run:
```
gain * adcSum * ECalUtils.MeV
```
    Parameters:
    
    use2014Gain - True to use 2014 gain formulation.
  - setUseTimeWalkCorrection
```
public void setUseTimeWalkCorrection(boolean useTimeWalkCorrection)
```
    Set to true to apply time walk correction from EcalTimeWalk.correctTimeWalk(double, double).
    This is only applicable to Mode-3 data.
    
    Parameters:
    
    useTimeWalkCorrection - True to apply time walk correction.
  - setUseRunningPedestal
```
public void setUseRunningPedestal(boolean useRunningPedestal)
```
    Set to true to use a running pedestal calibration from mode 7 data.
    The running pedestal values are retrieved from the event collection "EcalRunningPedestals" which is a Map between EcalChannel objects are their average pedestal.
    
    Parameters:
    
    useRunningPedestal - True to use a running pedestal value.
  - setFixedWidth
```
public void setFixedWidth(boolean fixedWidth)
```
  - setRunBackwards
```
public void setRunBackwards(boolean runBackwards)
```
    Set to true to generate a CalorimeterHit collection which is a conversion from energy to raw signals.
    
    Parameters:
    
    runBackwards - True to run the procedure backwards.
  - setDropBadFADC
```
public void setDropBadFADC(boolean dropBadFADC)
```
    Set to true to drop hits that are mapped to a hard-coded bad FADC configuration from the Test Run.
    
    Parameters:
    
    dropBadFADC - True to drop hits mapped to a bad FADC.
  - setThreshold
```
public void setThreshold(double threshold)
```
    Set a minimum energy threshold in GeV for created CalorimeterHit objects to be written into the output collection.
    
    Parameters:
    
    threshold - The minimum energy threshold in GeV.
  - setEmulateMode7
```
public void setEmulateMode7(boolean mode7)
```
    Set to true to use Mode-7 emulation in calculations. False is Mode-3.
    
    Parameters:
    
    mode7 - True to use Mode-7 emulation in calculations.
  - setEmulateFirmware
```
public void setEmulateFirmware(boolean emulateFirmware)
```
    Set to true to emulate firmware conversion of Mode-1 to Mode-3/7 data.
    
    Parameters:
    
    emulateFirmware - True to use firmware emulation.
  - setLeadingEdgeThreshold
```
public void setLeadingEdgeThreshold(double threshold)
```
    Set the leading-edge threshold in ADC counts, relative to pedestal, for pulse-finding and time determination.
    Used to convert Mode-1 readout into Mode-3 or Mode-7 data that is usable by clustering.
    
    Parameters:
    
    threshold - The leading edge threshold in ADC counts.
  - setWindowSamples
```
public void setWindowSamples(int windowSamples)
```
    Set the number of samples in the FADC readout window.
    This is needed in order to properly pedestal-correct clipped pulses for mode-3 and mode-7. It is ignored for mode-1 input, since this data already includes the number of samples.
    A non-positive number disables pulse-clipped pedestals and reverts to the old behavior which assumed that the integration range was constant.
    
    Parameters:
    
    windowSamples - The number of samples in the FADC readout window.
  - setNsa
```
public void setNsa(int nsa)
```
    Set the integration range in nanoseconds after the threshold crossing.
    These numbers must be multiples of 4 nanoseconds.
    This value is used for pulse integration in Mode-1, and pedestal subtraction in all modes.
    
    Parameters:
    
    nsa - The number of nanoseconds after the threshold crossing.
    
    See Also:
    
    setNsb(int)
  - setNsb
```
public void setNsb(int nsb)
```
    Set the integration range in nanoseconds before the threshold crossing.
    These numbers must be multiples of 4 nanoseconds.
    This value is used for pulse integration in Mode-1, and pedestal subtraction in all modes.
    
    Parameters:
    
    nsb - The number of nanoseconds after the threshold crossing.
    
    See Also:
    
    setNsa(int)
  - setNPeak
```
public void setNPeak(int nPeak)
```
    Set the maximum number of peaks to search for in the signal, which must be between 1 and 3, inclusive.
    
    Parameters:
    
    nPeak - The maximum number of peaks to search for in the signal.
  - setGain
```
public void setGain(double gain)
```
    Set a constant gain factor in the converter for all channels.
    
    Parameters:
    
    gain - The constant gain value.
  - setEcalCollectionName
```
public void setEcalCollectionName(String ecalCollectionName)
```
    Set the CalorimeterHit collection name, which is used as input in "normal" mode and output when running "backwards".
    
    Parameters:
    
    ecalCollectionName - The CalorimeterHit collection name.
    
    See Also:
    
    runBackwards
  - setRawCollectionName
```
public void setRawCollectionName(String rawCollectionName)
```
    Set the raw collection name which is used as output in "normal" mode and input when running "backwards".
    Depending on the Driver configuration, this could be a collection of RawTrackerHit objects for Mode-1 or RawCalorimeterHit objects for Mode-3 or Mode-7.
    
    Parameters:
    
    rawCollectionName - The raw collection name.
  - setApplyBadCrystalMap
```
public void setApplyBadCrystalMap(boolean apply)
```
    Set to true to ignore data from channels that are flagged as "bad" in the conditions system.
    
    Parameters:
    
    apply - True to ignore bad channels.
  - setDebug
```
public void setDebug(boolean debug)
```
    Set to true to turn on debug output.
    
    Parameters:
    
    debug - True to turn on debug output.
  - setDisplay
```
public void setDisplay(boolean display)
```
  - setUseTimestamps
```
public void setUseTimestamps(boolean useTimestamps)
```
    Set to true to use timestamp information from the ECal or trigger.
    
    Parameters:
    
    useTimestamps - True to use timestamp information.
  - setUseTruthTime
```
public void setUseTruthTime(boolean useTruthTime)
```
    Set to true to use MC truth information.
    
    Parameters:
    
    useTruthTime - True to use MC truth information.
  - setUseDAQConfig
```
public void setUseDAQConfig(boolean state)
```
    Sets whether the driver should use the DAQ configuration from EvIO file for its parameters. If activated, the converter will obtain gains, thresholds, pedestals, the window size, and the pulse integration window from the EvIO file. This will replace and overwrite any manually defined settings.
    
    Note that if this setting is active, the driver will not output any data until a DAQ configuration has been read from the data stream.
    
    Parameters:
    
    state - - true indicates that the configuration should be read from the DAQ data in an EvIO file. Setting this to false will cause the driver to use its regular manually-defined settings and pull gains and pedestals from the conditions database.
  - startOfData
```
public void startOfData()
```
    Overrides:
    
    startOfData in class org.lcsim.util.Driver
  - detectorChanged
```
public void detectorChanged(org.lcsim.geometry.Detector detector)
```
    Overrides:
    
    detectorChanged in class org.lcsim.util.Driver
  - isBadCrystal
```
public boolean isBadCrystal(org.lcsim.event.CalorimeterHit hit)
```
    Parameters:
    
    hit - the CalorimeterHit pointing to the channel
    
    Returns:
    
    false if the channel is a good one, true if it is a bad one
  - isBadFADC
```
public boolean isBadFADC(org.lcsim.event.CalorimeterHit hit)
```
    Parameters:
    
    hit - the CalorimeterHit pointing to the FADC
    
    Returns:
    
    false if the ADC is a good one, true if it is a bad one
  - getTimestamp
```
private static double getTimestamp(int system,
                                   org.lcsim.event.EventHeader event)
```
  - process
```
public void process(org.lcsim.event.EventHeader event)
```
    Overrides:
    
    process in class org.lcsim.util.Driver
  - findChannel
```
private EcalChannelConstants findChannel(long cellID)
```
    Convert physical ID to gain value.
    
    Parameters:
    
    cellID - (long)
    
    Returns:
    
    channel constants (EcalChannelConstants)
  - getCrate
```
private int getCrate(long cellID)
```
    Return crate number from cellID
    
    Parameters:
    
    cellID - (long)
    
    Returns:
    
    Crate number (int)
  - getSlot
```
private int getSlot(long cellID)
```
    Return slot number from cellID
    
    Parameters:
    
    cellID - (long)
    
    Returns:
    
    Slot number (int)

Class EcalRawConverterDriver

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

ecalConditions

converter

rawCollectionName

ecalCollectionName

ecalReadoutName

extraDataRelationsName

debug

threshold

applyBadCrystalMap

dropBadFADC

runBackwards

useTimestamps

useTruthTime

useDAQConfig

emulateFirmware

display

Constructor Detail

EcalRawConverterDriver

Method Detail

setUseFit

setGlobalFixedPulseWidth

setFixShapeParameter

setFitThresholdTimeLo

setFitThresholdTimeHi

setFitLimitTimeLo

setFitLimitTimeHi

setUse2014Gain

setUseTimeWalkCorrection

setUseRunningPedestal

setFixedWidth

setRunBackwards

setDropBadFADC

setThreshold

setEmulateMode7

setEmulateFirmware

setLeadingEdgeThreshold

setWindowSamples

setNsa

setNsb

setNPeak

setGain

setEcalCollectionName

setRawCollectionName

setApplyBadCrystalMap

setDebug

setDisplay

setUseTimestamps

setUseTruthTime

setUseDAQConfig

startOfData

detectorChanged

isBadCrystal

isBadFADC

getTimestamp

process

findChannel

getCrate

getSlot