Module for sorting events by time. More...

Inheritance diagram for MTimeSort:

Public Member Functions
virtual Action	Init (Diana::QEventAssembler &ev)

virtual Action	Do (Diana::QEventAssembler &ev)

virtual Action	Done ()
	Done method is called after event loop. More...

virtual Action	Init (Diana::QEventAssembler &ev)

virtual Action	Do (Diana::QEventAssembler &ev)

virtual Action	Done ()
	Done method is called after event loop. More...

	MTimeSort (QSequence *s)

virtual	~MTimeSort ()

virtual void	Init ()

virtual QEvent *	Do (QEvent *ev)

virtual void	Done ()
	Done method is called after event loop. More...

Public Member Functions inherited from QModule
	QModule ()
	constuctor More...

virtual	~QModule ()
	destructor More...

virtual void	Init (QEvent &ev)=0
	Init method is called before event loop. More...

virtual void	Do (QEvent &ev)
	Do method is called on each event, getting the event as argument. More...

virtual void	Do (QEvent &ev, const QEventList &neighbours)
	Do method is called on each event, getting the event and its neighbours as argument. More...

Public Member Functions inherited from QBaseModule
	QBaseModule (Type type)
	constructor More...

virtual	~QBaseModule ()
	constructor More...

double	GetDouble (const std::string &parname, double defVal, bool warnCfg=true) const
	Get a double parameter from config file. More...

std::vector< double >	GetVectorDouble (const std::string &parname, std::vector< double > defVal, bool warnCfg=true) const
	Get a std::vector<double> parameter from config file with syntax "{x,y,z}". More...

int	GetInt (const std::string &parname, int defVal, bool warnCfg=true) const
	Get an int parameter from config file ( see GetDouble() ) More...

std::vector< int >	GetVectorInt (const std::string &parname, std::vector< int > defVal, bool warnCfg=true) const
	Get an vector<int> parameter from config file ( see GetVectorDouble() ) More...

bool	GetBool (const std::string &parname, bool defVal, bool warnCfg=true) const
	Get a bool parameter from config file ( see GetDouble() ) More...

std::vector< bool >	GetVectorBool (const std::string &parname, std::vector< bool > defVal, bool warnCfg=true) const
	Get a vector<bool> parameter from config file ( see GetVectorDouble() ) More...

const std::string &	GetString (const std::string &parname, const std::string &defVal, bool warnCfg=true) const
	Get a string parameter from config file ( see GetDouble() ) More...

std::vector< std::string >	GetVectorString (const std::string &parname, std::vector< std::string > defVal, bool warnCfg=true) const
	Get a vector<string> parameter from config file ( see GetVectorDouble() ) More...

void	Debug (const char *descr,...) const
	Send a debug message (used to debug the module) with printf syntax. More...

void	Info (const char *descr,...) const
	Send an info message (information) with printf syntax. More...

void	Warn (const char *descr,...) const
	Send a warning message (an error that the framework can recover) with printf syntax. More...

void	Error (const char *descr,...) const
	Send an error message (an error that the framework cannot recover) with printf syntax. More...

void	Panic (const char *descr,...) const
	Send a panic message (stops the framework) with printf syntax. More...

const QGlobalDataManager &	GlobalData () const
	interface for saving and loading global QObjects More...

bool	GetRunAgain () const
	Check if the sequence will be reiterated. More...

void	SetRunAgain (bool b)
	Set that the sequence will be reiterated. More...

unsigned int	GetIteration () const
	Get Current sequence iteration. More...

unsigned int	GetOccurrence () const
	get the number of times the same module is loaded inside a QSequence More...

bool	isEnabled () const
	check if module is enabled More...

std::string	GetFullPath () const
	Get Full Path of module "GetName() + "." + GetOccurrence". More...

const std::string &	GetName () const
	Get Module name. More...

const std::string &	GetLabel () const
	Get Module name + the optional ExtraLabel ("name_extralabel") More...

MsgLevel	GetVerbosity ()
	get verbosity level set from config file More...

const QSequence &	GetSequence () const
	get reference to this sequence More...

void	Update (QSequence *s, unsigned int occurrence)
	set the occurrence in the same sequence. MV FIXME: should not be public More...

bool	NeedNeighbours ()
	check wheter this module needs neighbours (available after the first event is processed) More...

void	BeginBase (QEventAssembler &ev)
	Begin Base method is called before event loop. More...

bool	ProcessBase (QEventAssembler &ev, QEventList &evl, const bool exec, QEventList &ovl)
	ProcessBase method is called for each event, getting the event and as argument. More...

void	EndBase ()
	EndBase method is called after event loop. More...

const std::vector< QEventLabel > &	GetRequiredLabels () const
	Get labels of objects required by this module. More...

Private Attributes
std::map< int, std::vector< std::pair< int, unsigned long long > > >	fEventVector
	this is the name of the file where the sorted list is kept More...

int	fIndex
	An index to keep track of event. More...

int	fIteration
	What iteration are we on? More...

int	fNumberOfEvents
	Number of sorted events. More...

std::map< int, unsigned int >	fStartTime
	Start time of run. More...

std::map< int, std::vector< int > >	fChannelVector
	Vector of channel numbers. More...

bool	fSortByRun

std::string	fOutputFilename
	this is the name of the file where the sorted list is kept More...

std::vector< std::pair< int, unsigned long long > >	fEventVector
	vector to store event number and time More...

int	fStartTime
	Start time of run. More...

std::vector< int >	fChannelVector
	Vector of channel numbers. More...

Additional Inherited Members
Public Types inherited from QBaseModule
enum	Type { Module , Filter , Reader , Writer , Driver }

Protected Member Functions inherited from QBaseModule
QModuleConfig &	GetConfig ()
	Get module config. More...

void	SetNeedNeighbours (bool need)
	set wheter this module needs neighbours More...

Protected Member Functions inherited from QModuleTimeProfiling
	QModuleTimeProfiling ()
	ctor initialized internal variables More...

virtual	~QModuleTimeProfiling ()
	dtor does nothing More...

void	SetTimeProfilingOn (bool val)
	Set the time profiling on/off. More...

bool	GetTimeProfilingOn () const
	Check if the time profiling is on. More...

void	ResetTimer ()
	Reset the timer to now. More...

double	GetTimer () const
	return the time since the last reset More...

virtual void	StartProcessCall ()
	Start of a process call. More...

virtual void	EndProcessCall ()
	End a process call and increment time and calls. More...

unsigned long long	GetProcessCalls () const
	Return the total number of process calls. More...

double	GetTotalProcessTime () const
	Return the total processing time. More...

double	GetProcessCallTime () const
	Return the average time of a single process call. More...

std::string	GetTimeProfileReport (const std::string &prefix="") const
	Report the time profiling. More...

Protected Attributes inherited from QBaseModule
bool	fExecuted

Protected Attributes inherited from QModuleTimeProfiling
bool	fTimeProfilingOn
	Report the time profiling. More...

unsigned long long int	fProcessCalls
	NUmber of calls to the process. More...

double	fProcessTime
	Total time spent running the process. More...

Detailed Description

Module for sorting events by time.

Author: Laura Kogler

This module generates a list of events sorted by time and saves it to an ascii file

Config example:

  driver TimeSort
  verbosity = info
  enable = true
  OutputFilename = TimeSortedData.txt
  SortInPlace = true
  endmod

Parameters:
- OutputFilename [string = ""] This filename MUST end in .txt or .root If no
  filename is specified, event list will not be saved
- SortInPlace [bool = true] If true, the output file will be saved in time sorted order. Requires two iterations. If you just need a text file with a list of sorted events you can skip the second iteration by setting this to false.
This module has been changed to now sort in place without writing any external files; however, can still output a sorted list of events in case it is useful.

Author: Laura Kogler

This module generates a list of events sorted by time and saves it to an ascii file

Config example:

  module TimeSort
  verbosity = info
  enable = true
  OutputFilename = TimeSortedData.txt
  SortInPlace = true
  endmod

Parameters:
- OutputFilename [string = ""] This filename MUST end in .txt or .root If no
  filename is specified, event list will not be saved
- SortInPlace [bool = true] If true, the output file will be saved in time sorted order. Requires two iterations. If you just need a text file with a list of sorted events you can skip the second iteration by setting this to false.
This module has been changed to now sort in place without writing any external files; however, can still output a sorted list of events in case it is useful.

Definition at line 42 of file MTimeSort.hh.

Constructor & Destructor Documentation

◆ MTimeSort()

MTimeSort::MTimeSort ( QSequence * s )

Definition at line 28 of file MTimeSort.cc.

◆ ~MTimeSort()

MTimeSort::~MTimeSort ( )

virtual

Definition at line 32 of file MTimeSort.cc.

Member Function Documentation

◆ Do() [1/3]

virtual Action MTimeSort::Do ( Diana::QEventAssembler & ev )

virtual

◆ Do() [2/3]

virtual Action MTimeSort::Do ( Diana::QEventAssembler & ev )

virtual

◆ Do() [3/3]

QEvent * MTimeSort::Do ( QEvent * ev )

virtual

Definition at line 64 of file MTimeSort.cc.

References err, QBaseModule::Error(), fChannelVector, fEventVector, fIndex, fIteration, fNumberOfEvents, fStartTime, QTime::GetFromStartRunNs(), QEvent::GetReadNumber(), QTime::GetStartRunUnix(), and QERR_SUCCESS.

◆ Done() [1/3]

void MTimeSort::Done ( )

virtual

Done method is called after event loop.

Implements QModule.

Definition at line 118 of file MTimeSort.cc.

References CompareTimes().

◆ Done() [2/3]

virtual Action MTimeSort::Done ( )

virtual

Done method is called after event loop.

Implements QModule.

◆ Done() [3/3]

virtual void MTimeSort::Done ( )

virtual

Done method is called after event loop.

Implements QModule.

◆ Init() [1/3]

void MTimeSort::Init ( )

virtual

Definition at line 36 of file MTimeSort.cc.

References fEventVector, fIndex, fIteration, fOutputFilename, fStartTime, QBaseModule::GetIteration(), QBaseModule::GetString(), and QBaseModule::Panic().

◆ Init() [2/3]

virtual Action MTimeSort::Init ( Diana::QEventAssembler & ev )

virtual

◆ Init() [3/3]

virtual Action MTimeSort::Init ( Diana::QEventAssembler & ev )

virtual

Member Data Documentation

◆ fChannelVector [1/2]

std::vector< int > MTimeSort::fChannelVector

private

Vector of channel numbers.

Definition at line 74 of file MTimeSort.hh.

Referenced by Do().

◆ fChannelVector [2/2]

std::vector<int> MTimeSort::fChannelVector

private

Vector of channel numbers.

Definition at line 73 of file MTimeSort.hh.

◆ fEventVector [1/2]

std::vector< std::pair< int, unsigned long long > > MTimeSort::fEventVector

private

this is the name of the file where the sorted list is kept

vector to store event number and time

Definition at line 59 of file MTimeSort.hh.

Referenced by Do(), and Init().

◆ fEventVector [2/2]

std::vector< std::pair<int, unsigned long long> > MTimeSort::fEventVector

private

vector to store event number and time

Definition at line 58 of file MTimeSort.hh.

◆ fIndex

int MTimeSort::fIndex

private

An index to keep track of event.

Definition at line 62 of file MTimeSort.hh.

Referenced by Do(), and Init().

◆ fIteration

int MTimeSort::fIteration

private

What iteration are we on?

Definition at line 65 of file MTimeSort.hh.

Referenced by Do(), and Init().

◆ fNumberOfEvents

int MTimeSort::fNumberOfEvents

private

Number of sorted events.

Definition at line 68 of file MTimeSort.hh.

Referenced by Do().

◆ fOutputFilename

std::string MTimeSort::fOutputFilename

private

this is the name of the file where the sorted list is kept

Definition at line 55 of file MTimeSort.hh.

Referenced by Init().

◆ fSortByRun

bool MTimeSort::fSortByRun

private

Definition at line 76 of file MTimeSort.hh.

◆ fStartTime [1/2]

int MTimeSort::fStartTime

private

Start time of run.

Definition at line 71 of file MTimeSort.hh.

Referenced by Do(), and Init().

◆ fStartTime [2/2]

int MTimeSort::fStartTime

private

Start time of run.

Definition at line 70 of file MTimeSort.hh.

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

pkg/modtiming/MTimeSort.hh
pkg/modtiming/MTimeSort.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MTimeSort()

◆ ~MTimeSort()

Member Function Documentation

◆ Do() [1/3]

◆ Do() [2/3]

◆ Do() [3/3]

◆ Done() [1/3]

◆ Done() [2/3]

◆ Done() [3/3]

◆ Init() [1/3]

◆ Init() [2/3]

◆ Init() [3/3]

Member Data Documentation

◆ fChannelVector [1/2]

◆ fChannelVector [2/2]

◆ fEventVector [1/2]

◆ fEventVector [2/2]

◆ fIndex

◆ fIteration

◆ fNumberOfEvents

◆ fOutputFilename

◆ fSortByRun

◆ fStartTime [1/2]

◆ fStartTime [2/2]