PAASS
Software suite to Acquire and Analyze Data from Pixie16
Public Member Functions | Private Attributes
RawEvent Class Reference

The all important raw event. More...

#include <RawEvent.hpp>

Collaboration diagram for RawEvent:
Collaboration graph
[legend]

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

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.

Definition at line 42 of file RawEvent.hpp.

Constructor & Destructor Documentation

§ RawEvent()

RawEvent::RawEvent ( )
inline

Default Constructor

Definition at line 45 of file RawEvent.hpp.

§ ~RawEvent()

RawEvent::~RawEvent ( )
inline

Default Destructor

Definition at line 48 of file RawEvent.hpp.

Member Function Documentation

§ AddChan()

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

Definition at line 64 of file RawEvent.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ Clear()

void RawEvent::Clear ( void  )
inline

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

Definition at line 51 of file RawEvent.hpp.

§ GetEventList()

const std::vector<ChanEvent *>& RawEvent::GetEventList ( void  ) const
inline
Returns
the list of events

Definition at line 87 of file RawEvent.hpp.

Here is the caller graph for this function:

§ GetSummary() [1/2]

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

Definition at line 41 of file RawEvent.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ GetSummary() [2/2]

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

Definition at line 66 of file RawEvent.cpp.

§ Init()

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

initialize the map of used detectors. This will associate the name of a detector type (such as dssd_front, ge ...) with a detector summary. See ProcessEvent() for a description of the variables in the summary

Definition at line 11 of file RawEvent.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ Size()

size_t RawEvent::Size ( void  ) const
inline
Returns
the number of channels in the current event

Definition at line 54 of file RawEvent.hpp.

Here is the call graph for this function:

§ Zero()

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

Definition at line 28 of file RawEvent.cpp.

Here is the caller graph for this function:

Field Documentation

§ eventList

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

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

Definition at line 92 of file RawEvent.hpp.

§ nullSummaries

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

Summaries which were requested but don't exist

Definition at line 91 of file RawEvent.hpp.

§ sumMap

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

An STL map containing DetectorSummary classes associated with detector types

Definition at line 89 of file RawEvent.hpp.

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