Module for sorting events based on an ordered list. More...

Inheritance diagram for MSorter:

Public Member Functions
	MSorter (QSequence *s)

virtual	~MSorter ()

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::string	fSortFilename
	this is the name of the file where the sorted list is kept More...

QVector	fEventVector
	vector to store list of events More...

unsigned int	fIndex
	Index to tell which event we are on. 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 based on an ordered list.

Author: Laura Kogler

This module reads a list of events from a file and sorts events in that order.

Config example:

  module Sorter
  verbosity = info
  enable = true
  SortFile = TimeSortedData.txt
  endmod

Parameters:
- SortFile [string = "Sort.txt"] This file must contain a QVector named
  "EventList" which was written by the framework GlobalWriter

This module can be used in conjunction with the module TimeSort to sort events by time as demonstrated in the following example configuration file:


framework
load ASCIIGlobalReader
load ASCIIGlobalWriter
endfw

sequence TimeSort

reader RootFileReader
verbosity = info
enable = true
InputFileName = ../../data/stabilized_OF_q0736.root
endmod

module TimeSort
verbosity = info
enable = true
OutputFilename=../../data/Sort.txt
endmod

endseq

sequence WriteSortedEvents

reader RootFileReader
verbosity = info
enable = true
InputFileName = ../../data/stabilized_OF_q0736.root
endmod

module Sorter
verbosity = info
enable = true
SortFile = ../../data/Sort.txt
endmod

writer RootFileWriter
verbosity = info
enable = true
SaveTempFiles = false
OutputFilePrefix = sorted_
OutputDir = ../../data/
WriteFilesList = false
Description = Time sorted data
endmod

endseq

Definition at line 85 of file MSorter.hh.

Constructor & Destructor Documentation

◆ MSorter()

MSorter::MSorter ( QSequence * s )

Definition at line 19 of file MSorter.cc.

◆ ~MSorter()

MSorter::~MSorter ( )

virtual

Definition at line 23 of file MSorter.cc.

Member Function Documentation

◆ Do()

QEvent * MSorter::Do ( QEvent * ev )

virtual

Definition at line 42 of file MSorter.cc.

References fEventVector, fIndex, and QVector::Size().

◆ Done()

void MSorter::Done ( )

virtual

Done method is called after event loop.

Implements QModule.

Definition at line 57 of file MSorter.cc.

◆ Init()

void MSorter::Init ( )

virtual

Definition at line 27 of file MSorter.cc.

References fEventVector, fIndex, fSortFilename, QBaseModule::GetString(), QBaseModule::Info(), QBaseModule::Panic(), and QVector::Size().

Member Data Documentation

◆ fEventVector

QVector MSorter::fEventVector

private

vector to store list of events

Definition at line 106 of file MSorter.hh.

Referenced by Do(), and Init().

◆ fIndex

unsigned int MSorter::fIndex

private

Index to tell which event we are on.

Definition at line 109 of file MSorter.hh.

Referenced by Do(), and Init().

◆ fSortFilename

std::string MSorter::fSortFilename

private

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

Definition at line 103 of file MSorter.hh.

Referenced by Init().

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

pkg/modtiming/superold/MSorter.hh
pkg/modtiming/superold/MSorter.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MSorter()

◆ ~MSorter()

Member Function Documentation

◆ Do()

◆ Done()

◆ Init()

Member Data Documentation

◆ fEventVector

◆ fIndex

◆ fSortFilename