FADCConfig (HPS Java 4.3-SNAPSHOT API)

java.lang.Object
- org.hps.record.daqconfig.IDAQConfig
- - org.hps.record.daqconfig.FADCConfig

```
public class FADCConfig
extends IDAQConfig
```
Class FADCConfig stores FADC configuration settings parsed from the an EVIO file. This class manages the following properties:
- FADC Mode
- NSA
- NSB
- FADC Window Width
- FADC Window Time Offset
- Max Pulses per Channel Window
- Crystal Gains
- Crystal Thresholds
- Crystal Pedestals
Author:

Kyle McCarty

Field Summary

Fields
Modifier and Type	Field and Description
`private float[]`	`gains`
`private EcalChannel.EcalChannelCollection`	`geoMap`
`private Map<Point,Integer>`	`indexChannelMap`
`private int`	`maxPulses`
`private int`	`mode`
`private int`	`nsa`
`private int`	`nsb`
`private int`	`offset`
`private float[]`	`pedestals`
`private int[]`	`thresholds`
`private int`	`windowWidth`

Constructor Summary

Constructors
Constructor and Description

FADCConfig()

Constructors
Constructor and Description
`FADCConfig()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`getGain(EcalChannel channel)` Gets the gain for a crystal.
`float`	`getGain(int channelID)` Gets the gain for a crystal.
`float`	`getGain(int ix, int iy)` Gets the gain for a crystal.
`float`	`getGain(long cellID)` Gets the gain for a crystal.
`float`	`getGain(Point ixy)` Gets the gain for a crystal.
`int`	`getMaxPulses()` Gets the maximum number of pulses that the FADC will look for in a channel's window.
`int`	`getMode()` Gets the mode in which FADC data is written.
`int`	`getNSA()` Gets the number of samples (4 ns clock-cycles) that a pulse will be integrated by the FADC after a threshold-crossing event.
`int`	`getNSB()` Gets the number of samples (4 ns clock-cycles) that a pulse will be integrated by the FADC before a threshold-crossing event.
`float`	`getPedestal(EcalChannel channel)` Gets the pedestal for a crystal.
`float`	`getPedestal(int channelID)` Gets the pedestal for a crystal.
`float`	`getPedestal(int ix, int iy)` Gets the pedestal for a crystal.
`float`	`getPedestal(long cellID)` Gets the pedestal for a crystal.
`float`	`getPedestal(Point ixy)` Gets the pedestal for a crystal.
`int`	`getThreshold(EcalChannel channel)` Gets the threshold for a crystal.
`int`	`getThreshold(int channelID)` Gets the threshold for a crystal.
`int`	`getThreshold(int ix, int iy)` Gets the threshold for a crystal.
`int`	`getThreshold(long cellID)` Gets the threshold for a crystal.
`int`	`getThreshold(Point ixy)` Gets the threshold for a crystal.
`int`	`getWindowOffset()` Gets the time in nanoseconds that the readout window is offset.
`int`	`getWindowWidth()` Gets the length of the readout window for the FADC in nanoseconds.
`(package private) void`	`loadConfig(EvioDAQParser parser)` Updates the stored settings based on the argument parser.
`void`	`printConfig(PrintStream ps)` Prints a textual representation of the configuration bank to the terminal.
`private static void`	`validateChannelID(int channelID)` Throws an exception if the argument channel ID is not within the allowed range.

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

- Field Detail
  - mode
```
private int mode
```
  - nsa
```
private int nsa
```
  - nsb
```
private int nsb
```
  - windowWidth
```
private int windowWidth
```
  - offset
```
private int offset
```
  - maxPulses
```
private int maxPulses
```
  - indexChannelMap
```
private Map<Point,Integer> indexChannelMap
```
  - gains
```
private float[] gains
```
  - thresholds
```
private int[] thresholds
```
  - pedestals
```
private float[] pedestals
```
  - geoMap
```
private EcalChannel.EcalChannelCollection geoMap
```
- Constructor Detail
  - FADCConfig
```
public FADCConfig()
```
- Method Detail
  - loadConfig
```
void loadConfig(EvioDAQParser parser)
```
    Description copied from class: IDAQConfig
    
    Updates the stored settings based on the argument parser.
    
    Specified by:
    
    loadConfig in class IDAQConfig
    
    Parameters:
    
    parser - - The EVIO DAQ bank parser.
  - getGain
```
public float getGain(EcalChannel channel)
```
    Gets the gain for a crystal.
    
    Parameters:
    
    channel - - The channel object corresponding to the crystal.
    
    Returns:
    
    Returns the gain as a float in units of MeV per ADC.
  - getGain
```
public float getGain(int channelID)
```
    Gets the gain for a crystal.
    
    Parameters:
    
    channelID - - The channel ID corresponding to the crystal.
    
    Returns:
    
    Returns the gain as a float in units of MeV per ADC.
  - getGain
```
public float getGain(int ix,
                     int iy)
```
    Gets the gain for a crystal.
    
    Parameters:
    
    ix - - The x-index of the crystal.
    
    iy - - The y-index of the crystal.
    
    Returns:
    
    Returns the gain as a float in units of MeV per ADC.
  - getGain
```
public float getGain(long cellID)
```
    Gets the gain for a crystal.
    
    Parameters:
    
    cellID - - The geometric ID for the crystal.
    
    Returns:
    
    Returns the gain as a float in units of MeV per ADC.
  - getGain
```
public float getGain(Point ixy)
```
    Gets the gain for a crystal.
    
    Parameters:
    
    ixy - - The a point representing the x/y-indices of the crystal.
    
    Returns:
    
    Returns the gain as a float in units of MeV per ADC.
  - getMaxPulses
```
public int getMaxPulses()
```
    Gets the maximum number of pulses that the FADC will look for in a channel's window.
    
    Returns:
    
    Returns the maximum number of pulses.
  - getMode
```
public int getMode()
```
    Gets the mode in which FADC data is written.
    
    Returns:
    
    Returns the mode as an int; either 1, 3, or 7.
  - getNSA
```
public int getNSA()
```
    Gets the number of samples (4 ns clock-cycles) that a pulse will be integrated by the FADC after a threshold-crossing event.
    
    Returns:
    
    Returns the samples as an int in clock-cycles.
  - getNSB
```
public int getNSB()
```
    Gets the number of samples (4 ns clock-cycles) that a pulse will be integrated by the FADC before a threshold-crossing event.
    
    Returns:
    
    Returns the samples as an int in clock-cycles.
  - getPedestal
```
public float getPedestal(EcalChannel channel)
```
    Gets the pedestal for a crystal.
    
    Parameters:
    
    channel - - The channel object corresponding to the crystal.
    
    Returns:
    
    Returns the pedestal as a float in units of ADC.
  - getPedestal
```
public float getPedestal(int channelID)
```
    Gets the pedestal for a crystal.
    
    Parameters:
    
    channelID - - The channel ID corresponding to the crystal.
    
    Returns:
    
    Returns the pedestal as a float in units of ADC.
  - getPedestal
```
public float getPedestal(int ix,
                         int iy)
```
    Gets the pedestal for a crystal.
    
    Parameters:
    
    ix - - The x-index of the crystal.
    
    iy - - The y-index of the crystal.
    
    Returns:
    
    Returns the pedestal as a float in units of ADC.
  - getPedestal
```
public float getPedestal(long cellID)
```
    Gets the pedestal for a crystal.
    
    Parameters:
    
    cellID - - The geometric ID for the crystal.
    
    Returns:
    
    Returns the pedestal as a float in units of ADC.
  - getPedestal
```
public float getPedestal(Point ixy)
```
    Gets the pedestal for a crystal.
    
    Parameters:
    
    ixy - - The a point representing the x/y-indices of the crystal.
    
    Returns:
    
    Returns the pedestal as a float in units of ADC.
  - getThreshold
```
public int getThreshold(EcalChannel channel)
```
    Gets the threshold for a crystal.
    
    Parameters:
    
    channel - - The channel object corresponding to the crystal.
    
    Returns:
    
    Returns the threshold as a int in units of ADC.
  - getThreshold
```
public int getThreshold(int channelID)
```
    Gets the threshold for a crystal.
    
    Parameters:
    
    channelID - - The channel ID corresponding to the crystal.
    
    Returns:
    
    Returns the threshold as a int in units of ADC.
  - getThreshold
```
public int getThreshold(int ix,
                        int iy)
```
    Gets the threshold for a crystal.
    
    Parameters:
    
    ix - - The x-index of the crystal.
    
    iy - - The y-index of the crystal.
    
    Returns:
    
    Returns the threshold as a int in units of ADC.
  - getThreshold
```
public int getThreshold(long cellID)
```
    Gets the threshold for a crystal.
    
    Parameters:
    
    cellID - - The geometric ID for the crystal.
    
    Returns:
    
    Returns the threshold as a int in units of ADC.
  - getThreshold
```
public int getThreshold(Point ixy)
```
    Gets the threshold for a crystal.
    
    Parameters:
    
    ixy - - The a point representing the x/y-indices of the crystal.
    
    Returns:
    
    Returns the threshold as a int in units of ADC.
  - getWindowWidth
```
public int getWindowWidth()
```
    Gets the length of the readout window for the FADC in nanoseconds.
    
    Returns:
    
    Returns the window length.
  - getWindowOffset
```
public int getWindowOffset()
```
    Gets the time in nanoseconds that the readout window is offset.
    
    Returns:
    
    Returns the offset time in nanoseconds.
  - printConfig
```
public void printConfig(PrintStream ps)
```
    Description copied from class: IDAQConfig
    
    Prints a textual representation of the configuration bank to the terminal.
    
    Specified by:
    
    printConfig in class IDAQConfig
  - validateChannelID
```
private static final void validateChannelID(int channelID)
```
    Throws an exception if the argument channel ID is not within the allowed range.
    
    Parameters:
    
    channelID - - The channel ID to validate.

Class FADCConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mode

nsa

nsb

windowWidth

offset

maxPulses

indexChannelMap

gains

thresholds

pedestals

geoMap

Constructor Detail

FADCConfig

Method Detail

loadConfig

getGain

getGain

getGain

getGain

getGain

getMaxPulses

getMode

getNSA

getNSB

getPedestal

getPedestal

getPedestal

getPedestal

getPedestal

getThreshold

getThreshold

getThreshold

getThreshold

getThreshold

getWindowWidth

getWindowOffset

printConfig

validateChannelID