hpstr
The Heavy Photon Search Toolkit for Reconstruction (hpstr) provides an interface to physics data from the HPS experiment saved in the LCIO format and converts it into an ROOT based format.
Loading...
Searching...
No Matches
EventHeader Class Reference

#include <EventHeader.h>

Inheritance diagram for EventHeader:

Public Member Functions

 EventHeader ()
 ~EventHeader ()
void Clear (Option_t *option="")
void Copy (TObject &obj) const
void setEventNumber (const int event_number)
int getEventNumber () const
void setEventTime (const long event_time)
long getEventTime () const
void setRunNumber (const int run_number)
int getRunNumber () const
void setWeight (const double weight)
double getWeight () const
void setPair0Trigger (const int pair0_trigger)
bool isPair0Trigger () const
void setPair1Trigger (const int pair1_trigger)
bool isPair1Trigger () const
void setPulserTrigger (const int pulser_trigger)
bool isPulserTrigger () const
void setSingle0Trigger (const int single0_trigger)
bool isSingle0Trigger () const
void setSingle1Trigger (const int single1_trigger)
bool isSingle1Trigger () const
void setSvtBiasState (const int svt_bias_state)
bool isSvtBiasOn () const
void setSvtBurstModeNoise (const int svt_burstmode_noise)
bool hasSvtBurstModeNoise () const
void setSvtEventHeaderState (const int svt_event_header_state)
bool hasSvtEventHeaderErrors () const
void setSvtLatencyState (const int svt_latency_state)
bool isSvtLatencyGood () const
void setSvtPositionState (const int svt_position_state)
bool isSvtClosed () const
void setRfTime (const int channel, const double rf_time)
double getRfTime (const int channel) const
void Print ()

Private Member Functions

 ClassDef (EventHeader, 2)

Private Attributes

int event_number_ {-9999}
long event_time_ {-9999}
int run_number_ {-9999}
double weight_ {1.0}
int pair0_trigger_ {0}
int pair1_trigger_ {0}
int pulser_trigger_ {0}
int single0_trigger_ {0}
int single1_trigger_ {0}
int svt_bias_state_ {0}
int svt_burstmode_noise_ {0}
int svt_event_header_state_ {0}
int svt_latency_state_ {0}
int svt_position_state_ {0}
double rf_times_ [2]

Detailed Description

Definition at line 22 of file EventHeader.h.

Constructor & Destructor Documentation

◆ EventHeader()

Constructor

◆ ~EventHeader()

Destructor

Definition at line 15 of file EventHeader.cxx.

Member Function Documentation

◆ ClassDef()

ClassDef ( EventHeader ,
2  )
private

◆ Clear()

void Clear ( Option_t * option = "")

Reset the EventHeader object

Definition at line 19 of file EventHeader.cxx.

◆ Copy()

void Copy ( TObject & obj) const

Copy this object

Parameters
objThe target object.

Definition at line 23 of file EventHeader.cxx.

◆ getEventNumber()

int getEventNumber ( ) const
inline
Returns
The event number.

Definition at line 50 of file EventHeader.h.

◆ getEventTime()

long getEventTime ( ) const
inline
Returns
The event time.

Definition at line 61 of file EventHeader.h.

◆ getRfTime()

double getRfTime ( const int channel) const
inline

Get the RF time.

Parameters
channelThe channel associated with the RF time.
Returns
The RF time.

Definition at line 275 of file EventHeader.h.

◆ getRunNumber()

int getRunNumber ( ) const
inline
Returns
The run number.

Definition at line 69 of file EventHeader.h.

◆ getWeight()

double getWeight ( ) const
inline
Returns
The event weight.

Definition at line 80 of file EventHeader.h.

◆ hasSvtBurstModeNoise()

bool hasSvtBurstModeNoise ( ) const
inline

Indicates whether the event was affected by SVT burst noise.

Returns
Returns true if the event has SVT burst noise, false otherwise.

Definition at line 199 of file EventHeader.h.

◆ hasSvtEventHeaderErrors()

bool hasSvtEventHeaderErrors ( ) const
inline

Indicates whether the SVT event headers had errors.

Returns
Returns true if the SVT event headers had an error, false otherwise.

Definition at line 218 of file EventHeader.h.

◆ isPair0Trigger()

bool isPair0Trigger ( ) const
inline

Indicate whether a pair0 trigger was registered for the event.

Returns
Returns true if a pair0 trigger was registered for the, false otherwise.

Definition at line 96 of file EventHeader.h.

◆ isPair1Trigger()

bool isPair1Trigger ( ) const
inline

Indicate whether a pair1 trigger was registered for the event.

Returns
Returns true if a pair1 trigger was registered for the, false otherwise.

Definition at line 112 of file EventHeader.h.

◆ isPulserTrigger()

bool isPulserTrigger ( ) const
inline

Indicate whether a pulser (random) trigger was registered for the event.

Returns
Returns true if a pulser trigger was registered for the, false otherwise.

Definition at line 129 of file EventHeader.h.

◆ isSingle0Trigger()

bool isSingle0Trigger ( ) const
inline

Indicate whether a single0 trigger was registered for the event.

Returns
Returns true if a single0 trigger was registered for the, false otherwise.

Definition at line 145 of file EventHeader.h.

◆ isSingle1Trigger()

bool isSingle1Trigger ( ) const
inline

Indicate whether a single1 trigger was registered for the event.

Returns
Returns true if a single1 trigger was registered for the, false otherwise.

Definition at line 161 of file EventHeader.h.

◆ isSvtBiasOn()

bool isSvtBiasOn ( ) const
inline

Indicate whether the SVT bias was on during the event.

Returns
Returns true if the bias was one, false otherwise.

Definition at line 179 of file EventHeader.h.

◆ isSvtClosed()

bool isSvtClosed ( ) const
inline

Indicates whether the SVT was open or closed during an event.

Returns
Returns true if the SVT was closed, false otherwise.

Definition at line 256 of file EventHeader.h.

◆ isSvtLatencyGood()

bool isSvtLatencyGood ( ) const
inline

Indicate whether the SVT latency was correct during an event.

Returns
Returns true if the SVT latency was correct, false otherwise.

Definition at line 237 of file EventHeader.h.

◆ Print()

void Print ( )

Definition at line 44 of file EventHeader.cxx.

◆ setEventNumber()

void setEventNumber ( const int event_number)
inline

Set the event number.

Parameters
event_numberThe event number.

Definition at line 47 of file EventHeader.h.

◆ setEventTime()

void setEventTime ( const long event_time)
inline

Set the event time stamp. The event time is currently the Unix time stamp associated with the event.

Parameters
event_timeThe Unix time stamp of the event.

Definition at line 58 of file EventHeader.h.

◆ setPair0Trigger()

void setPair0Trigger ( const int pair0_trigger)
inline
Parameters
pair0_triggerSet Flag indicating whether this event was due to a pair0 trigger.

Definition at line 86 of file EventHeader.h.

◆ setPair1Trigger()

void setPair1Trigger ( const int pair1_trigger)
inline
Parameters
pair1_triggerSet Flag indicating whether this event was due to a pair1 trigger.

Definition at line 102 of file EventHeader.h.

◆ setPulserTrigger()

void setPulserTrigger ( const int pulser_trigger)
inline
Parameters
pulser_triggerSet Flag indicating whether this event was due to a pulser trigger.

Definition at line 118 of file EventHeader.h.

◆ setRfTime()

void setRfTime ( const int channel,
const double rf_time )
inline

Set the event RF time.

Parameters
channelThe channel from which the RF time was retrieved.
rf_timeThe event RF time.

Definition at line 265 of file EventHeader.h.

◆ setRunNumber()

void setRunNumber ( const int run_number)
inline
Parameters
event_timeThe run number.

Definition at line 66 of file EventHeader.h.

◆ setSingle0Trigger()

void setSingle0Trigger ( const int single0_trigger)
inline
Parameters
single0_triggerSet Flag indicating whether this event was due to a single0 trigger.

Definition at line 135 of file EventHeader.h.

◆ setSingle1Trigger()

void setSingle1Trigger ( const int single1_trigger)
inline
Parameters
single1_triggerSet Flag indicating whether this event was due to a single1 trigger.

Definition at line 151 of file EventHeader.h.

◆ setSvtBiasState()

void setSvtBiasState ( const int svt_bias_state)
inline

Set the state of the SVT bias during the event i.e. was it on or off?

Parameters
svt_bias_stateThe state of the SVT bias. It's set to 0 if the bias was off or 1 if it was on.

Definition at line 170 of file EventHeader.h.

◆ setSvtBurstModeNoise()

void setSvtBurstModeNoise ( const int svt_burstmode_noise)
inline

Set the flag indicating whether the event was affected by SVT burst noise.

Parameters
svt_burstmode_noiseFlag indicating whether an event was affected by SVT burst noise. It's set to 0 if it was or 1 if it wasn't.

Definition at line 189 of file EventHeader.h.

◆ setSvtEventHeaderState()

void setSvtEventHeaderState ( const int svt_event_header_state)
inline

Set the flag indicating whether the SVT headers had errors.

Parameters
svt_event_header_stateFlag indicating whether the SVT event headers had errors.

Definition at line 208 of file EventHeader.h.

◆ setSvtLatencyState()

void setSvtLatencyState ( const int svt_latency_state)
inline

Set the flag indicating whether the SVT latency was correct during an event.

Parameters
svt_latency_stateFlag indicating whether the SVT latency was correct during an event.

Definition at line 227 of file EventHeader.h.

◆ setSvtPositionState()

void setSvtPositionState ( const int svt_position_state)
inline

Set the state of indicating whether the SVT was open or closed during an event.

Parameters
svt_position_stateThe state indicating whether the SVT was open or closed. It's set to 0 if the SVT was open or 1 if it was closed.

Definition at line 247 of file EventHeader.h.

◆ setWeight()

void setWeight ( const double weight)
inline

Set the event weight, as read from EVENT::LCEvent::getWeight(). Defaults to 1.0 for unweighted (e.g. data or unbiased MC) events.

Parameters
weightThe event weight.

Definition at line 77 of file EventHeader.h.

Member Data Documentation

◆ event_number_

int event_number_ {-9999}
private

Event number

Definition at line 282 of file EventHeader.h.

◆ event_time_

long event_time_ {-9999}
private

Event time

Definition at line 285 of file EventHeader.h.

◆ pair0_trigger_

int pair0_trigger_ {0}
private

Flag indicating that a pair0 trigger was registered. It's set to 1 if it was registered or 0 if it wasn't.

Definition at line 297 of file EventHeader.h.

◆ pair1_trigger_

int pair1_trigger_ {0}
private

Flag indicating that a pair1 trigger was registered. It's set to 1 if it was registered or 0 if it wasn't.

Definition at line 303 of file EventHeader.h.

◆ pulser_trigger_

int pulser_trigger_ {0}
private

Flag indicating that a pulser (random) trigger was registered. It's set to 1 if it was registered or 0 if it wasn't.

Definition at line 309 of file EventHeader.h.

◆ rf_times_

double rf_times_[2]
private

The RF time

Definition at line 354 of file EventHeader.h.

◆ run_number_

int run_number_ {-9999}
private

Run number

Definition at line 288 of file EventHeader.h.

◆ single0_trigger_

int single0_trigger_ {0}
private

Flag indicating that a singles0 trigger was registered. It's set to 1 if it was registered or 0 if it wasn't.

Definition at line 315 of file EventHeader.h.

◆ single1_trigger_

int single1_trigger_ {0}
private

Flag indicating that a singles1 trigger was registered. It's set to 1 if it was registered or 0 if it wasn't.

Definition at line 321 of file EventHeader.h.

◆ svt_bias_state_

int svt_bias_state_ {0}
private

Flag indicating the state of the SVT bias. It's set to 0 if the bias was off or 1 if it was on.

Definition at line 327 of file EventHeader.h.

◆ svt_burstmode_noise_

int svt_burstmode_noise_ {0}
private

Flag indicating whether the event was affected by SVT burst noise. It's set to 0 if the event saw burst noise or 1 if it was fine.

Definition at line 333 of file EventHeader.h.

◆ svt_event_header_state_

int svt_event_header_state_ {0}
private

Flag indicating whether the SVT event headers had an error. It's set to 0 if the event headers had and error, of 1 if it was errorless.

Definition at line 339 of file EventHeader.h.

◆ svt_latency_state_

int svt_latency_state_ {0}
private

Flag indicating whether the SVT latency was correct during an event. It's set to 0 if the latency was incorrect, 1 if it was fine.

Definition at line 345 of file EventHeader.h.

◆ svt_position_state_

int svt_position_state_ {0}
private

Flag indicating whether the SVT was open or closed. It's set to 0 if the SVT was open or 1 if it was closed.

Definition at line 351 of file EventHeader.h.

◆ weight_

double weight_ {1.0}
private

Event weight, e.g. from a biased/forced MC generation step.

Definition at line 291 of file EventHeader.h.


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