CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
GctFormatTranslateV35.h
Go to the documentation of this file.
1 #ifndef GctFormatTranslateV35_h_
2 #define GctFormatTranslateV35_h_
3 
5 
15 // ************************************************************************
16 // *** THE TRANSLATION PROCESS MUST NEVER THROW ANY KIND OF EXCEPTION! ***
17 // ************************************************************************
18 
20 {
21 public:
22 
23  /* PUBLIC METHODS */
24 
26 
28  explicit GctFormatTranslateV35(bool hltMode = false, bool unpackSharedRegions = false);
29 
30  virtual ~GctFormatTranslateV35();
31 
33  virtual GctBlockHeader generateBlockHeader(const unsigned char * data) const;
34 
36  virtual bool convertBlock(const unsigned char * d, const GctBlockHeader& hdr);
37 
38 
39  /* ------------------------------ */
40  /* Public Block Packing Functions */
41  /* ------------------------------ */
42 
43  // -- TO DO --
44 
45 
46 protected:
47 
48  /* PROTECTED METHODS */
49 
50  /* Static data member access methods */
52  virtual const BlockLengthMap& blockLengthMap() const { return m_blockLength; }
53 
54  virtual BlockNameMap& blockNameMap() { return m_blockName; }
55  virtual const BlockNameMap& blockNameMap() const { return m_blockName; }
56 
58  virtual const BlkToRctCrateMap& rctEmCrateMap() const { return m_rctEmCrate; }
59 
61  virtual const BlkToRctCrateMap& rctJetCrateMap() const { return m_rctJetCrate; }
62 
65 
66 
67  /* Other general methods */
69  virtual uint32_t generateRawHeader(const uint32_t blockId,
70  const uint32_t nSamples,
71  const uint32_t bxId,
72  const uint32_t eventId) const;
73 
74 
75 private:
76 
77  /* PRIVATE TYPEDEFS */
78 
80  typedef void (GctFormatTranslateV35::*PtrToUnpackFn)(const unsigned char *, const GctBlockHeader&);
82  typedef std::map<unsigned int, PtrToUnpackFn> BlockIdToUnpackFnMap;
83 
84 
85  /* PRIVATE MEMBER DATA */
86 
89 
92 
95 
98 
102 
105 
106 
107  /* PRIVATE METHODS */
108 
109  /* --------------------------------- */
110  /* Private Block Unpacking Functions */
111  /* --------------------------------- */
112 
114  void blockToGctEmCandsAndEnergySums(const unsigned char * d, const GctBlockHeader& hdr);
115 
117  void blockToGctJetCandsAndCounts(const unsigned char * d, const GctBlockHeader& hdr);
118 
120  void blockToGctInternEmCand(const unsigned char * d, const GctBlockHeader& hdr);
121 
123  void blockToRctEmCand(const unsigned char * d, const GctBlockHeader& hdr);
124 
126  void blockToRctCaloRegions(const unsigned char * d, const GctBlockHeader& hdr);
127 
129  void blockToFibres(const unsigned char * d, const GctBlockHeader& hdr);
130 
132  void blockToFibresAndToRctEmCand(const unsigned char * d, const GctBlockHeader& hdr);
133 
135  void blockToGctInternEtSums(const unsigned char * d, const GctBlockHeader& hdr);
136 
138  void blockToGctInternEtSumsAndJetCluster(const unsigned char * d, const GctBlockHeader& hdr);
139 
141  void blockToGctTrigObjects(const unsigned char * d, const GctBlockHeader& hdr);
142 
144  void blockToGctJetClusterMinimal(const unsigned char * d, const GctBlockHeader& hdr);
145 
147  void blockToGctJetPreCluster(const unsigned char * d, const GctBlockHeader& hdr);
148 
150  void blockToGctInternRingSums(const unsigned char * d, const GctBlockHeader& hdr);
151 
153  void blockToGctWheelOutputInternEtAndRingSums(const unsigned char * d, const GctBlockHeader& hdr);
154 
156  void blockToGctWheelInputInternEtAndRingSums(const unsigned char * d, const GctBlockHeader& hdr);
157 };
158 
159 #endif
virtual BlkToRctCrateMap & rctJetCrateMap()
get the static block ID to RCT crate map for jets
virtual GctBlockHeader generateBlockHeader(const unsigned char *data) const
Generate a block header from four 8-bit values.
virtual const BlkToRctCrateMap & rctEmCrateMap() const
get static the block ID to RCT crate map for electrons.
static BlockLengthMap m_blockLength
Map to translate block number to fundamental size of a block (i.e. for 1 time-sample).
void blockToRctCaloRegions(const unsigned char *d, const GctBlockHeader &hdr)
Unpack RCT Calo Regions.
virtual const BlockNameMap & blockNameMap() const
get the static block ID to blockname map.
GctFormatTranslateV35(bool hltMode=false, bool unpackSharedRegions=false)
Constructor.
void blockToGctJetCandsAndCounts(const unsigned char *d, const GctBlockHeader &hdr)
Unpack GCT Jet Candidates and jet counts.
Abstract interface for RawToDigi/DigiToRaw conversions of GCT data.
void blockToGctJetPreCluster(const unsigned char *d, const GctBlockHeader &hdr)
unpack GCT internal shared jet finder info
virtual bool convertBlock(const unsigned char *d, const GctBlockHeader &hdr)
Get digis from the block - will return true if it succeeds, false otherwise.
void blockToFibres(const unsigned char *d, const GctBlockHeader &hdr)
unpack Fibres
void blockToGctInternRingSums(const unsigned char *d, const GctBlockHeader &hdr)
unpack GCT internal HF ring sums
void blockToGctTrigObjects(const unsigned char *d, const GctBlockHeader &hdr)
unpack GCT internal wheel and conc jets
void blockToGctEmCandsAndEnergySums(const unsigned char *d, const GctBlockHeader &hdr)
unpack GCT EM Candidates and energy sums.
virtual const BlockIdToEmCandIsoBoundMap & internEmIsoBounds() const
get the static intern EM cand isolated boundary map.
virtual BlkToRctCrateMap & rctEmCrateMap()
get the static block ID to RCT crate map for electrons.
void blockToGctWheelInputInternEtAndRingSums(const unsigned char *d, const GctBlockHeader &hdr)
unpack GCT internal input to wheel
Simple class for holding the basic attributes of an 32-bit block header.
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.
Unpacks/packs the V35 raw format.
static BlkToRctCrateMap m_rctEmCrate
Map to relate capture block ID to the RCT crate the data originated from (for electrons).
void blockToGctInternEmCand(const unsigned char *d, const GctBlockHeader &hdr)
unpack GCT internal EM Candidates
virtual BlockNameMap & blockNameMap()
get the static block ID to block-name map.
void blockToGctJetClusterMinimal(const unsigned char *d, const GctBlockHeader &hdr)
unpack GCT internal input to wheel jet sort
virtual BlockLengthMap & blockLengthMap()
get the static block ID to block-length map.
std::map< unsigned int, unsigned int > BlockLengthMap
Block ID to Block Length map.
bool hltMode() const
Protected interface to get HLT optimisation mode flag.
void blockToGctInternEtSums(const unsigned char *d, const GctBlockHeader &hdr)
unpack GCT internal Et sums
void blockToGctInternEtSumsAndJetCluster(const unsigned char *d, const GctBlockHeader &hdr)
unpack GCT internal output of leaf jet finder
static BlkToRctCrateMap m_rctJetCrate
Map to relate capture block ID to the RCT crate the data originated from (for jets).
virtual const BlockLengthMap & blockLengthMap() const
get the static block ID to block-length map.
void blockToFibresAndToRctEmCand(const unsigned char *d, const GctBlockHeader &hdr)
unpack Fibres and RCT EM Candidates
virtual ~GctFormatTranslateV35()
Destructor.
static BlockIdToUnpackFnMap m_blockUnpackFn
Block ID to unpack function map.
void blockToRctEmCand(const unsigned char *d, const GctBlockHeader &hdr)
unpack RCT EM Candidates
virtual const BlkToRctCrateMap & rctJetCrateMap() const
get the static block ID to RCT crate map for jets
std::map< unsigned int, IsoBoundaryPair > BlockIdToEmCandIsoBoundMap
A typdef for mapping Block IDs to IsoBoundaryPairs.
std::map< unsigned int, unsigned int > BlkToRctCrateMap
Typedef for mapping block ID to RCT crate.
std::map< unsigned int, std::string > BlockNameMap
Block ID to Block Description map.
void blockToGctWheelOutputInternEtAndRingSums(const unsigned char *d, const GctBlockHeader &hdr)
unpack GCT internal output of wheel
static BlockNameMap m_blockName
Map to hold a description for each block number.
virtual BlockIdToEmCandIsoBoundMap & internEmIsoBounds()
get the static intern EM cand isolated boundary map.
void(GctFormatTranslateV35::* PtrToUnpackFn)(const unsigned char *, const GctBlockHeader &)
Function pointer typdef to a block unpack function.
std::map< unsigned int, PtrToUnpackFn > BlockIdToUnpackFnMap
Typedef for a block ID to unpack function map.
static BlockIdToEmCandIsoBoundMap m_internEmIsoBounds