CMS 3D CMS Logo

L1GctInternJetData Class Reference

L1 GCT internal jet candidate. More...

#include <DataFormats/L1GlobalCaloTrigger/interface/L1GctInternJetData.h>

List of all members.

Public Types

enum  L1GctInternJetType {
  null, jet_cluster, jet_cluster_minimal, jet_precluster,
  gct_trig_object
}

Public Member Functions

int16_t bx () const
 get BX number
uint16_t capBlock () const
 get capture block
uint16_t capIndex () const
 get index within capture block
bool empty () const
 was an object really found?
uint16_t et () const
 get et
uint16_t eta () const
 get eta
 L1GctInternJetData (L1CaloRegionDetId rgn, uint16_t capBlock, uint16_t capIndex, int16_t bx, uint8_t sgnEta, uint8_t oflow, uint16_t et, uint8_t eta, uint8_t phi, uint8_t tauVeto, uint8_t rank)
 construct from individual quantities
 L1GctInternJetData ()
 default constructor (for vector initialisation etc.)
uint16_t oflow () const
 get oflow
bool operator!= (const L1GctInternJetData &c) const
 inequality operator
bool operator== (const L1GctInternJetData &c) const
 equality operator
uint16_t phi () const
 get phi
uint16_t rank () const
 get rank bits
uint32_t raw () const
 get the raw data
L1CaloRegionDetId regionId () const
 region associated with the candidate
void setBx (uint16_t bx)
 set bx
void setCapBlock (uint16_t capBlock)
 set cap block
void setCapIndex (uint16_t capIndex)
 set cap index
void setData (uint8_t sgnEta, uint8_t oflow, uint16_t et, uint8_t eta, uint8_t phi, uint8_t tauVeto, uint8_t rank)
 construct data word from components
void setRawData (uint32_t data)
 set data
void setRegionId (L1CaloRegionDetId rgn)
 set region
void setType (L1GctInternJetType type)
 set type
uint16_t sgnEta () const
 get sign of eta
uint16_t tauVeto () const
 get tau veto
L1GctInternJetData::L1GctInternJetType type () const
 'type' of object
virtual ~L1GctInternJetData ()
 destructor (virtual to prevent compiler warnings)

Static Public Member Functions

static L1GctInternJetData fromGctTrigObject (L1CaloRegionDetId rgn, uint16_t capBlock, uint16_t capIndex, int16_t bx, uint32_t data)
 construct from "gct_trig_object"
static L1GctInternJetData fromJetCluster (L1CaloRegionDetId rgn, uint16_t capBlock, uint16_t capIndex, int16_t bx, uint32_t data)
 construct from "jet_cluster"
static L1GctInternJetData fromJetClusterMinimal (L1CaloRegionDetId rgn, uint16_t capBlock, uint16_t capIndex, int16_t bx, uint32_t data)
 construct from "jet_cluster_minimal"
static L1GctInternJetData fromJetPreCluster (L1CaloRegionDetId rgn, uint16_t capBlock, uint16_t capIndex, int16_t bx, uint32_t data)
 construct from "jet_precluster"

Private Attributes

int16_t bx_
uint16_t capBlock_
uint16_t capIndex_
uint32_t data_
L1CaloRegionDetId regionId_
L1GctInternJetType type_

Detailed Description

L1 GCT internal jet candidate.

Author:
Jim Brooke
Date:
June 2006

Definition at line 15 of file L1GctInternJetData.h.

Member Enumeration Documentation

enum L1GctInternJetData::L1GctInternJetType

Enumerator:
null 
jet_cluster 
jet_cluster_minimal 
jet_precluster 
gct_trig_object 

Definition at line 19 of file L1GctInternJetData.h.

00019 { null, jet_cluster, jet_cluster_minimal, jet_precluster,gct_trig_object };

Constructor & Destructor Documentation

L1GctInternJetData::L1GctInternJetData (  ) 

default constructor (for vector initialisation etc.)

Definition at line 3 of file L1GctInternJetData.cc.

00003                                        :
00004   capBlock_(0),
00005   capIndex_(0),
00006   bx_(0),
00007   type_(null),
00008   data_(0)
00009 {
00010 
00011 }

L1GctInternJetData::L1GctInternJetData ( L1CaloRegionDetId  rgn,
uint16_t  capBlock,
uint16_t  capIndex,
int16_t  bx,
uint8_t  sgnEta,
uint8_t  oflow,
uint16_t  et,
uint8_t  eta,
uint8_t  phi,
uint8_t  tauVeto,
uint8_t  rank 
)

construct from individual quantities

Definition at line 14 of file L1GctInternJetData.cc.

References setData().

00024                                                      :
00025   regionId_(rgn),
00026   capBlock_(capBlock),
00027   capIndex_(capIndex),
00028   bx_(bx),
00029   type_(null),
00030   data_(0)
00031 {
00032   setData(sgnEta, oflow, et, eta, phi, tauVeto, rank);
00033 }

L1GctInternJetData::~L1GctInternJetData (  )  [virtual]

destructor (virtual to prevent compiler warnings)

Definition at line 109 of file L1GctInternJetData.cc.

00109                                         {
00110 
00111 }

Member Function Documentation

int16_t L1GctInternJetData::bx (  )  const [inline]

get BX number

Definition at line 91 of file L1GctInternJetData.h.

References bx_.

Referenced by operator<<(), and operator==().

00091 { return bx_; }

uint16_t L1GctInternJetData::capBlock (  )  const [inline]

get capture block

Definition at line 85 of file L1GctInternJetData.h.

References capBlock_.

Referenced by operator<<().

00085 { return capBlock_; }

uint16_t L1GctInternJetData::capIndex (  )  const [inline]

get index within capture block

Definition at line 88 of file L1GctInternJetData.h.

References capIndex_.

Referenced by operator<<().

00088 { return capIndex_; }

bool L1GctInternJetData::empty (  )  const [inline]

was an object really found?

Definition at line 82 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

00082 { return (data_ == 0); }

uint16_t L1GctInternJetData::et (  )  const [inline]

get et

Definition at line 109 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

00109 { return (data_>>16) & 0xfff; }

uint16_t L1GctInternJetData::eta (  )  const [inline]

get eta

Definition at line 106 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

00106 { return (data_>>12) & 0xf; }

L1GctInternJetData L1GctInternJetData::fromGctTrigObject ( L1CaloRegionDetId  rgn,
uint16_t  capBlock,
uint16_t  capIndex,
int16_t  bx,
uint32_t  data 
) [static]

construct from "gct_trig_object"

Definition at line 91 of file L1GctInternJetData.cc.

References d, gct_trig_object, setBx(), setCapBlock(), setCapIndex(), setData(), setRegionId(), and setType().

Referenced by GctFormatTranslateV35::blockToGctTrigObjects(), and GctFormatTranslateV38::blockToGctTrigObjects().

00095                                                                         {
00096   L1GctInternJetData d;
00097 
00098   d.setRegionId(rgn);
00099   d.setCapBlock(capBlock);
00100   d.setCapIndex(capIndex);
00101   d.setBx(bx);
00102   d.setType(gct_trig_object);
00103   d.setData( (data>>10)&0x1, 0, 0, (data>>6)&0xf, (data>>11)&0x1f, 0, data&0x3f );
00104 
00105   return d;
00106 }

L1GctInternJetData L1GctInternJetData::fromJetCluster ( L1CaloRegionDetId  rgn,
uint16_t  capBlock,
uint16_t  capIndex,
int16_t  bx,
uint32_t  data 
) [static]

construct from "jet_cluster"

Definition at line 37 of file L1GctInternJetData.cc.

References d, jet_cluster, setBx(), setCapBlock(), setCapIndex(), setRawData(), setRegionId(), and setType().

00041                                                                      {
00042   L1GctInternJetData d;
00043 
00044   d.setRegionId(rgn);
00045   d.setCapBlock(capBlock);
00046   d.setCapIndex(capIndex);
00047   d.setBx(bx);
00048   d.setType(jet_cluster);
00049   d.setRawData(data&0x1fffffff);
00050 
00051   return d;
00052 }

L1GctInternJetData L1GctInternJetData::fromJetClusterMinimal ( L1CaloRegionDetId  rgn,
uint16_t  capBlock,
uint16_t  capIndex,
int16_t  bx,
uint32_t  data 
) [static]

construct from "jet_cluster_minimal"

Definition at line 73 of file L1GctInternJetData.cc.

References d, jet_cluster_minimal, setBx(), setCapBlock(), setCapIndex(), setData(), setRegionId(), and setType().

Referenced by GctFormatTranslateV35::blockToGctJetClusterMinimal(), and GctFormatTranslateV38::blockToGctJetClusterMinimal().

00077                                                                             {
00078   L1GctInternJetData d;
00079 
00080   d.setRegionId(rgn);
00081   d.setCapBlock(capBlock);
00082   d.setCapIndex(capIndex);
00083   d.setBx(bx);
00084   d.setType(jet_cluster_minimal);
00085   d.setData( 0, (data>>10)&0x1, 0, (data>>6)&0xf, (data>>12)&0x1, (data>>11)&0x1, data&0x3f );
00086 
00087   return d;
00088 }

L1GctInternJetData L1GctInternJetData::fromJetPreCluster ( L1CaloRegionDetId  rgn,
uint16_t  capBlock,
uint16_t  capIndex,
int16_t  bx,
uint32_t  data 
) [static]

construct from "jet_precluster"

Definition at line 55 of file L1GctInternJetData.cc.

References d, jet_precluster, setBx(), setCapBlock(), setCapIndex(), setData(), setRegionId(), and setType().

Referenced by GctFormatTranslateV35::blockToGctJetPreCluster(), and GctFormatTranslateV38::blockToGctJetPreCluster().

00059                                                                         {
00060   L1GctInternJetData d;
00061 
00062   d.setRegionId(rgn);
00063   d.setCapBlock(capBlock);
00064   d.setCapIndex(capIndex);
00065   d.setBx(bx);
00066   d.setType(jet_precluster);
00067   d.setData( 0, (data>>10)&0x1, data&0x3ff, (data>>12)&0xf, 0, (data>>11)&0x1, 0 );
00068 
00069   return d;
00070 }

uint16_t L1GctInternJetData::oflow (  )  const [inline]

get oflow

Definition at line 112 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

00112 { return (data_>>28) & 0x1; }

bool L1GctInternJetData::operator!= ( const L1GctInternJetData &  c  )  const [inline]

inequality operator

Definition at line 154 of file L1GctInternJetData.h.

00154 { return !(*this == c); }

bool L1GctInternJetData::operator== ( const L1GctInternJetData &  c  )  const

equality operator

operators

equality operator

Definition at line 136 of file L1GctInternJetData.cc.

References bx(), bx_, data_, raw(), regionId(), regionId_, type(), and type_.

00136                                                                      {
00137   return (type_ == c.type() && data_ == c.raw() && regionId_ == c.regionId() && bx_ == c.bx());
00138 }

uint16_t L1GctInternJetData::phi (  )  const [inline]

get phi

Definition at line 103 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

00103 { return (data_>>7) & 0x1f; }

uint16_t L1GctInternJetData::rank (  )  const [inline]

get rank bits

Definition at line 97 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

00097 { return data_ & 0x3f; }

uint32_t L1GctInternJetData::raw (  )  const [inline]

get the raw data

Definition at line 94 of file L1GctInternJetData.h.

References data_.

Referenced by operator==().

00094 { return data_; }

L1CaloRegionDetId L1GctInternJetData::regionId (  )  const [inline]

region associated with the candidate

Definition at line 79 of file L1GctInternJetData.h.

References regionId_.

Referenced by operator==().

00079 { return regionId_; }

void L1GctInternJetData::setBx ( uint16_t  bx  )  [inline]

set bx

Definition at line 130 of file L1GctInternJetData.h.

References bx_.

Referenced by fromGctTrigObject(), fromJetCluster(), fromJetClusterMinimal(), and fromJetPreCluster().

00130 { bx_ = bx; }

void L1GctInternJetData::setCapBlock ( uint16_t  capBlock  )  [inline]

set cap block

Definition at line 124 of file L1GctInternJetData.h.

References capBlock_.

Referenced by fromGctTrigObject(), fromJetCluster(), fromJetClusterMinimal(), and fromJetPreCluster().

00124 { capBlock_ = capBlock; }

void L1GctInternJetData::setCapIndex ( uint16_t  capIndex  )  [inline]

set cap index

Definition at line 127 of file L1GctInternJetData.h.

References capIndex_.

Referenced by fromGctTrigObject(), fromJetCluster(), fromJetClusterMinimal(), and fromJetPreCluster().

00127 { capIndex_ = capIndex; }

void L1GctInternJetData::setData ( uint8_t  sgnEta,
uint8_t  oflow,
uint16_t  et,
uint8_t  eta,
uint8_t  phi,
uint8_t  tauVeto,
uint8_t  rank 
)

construct data word from components

construct

Definition at line 115 of file L1GctInternJetData.cc.

References data_.

Referenced by fromGctTrigObject(), fromJetClusterMinimal(), fromJetPreCluster(), and L1GctInternJetData().

00121                                                {
00122   data_ = 0;
00123   data_ = rank & 0x3f;
00124   data_ |= (tauVeto & 0x1) << 6;
00125   data_ |= (phi & 0x1f) << 7;
00126   data_ |= (eta & 0xf) << 12;
00127   data_ |= (et & 0xfff) << 16;
00128   data_ |= (oflow & 0x1) << 28;
00129   data_ |= (sgnEta & 0x1) << 29;
00130 }

void L1GctInternJetData::setRawData ( uint32_t  data  )  [inline]

set data

Definition at line 136 of file L1GctInternJetData.h.

References data_.

Referenced by fromJetCluster().

00136 { data_ = data; }

void L1GctInternJetData::setRegionId ( L1CaloRegionDetId  rgn  )  [inline]

set region

Definition at line 121 of file L1GctInternJetData.h.

References regionId_.

Referenced by fromGctTrigObject(), fromJetCluster(), fromJetClusterMinimal(), and fromJetPreCluster().

00121 { regionId_ = rgn; }

void L1GctInternJetData::setType ( L1GctInternJetType  type  )  [inline]

set type

Definition at line 133 of file L1GctInternJetData.h.

References type_.

Referenced by fromGctTrigObject(), fromJetCluster(), fromJetClusterMinimal(), and fromJetPreCluster().

00133 { type_ = type; }

uint16_t L1GctInternJetData::sgnEta (  )  const [inline]

get sign of eta

Definition at line 115 of file L1GctInternJetData.h.

References data_.

00115 { return (data_>>29) & 0x1; }

uint16_t L1GctInternJetData::tauVeto (  )  const [inline]

get tau veto

Definition at line 100 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

00100 { return (data_>>6) & 0x1; }

L1GctInternJetData::L1GctInternJetType L1GctInternJetData::type (  )  const [inline]

'type' of object

Definition at line 76 of file L1GctInternJetData.h.

References type_.

Referenced by operator<<(), and operator==().

00076 { return type_; }

Member Data Documentation

int16_t L1GctInternJetData::bx_ [private]

Definition at line 165 of file L1GctInternJetData.h.

Referenced by bx(), operator==(), and setBx().

uint16_t L1GctInternJetData::capBlock_ [private]

Definition at line 163 of file L1GctInternJetData.h.

Referenced by capBlock(), and setCapBlock().

uint16_t L1GctInternJetData::capIndex_ [private]

Definition at line 164 of file L1GctInternJetData.h.

Referenced by capIndex(), and setCapIndex().

uint32_t L1GctInternJetData::data_ [private]

Definition at line 171 of file L1GctInternJetData.h.

Referenced by empty(), et(), eta(), oflow(), operator==(), phi(), rank(), raw(), setData(), setRawData(), sgnEta(), and tauVeto().

L1CaloRegionDetId L1GctInternJetData::regionId_ [private]

Definition at line 160 of file L1GctInternJetData.h.

Referenced by operator==(), regionId(), and setRegionId().

L1GctInternJetType L1GctInternJetData::type_ [private]

Definition at line 168 of file L1GctInternJetData.h.

Referenced by operator==(), setType(), and type().

The documentation for this class was generated from the following files:
Generated on Tue Jun 9 18:26:33 2009 for CMSSW by  doxygen 1.5.4