Unpacks/packs the MC Legacy data originally produced by the GctBlockPacker class. More...

#include <GctFormatTranslateMCLegacy.h>

Inheritance diagram for GctFormatTranslateMCLegacy:

Public Member Functions
virtual bool	convertBlock (const unsigned char *d, const GctBlockHeader &hdr) override
	Get digis from the block - will return true if it succeeds, false otherwise. More...

	GctFormatTranslateMCLegacy (bool hltMode=false, bool unpackSharedRegions=false)
	Constructor. More...

virtual GctBlockHeader	generateBlockHeader (const unsigned char *data) const override
	Generate a block header from four 8-bit values. More...

void	writeAllRctCaloRegionBlock (unsigned char d, const L1CaloRegionCollection rctCalo)
	Writes the giant hack that is the RCT Calo Regions block. More...

void	writeGctOutEmAndEnergyBlock (unsigned char d, const L1GctEmCandCollection iso, const L1GctEmCandCollection nonIso, const L1GctEtTotalCollection etTotal, const L1GctEtHadCollection etHad, const L1GctEtMissCollection etMiss)
	Writes GCT output EM and energy sums block into an unsigned char array, starting at the position pointed to by d. More...

void	writeGctOutJetBlock (unsigned char d, const L1GctJetCandCollection cenJets, const L1GctJetCandCollection forJets, const L1GctJetCandCollection tauJets, const L1GctHFRingEtSumsCollection hfRingSums, const L1GctHFBitCountsCollection hfBitCounts, const L1GctHtMissCollection *htMiss)
	Writes GCT output jet cands and counts into an unsigned char array, starting at the position pointed to by d. More...

void	writeRctEmCandBlocks (unsigned char d, const L1CaloEmCollection rctEm)
	Writes the 4 RCT EM Candidate blocks. More...

virtual	~GctFormatTranslateMCLegacy ()
	Destructor. More...

Public Member Functions inherited from GctFormatTranslateBase
	GctFormatTranslateBase (bool hltMode=false, bool unpackSharedRegions=false)
	Constructor. More...

const std::string &	getBlockDescription (const GctBlockHeader &header) const
	Get block description. More...

void	setPackingBxId (uint32_t bxId)

void	setPackingEventId (uint32_t eventId)

void	setUnpackCollections (GctUnpackCollections *const collections)
	Set the pointer to the unpack collections. More...

virtual	~GctFormatTranslateBase ()
	Destructor. More...

Protected Member Functions
virtual const BlockLengthMap &	blockLengthMap () const overridefinal
	get the static block ID to block-length map. More...

virtual const BlockNameMap &	blockNameMap () const overridefinal
	get the static block ID to blockname map. More...

virtual uint32_t	generateRawHeader (const uint32_t blockId, const uint32_t nSamples, const uint32_t bxId, const uint32_t eventId) const
	Returns a raw 32-bit header word generated from the blockId, number of time samples, bunch-crossing and event IDs. More...

virtual const BlockIdToEmCandIsoBoundMap &	internEmIsoBounds () const overridefinal
	get the static intern EM cand isolated boundary map. More...

virtual const BlkToRctCrateMap &	rctEmCrateMap () const overridefinal
	get static the block ID to RCT crate map for electrons. More...

virtual const BlkToRctCrateMap &	rctJetCrateMap () const overridefinal
	get the static block ID to RCT crate map for jets More...

Protected Member Functions inherited from GctFormatTranslateBase
void	blockDoNothing (const unsigned char *d, const GctBlockHeader &hdr)
	The null unpack function - obviously common to all formats. More...

bool	checkBlock (const GctBlockHeader &hdr) const
	Performs checks on the block header to see if the block is possible to unpack or not. More...

GctUnpackCollections *const	colls () const
	Protected access to the GCT Unpack Collections. More...

L1GctJetCandCollection *const	gctJets (const unsigned cat) const
	Get a specific jet candandiate collection using the JetCandCategory enumeration. More...

bool	hltMode () const
	Protected interface to get HLT optimisation mode flag. More...

const uint32_t	packingBxId () const
	Get the BxId to be used when packing data. More...

const uint32_t	packingEventId () const
	Get the EventId to be used when packing data. More...

const SourceCardRouting &	srcCardRouting () const
	Protected interface to the unpackSharedRegions commissioning option. More...

bool	unpackSharedRegions () const

void	writeRawHeader (unsigned char *data, uint32_t blockId, uint32_t nSamples) const
	Writes a raw block header into the raw data array for a given block ID and number of time-samples. More...

Private Types
typedef std::map< unsigned int, PtrToUnpackFn >	BlockIdToUnpackFnMap
	Typedef for a block ID to unpack function map. More...

typedef void(GctFormatTranslateMCLegacy::*	PtrToUnpackFn )(const unsigned char *, const GctBlockHeader &)
	Function pointer typdef to a block unpack function. More...

Private Member Functions
void	blockToAllRctCaloRegions (const unsigned char *d, const GctBlockHeader &hdr)
	Unpack All RCT Calo Regions ('orrible hack for DigiToRaw use) More...

void	blockToFibres (const unsigned char *d, const GctBlockHeader &hdr)
	unpack Fibres More...

void	blockToFibresAndToRctEmCand (const unsigned char *d, const GctBlockHeader &hdr)
	unpack Fibres and RCT EM Candidates More...

void	blockToGctEmCandsAndEnergySums (const unsigned char *d, const GctBlockHeader &hdr)
	unpack GCT EM Candidates and energy sums. More...

void	blockToGctJetCandsAndCounts (const unsigned char *d, const GctBlockHeader &hdr)
	Unpack GCT Jet Candidates and jet counts. More...

void	blockToRctEmCand (const unsigned char *d, const GctBlockHeader &hdr)
	unpack RCT EM Candidates More...

template<typename Collection >
bool	findBx0OffsetInCollection (unsigned &bx0Offset, const Collection *coll)
	Template function (used in packing) that will find the offset to first item in a collection vector where bx=0. More...

Static Private Attributes
static const BlockLengthMap	m_blockLength
	Map to translate block number to fundamental size of a block (i.e. for 1 time-sample). More...

static const BlockNameMap	m_blockName
	Map to hold a description for each block number. More...

static const BlockIdToUnpackFnMap	m_blockUnpackFn
	Block ID to unpack function map. More...

static const BlockIdToEmCandIsoBoundMap	m_internEmIsoBounds

static const BlkToRctCrateMap	m_rctEmCrate
	Map to relate capture block ID to the RCT crate the data originated from (for electrons). More...

static const BlkToRctCrateMap	m_rctJetCrate
	Map to relate capture block ID to the RCT crate the data originated from (for jets). More...

Additional Inherited Members
Protected Types inherited from GctFormatTranslateBase
typedef std::map< unsigned int, unsigned int >	BlkToRctCrateMap
	Typedef for mapping block ID to RCT crate. More...

typedef std::map< unsigned int, IsoBoundaryPair >	BlockIdToEmCandIsoBoundMap
	A typdef for mapping Block IDs to IsoBoundaryPairs. More...

typedef std::map< unsigned int, unsigned int >	BlockLengthMap
	Block ID to Block Length map. More...

typedef std::pair< unsigned int, unsigned int >	BlockLengthPair
	Block ID/length pair. More...

typedef std::map< unsigned int, std::string >	BlockNameMap
	Block ID to Block Description map. More...

typedef std::pair< unsigned int, std::string >	BlockNamePair
	Block ID/Description pair. More...

enum	EmCandCatagory { NON_ISO_EM_CANDS, ISO_EM_CANDS, NUM_EM_CAND_CATEGORIES }
	An enum of the EM candidate types. More...

typedef std::pair< unsigned int, unsigned int >	IsoBoundaryPair

enum	JetCandCategory { TAU_JETS, FORWARD_JETS, CENTRAL_JETS, NUM_JET_CATEGORIES }
	Useful enumeration for jet candidate pack/unpack. More...

Detailed Description

Unpacks/packs the MC Legacy data originally produced by the GctBlockPacker class.

The data produced by the legacy GctBlockPacker class should have a firmware version header that wasn't set to anything, i.e.: 0x00000000

Author: Robert Frazier

Definition at line 20 of file GctFormatTranslateMCLegacy.h.

Member Typedef Documentation

typedef std::map<unsigned int, PtrToUnpackFn> GctFormatTranslateMCLegacy::BlockIdToUnpackFnMap

private

Typedef for a block ID to unpack function map.

Definition at line 101 of file GctFormatTranslateMCLegacy.h.

typedef void(GctFormatTranslateMCLegacy::* GctFormatTranslateMCLegacy::PtrToUnpackFn)(const unsigned char *, const GctBlockHeader &)

private

Function pointer typdef to a block unpack function.

Definition at line 99 of file GctFormatTranslateMCLegacy.h.

Constructor & Destructor Documentation

GctFormatTranslateMCLegacy::GctFormatTranslateMCLegacy	(	bool	hltMode = `false`,
		bool	unpackSharedRegions = `false`
	)

explicit

Constructor.

Parameters

hltMode	- set true to unpack only BX zero and GCT output data (i.e. to run as quick as possible).
unpackSharedRegions	- this is a commissioning option to unpack the shared RCT calo regions.

Definition at line 86 of file GctFormatTranslateMCLegacy.cc.

GctFormatTranslateMCLegacy::~GctFormatTranslateMCLegacy ( )

virtual

Destructor.

Definition at line 91 of file GctFormatTranslateMCLegacy.cc.

Member Function Documentation

virtual const BlockLengthMap& GctFormatTranslateMCLegacy::blockLengthMap ( ) const

inlinefinaloverrideprotectedvirtual

get the static block ID to block-length map.

Implements GctFormatTranslateBase.

Definition at line 75 of file GctFormatTranslateMCLegacy.h.

virtual const BlockNameMap& GctFormatTranslateMCLegacy::blockNameMap ( ) const

inlinefinaloverrideprotectedvirtual

get the static block ID to blockname map.

Implements GctFormatTranslateBase.

Definition at line 77 of file GctFormatTranslateMCLegacy.h.

void GctFormatTranslateMCLegacy::blockToAllRctCaloRegions	(	const unsigned char *	d,
		const GctBlockHeader &	hdr
	)

private

Unpack All RCT Calo Regions ('orrible hack for DigiToRaw use)

Definition at line 649 of file GctFormatTranslateMCLegacy.cc.

void GctFormatTranslateMCLegacy::blockToFibres	(	const unsigned char *	d,
		const GctBlockHeader &	hdr
	)

private

unpack Fibres

Definition at line 623 of file GctFormatTranslateMCLegacy.cc.

void GctFormatTranslateMCLegacy::blockToFibresAndToRctEmCand	(	const unsigned char *	d,
		const GctBlockHeader &	hdr
	)

private

unpack Fibres and RCT EM Candidates

Definition at line 643 of file GctFormatTranslateMCLegacy.cc.

void GctFormatTranslateMCLegacy::blockToGctEmCandsAndEnergySums	(	const unsigned char *	d,
		const GctBlockHeader &	hdr
	)

private

unpack GCT EM Candidates and energy sums.

Definition at line 453 of file GctFormatTranslateMCLegacy.cc.

void GctFormatTranslateMCLegacy::blockToGctJetCandsAndCounts	(	const unsigned char *	d,
		const GctBlockHeader &	hdr
	)

private

Unpack GCT Jet Candidates and jet counts.

Definition at line 506 of file GctFormatTranslateMCLegacy.cc.

void GctFormatTranslateMCLegacy::blockToRctEmCand	(	const unsigned char *	d,
		const GctBlockHeader &	hdr
	)

private

unpack RCT EM Candidates

Definition at line 567 of file GctFormatTranslateMCLegacy.cc.

bool GctFormatTranslateMCLegacy::convertBlock	(	const unsigned char *	d,
		const GctBlockHeader &	hdr
	)

overridevirtual

Get digis from the block - will return true if it succeeds, false otherwise.

Implements GctFormatTranslateBase.

Definition at line 123 of file GctFormatTranslateMCLegacy.cc.

template<typename Collection >

bool GctFormatTranslateMCLegacy::findBx0OffsetInCollection	(	unsigned &	bx0Offset,
		const Collection *	coll
	)

private

Template function (used in packing) that will find the offset to first item in a collection vector where bx=0.

Returns false if fails to find any item in the collection with bx=0

Definition at line 699 of file GctFormatTranslateMCLegacy.cc.

GctBlockHeader GctFormatTranslateMCLegacy::generateBlockHeader ( const unsigned char * data ) const

overridevirtual

Generate a block header from four 8-bit values.

Implements GctFormatTranslateBase.

Definition at line 95 of file GctFormatTranslateMCLegacy.cc.

uint32_t GctFormatTranslateMCLegacy::generateRawHeader	(	const uint32_t	blockId,
		const uint32_t	nSamples,
		const uint32_t	bxId,
		const uint32_t	eventId
	)		const

protectedvirtual

Returns a raw 32-bit header word generated from the blockId, number of time samples, bunch-crossing and event IDs.

Implements GctFormatTranslateBase.

Definition at line 431 of file GctFormatTranslateMCLegacy.cc.

virtual const BlockIdToEmCandIsoBoundMap& GctFormatTranslateMCLegacy::internEmIsoBounds ( ) const

inlinefinaloverrideprotectedvirtual

get the static intern EM cand isolated boundary map.

Implements GctFormatTranslateBase.

Definition at line 83 of file GctFormatTranslateMCLegacy.h.

virtual const BlkToRctCrateMap& GctFormatTranslateMCLegacy::rctEmCrateMap ( ) const

inlinefinaloverrideprotectedvirtual

get static the block ID to RCT crate map for electrons.

Implements GctFormatTranslateBase.

Definition at line 79 of file GctFormatTranslateMCLegacy.h.

virtual const BlkToRctCrateMap& GctFormatTranslateMCLegacy::rctJetCrateMap ( ) const

inlinefinaloverrideprotectedvirtual

get the static block ID to RCT crate map for jets

Implements GctFormatTranslateBase.

Definition at line 81 of file GctFormatTranslateMCLegacy.h.

void GctFormatTranslateMCLegacy::writeAllRctCaloRegionBlock	(	unsigned char *	d,
		const L1CaloRegionCollection *	rctCalo
	)

Writes the giant hack that is the RCT Calo Regions block.

Definition at line 377 of file GctFormatTranslateMCLegacy.cc.

void GctFormatTranslateMCLegacy::writeGctOutEmAndEnergyBlock	(	unsigned char *	d,
		const L1GctEmCandCollection *	iso,
		const L1GctEmCandCollection *	nonIso,
		const L1GctEtTotalCollection *	etTotal,
		const L1GctEtHadCollection *	etHad,
		const L1GctEtMissCollection *	etMiss
	)

Writes GCT output EM and energy sums block into an unsigned char array, starting at the position pointed to by d.

Parameters

d	must be pointing at the position where the EM Output block header should be written!

Definition at line 139 of file GctFormatTranslateMCLegacy.cc.

void GctFormatTranslateMCLegacy::writeGctOutJetBlock	(	unsigned char *	d,
		const L1GctJetCandCollection *	cenJets,
		const L1GctJetCandCollection *	forJets,
		const L1GctJetCandCollection *	tauJets,
		const L1GctHFRingEtSumsCollection *	hfRingSums,
		const L1GctHFBitCountsCollection *	hfBitCounts,
		const L1GctHtMissCollection *	htMiss
	)

Writes GCT output jet cands and counts into an unsigned char array, starting at the position pointed to by d.

Parameters

d	must be pointing at the position where the Jet Output block header should be written!

Definition at line 211 of file GctFormatTranslateMCLegacy.cc.

void GctFormatTranslateMCLegacy::writeRctEmCandBlocks	(	unsigned char *	d,
		const L1CaloEmCollection *	rctEm
	)

Writes the 4 RCT EM Candidate blocks.

Definition at line 292 of file GctFormatTranslateMCLegacy.cc.

Member Data Documentation

const GctFormatTranslateMCLegacy::BlockLengthMap GctFormatTranslateMCLegacy::m_blockLength

staticprivate

Initial value:

={
  
  {0x000,0},   
  {0x0ff,198}, 
  
  {0x583,8},   
  
  {0x683,6},   
  
  {0x804,15},  
  {0x884,12},  
  {0xc04,15},  
  {0xc84,12}
}

Map to translate block number to fundamental size of a block (i.e. for 1 time-sample).

Definition at line 107 of file GctFormatTranslateMCLegacy.h.

const GctFormatTranslateMCLegacy::BlockNameMap GctFormatTranslateMCLegacy::m_blockName

staticprivate

Initial value:

= {
  
    {0x000,"NULL"},
    {0x0ff,"All RCT Calo Regions"},  
    
    {0x583,"ConcJet: Jet Cands and Counts Output to GT"},
    
    {0x683,"ConcElec: EM Cands and Energy Sums Output to GT"},
    
    {0x804,"Leaf0ElecPosEtaU1: Raw Input"},
    {0x884,"Leaf0ElecPosEtaU2: Raw Input"},
    {0xc04,"Leaf0ElecNegEtaU1: Raw Input"},
    {0xc84,"Leaf0ElecNegEtaU2: Raw Input"}
}

Map to hold a description for each block number.

Definition at line 110 of file GctFormatTranslateMCLegacy.h.

const GctFormatTranslateMCLegacy::BlockIdToUnpackFnMap GctFormatTranslateMCLegacy::m_blockUnpackFn

staticprivate

Initial value:

= {
  
  {0x000,&GctFormatTranslateMCLegacy::blockDoNothing},                    
  {0x0ff,&GctFormatTranslateMCLegacy::blockToAllRctCaloRegions},          
    
  {0x583,&GctFormatTranslateMCLegacy::blockToGctJetCandsAndCounts},       
    
  {0x683,&GctFormatTranslateMCLegacy::blockToGctEmCandsAndEnergySums},    
    
  {0x804,&GctFormatTranslateMCLegacy::blockToFibresAndToRctEmCand},       
  {0x884,&GctFormatTranslateMCLegacy::blockToFibresAndToRctEmCand},       
  {0xc04,&GctFormatTranslateMCLegacy::blockToFibresAndToRctEmCand},       
  {0xc84,&GctFormatTranslateMCLegacy::blockToFibresAndToRctEmCand}       
}

Block ID to unpack function map.

Definition at line 123 of file GctFormatTranslateMCLegacy.h.

const GctFormatTranslateMCLegacy::BlockIdToEmCandIsoBoundMap GctFormatTranslateMCLegacy::m_internEmIsoBounds

staticprivate

A map of Block IDs to IsoBoundaryPairs for storing the location of the isolated Internal EM cands in the pipeline, as this differs with Block ID.

Definition at line 120 of file GctFormatTranslateMCLegacy.h.

const GctFormatTranslateMCLegacy::BlkToRctCrateMap GctFormatTranslateMCLegacy::m_rctEmCrate

staticprivate

Initial value:

= {
  {0x804,13},
  {0x884,9},
  {0xc04,4},
  {0xc84,0}
}

Map to relate capture block ID to the RCT crate the data originated from (for electrons).

Definition at line 113 of file GctFormatTranslateMCLegacy.h.

const GctFormatTranslateMCLegacy::BlkToRctCrateMap GctFormatTranslateMCLegacy::m_rctJetCrate

staticprivate

Map to relate capture block ID to the RCT crate the data originated from (for jets).

Definition at line 116 of file GctFormatTranslateMCLegacy.h.

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation