RawEvent Class Reference

The all important raw event. More...

#include <RawEvent.hpp>

Collaboration diagram for RawEvent:

Public Member Functions
	RawEvent ()
	~RawEvent ()
void	Clear (void)
size_t	Size (void) const
void	Init (const std::set< std::string > &usedTypes)
	Raw event initialization and set the rawevent detector summary map with the passed argument. More...
void	AddChan (ChanEvent *event)
void	Zero (const std::set< std::string > &usedev)
	Raw event zeroing. More...
Correlator &	GetCorrelator ()
DetectorSummary *	GetSummary (const std::string &a, bool construct=true)
	Get a pointer to a specific detector summary. More...
const DetectorSummary *	GetSummary (const std::string &a) const
const std::vector< ChanEvent * > &	GetEventList (void) const

Private Attributes
std::map< std::string, DetectorSummary >	sumMap
std::set< std::string >	nullSummaries
std::vector< ChanEvent * >	eventList
Correlator	correlator

Detailed Description

The all important raw event.

The rawevent serves as the basis for the experimental analysis. The rawevent includes a vector of individual channels that have been deemed to be close to each other in time. This determination is performed in ScanList() from PixieStd.cpp. The rawevent also includes a map of detector summaries which contains a detector summary for each detector type that is used in the analysis

The rawevent is intended to be versatile enough to remain unaltered unless LARGE changes are made to the pixie16 code. Be careful when altering the rawevent.

Constructor & Destructor Documentation

RawEvent::RawEvent ( )

inline

Default Constructor

RawEvent::~RawEvent ( )

inline

Default Destructor

Member Function Documentation

void RawEvent::AddChan ( ChanEvent *  event )

inline

Add a channel event to the raw event

Parameters

[in]

event

: the event to add to the raw event

void RawEvent::Clear ( void  )

inline

Clear the list of individual channel events (Memory is managed elsewhere)

Correlator& RawEvent::GetCorrelator ( )

inline

Returns

A reference to the correlator

const std::vector<ChanEvent *>& RawEvent::GetEventList ( void  ) const

inline

Returns

the list of events

DetectorSummary* RawEvent::GetSummary	(	const std::string &	a,
		bool	construct = true
	)

Get a pointer to a specific detector summary.

Retrieve from the detector summary map a pointer to the specific detector summary that is associated with the passed string.

Parameters

[in]	a	: the summary that you would like
[in]	construct	: flag indicating if we need to construct the summary

Returns

a pointer to the summary

const DetectorSummary* RawEvent::GetSummary

(

const std::string &

a

)

const

Returns

a pointer to the requested summary

Parameters

[in]

a

: the name of the summary that you would like

void RawEvent::Init

(

const std::set< std::string > &

usedTypes

)

Raw event initialization and set the rawevent detector summary map with the passed argument.

Parameters

[in]

usedTypes

: the list of types used in the analysis

size_t RawEvent::Size ( void  ) const

inline

Returns

the number of channels in the current event

void RawEvent::Zero

(

const std::set< std::string > &

usedev

)

Raw event zeroing.

For any detector type that was used in the event, zero the appropriate detector summary in the map, and clear the event list

Parameters

[in]

usedev

: the detector summary to zero

Field Documentation

Correlator RawEvent::correlator

private

class to correlate decay data with implantation data

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

private

Pointers to all the channels that are close enough in time to be considered a single event

std::set<std::string> RawEvent::nullSummaries

mutableprivate

Summaries which were requested but don't exist

std::map<std::string, DetectorSummary> RawEvent::sumMap

private

An STL map containing DetectorSummary classes associated with detector types

---

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

• include/RawEvent.hpp