PAASS
Software suite to Acquire and Analyze Data from Pixie16
Public Member Functions | Private Member Functions | Private Attributes
ChanEvent Class Reference

A channel event. More...

#include <ChanEvent.hpp>

Collaboration diagram for ChanEvent:
Collaboration graph
[legend]

Public Member Functions

 ChanEvent ()
 
 ChanEvent (const XiaData &data)
 Constructor setting XIA Data. More...
 
 ~ChanEvent ()
 Default Destructor. More...
 
void SetEnergy (double a)
 
void SetCalEnergy (double a)
 
void SetCorrectedTime (double a)
 
void SetCalTime (double a)
 
void SetHighResTime (double a)
 
bool GetCfdSourceBit () const
 
bool CfdForceTrig () const
 
double GetEnergy () const
 
double GetCalEnergy () const
 
double GetCorrectedTime () const
 
double GetTime () const
 
double GetCalTime () const
 
double GetHighResTime () const
 
double GetEventTime () const
 
const Trace & GetTrace () const
 
Trace & GetTrace ()
 
unsigned long GetTrigTime () const
 
unsigned long GetEventTimeLo () const
 
unsigned long GetEventTimeHi () const
 
unsigned long GetRunTime0 () const
 
unsigned long GetRunTime1 () const
 
unsigned long GetRunTime2 () const
 
bool IsPileup () const
 
bool IsSaturated () const
 
const Identifier & GetChanID () const
 
int GetID () const
 
unsigned long GetQdcValue (int i) const
 
void ZeroVar ()
 [Zero Channel] More...
 

Private Member Functions

void ZeroNums (void)
 

Private Attributes

XiaData data_
 The data decoded from the XIA header. More...
 
double energy
 
double calEnergy
 
double calTime
 
double correctedTime
 
double highResTime
 
Trace trace
 
pixie::word_t trigTime
 
pixie::word_t runTime0
 
pixie::word_t runTime1
 
pixie::word_t runTime2
 
double time
 
double eventTime
 

Detailed Description

A channel event.

All data is grouped together into channels. For each pixie16 channel that fires the energy, time (both trigger time and event time), and trace (if applicable) are obtained. Additional information includes the channels identifier, calibrated energies, trace analysis information. Note that this currently stores raw values internally through pixie word types but returns data values through native C types. This is potentially non-portable.

Definition at line 23 of file ChanEvent.hpp.

Constructor & Destructor Documentation

§ ChanEvent() [1/2]

ChanEvent::ChanEvent ( )
inline

Default constructor that zeroes all values

Definition at line 26 of file ChanEvent.hpp.

Here is the call graph for this function:

§ ChanEvent() [2/2]

ChanEvent::ChanEvent ( const XiaData &  data)
inline

Constructor setting XIA Data.

Definition at line 29 of file ChanEvent.hpp.

Here is the call graph for this function:

§ ~ChanEvent()

ChanEvent::~ChanEvent ( )
inline

Default Destructor.

Definition at line 35 of file ChanEvent.hpp.

Member Function Documentation

§ CfdForceTrig()

bool ChanEvent::CfdForceTrig ( ) const
inline
Returns
true if the CFD was forced trigger

Definition at line 62 of file ChanEvent.hpp.

Here is the call graph for this function:

§ GetCalEnergy()

double ChanEvent::GetCalEnergy ( ) const
inline

<

Returns
the calibrated energy

Definition at line 69 of file ChanEvent.hpp.

Here is the caller graph for this function:

§ GetCalTime()

double ChanEvent::GetCalTime ( ) const
inline

<

Returns
the calibrated time

Definition at line 78 of file ChanEvent.hpp.

§ GetCfdSourceBit()

bool ChanEvent::GetCfdSourceBit ( ) const
inline
Returns
the CFD source bit

Definition at line 58 of file ChanEvent.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ GetChanID()

const Identifier & ChanEvent::GetChanID ( ) const
Returns
The identifier in the map for the channel event

Definition at line 33 of file ChanEvent.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ GetCorrectedTime()

double ChanEvent::GetCorrectedTime ( ) const
inline

<

Returns
the corrected time

Definition at line 72 of file ChanEvent.hpp.

Here is the caller graph for this function:

§ GetEnergy()

double ChanEvent::GetEnergy ( ) const
inline

<

Returns
the raw energy

Definition at line 66 of file ChanEvent.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ GetEventTime()

double ChanEvent::GetEventTime ( ) const
inline

<

Returns
the event time

Definition at line 84 of file ChanEvent.hpp.

Here is the call graph for this function:

§ GetEventTimeHi()

unsigned long ChanEvent::GetEventTimeHi ( ) const
inline

<

Returns
the upper 32 bits of event time

Definition at line 99 of file ChanEvent.hpp.

Here is the call graph for this function:

§ GetEventTimeLo()

unsigned long ChanEvent::GetEventTimeLo ( ) const
inline

<

Returns
the lower 32 bits of event time

Definition at line 96 of file ChanEvent.hpp.

Here is the call graph for this function:

§ GetHighResTime()

double ChanEvent::GetHighResTime ( ) const
inline

<

Returns
the high-resolution time in ns

Definition at line 81 of file ChanEvent.hpp.

Here is the caller graph for this function:

§ GetID()

int ChanEvent::GetID ( ) const
Returns
the channel id defined as pixie module # * 16 + channel number

Definition at line 38 of file ChanEvent.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ GetQdcValue()

unsigned long ChanEvent::GetQdcValue ( int  i) const
Returns
The Onboard QDC value at i
Parameters
[in]i: the QDC number to obtain, possible values [0,7]

Definition at line 29 of file ChanEvent.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ GetRunTime0()

unsigned long ChanEvent::GetRunTime0 ( ) const
inline

<

Returns
the lower bits of run time

Definition at line 102 of file ChanEvent.hpp.

§ GetRunTime1()

unsigned long ChanEvent::GetRunTime1 ( ) const
inline

<

Returns
the middle bits of run time

Definition at line 105 of file ChanEvent.hpp.

§ GetRunTime2()

unsigned long ChanEvent::GetRunTime2 ( ) const
inline

<

Returns
the higher bits of run time

Definition at line 108 of file ChanEvent.hpp.

§ GetTime()

double ChanEvent::GetTime ( ) const
inline

<

Returns
the raw time in clock ticks

Definition at line 75 of file ChanEvent.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ GetTrace() [1/2]

const Trace& ChanEvent::GetTrace ( ) const
inline

<

Returns
a reference to the trace

Definition at line 87 of file ChanEvent.hpp.

Here is the caller graph for this function:

§ GetTrace() [2/2]

Trace& ChanEvent::GetTrace ( )
inline
Returns
a reference which can alter the trace

Definition at line 90 of file ChanEvent.hpp.

§ GetTrigTime()

unsigned long ChanEvent::GetTrigTime ( ) const
inline

<

Returns
the channel trigger time

Definition at line 93 of file ChanEvent.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ IsPileup()

bool ChanEvent::IsPileup ( ) const
inline

<

Returns
true if channel is pileup

Definition at line 111 of file ChanEvent.hpp.

Here is the call graph for this function:

§ IsSaturated()

bool ChanEvent::IsSaturated ( ) const
inline

<

Returns
whether the trace is saturated

Definition at line 114 of file ChanEvent.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ SetCalEnergy()

void ChanEvent::SetCalEnergy ( double  a)
inline

Set the calibrated energy

Parameters
[in]a: the calibrated energy

Definition at line 43 of file ChanEvent.hpp.

Here is the caller graph for this function:

§ SetCalTime()

void ChanEvent::SetCalTime ( double  a)
inline

Set the Calibrated time

Parameters
[in]a: the calibrated time

Definition at line 51 of file ChanEvent.hpp.

§ SetCorrectedTime()

void ChanEvent::SetCorrectedTime ( double  a)
inline

Set the Walk corrected time

Parameters
[in]a: the walk corrected time

Definition at line 47 of file ChanEvent.hpp.

Here is the caller graph for this function:

§ SetEnergy()

void ChanEvent::SetEnergy ( double  a)
inline

Set the energy

Parameters
[in]a: the energy

Definition at line 39 of file ChanEvent.hpp.

Here is the caller graph for this function:

§ SetHighResTime()

void ChanEvent::SetHighResTime ( double  a)
inline

Set the high resolution time (Filter time + phase )

Parameters
[in]a: the high resolution time

Definition at line 55 of file ChanEvent.hpp.

Here is the caller graph for this function:

§ ZeroNums()

void ChanEvent::ZeroNums ( void  )
private

Zero members which do not have constructors associated with them

Definition at line 15 of file ChanEvent.cpp.

Here is the caller graph for this function:

§ ZeroVar()

void ChanEvent::ZeroVar ( )

[Zero Channel]

Channel event zeroing All numerical values are set to -1, and the trace, and traceinfo vectors are cleared and the channel identifier is zeroed using its identifier::zeroid method.

Definition at line 44 of file ChanEvent.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

Field Documentation

§ calEnergy

double ChanEvent::calEnergy
private

Calibrated channel energy, calibration performed in ThreshAndCal function in the detector_driver.cpp

Definition at line 135 of file ChanEvent.hpp.

§ calTime

double ChanEvent::calTime
private

Calibrated time, currently unused

Definition at line 138 of file ChanEvent.hpp.

§ correctedTime

double ChanEvent::correctedTime
private

Energy-walk corrected time

Definition at line 139 of file ChanEvent.hpp.

§ data_

XiaData ChanEvent::data_
private

The data decoded from the XIA header.

Definition at line 132 of file ChanEvent.hpp.

§ energy

double ChanEvent::energy
private

Raw channel energy

Definition at line 134 of file ChanEvent.hpp.

§ eventTime

double ChanEvent::eventTime
private

The event time recorded by Pixie

Definition at line 150 of file ChanEvent.hpp.

§ highResTime

double ChanEvent::highResTime
private

timing resolution less than 1 adc sample

Definition at line 140 of file ChanEvent.hpp.

§ runTime0

pixie::word_t ChanEvent::runTime0
private

Lower bits of run time

Definition at line 145 of file ChanEvent.hpp.

§ runTime1

pixie::word_t ChanEvent::runTime1
private

Upper bits of run time

Definition at line 146 of file ChanEvent.hpp.

§ runTime2

pixie::word_t ChanEvent::runTime2
private

Higher bits of run time

Definition at line 147 of file ChanEvent.hpp.

§ time

double ChanEvent::time
private

Raw channel time, 64 bit from pixie16 channel event time

Definition at line 149 of file ChanEvent.hpp.

§ trace

Trace ChanEvent::trace
private

Channel trace if present

Definition at line 141 of file ChanEvent.hpp.

§ trigTime

pixie::word_t ChanEvent::trigTime
private

The channel trigger time, trigger time and the lower 32 bits of the event time are not necessarily the same but could be separated by a constant value.

Definition at line 142 of file ChanEvent.hpp.

The documentation for this class was generated from the following files: