LDMX Software
ldmx::HcalVetoResult Class Reference

Public Member Functions

 HcalVetoResult ()=default
 Constructor.
 
virtual ~HcalVetoResult ()=default
 Destructor.
 
void Clear ()
 Reset the object.
 
void Print () const
 Print out the object.
 
bool passesVeto () const
 Checks if the event passes the Hcal veto.
 
ldmx::HcalHit getMaxPEHit () const
 
float getTotalPE () const
 
float getNumValidHits () const
 
void setVetoResult (const bool &passes_veto=true)
 Sets whether the Hcal veto was passed or not.
 
void setMaxPEHit (const ldmx::HcalHit max_PE_hit)
 Set the maximum PE hit.
 
void setTotalPE (const float total_PE)
 Set the total number of PE.
 
void setNumValidHits (const float num_valid_hits)
 Set the number of valid hits.
 

Private Member Functions

 ClassDef (HcalVetoResult, 3)
 

Private Attributes

ldmx::HcalHit max_PE_hit_
 Reference to max PE hit.
 
float total_PE_ {0.0}
 
int num_valid_hits_ {0}
 
bool passes_veto_ {false}
 Flag indicating whether the event passes the Hcal veto.
 

Detailed Description

Definition at line 23 of file HcalVetoResult.h.

Member Function Documentation

◆ Clear()

void ldmx::HcalVetoResult::Clear ( )

Reset the object.

Definition at line 17 of file HcalVetoResult.cxx.

17{ passes_veto_ = false; }
bool passes_veto_
Flag indicating whether the event passes the Hcal veto.

References passes_veto_.

◆ getMaxPEHit()

ldmx::HcalHit ldmx::HcalVetoResult::getMaxPEHit ( ) const
inline
Returns
The maximum PE HcalHit.

Definition at line 41 of file HcalVetoResult.h.

41{ return max_PE_hit_; }
ldmx::HcalHit max_PE_hit_
Reference to max PE hit.

References max_PE_hit_.

Referenced by framework::test::TestAnalyzer::analyze().

◆ getNumValidHits()

float ldmx::HcalVetoResult::getNumValidHits ( ) const
inline
Returns
The number of valid hits.

Definition at line 47 of file HcalVetoResult.h.

47{ return num_valid_hits_; }

◆ getTotalPE()

float ldmx::HcalVetoResult::getTotalPE ( ) const
inline
Returns
The total number of PE.

Definition at line 44 of file HcalVetoResult.h.

44{ return total_PE_; }

◆ passesVeto()

bool ldmx::HcalVetoResult::passesVeto ( ) const
inline

Checks if the event passes the Hcal veto.

Definition at line 38 of file HcalVetoResult.h.

38{ return passes_veto_; };

References passes_veto_.

Referenced by framework::test::TestAnalyzer::analyze(), and framework::test::TestProducer::produce().

◆ Print()

void ldmx::HcalVetoResult::Print ( ) const

Print out the object.

Definition at line 19 of file HcalVetoResult.cxx.

19 {
20 std::cout << "[ HcalVetoResult ]: Passes veto : "
21 << " Passes veto: " << passes_veto_ << std::endl;
23}
void Print() const
Print out the object.
Definition HcalHit.cxx:15

References max_PE_hit_, passes_veto_, and ldmx::HcalHit::Print().

◆ setMaxPEHit()

void ldmx::HcalVetoResult::setMaxPEHit ( const ldmx::HcalHit max_PE_hit)
inline

Set the maximum PE hit.

Parameters
max_PE_hitThe maximum PE HcalHit

Definition at line 63 of file HcalVetoResult.h.

63{ max_PE_hit_ = max_PE_hit; }

References max_PE_hit_.

Referenced by framework::test::TestProducer::produce(), hcal::HcalVetoProcessor::produce(), and hcal::HcalWABVetoProcessor::produce().

◆ setNumValidHits()

void ldmx::HcalVetoResult::setNumValidHits ( const float num_valid_hits)
inline

Set the number of valid hits.

Parameters
num_valid_hitsThe number of valid hits

Definition at line 77 of file HcalVetoResult.h.

77 {
78 num_valid_hits_ = num_valid_hits;
79 }

Referenced by hcal::HcalVetoProcessor::produce().

◆ setTotalPE()

void ldmx::HcalVetoResult::setTotalPE ( const float total_PE)
inline

Set the total number of PE.

Parameters
total_PEThe maximum PE HcalHit

Definition at line 70 of file HcalVetoResult.h.

70{ total_PE_ = total_PE; }

Referenced by hcal::HcalVetoProcessor::produce().

◆ setVetoResult()

void ldmx::HcalVetoResult::setVetoResult ( const bool & passes_veto = true)
inline

Sets whether the Hcal veto was passed or not.

Parameters
passes_vetoVeto result.

Definition at line 54 of file HcalVetoResult.h.

54 {
55 passes_veto_ = passes_veto;
56 }

References passes_veto_.

Referenced by framework::test::TestProducer::produce(), hcal::HcalVetoProcessor::produce(), and hcal::HcalWABVetoProcessor::produce().

Member Data Documentation

◆ max_PE_hit_

ldmx::HcalHit ldmx::HcalVetoResult::max_PE_hit_
private

Reference to max PE hit.

Definition at line 83 of file HcalVetoResult.h.

Referenced by getMaxPEHit(), Print(), and setMaxPEHit().

◆ num_valid_hits_

int ldmx::HcalVetoResult::num_valid_hits_ {0}
private

Definition at line 89 of file HcalVetoResult.h.

89{0};

◆ passes_veto_

bool ldmx::HcalVetoResult::passes_veto_ {false}
private

Flag indicating whether the event passes the Hcal veto.

Definition at line 92 of file HcalVetoResult.h.

92{false};

Referenced by Clear(), passesVeto(), Print(), and setVetoResult().

◆ total_PE_

float ldmx::HcalVetoResult::total_PE_ {0.0}
private

Definition at line 86 of file HcalVetoResult.h.

86{0.0};

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