DetectorSummary Class Reference

Summary of all channels of one detector type. More...

#include <DetectorSummary.hpp>

Collaboration diagram for DetectorSummary:

Public Member Functions
	DetectorSummary ()
	DetectorSummary (const std::string &str, const std::vector< ChanEvent * > &fullList)
void	Zero ()
void	AddEvent (ChanEvent *ev)
void	SetName (const std::string &a)
const ChanEvent *	GetMaxEvent (void) const
ChanEvent *	GetMaxEvent (bool fake)
int	GetMult () const
const std::string &	GetName () const
const std::vector< ChanEvent * > &	GetList () const

Private Attributes
std::string	name
std::string	type
std::string	subtype
std::string	tag
std::vector< ChanEvent * >	eventList
ChanEvent *	maxEvent

Detailed Description

Summary of all channels of one detector type.

For each group of detectors that exists in the analysis, a detector summary is created. The detector summary includes the multiplicity, maximum deposited energy, and physical location (strip number, detector number ...) where the maximum energy was deposited for a type of detectors. Also pointers to all channels of this type are stored in a vector, as well as the channel event where the maximum energy was deposited. Lastly, the detector summary records the detector name to which it applies.

Constructor & Destructor Documentation

DetectorSummary::DetectorSummary

(

)

Default Constructor

DetectorSummary::DetectorSummary	(	const std::string &	str,
		const std::vector< ChanEvent * > &	fullList
	)

Constructor taking a string and the full channel list

Parameters

[in]	str	: the type to make the summary for
[in]	fullList	: the full list of channels in the event

Member Function Documentation

void DetectorSummary::AddEvent

(

ChanEvent *

ev

)

Add an event to the summary

Parameters

[in]

ev

: the event to add

const std::vector<ChanEvent*>& DetectorSummary::GetList ( ) const

inline

Returns

the list of al channels in the raw event with this detector type

const ChanEvent* DetectorSummary::GetMaxEvent ( void  ) const

inline

Returns

the max event in the summary (constant)

ChanEvent* DetectorSummary::GetMaxEvent ( bool  fake )

inline

Returns

the max event with the ability to change it

Parameters

[in]

fake

: a bool to allow overloading the function name

int DetectorSummary::GetMult ( ) const

inline

Returns

the multiplicity of the summary

const std::string& DetectorSummary::GetName ( ) const

inline

Returns

get the detector name

void DetectorSummary::SetName ( const std::string &  a )

inline

Set the detector name

Parameters

[in]

a

: the name of the detector

void DetectorSummary::Zero

(

)

Zero the summary

Field Documentation

std::vector<ChanEvent*> DetectorSummary::eventList

private

list of events associated with this detector group

ChanEvent* DetectorSummary::maxEvent

private

event with maximum energy deposition

std::string DetectorSummary::name

private

name associated with this summary

std::string DetectorSummary::subtype

private

detector subtype associated with this summary

std::string DetectorSummary::tag

private

detector tag associated with this summary

std::string DetectorSummary::type

private

detector type associated with this summary

---

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

• include/DetectorSummary.hpp