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.

Definition at line 28 of file DetectorSummary.hpp.

Constructor & Destructor Documentation

DetectorSummary() [1/2]

DetectorSummary::DetectorSummary

(

)

Default Constructor

Definition at line 15 of file DetectorSummary.cpp.

DetectorSummary() [2/2]

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

Definition at line 19 of file DetectorSummary.cpp.

Here is the call graph for this function:

Member Function Documentation

AddEvent()

void DetectorSummary::AddEvent

(

ChanEvent *

ev

)

Add an event to the summary

Parameters

[in]

ev

: the event to add

Definition at line 55 of file DetectorSummary.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

GetList()

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

inline

Returns

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

Definition at line 63 of file DetectorSummary.hpp.

Here is the caller graph for this function:

GetMaxEvent() [1/2]

const ChanEvent* DetectorSummary::GetMaxEvent ( void  ) const

inline

Returns

the max event in the summary (constant)

Definition at line 50 of file DetectorSummary.hpp.

Here is the caller graph for this function:

GetMaxEvent() [2/2]

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

Definition at line 54 of file DetectorSummary.hpp.

GetMult()

int DetectorSummary::GetMult ( ) const

inline

Returns

the multiplicity of the summary

Definition at line 57 of file DetectorSummary.hpp.

Here is the caller graph for this function:

GetName()

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

inline

Returns

get the detector name

Definition at line 60 of file DetectorSummary.hpp.

Here is the caller graph for this function:

SetName()

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

inline

Set the detector name

Parameters

[in]

a

: the name of the detector

Definition at line 47 of file DetectorSummary.hpp.

Here is the caller graph for this function:

Zero()

void DetectorSummary::Zero

(

)

Zero the summary

Definition at line 10 of file DetectorSummary.cpp.

Here is the caller graph for this function:

Field Documentation

eventList

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

private

list of events associated with this detector group

Definition at line 69 of file DetectorSummary.hpp.

maxEvent

ChanEvent* DetectorSummary::maxEvent

private

event with maximum energy deposition

Definition at line 70 of file DetectorSummary.hpp.

name

std::string DetectorSummary::name

private

name associated with this summary

Definition at line 63 of file DetectorSummary.hpp.

subtype

std::string DetectorSummary::subtype

private

detector subtype associated with this summary

Definition at line 67 of file DetectorSummary.hpp.

tag

std::string DetectorSummary::tag

private

detector tag associated with this summary

Definition at line 68 of file DetectorSummary.hpp.

type

std::string DetectorSummary::type

private

detector type associated with this summary

Definition at line 66 of file DetectorSummary.hpp.

---

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

• DetectorSummary.hpp
• DetectorSummary.cpp