Class Index Cross Index Namespace Index

Class FrameCPP::Version_3_4_5::Event

Event Data
Contained in: FrameCPP::Version_3_4_5
Derived from: FrameCPP::Version_3_4_5::Base
Derived by: none

#include "../../../../../lib/framecpp/src/Version3_4_5/event.hh"


public function member index:

Event(); Default Constructor.
Event(const Event& eventData); Copy Constructor.
Event(const std::string& name, const std::string& comment, const std::string& inputs, const Time& time, REAL_4 timeBefore, REAL_4 timeAfter, INT_4U eventStatus, REAL_4 amplitude, REAL_4 prob, const std::string& statistics, const std::vector<std::pair<std::string, REAL_4> >& parameters); Constructor.
inline REAL_4 getAmplitude() const; Continuous output amplitude returned by event.
virtual INT_2U getClassId() const;
inline const std::string& getComment() const; Event description.
inline INT_4U getEventStatus() const; Event status defined by the event.
inline const Time& getGTime() const; Event occurrence time.
inline const std::string& getInputs() const; Input channels.
const std::string& getName() const;
inline const std::vector<std::pair<std::string, REAL_4> >& getParameters() const; Additional parameters
inline REAL_4 getProbability() const; Probability.
static SH getSH(); Structure Header.
static SH getSH3(); Structure Header.
static SH getSH4(); Structure Header.
inline const std::string& getStatistics() const; Statistical description.
inline REAL_4 getTimeAfter() const; Signal duration after event occurence
inline REAL_4 getTimeBefore() const; Signal duration before event occurence
inline bool operator !=(const Event& eventData) const; Not-equal Comparison.
const Event& operator +=(const Event& event); += Operator.
const Event& operator =(const Event& eventData); Assignment Operator.
bool operator ==(const Event& eventData) const; Equal comparison.
inline Event::DataContainer& refData(); Data Container.
inline const Event::DataContainer& refData() const; Data Container
inline Event::TableContainer& refTable(); Table Container.
inline const Event::TableContainer& refTable() const; Table Container
 

private function member index:

static Event* read(FrameReaderBase& in); Reads a Event object from an Input object.
static Event* read3(FrameReaderBase& in); Read FrameCPP version 3 Trigger Data structure.
static Event* read4(FrameReaderBase& in); Read FrameCPP version 4 Trigger Data structure.
virtual void write(Output& out) const; Writes an Event object to an Output object.
 

Description:

This class represents event data. It is modeled after the FrEvent structure in the Frame Specification, LIGO-T970130-B-E.

The Event class stores the following attributes:
AttributeDescription
name Name of event
comment Descriptor of event
inputs Input channels and filter parameters to event process
GTime Event occurrent time (integer seconds & nanoseconds)
timeBefore Signal duration before event occurence time
timeAfter Signal duration after event occurence time
eventStatusDefined by event
amplitude Continuous output amplitude returned by event
probabilityLikelihood estimate of event.
statistics Statistical description of event
parameters Additional event parameters

The Event object also contains the following data:
DataDescription
dataVect Container for additional event results.
tableTable Container for additional event data.

The data is available through the container object inside Event. This are accessed via the refData and refTable method.


Function Member Descriptions:


FrameCPP::Version_3_4_5::Event::Event - Default Constructor.


Event();
This creates a Event object with the following properties:

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Event::Event - Copy Constructor.


Event(const Event& eventData);
This performs a deep copy of the object.

Parameters:
ParameterDescription
const Event& eventDataEvent data to be copied.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Event::Event - Constructor.


Event(const std::string& name, const std::string& comment, const std::string& inputs, const Time& time, REAL_4 timeBefore, REAL_4 timeAfter, INT_4U eventStatus, REAL_4 amplitude, REAL_4 prob, const std::string& statistics, const std::vector<std::pair<std::string, REAL_4> >& parameters);
Creates a Event object with the specified attributes but no data.

Parameters:
ParameterDescription
const std::string& nameEvent name.
const std::string& commentEvent description.
const std::string& inputsInput channels and filter parameters to evenet process.
const Time& timeEvent occurrence time.
REAL_4 timeBeforeSignal duration before event occurrence.
REAL_4 timeAfterSignar dutaion after event occurrence.
INT_4U eventStatusDefined by event.
REAL_4 amplitudeContinuous output amplitude returned by event.
REAL_4 probLikelihood estimate of event.
const std::string& statisticsStatistical description.
const std::vector >& parametersAdditional event parameters.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Event::getAmplitude - Continuous output amplitude returned by event.


inline REAL_4 getAmplitude() const;
Gets continuous output amplitude returned by event.

Return value:
REAL_4- Event amplitude.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::getClassId


virtual INT_2U getClassId() const;

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Event::getComment - Event description.


inline const std::string& getComment() const;
Gets the description of the event.

Return value:
const std::string&- The event description.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::getEventStatus - Event status defined by the event.


inline INT_4U getEventStatus() const;
Gets event status.

Return value:
INT_4U- Event status.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::getGTime - Event occurrence time.


inline const Time& getGTime() const;
Gets the event occurrence time. This is the integer seconds and nanoseconds since the beginning of the frame.

Return value:
const Time&- The event occurrence time.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::getInputs - Input channels.


inline const std::string& getInputs() const;
Gets the input channels and filter parameters to the event process.

Return value:
const std::string&- The input channels and filter parameters.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::getName


const std::string& getName() const;



FrameCPP::Version_3_4_5::Event::getParameters - Additional parameters


inline const std::vector<std::pair<std::string, REAL_4> >& getParameters() const;
Gets additional parameter vector

Return value:
const std::vector >- parameters.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::getProbability - Probability.


inline REAL_4 getProbability() const;
Returns the likelihood estimate of the event, if available. This will be -1 if it cannot be estimated.

Return value:
REAL_4- Probability.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::getSH - Structure Header.


static SH getSH();
Constructs the Structure Header for this class.

Return value:
SH- Structure header for Event Data.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed



FrameCPP::Version_3_4_5::Event::getSH3 - Structure Header.


static SH getSH3();
Constructs frame data format version 3 Structure Header for this class.

Return value:
SH- Structure header for Event Data.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed



FrameCPP::Version_3_4_5::Event::getSH4 - Structure Header.


static SH getSH4();
Constructs frame data format version 4 Structure Header for this class.

Return value:
SH- Structure header for Event Data.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed



FrameCPP::Version_3_4_5::Event::getStatistics - Statistical description.


inline const std::string& getStatistics() const;
Gets the statistical description of the event (if relevant or applicable).

Return value:
const std::string&- Statistics.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::getTimeAfter - Signal duration after event occurence


inline REAL_4 getTimeAfter() const;
Gets signal duration after event occurence.

Return value:
REAL_4- signal duration after event occurence.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::getTimeBefore - Signal duration before event occurence


inline REAL_4 getTimeBefore() const;
Gets signal duration before event occurence.

Return value:
REAL_4- Signal duration before event occurence.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::operator != - Not-equal Comparison.


inline bool operator !=(const Event& eventData) const;
Determines whether two objects are not equal. All contained data is compared.

Parameters:
ParameterDescription
const Event& eventDataThe object to compare with.

Return value:
bool- True if the objects are not equal, false otherwise.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Event::operator += - += Operator.


const Event& operator +=(const Event& event);

Parameters:
ParameterDescription
const Event& eventData to be added.

Return value:
const Event&- This object.


FrameCPP::Version_3_4_5::Event::operator = - Assignment Operator.


const Event& operator =(const Event& eventData);
A deep copy is performed for owned data.

Parameters:
ParameterDescription
const Event& eventDataData to be copied.

Return value:
const Event&- This event.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed.



FrameCPP::Version_3_4_5::Event::operator == - Equal comparison.


bool operator ==(const Event& eventData) const;
Determines whether two Event objects are equal. For this comparison, all of the data is compared.

Parameters:
ParameterDescription
const Event& eventDataThe object to compare with.

Return value:
bool- True if the objects are equal.

Exceptions:
ExceptionDescription
None.



FrameCPP::Version_3_4_5::Event::read - Reads a Event object from an Input object.


static Event* read(FrameReaderBase& in);
This method creates a dynamically allocated object.

*NOTE* This method allocates memory and returns a pointer to it. The user is responsible for freeing this memory.


Parameters:
ParameterDescription
Input& inFrame reader.

Return value:
Event*- Newly allocated and read data.

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed
read_failureRead failed



FrameCPP::Version_3_4_5::Event::read3 - Read FrameCPP version 3 Trigger Data structure.


static Event* read3(FrameReaderBase& in);

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed
read_failureRead failed



FrameCPP::Version_3_4_5::Event::read4 - Read FrameCPP version 4 Trigger Data structure.


static Event* read4(FrameReaderBase& in);

Exceptions:
ExceptionDescription
std::bad_allocMemory allocation failed
read_failureRead failed



FrameCPP::Version_3_4_5::Event::refData - Data Container.


inline Event::DataContainer& refData();
Get the container which contains the data.

Return value:
SearchContainer< Vect, &Vect::getName >&- Data container.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::refData - Data Container


inline const Event::DataContainer& refData() const;
Get the container which contains the data.

Return value:
const SearchContainer< Vect, &Vect::getName >&

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::refTable - Table Container.


inline Event::TableContainer& refTable();
Get table container.

Return value:
SearchContainer< Table, &Table::getName >&- Table.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::refTable - Table Container


inline const Event::TableContainer& refTable() const;
Get table container.

Return value:
const SearchContainer< Table, &Table::getName >&- Table.

Exceptions:
ExceptionDescription
None.
None.



FrameCPP::Version_3_4_5::Event::write - Writes an Event object to an Output object.


virtual void write(Output& out) const;

Parameters:
ParameterDescription
Output& out outOutput data object.

Exceptions:
ExceptionDescription
write_failureWrite failed



Variable Member Descriptions:


FrameCPP::Version_3_4_5::Event::mAmplitude - Continuous output amplitude returned by event.

REAL_4 mAmplitude;

FrameCPP::Version_3_4_5::Event::mComment - Comment.

std::string mComment;

FrameCPP::Version_3_4_5::Event::mData - Additional event results.

DataContainer mData;

FrameCPP::Version_3_4_5::Event::mEventStatus - Defined by event.

INT_4U mEventStatus;

FrameCPP::Version_3_4_5::Event::mGTime - GPS time.

Time mGTime;

FrameCPP::Version_3_4_5::Event::mInputs - Input channels and filter parameters to event process.

std::string mInputs;

FrameCPP::Version_3_4_5::Event::mName - Name of event.

std::string mName;

FrameCPP::Version_3_4_5::Event::mParameters - Additional parameters

std::vector<std::pair<std::string, REAL_4> > mParameters;

FrameCPP::Version_3_4_5::Event::mProbability - Likelihood estimate of event (eq. -1, if can not be estimated).

REAL_4 mProbability;

FrameCPP::Version_3_4_5::Event::mStatistics - Statistical description of event.

std::string mStatistics;

FrameCPP::Version_3_4_5::Event::mTable - Additional event information.

TableContainer mTable;

FrameCPP::Version_3_4_5::Event::mTimeAfter - Signal duration after mGTime.

REAL_4 mTimeAfter;

FrameCPP::Version_3_4_5::Event::mTimeBefore - Signal duration before mGTime.

REAL_4 mTimeBefore;