ldmx::HcalVetoResult Class Reference

Public Member Functions
	HcalVetoResult ()=default
	Constructor.
virtual	~HcalVetoResult ()=default
	Destructor.
void	clear ()
	Reset 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, 4)

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.

Friends
std::ostream &	operator<< (std::ostream &o, const HcalVetoResult &d)
	Print out the object.

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.

{ passes_veto_ = false; }

References passes_veto_.

getMaxPEHit()

ldmx::HcalHit ldmx::HcalVetoResult::getMaxPEHit ( ) const

inline

Returns

The maximum PE HcalHit.

Definition at line 41 of file HcalVetoResult.h.

{ return 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.

{ 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.

{ 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.

{ return passes_veto_; };

References passes_veto_.

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

setMaxPEHit()

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

inline

Set the maximum PE hit.

Parameters

max_PE_hit

The maximum PE HcalHit

Definition at line 63 of file HcalVetoResult.h.

{ 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_hits

The number of valid hits_

Definition at line 77 of file HcalVetoResult.h.

                                                   {
    num_valid_hits_ = num_valid_hits;
  }

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

setTotalPE()

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

inline

Set the total number of PE.

Parameters

total_PE

The maximum PE HcalHit

Definition at line 70 of file HcalVetoResult.h.

{ 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_veto

Veto result.

Definition at line 54 of file HcalVetoResult.h.

                                                     {
    passes_veto_ = passes_veto;
  }

References passes_veto_.

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

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & o, const HcalVetoResult & d )

friend

Print out the object.

Definition at line 19 of file HcalVetoResult.cxx.

                                                               {
  return o << "HcalVetoResult { passes veto : " << c.passes_veto_
           << " with max hitL " << c.max_pe_hit_ << " }";
}

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(), and setMaxPEHit().

num_valid_hits_

int ldmx::HcalVetoResult::num_valid_hits_ {0}

private

Definition at line 89 of file HcalVetoResult.h.

{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.

{false};

Referenced by clear(), passesVeto(), and setVetoResult().

total_pe_

float ldmx::HcalVetoResult::total_pe_ {0.0}

private

Definition at line 86 of file HcalVetoResult.h.

{0.0};

---

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

• Hcal/include/Hcal/Event/HcalVetoResult.h
• Hcal/src/Hcal/Event/HcalVetoResult.cxx