EvioDAQParser (HPS Java 4.3-SNAPSHOT API)

java.lang.Object
- org.hps.record.daqconfig.EvioDAQParser

```
public class EvioDAQParser
extends Object
```
Class EvioDAQParser takes DAQ configuration banks from EvIO data and extracts the configuration parameters from them. These are then stored within package-accessible variables within the class.

Note that this class should not be used directly to acquire DAQ configuration data. It is intended to be used internally by the EvIO parser and the class ConfigurationManager. The latter should be used for accessing this information for any other classes.

Author:

Nathan Baltzell

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BANK_TAG` The EvIO bank identification tag for DAQ configuration banks.
`private List<EcalChannel>`	`channels`
`private Map<String,List<String>>`	`configMap`
`private boolean`	`debug`
`private EcalConditions`	`ecalConditions`
`(package private) int`	`fadcMODE` The pulse-processing mode used by the FADC.
`(package private) int`	`fadcNPEAK` The maximum number of pulses that will be extracted from a single channel within a readout window.
`(package private) int`	`fadcNSA` The length of time after a pulse-crossing event that the pulse should be integrated.
`(package private) int`	`fadcNSB` The length of time before a pulse-crossing event that the pulse should be integrated.
`(package private) int`	`fadcOFFSET` The time-offset of the readout window in ns.
`(package private) int`	`fadcWIDTH` The size of readout window in nanoseconds.
`(package private) Map<EcalChannel,Float>`	`GAIN` Map of `EcalChannel` to the gain for that channel.
`(package private) int`	`gtpMinSeedEnergy` The seed energy lower bound cut used by the clusterer.
`(package private) int`	`gtpWindowAfter` The length of the clustering verification/inclusion window after the seed hit.
`(package private) int`	`gtpWindowBefore` The length of the clustering verification/inclusion window before the seed hit.
`private int`	`nBanks`
`(package private) boolean[]`	`pairsCoplanarityEn` Indicates whether the pair trigger pair coplanarity cuts are enabled or not.
`(package private) int[]`	`pairsCoplanarityMax` Specifies the value of the pair trigger pair coplanarity cuts.
`(package private) boolean[]`	`pairsEn` Indicates whether the pair triggers are enabled or not.
`(package private) boolean[]`	`pairsEnergyDiffEn` Indicates whether the pair trigger pair energy difference cuts are enabled or not.
`(package private) int[]`	`pairsEnergyDiffMax` Specifies the value of the pair trigger pair energy difference cuts.
`(package private) boolean[]`	`pairsEnergyDistEn` Indicates whether the pair trigger pair energy slope cuts are enabled or not.
`(package private) int[]`	`pairsEnergyDistMin` Specifies the value of the pair trigger pair energy slope cuts.
`(package private) float[]`	`pairsEnergyDistSlope` Specifies the value of the pair trigger pair energy slope cuts' parameter F.
`(package private) int[]`	`pairsEnergyMax` Specifies the value of the pair trigger cluster total energy upper bound cuts.
`(package private) int[]`	`pairsEnergyMin` Specifies the value of the pair trigger cluster total energy lower bound cuts.
`(package private) int[]`	`pairsEnergySumMax` Specifies the value of the pair trigger pair energy sum lower bound cuts.
`(package private) boolean[]`	`pairsEnergySumMaxMinEn` Indicates whether the pair trigger pair energy sum cuts are enabled or not.
`(package private) int[]`	`pairsEnergySumMin` Specifies the value of the pair trigger pair energy sum upper bound cuts.
`private static int[]`	`pairsIOsrc`
`(package private) int[]`	`pairsNhitsMin` Specifies the value of the pair trigger cluster hit count cuts.
`(package private) int[]`	`pairsTimeDiffMax` Specifies the value of the pair trigger pair time coincidence cuts.
`(package private) Map<EcalChannel,Float>`	`PEDESTAL` Map of `EcalChannel` to the pedestal for that channel.
`(package private) boolean[]`	`singlesEn` Indicates whether the singles triggers are enabled or not.
`(package private) int[]`	`singlesEnergyMax` Specifies the value of the singles trigger cluster total energy upper bound cuts.
`(package private) boolean[]`	`singlesEnergyMaxEn` Indicates whether the singles trigger cluster total energy upper bound cuts are enabled or not.
`(package private) int[]`	`singlesEnergyMin` Specifies the value of the singles trigger cluster total energy lower bound cuts.
`(package private) boolean[]`	`singlesEnergyMinEn` Indicates whether the singles trigger cluster total energy lower bound cuts are enabled or not.
`private static int[]`	`singlesIOsrc`
`(package private) int[]`	`singlesNhits` Specifies the value of the singles trigger cluster hit count cuts.
`(package private) boolean[]`	`singlesNhitsEn` Indicates whether the singles trigger cluster hit count cuts are enabled or not.
`private int`	`thisFadcSlot`
`(package private) Map<EcalChannel,Integer>`	`THRESHOLD` Map of `EcalChannel` to the threshold for that channel.

Constructor Summary

Constructors
Constructor and Description

EvioDAQParser()
Instantiates the EvioDAQParser.

Constructors
Constructor and Description
`EvioDAQParser()` Instantiates the `EvioDAQParser`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EcalChannel`	`findChannel(int channel_id)` Gets the database crystal channel object based on the crystal's numerical index.
`EcalChannel`	`findChannel(int crate, int fadcSlot, int fadcChan)` Gets the database calorimeter channel for a channel defined by a crate number, FADC slot, and FADC channel.
`private void`	`fixConfigMap2014Run(int runNumber)` Method corrects parameter data for runs that either did not correctly record the full configuration data or were bugged.
`boolean`	`getBoolConfigSSP(int itrig, String stub, int ival)` Gets an SSP parameter value using a shortened version of the full parameter key and parses it as a `boolean`.
`String`	`getConfigParameter(String key, int ival)` Gets a parameter value associated with a parameter key.
`String`	`getConfigSSP(int itrig, String stub, int ival)` Gets an SSP parameter value using a shortened version of the full parameter key.
`float`	`getFloatConfigSSP(int itrig, String stub, int ival)` Gets an SSP parameter value using a shortened version of the full parameter key and parses it as a `float`.
`int`	`getIntConfigSSP(int itrig, String stub, int ival)` Gets an SSP parameter value using a shortened version of the full parameter key and parses it as a `int`.
`private void`	`loadConfigMap(int crate, String[] configTables)` Converts the textual configuration information into a map, where the first column value becomes the map entry key and the remainder becomes the map entry value.
`void`	`parse(int crate, int runNumber, String[] configurationTables)` Parses a set of configuration tables to obtain DAQ configuration parameters.
`void`	`parseConfigMap()` Parses the configuration parameter map entries and extracts the parameter values for those parameters which have the standard format of `[PARAMETER KEY] --> { [PARAMETER VALUES] }`.
`private void`	`parseFADC(int crate, String key, List<String> vals)` Parses FADC configuration parameter entries.
`void`	`printMap()` Prints the mapped parameter keys and values to the terminal.
`void`	`printVars()` Prints the parsed parameter values to the terminal.
`private void`	`setChannelParsFloat(int crate, int slot, Map<EcalChannel,Float> map, List<String> vals)` Takes a list of 16 values (in argument `vals`) and maps the appropriate database calorimeter channel to the list value.
`private void`	`setChannelParsInt(int crate, int slot, Map<EcalChannel,Integer> map, List<String> vals)` Takes a list of 16 values (in argument `vals`) and maps the appropriate database calorimeter channel to the list value.

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

- Field Detail
  - BANK_TAG
```
public static final int BANK_TAG
```
    The EvIO bank identification tag for DAQ configuration banks.
    
    See Also:
    
    Constant Field Values
  - singlesIOsrc
```
private static final int[] singlesIOsrc
```
  - pairsIOsrc
```
private static final int[] pairsIOsrc
```
  - configMap
```
private Map<String,List<String>> configMap
```
  - nBanks
```
private int nBanks
```
  - debug
```
private boolean debug
```
  - fadcNSA
```
int fadcNSA
```
    The length of time after a pulse-crossing event that the pulse should be integrated. Uses units of clock-cycles.
  - fadcNSB
```
int fadcNSB
```
    The length of time before a pulse-crossing event that the pulse should be integrated. Uses units of clock-cycles.
  - fadcNPEAK
```
int fadcNPEAK
```
    The maximum number of pulses that will be extracted from a single channel within a readout window.
  - fadcMODE
```
int fadcMODE
```
    The pulse-processing mode used by the FADC. This should be 1, 3, or 7.
  - fadcWIDTH
```
int fadcWIDTH
```
    The size of readout window in nanoseconds.
  - fadcOFFSET
```
int fadcOFFSET
```
    The time-offset of the readout window in ns.
  - GAIN
```
Map<EcalChannel,Float> GAIN
```
    Map of EcalChannel to the gain for that channel. Uses units of ADC / MeV for the mapped value.
  - PEDESTAL
```
Map<EcalChannel,Float> PEDESTAL
```
    Map of EcalChannel to the pedestal for that channel. Uses units of ADC for the mapped value.
  - THRESHOLD
```
Map<EcalChannel,Integer> THRESHOLD
```
    Map of EcalChannel to the threshold for that channel. Uses units of ADC for the mapped value.
  - gtpMinSeedEnergy
```
int gtpMinSeedEnergy
```
    The seed energy lower bound cut used by the clusterer. Value is in units of MeV.
  - gtpWindowBefore
```
int gtpWindowBefore
```
    The length of the clustering verification/inclusion window before the seed hit. Uses units of clock-cycles.
  - gtpWindowAfter
```
int gtpWindowAfter
```
    The length of the clustering verification/inclusion window after the seed hit. Uses units of clock-cycles.
  - singlesEn
```
boolean[] singlesEn
```
    Indicates whether the singles triggers are enabled or not. Uses the format { Singles0_Enabled, Singles1_Enabled }.
  - pairsEn
```
boolean[] pairsEn
```
    Indicates whether the pair triggers are enabled or not. Uses the format { Pair0_Enabled, Pair1_Enabled }.
  - singlesNhitsEn
```
boolean[] singlesNhitsEn
```
    Indicates whether the singles trigger cluster hit count cuts are enabled or not. Uses the format { Singles0_Cut_Enabled, Singles1_Cut_Enabled }.
  - singlesEnergyMinEn
```
boolean[] singlesEnergyMinEn
```
    Indicates whether the singles trigger cluster total energy lower bound cuts are enabled or not. Uses the format { Singles0_Cut_Enabled, Singles1_Cut_Enabled }.
  - singlesEnergyMaxEn
```
boolean[] singlesEnergyMaxEn
```
    Indicates whether the singles trigger cluster total energy upper bound cuts are enabled or not. Uses the format { Singles0_Cut_Enabled, Singles1_Cut_Enabled }.
  - pairsEnergySumMaxMinEn
```
boolean[] pairsEnergySumMaxMinEn
```
    Indicates whether the pair trigger pair energy sum cuts are enabled or not. Uses the format { Pair0_Cut_Enabled, Pair1_Cut_Enabled }.
  - pairsEnergyDiffEn
```
boolean[] pairsEnergyDiffEn
```
    Indicates whether the pair trigger pair energy difference cuts are enabled or not. Uses the format { Pair0_Cut_Enabled, Pair1_Cut_Enabled }.
  - pairsCoplanarityEn
```
boolean[] pairsCoplanarityEn
```
    Indicates whether the pair trigger pair coplanarity cuts are enabled or not. Uses the format { Pair0_Cut_Enabled, Pair1_Cut_Enabled }.
  - pairsEnergyDistEn
```
boolean[] pairsEnergyDistEn
```
    Indicates whether the pair trigger pair energy slope cuts are enabled or not. Uses the format { Pair0_Cut_Enabled, Pair1_Cut_Enabled }.
  - singlesNhits
```
int[] singlesNhits
```
    Specifies the value of the singles trigger cluster hit count cuts. Use the format, in units of hits, { Singles0_Cut_Value, Singles1_Cut_Value }.
  - singlesEnergyMin
```
int[] singlesEnergyMin
```
    Specifies the value of the singles trigger cluster total energy lower bound cuts. Use the format, in units of MeV, { Singles0_Cut_Value, Singles1_Cut_Value }.
  - singlesEnergyMax
```
int[] singlesEnergyMax
```
    Specifies the value of the singles trigger cluster total energy upper bound cuts. Use the format, in units of MeV, { Singles0_Cut_Value, Singles1_Cut_Value }.
  - pairsNhitsMin
```
int[] pairsNhitsMin
```
    Specifies the value of the pair trigger cluster hit count cuts. Use the format, in units of hits, { Pair0_Cut_Value, Pair1_Cut_Value }.
  - pairsEnergyMin
```
int[] pairsEnergyMin
```
    Specifies the value of the pair trigger cluster total energy lower bound cuts. Use the format, in units of MeV, { Pair0_Cut_Value, Pair1_Cut_Value }.
  - pairsEnergyMax
```
int[] pairsEnergyMax
```
    Specifies the value of the pair trigger cluster total energy upper bound cuts. Use the format, in units of MeV, { Pair0_Cut_Value, Pair1_Cut_Value }.
  - pairsEnergySumMin
```
int[] pairsEnergySumMin
```
    Specifies the value of the pair trigger pair energy sum upper bound cuts. Use the format, in units of MeV, { Pair0_Cut_Value, Pair1_Cut_Value }.
  - pairsEnergySumMax
```
int[] pairsEnergySumMax
```
    Specifies the value of the pair trigger pair energy sum lower bound cuts. Use the format, in units of MeV, { Pair0_Cut_Value, Pair1_Cut_Value }.
  - pairsEnergyDiffMax
```
int[] pairsEnergyDiffMax
```
    Specifies the value of the pair trigger pair energy difference cuts. Use the format, in units of MeV, { Pair0_Cut_Value, Pair1_Cut_Value }.
  - pairsCoplanarityMax
```
int[] pairsCoplanarityMax
```
    Specifies the value of the pair trigger pair coplanarity cuts. Use the format, in units of degrees, { Pair0_Cut_Value, Pair1_Cut_Value }.
  - pairsTimeDiffMax
```
int[] pairsTimeDiffMax
```
    Specifies the value of the pair trigger pair time coincidence cuts. Use the format, in units of nanoseconds, { Pair0_Cut_Value, Pair1_Cut_Value }.
  - pairsEnergyDistMin
```
int[] pairsEnergyDistMin
```
    Specifies the value of the pair trigger pair energy slope cuts. Use the format, in units of MeV, { Pair0_Cut_Value, Pair1_Cut_Value }.
  - pairsEnergyDistSlope
```
float[] pairsEnergyDistSlope
```
    Specifies the value of the pair trigger pair energy slope cuts' parameter F. Use the format, in units of MeV / mm, { Pair0_Cut_Value, Pair1_Cut_Value }.
  - thisFadcSlot
```
private int thisFadcSlot
```
  - ecalConditions
```
private EcalConditions ecalConditions
```
  - channels
```
private List<EcalChannel> channels
```
- Constructor Detail
  - EvioDAQParser
```
public EvioDAQParser()
```
    Instantiates the EvioDAQParser.
- Method Detail
  - parse
```
public void parse(int crate,
                  int runNumber,
                  String[] configurationTables)
```
    Parses a set of configuration tables to obtain DAQ configuration parameters.
    
    Parameters:
    
    crate - - The crate associated with the configuration tables.
    
    runNumber - - The run number for the current data set.
    
    configurationTables - - Tables containing DAQ configuration parameters.
  - loadConfigMap
```
private void loadConfigMap(int crate,
                           String[] configTables)
```
    Converts the textual configuration information into a map, where the first column value becomes the map entry key and the remainder becomes the map entry value.
    
    Parameters:
    
    crate - - The calorimeter crate associated with the textual configuration data.
    
    configTables - - An array of textual configuration tables that contain the DAQ configuration parameters.
  - parseConfigMap
```
public void parseConfigMap()
```
    Parses the configuration parameter map entries and extracts the parameter values for those parameters which have the standard format of [PARAMETER KEY] --> { [PARAMETER VALUES] }.
  - fixConfigMap2014Run
```
private void fixConfigMap2014Run(int runNumber)
```
    Method corrects parameter data for runs that either did not correctly record the full configuration data or were bugged. It populates missing fields with a zero value entry.
    
    Parameters:
    
    runNumber - - The run number for the current run. This is used to determine if the run is a "bugged" run.
  - parseFADC
```
private void parseFADC(int crate,
                       String key,
                       List<String> vals)
```
    Parses FADC configuration parameter entries. These all have 17 lines, the first of which is the parameter key and the subsequent being parameter values corresponding to the 16 FADC channels for the indicated FADC slot. These entries contain thresholds, gains, and pedestals.
    
    Parameters:
    
    crate - - The crate associated with this parameter entry.
    
    key - - The parameter key.
    
    vals - - A list of 16 values with indices corresponding to the FADC channel with which they are associated.
  - setChannelParsFloat
```
private void setChannelParsFloat(int crate,
                                 int slot,
                                 Map<EcalChannel,Float> map,
                                 List<String> vals)
```
    Takes a list of 16 values (in argument vals) and maps the appropriate database calorimeter channel to the list value. This assumes that the String values should be parsed to Float objects.
    
    Parameters:
    
    crate - - The calorimeter crate associated with the values.
    
    slot - - The FADC slot associated with the values.
    
    map - - The map in which to place the values.
    
    vals - - A List of 16 String objects representing the channel values. This should correspond to FADC channels 0 - 15.
  - setChannelParsInt
```
private void setChannelParsInt(int crate,
                               int slot,
                               Map<EcalChannel,Integer> map,
                               List<String> vals)
```
    Takes a list of 16 values (in argument vals) and maps the appropriate database calorimeter channel to the list value. This assumes that the String values should be parsed to Integer objects.
    
    Parameters:
    
    crate - - The calorimeter crate associated with the values.
    
    slot - - The FADC slot associated with the values.
    
    map - - The map in which to place the values.
    
    vals - - A List of 16 String objects representing the channel values.
  - printMap
```
public void printMap()
```
    Prints the mapped parameter keys and values to the terminal.
  - printVars
```
public void printVars()
```
    Prints the parsed parameter values to the terminal.
  - getFloatConfigSSP
```
public float getFloatConfigSSP(int itrig,
                               String stub,
                               int ival)
```
    Gets an SSP parameter value using a shortened version of the full parameter key and parses it as a float.
    
    Parameters:
    
    itrig - - The number of the trigger for which to obtain the parameter value.
    
    stub - - The shortened version of the parameter key. This corresponds to "SSP_HPS_[STUB]_[TRIGGER NUMBER]".
    
    ival - - The index of the value that is to be obtained.
    
    Returns:
    
    Returns the requested value if it exists. Otherwise, a value of 0 is returned and a message is logged.
  - getIntConfigSSP
```
public int getIntConfigSSP(int itrig,
                           String stub,
                           int ival)
```
    Gets an SSP parameter value using a shortened version of the full parameter key and parses it as a int.
    
    Parameters:
    
    itrig - - The number of the trigger for which to obtain the parameter value.
    
    stub - - The shortened version of the parameter key. This corresponds to "SSP_HPS_[STUB]_[TRIGGER NUMBER]".
    
    ival - - The index of the value that is to be obtained.
    
    Returns:
    
    Returns the requested value if it exists. Otherwise, a value of 0 is returned and a message is logged.
  - getBoolConfigSSP
```
public boolean getBoolConfigSSP(int itrig,
                                String stub,
                                int ival)
```
    Gets an SSP parameter value using a shortened version of the full parameter key and parses it as a boolean.
    
    Parameters:
    
    itrig - - The number of the trigger for which to obtain the parameter value.
    
    stub - - The shortened version of the parameter key. This corresponds to "SSP_HPS_[STUB]_[TRIGGER NUMBER]".
    
    ival - - The index of the value that is to be obtained.
    
    Returns:
    
    Returns the requested value if it exists. Otherwise, a value of false is returned and a message is logged.
  - getConfigSSP
```
public String getConfigSSP(int itrig,
                           String stub,
                           int ival)
```
    Gets an SSP parameter value using a shortened version of the full parameter key.
    
    Parameters:
    
    itrig - - The number of the trigger for which to obtain the parameter value.
    
    stub - - The shortened version of the parameter key. This corresponds to "SSP_HPS_[STUB]_[TRIGGER NUMBER]".
    
    ival - - The index of the value that is to be obtained.
    
    Returns:
    
    Returns the requested value if it exists. Otherwise, a value of "0" is returned and a message is logged.
  - getConfigParameter
```
public String getConfigParameter(String key,
                                 int ival)
```
    Gets a parameter value associated with a parameter key.
    
    Parameters:
    
    key - - The parameter key to which the value belongs.
    
    ival - - The index of the desired parameter value.
    
    Returns:
    
    Returns the requested parameter value if it exists and returns "0" otherwise. In the event that a parameter can not be found, an error message is passed to the logger.
  - findChannel
```
public EcalChannel findChannel(int crate,
                               int fadcSlot,
                               int fadcChan)
```
    Gets the database calorimeter channel for a channel defined by a crate number, FADC slot, and FADC channel.
    
    Parameters:
    
    crate - - The crate number.
    
    fadcSlot - - The FADC slot.
    
    fadcChan - - The FADC channel.
    
    Returns:
    
    Returns the database channel as a EcalChannel if it exists, and null if it does not.
  - findChannel
```
public EcalChannel findChannel(int channel_id)
```
    Gets the database crystal channel object based on the crystal's numerical index.
    
    Parameters:
    
    channel_id - - The crystal index.
    
    Returns:
    
    Returns the channel as an EcalChannel.

Class EvioDAQParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BANK_TAG

singlesIOsrc

pairsIOsrc

configMap

nBanks

debug

fadcNSA

fadcNSB

fadcNPEAK

fadcMODE

fadcWIDTH

fadcOFFSET

GAIN

PEDESTAL

THRESHOLD

gtpMinSeedEnergy

gtpWindowBefore

gtpWindowAfter

singlesEn

pairsEn

singlesNhitsEn

singlesEnergyMinEn

singlesEnergyMaxEn

pairsEnergySumMaxMinEn

pairsEnergyDiffEn

pairsCoplanarityEn

pairsEnergyDistEn

singlesNhits

singlesEnergyMin

singlesEnergyMax

pairsNhitsMin

pairsEnergyMin

pairsEnergyMax

pairsEnergySumMin

pairsEnergySumMax

pairsEnergyDiffMax

pairsCoplanarityMax

pairsTimeDiffMax

pairsEnergyDistMin

pairsEnergyDistSlope

thisFadcSlot

ecalConditions

channels

Constructor Detail

EvioDAQParser

Method Detail

parse

loadConfigMap

parseConfigMap

fixConfigMap2014Run

parseFADC

setChannelParsFloat

setChannelParsInt

printMap

printVars

getFloatConfigSSP

getIntConfigSSP

getBoolConfigSSP

getConfigSSP

getConfigParameter

findChannel

findChannel