#include <LaserSorter.h>

Inheritance diagram for LaserSorter:

Classes
struct	IndexRecord

class	OutStreamRecord

struct	stats_t

Public Member Functions
virtual void	analyze (const edm::Event &, const edm::EventSetup &)

virtual void	beginJob ()

virtual void	beginRun (edm::Run const &, edm::EventSetup const &)

virtual void	endJob ()

	LaserSorter (const edm::ParameterSet &)

	~LaserSorter ()

Public Member Functions inherited from edm::EDAnalyzer
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	EDAnalyzer ()

ModuleDescription const &	moduleDescription () const

std::string	workerType () const

virtual	~EDAnalyzer ()

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

	EDConsumerBase ()

ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const

std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesDependentUpon (std::string const &iProcessName, std::string const &iModuleLabel, bool iPrint, std::vector< char const * > &oModuleLabels) const

void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)

virtual	~EDConsumerBase ()

Private Types
typedef boost::ptr_list < OutStreamRecord >	OutStreamList

Private Member Functions
void	closeAllStreams ()

void	closeOldStreams (edm::LuminosityBlockNumber_t lumiBlock)

OutStreamList::iterator	closeOutStream (OutStreamList::iterator streamRecord)

OutStreamList::iterator	createOutStream (int fedId, edm::LuminosityBlockNumber_t lumiBlock)

int	dcc2Lme (int dccNum, int dccSide)

int	getDetailedTriggerType (const edm::Handle< FEDRawDataCollection > &rawdata, double *proba=0)

std::vector< int >	getFullyReadoutDccs (const FEDRawDataCollection &data) const

int	getOrbitFromDcc (const edm::Handle< FEDRawDataCollection > &rawdata) const

void	getOutputFedList (const edm::Event &event, const FEDRawDataCollection &data, std::vector< unsigned > &fedIds) const

OutStreamRecord *	getStream (int fedId, edm::LuminosityBlockNumber_t lumiBlock)

bool	isDccEventEmpty (const FEDRawData &data, size_t dccLen=0, int nTowerBlocks=0) const

int	readFormatVersion (std::ifstream &in, const std::string &fileName)

bool	readIndexTable (std::ifstream &in, std::string &inName, OutStreamRecord &outRcd, std::string *err)

bool	renameAsBackup (const std::string &fileName, std::string &newFileName)

void	restoreStreamsOfLumiBlock (int lumiBlock)

void	streamFileName (int fedId, edm::LuminosityBlockNumber_t lumiBlock, std::string &tmpName, std::string &finalName)

bool	writeEvent (OutStreamRecord &out, const edm::Event &event, int detailedTriggerType, const FEDRawDataCollection &data)

bool	writeEventHeader (std::ofstream &out, const edm::Event &evt, int fedId, unsigned nFeds)

bool	writeFedBlock (std::ofstream &out, const FEDRawData &data)

void	writeFileHeader (std::ofstream &out)

bool	writeIndexTable (std::ofstream &out, std::vector< IndexRecord > &indices)

Static Private Member Functions
static std::string	toString (uint64_t t)

Private Attributes
int	detailedTrigType_

bool	disableOutput_

bool	doOutputList_

edm::InputTag	fedRawDataCollectionTag_

edm::EDGetTokenT < FEDRawDataCollection >	fedRawDataCollectionToken_

std::vector< std::string >	fedSubDirs_

unsigned char	formatVersion_

int	iNoEcalDataMess_

int	iNoFullReadoutDccError_

std::ofstream	logFile_

edm::LuminosityBlockNumber_t	lumiBlock_

edm::LuminosityBlockNumber_t	lumiBlockPrev_

int	lumiBlockSpan_

int	maxFullReadoutDccError_

int	maxNoEcalDataMess_

int	orbit_

int	orbitCountInALumiBlock_

struct timeval	orbitZeroTime_

std::string	outputDir_

std::ofstream	outputList_

std::string	outputListFile_

OutStreamList	outStreamList_

bool	overWriteLumiBlockId_

edm::RunNumber_t	runNumber_

struct LaserSorter::stats_t	stats_

std::ofstream	timeLog_

std::string	timeLogFile_

timeval	timer_

bool	timing_

int	verbosity_

Static Private Attributes
static const int	ecalDccFedIdMax_ = 654

static const int	ecalDccFedIdMin_ = 601

static const int	indexOffset32_ = 1

static const int	matacqFedId_ = 655

static const unsigned	maxEvents_ = 1<<20

static const stats_t	stats_init = {0, 0, 0, 0, 0}

Additional Inherited Members
Public Types inherited from edm::EDAnalyzer
typedef EDAnalyzer	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Static Public Member Functions inherited from edm::EDAnalyzer
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)

ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...

template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()

void	consumesMany (const TypeToGet &id)

template<BranchType B>
void	consumesMany (const TypeToGet &id)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Detailed Description

This module is used to classify events of laser sequence acquired in a global run. Sorting: Events are grouped by bunch of consecutive events from the same FED. A file of such a bunch of events is identified by the FED or ECAL sector and the luminosity block id of the first event.

Sorting strategy: It is assumes that:

one sequence FED does not overlap more than two lumi blocks.
lumi blocks are read in order A FED file will be closed as soon as one event 2 lumi block ahead from the first event feed in the file is read.

File completion: while being feeding, .part is appended at the end of the each output file.Once a file is completed (see above), it is renamed without the enclosing .part suffix.

Definition at line 44 of file LaserSorter.h.

Member Typedef Documentation

typedef boost::ptr_list<OutStreamRecord> LaserSorter::OutStreamList

private

Definition at line 117 of file LaserSorter.h.

Constructor & Destructor Documentation

LaserSorter::LaserSorter ( const edm::ParameterSet & pset )

Definition at line 80 of file LaserSorter.cc.

LaserSorter::~LaserSorter ( )

Definition at line 169 of file LaserSorter.cc.

Member Function Documentation

void LaserSorter::analyze	(	const edm::Event &	event,
		const edm::EventSetup &	es
	)

virtual

Implements edm::EDAnalyzer.

Definition at line 181 of file LaserSorter.cc.

void LaserSorter::beginJob ( void )

virtual

Reimplemented from edm::EDAnalyzer.

Definition at line 951 of file LaserSorter.cc.

void LaserSorter::beginRun	(	edm::Run const &	run,
		edm::EventSetup const &	es
	)

virtual

Reimplemented from edm::EDAnalyzer.

Definition at line 1217 of file LaserSorter.cc.

void LaserSorter::closeAllStreams ( )

private

Closes all opened output streams.

Definition at line 468 of file LaserSorter.cc.

void LaserSorter::closeOldStreams ( edm::LuminosityBlockNumber_t lumiBlock )

private

Closes output stream 2 lumi block older than the input 'lumiBlock' ID.

Parameters

lumiBlock ID of the reference luminosity block.

Definition at line 475 of file LaserSorter.cc.

LaserSorter::OutStreamList::iterator LaserSorter::closeOutStream ( OutStreamList::iterator streamRecord )

private

Closes an output stream and removed it from opened stream records. Beware: this methode modifies outStreamList_.

Parameters

streamRecord record of the output stream to close.

Returns: iterator to element next to the deleted one.

Definition at line 897 of file LaserSorter.cc.

LaserSorter::OutStreamList::iterator LaserSorter::createOutStream	(	int	fedId,
		edm::LuminosityBlockNumber_t	lumiBlock
	)

private

Creates an output stream. It must be ensured before calling this method that the output stream is not already opened (See outStreamList_).

Parameters

fedId	FED ID of the event to stream out.
lumiBlock	starting lumi block of the event group to write to the stream.

Returns: iterator to the new stream record. outStreamList_.end() in case of failure.

Definition at line 640 of file LaserSorter.cc.

int LaserSorter::dcc2Lme	(	int	dccNum,
		int	dccSide
	)

private

Definition at line 374 of file LaserSorter.cc.

void LaserSorter::endJob ( void )

virtual

Reimplemented from edm::EDAnalyzer.

Definition at line 945 of file LaserSorter.cc.

int LaserSorter::getDetailedTriggerType	(	const edm::Handle< FEDRawDataCollection > &	rawdata,
		double *	proba = `0`
	)

private

Retrieve detailed trigger type (trigger type, DCC, side) from raw event

Parameters

rawdata	FED data collection
proba	if not null used to store the maximum of occurence frequency of the detailed trigger types (DTT) appearing in each DCC block. In normal condition every DCC indicated the same DTT and this value is 1.

Returns: detailed trigger type. In case of descripancy between the DCCs, the most frequent value is returned if it covers more than 80% of the present DCC blocks, -1 is returned otherwise. If event does not contain any ECAL data -2 is returned.

Definition at line 427 of file LaserSorter.cc.

std::vector< int > LaserSorter::getFullyReadoutDccs ( const FEDRawDataCollection & data ) const

private

Retrieves DCCs which were fully read out (>=68 readout channels).

Parameters

data	DCC data collection

Returns: FED ids.

Definition at line 1025 of file LaserSorter.cc.

int LaserSorter::getOrbitFromDcc ( const edm::Handle< FEDRawDataCollection > & rawdata ) const

private

Retrieves the orbit ID from DCC headers. The first header found is used. the raw data where to read the orbit id.

Returns: the event orbit ID or -1 if it was not found

Definition at line 405 of file LaserSorter.cc.

void LaserSorter::getOutputFedList	(	const edm::Event &	event,
		const FEDRawDataCollection &	data,
		std::vector< unsigned > &	fedIds
	)		const

private

Computes the list of FEDs which data must be written out.

Parameters

data	CMS raw event
fedIds	[out] list of FEDs to keep

Definition at line 997 of file LaserSorter.cc.

LaserSorter::OutStreamRecord * LaserSorter::getStream	(	int	fedId,
		edm::LuminosityBlockNumber_t	lumiBlock
	)

private

Gets and eventually creates the output stream for writing the events of a given FED and luminosity block.

Parameters

fedId	ID of the FED the event is issued from
lumiBlock	luminositu block of the event

Returns: pointer of the output stream record or null if not found.

Definition at line 500 of file LaserSorter.cc.

bool LaserSorter::isDccEventEmpty	(	const FEDRawData &	data,
		size_t *	dccLen = `0`,
		int *	nTowerBlocks = `0`
	)		const

private

Checks if an ECAL DCC event is empty. It is considered as empty if it does not contains FE data ("tower" block). So an event containing SRP or TCC data can be tagged as empty by this method. , if not null filled with the event length read from the DCC header. if not null, filled with number of tower blocks

Returns: true if event is empty, false otherwise

Definition at line 954 of file LaserSorter.cc.

int LaserSorter::readFormatVersion	(	std::ifstream &	in,
		const std::string &	fileName
	)

private

Gets format version of an LMF file. Position of file is preserved.

Parameters

in	stream to read the file
fileName	name of the file. Used in error message.

Returns: version or -1 in case of error.

Definition at line 1151 of file LaserSorter.cc.

bool LaserSorter::readIndexTable	(	std::ifstream &	in,
		std::string &	inName,
		OutStreamRecord &	outRcd,
		std::string *	err
	)

private

Read index table of an LMF file.

Parameters

in	LMF file whose index table must be read.
inName	name of the in file
outRcd	record of the output file. whose the index table must be copied to.
err	if not nul, in case of failure filled with the error message.

Returns: true in case of success, false otherwise

Definition at line 1077 of file LaserSorter.cc.

bool LaserSorter::renameAsBackup	(	const std::string &	fileName,
		std::string &	newFileName
	)

private

Definition at line 618 of file LaserSorter.cc.

void LaserSorter::restoreStreamsOfLumiBlock ( int lumiBlock )

private

Opens output streams associated to a lumi block according to already existing files. To be used when previously processed luminosity block is not

Parameters

lumiBlock ID of the luminosity block whose output streams must be reopened.

Definition at line 1199 of file LaserSorter.cc.

void LaserSorter::streamFileName	(	int	fedId,
		edm::LuminosityBlockNumber_t	lumiBlock,
		std::string &	tmpName,
		std::string &	finalName
	)

private

Builds the file names for the group of event corresponding to a FED and a starting lumi block.

Parameters

	fedId	FED ID of the event set
	lumiBlock	starting luminoisty block of the event set
[out]	tmpName	name of the file to use when filling it.
[out]	finalName	name of the file once completed.

Definition at line 843 of file LaserSorter.cc.

std::string LaserSorter::toString ( uint64_t t )

staticprivate

Help function to format a date

Definition at line 1184 of file LaserSorter.cc.

bool LaserSorter::writeEvent	(	OutStreamRecord &	out,
		const edm::Event &	event,
		int	detailedTriggerType,
		const FEDRawDataCollection &	data
	)

private

Writes a monitoring events to an output stream.

Parameters

out	stream to write the event out
event	EDM event, used to retrieve meta information like timestamp and ID.
ID	of the unique FED block of the event
data	DCC data

Returns: true on success, false on failure

See Also: getStream(int, edm::LuminosityBlockNumber_t)

Definition at line 530 of file LaserSorter.cc.

bool LaserSorter::writeEventHeader	(	std::ofstream &	out,
		const edm::Event &	evt,
		int	fedId,
		unsigned	nFeds
	)

private

Write event header with event identification and timestamp.

Parameters

out	output stream to write to
evt	event

Returns: false in case of write failure

Definition at line 793 of file LaserSorter.cc.

bool LaserSorter::writeFedBlock	(	std::ofstream &	out,
		const FEDRawData &	data
	)

private

Writes out data of a FED

Parameters

out	stream to write the event out
data	FED data

Returns: true on success, false on failure

Definition at line 581 of file LaserSorter.cc.

void LaserSorter::writeFileHeader ( std::ofstream & out )

private

Writing file header for an LMF binary file

Parameters

out	stream of the output file

Definition at line 776 of file LaserSorter.cc.

bool LaserSorter::writeIndexTable	(	std::ofstream &	out,
		std::vector< IndexRecord > &	indices
	)

private

Writes index table in LMF output file. stream must be positionned to the place for the index table (end of file).

Parameters

out	stream of output file.
indices	index table

Definition at line 1037 of file LaserSorter.cc.

Member Data Documentation

int LaserSorter::detailedTrigType_

private

Trigger type of calibration event. -1 if unkown.

Definition at line 320 of file LaserSorter.h.

bool LaserSorter::disableOutput_

private

Switch to disable writing output file (for test purpose).

Definition at line 357 of file LaserSorter.h.

bool LaserSorter::doOutputList_

private

Switch for logging paths of the output files

Definition at line 381 of file LaserSorter.h.

const int LaserSorter::ecalDccFedIdMax_ = 654

staticprivate

Lower bound of ECAL DCC FED ID

Definition at line 316 of file LaserSorter.h.

const int LaserSorter::ecalDccFedIdMin_ = 601

staticprivate

Lower bound of ECAL DCC FED ID

Definition at line 312 of file LaserSorter.h.

edm::InputTag LaserSorter::fedRawDataCollectionTag_

private

Definition at line 441 of file LaserSorter.h.

edm::EDGetTokenT<FEDRawDataCollection> LaserSorter::fedRawDataCollectionToken_

private

Definition at line 442 of file LaserSorter.h.

std::vector<std::string> LaserSorter::fedSubDirs_

private

Subdirectories for output file of each FED

Definition at line 349 of file LaserSorter.h.

unsigned char LaserSorter::formatVersion_

private

Data format version of lmf output file

Definition at line 341 of file LaserSorter.h.

const int LaserSorter::indexOffset32_ = 1

staticprivate

Definition at line 450 of file LaserSorter.h.

int LaserSorter::iNoEcalDataMess_

private

number of "ECAL DCC data" message in a run

Definition at line 422 of file LaserSorter.h.

int LaserSorter::iNoFullReadoutDccError_

private

Number of "No fully readout DCC error"

Definition at line 412 of file LaserSorter.h.

std::ofstream LaserSorter::logFile_

private

File for logging

Definition at line 324 of file LaserSorter.h.

edm::LuminosityBlockNumber_t LaserSorter::lumiBlock_

private

Luminosity block of event under processing

Definition at line 328 of file LaserSorter.h.

edm::LuminosityBlockNumber_t LaserSorter::lumiBlockPrev_

private

Luminosity block of previous processed event

Definition at line 332 of file LaserSorter.h.

int LaserSorter::lumiBlockSpan_

private

Tolerance on lumi block spanning of a FED sequence. Subsequent events of a same FED must span at most on 2*lumiBlockSpan_+1 luminosity blocks.

It is important that the laser sequence scane does not pass twice on the same FED within the 2*lumiBlockSpan_+1. Failing this requirement will result mixing event of different passes in the same output file.
The number of input files opened simultinuously is proportional to 2*lumiBlockSpan_+1. So increasing lumiBlockSpan_ will also increase the number of opened files and may have some impact of sorting time performances.

Definition at line 439 of file LaserSorter.h.

const int LaserSorter::matacqFedId_ = 655

staticprivate

FED ID associated to Matacq data

Definition at line 446 of file LaserSorter.h.

const unsigned LaserSorter::maxEvents_ = 1<<20

staticprivate

Limit of number of events to prevent exhausting memory with indexTable_ in case of file corruption.

Definition at line 455 of file LaserSorter.h.

int LaserSorter::maxFullReadoutDccError_

private

Maximum number of "No fully readout DCC error" message in a run

Definition at line 417 of file LaserSorter.h.

int LaserSorter::maxNoEcalDataMess_

private

Maximum number of "ECAL DCC data" message in a run

Definition at line 426 of file LaserSorter.h.

int LaserSorter::orbit_

private

Definition at line 486 of file LaserSorter.h.

int LaserSorter::orbitCountInALumiBlock_

private

Length of a lumi block in number of orbits used when overWriteLumiBlockId is set to true; LB = orbit_id / orbitCountInALumiBlock_

Definition at line 484 of file LaserSorter.h.

struct timeval LaserSorter::orbitZeroTime_

private

Time stamp offset to use to calculate calibration time from the orbit id. It is obtained from the matacq block (time originates from the PC hosting the laser supervisor). and used in case the event is missing timestamp, in principle for data acquired with the minidaq Calibration event time = orbitZeroTime_ + orbit_ * (89.1 microsec).

Definition at line 495 of file LaserSorter.h.

std::string LaserSorter::outputDir_

private

Top directory for output files

Definition at line 345 of file LaserSorter.h.

std::ofstream LaserSorter::outputList_

private

stream where list of output file is listed to

Definition at line 389 of file LaserSorter.h.

std::string LaserSorter::outputListFile_

private

name of file where list of output file is listed to

Definition at line 377 of file LaserSorter.h.

OutStreamList LaserSorter::outStreamList_

private

List of output stream to write sorted data

Definition at line 337 of file LaserSorter.h.

bool LaserSorter::overWriteLumiBlockId_

private

Switch to recompute and overwrite the lumi block ID

Definition at line 477 of file LaserSorter.h.

edm::RunNumber_t LaserSorter::runNumber_

private

Run number of event under process

Definition at line 361 of file LaserSorter.h.

struct LaserSorter::stats_t LaserSorter::stats_

private

const LaserSorter::stats_t LaserSorter::stats_init = {0, 0, 0, 0, 0}

staticprivate

Definition at line 473 of file LaserSorter.h.

std::ofstream LaserSorter::timeLog_

private

Output stream to log code timing

Definition at line 369 of file LaserSorter.h.

std::string LaserSorter::timeLogFile_

private

Name of the file to log the processing time

Definition at line 353 of file LaserSorter.h.

timeval LaserSorter::timer_

private

Buffer for timing

Definition at line 365 of file LaserSorter.h.

bool LaserSorter::timing_

private

Switch for code timing.

Definition at line 373 of file LaserSorter.h.

int LaserSorter::verbosity_

private

Debugging message verbosity level

Definition at line 385 of file LaserSorter.h.

Classes

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation