CMS 3D CMS Logo
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes

L1GctInternJetData Class Reference

L1 GCT internal jet candidate. More...

#include <L1GctInternJetData.h>

List of all members.

Public Types

enum  L1GctInternJetType {
  null, emulator, 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 fromEmulator (L1CaloRegionDetId rgn, int16_t bx, uint16_t et, bool overFlow, bool tauVeto, uint8_t eta, uint8_t phi, uint16_t rank)
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 
emulator 
jet_cluster 
jet_cluster_minimal 
jet_precluster 
gct_trig_object 

Definition at line 19 of file L1GctInternJetData.h.

{ null, emulator, 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.

                                       :
  capBlock_(0),
  capIndex_(0),
  bx_(0),
  type_(null),
  data_(0)
{

}
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().

                                                     :
  regionId_(rgn),
  capBlock_(capBlock),
  capIndex_(capIndex),
  bx_(bx),
  type_(null),
  data_(0)
{
  setData(sgnEta, oflow, et, eta, phi, tauVeto, rank);
}
L1GctInternJetData::~L1GctInternJetData ( ) [virtual]

destructor (virtual to prevent compiler warnings)

Definition at line 129 of file L1GctInternJetData.cc.

                                        {

}

Member Function Documentation

int16_t L1GctInternJetData::bx ( ) const [inline]

get BX number

Definition at line 102 of file L1GctInternJetData.h.

References bx_.

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

{ return bx_; }
uint16_t L1GctInternJetData::capBlock ( ) const [inline]

get capture block

Definition at line 96 of file L1GctInternJetData.h.

References capBlock_.

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

{ return capBlock_; }
uint16_t L1GctInternJetData::capIndex ( ) const [inline]

get index within capture block

Definition at line 99 of file L1GctInternJetData.h.

References capIndex_.

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

{ return capIndex_; }
bool L1GctInternJetData::empty ( ) const [inline]

was an object really found?

Definition at line 93 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

{ return (data_ == 0); }
uint16_t L1GctInternJetData::et ( ) const [inline]

get et

Definition at line 120 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

{ return (data_>>16) & 0xfff; }
uint16_t L1GctInternJetData::eta ( ) const [inline]

get eta

Definition at line 117 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

{ return (data_>>12) & 0xf; }
L1GctInternJetData L1GctInternJetData::fromEmulator ( L1CaloRegionDetId  rgn,
int16_t  bx,
uint16_t  et,
bool  overFlow,
bool  tauVeto,
uint8_t  eta,
uint8_t  phi,
uint16_t  rank 
) [static]

Definition at line 38 of file L1GctInternJetData.cc.

References emulator, setBx(), setData(), setRegionId(), and setType().

Referenced by L1GctJetFinderBase::getInternalJets().

                                                                   {
  L1GctInternJetData d;

  d.setType(emulator);
  d.setRegionId(rgn);
  d.setData(0, (oflow ? 1 : 0), et, eta, phi, (tauVeto ? 1 : 0), rank);
  d.setBx(bx);

  return d;
}
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 111 of file L1GctInternJetData.cc.

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

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

                                                                        {
  L1GctInternJetData d;

  d.setRegionId(rgn);
  d.setCapBlock(capBlock);
  d.setCapIndex(capIndex);
  d.setBx(bx);
  d.setType(gct_trig_object);
  d.setData( (data>>10)&0x1, 0, 0, (data>>6)&0xf, (data>>11)&0x1f, 0, data&0x3f );

  return d;
}
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 57 of file L1GctInternJetData.cc.

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

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

                                                                     {
  L1GctInternJetData d;

  d.setRegionId(rgn);
  d.setCapBlock(capBlock);
  d.setCapIndex(capIndex);
  d.setBx(bx);
  d.setType(jet_cluster);
  d.setRawData(data&0x1fffffff);

  return d;
}
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 93 of file L1GctInternJetData.cc.

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

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

                                                                            {
  L1GctInternJetData d;

  d.setRegionId(rgn);
  d.setCapBlock(capBlock);
  d.setCapIndex(capIndex);
  d.setBx(bx);
  d.setType(jet_cluster_minimal);
  d.setData( 0, (data>>10)&0x1, 0, (data>>6)&0xf, (data>>12)&0x1, (data>>11)&0x1, data&0x3f );

  return d;
}
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 75 of file L1GctInternJetData.cc.

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

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

                                                                        {
  L1GctInternJetData d;

  d.setRegionId(rgn);
  d.setCapBlock(capBlock);
  d.setCapIndex(capIndex);
  d.setBx(bx);
  d.setType(jet_precluster);
  d.setData( 0, (data>>10)&0x1, data&0x3ff, (data>>12)&0xf, 0, (data>>11)&0x1, 0 );

  return d;
}
uint16_t L1GctInternJetData::oflow ( ) const [inline]

get oflow

Definition at line 123 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

{ return (data_>>28) & 0x1; }
bool L1GctInternJetData::operator!= ( const L1GctInternJetData &  c) const [inline]

inequality operator

Definition at line 165 of file L1GctInternJetData.h.

References trackerHits::c.

{ return !(*this == c); }
bool L1GctInternJetData::operator== ( const L1GctInternJetData &  c) const

equality operator

operators

Definition at line 156 of file L1GctInternJetData.cc.

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

                                                                     {
  return (type_ == c.type() && data_ == c.raw() && regionId_ == c.regionId() && bx_ == c.bx());
}
uint16_t L1GctInternJetData::phi ( ) const [inline]

get phi

Definition at line 114 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

{ return (data_>>7) & 0x1f; }
uint16_t L1GctInternJetData::rank ( ) const [inline]

get rank bits

Definition at line 108 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

{ return data_ & 0x3f; }
uint32_t L1GctInternJetData::raw ( ) const [inline]

get the raw data

Definition at line 105 of file L1GctInternJetData.h.

References data_.

Referenced by operator==().

{ return data_; }
L1CaloRegionDetId L1GctInternJetData::regionId ( ) const [inline]

region associated with the candidate

Definition at line 90 of file L1GctInternJetData.h.

References regionId_.

Referenced by operator==().

{ return regionId_; }
void L1GctInternJetData::setBx ( uint16_t  bx) [inline]

set bx

Definition at line 141 of file L1GctInternJetData.h.

References bx(), and bx_.

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

{ bx_ = bx; }
void L1GctInternJetData::setCapBlock ( uint16_t  capBlock) [inline]

set cap block

Definition at line 135 of file L1GctInternJetData.h.

References capBlock(), and capBlock_.

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

{ capBlock_ = capBlock; }
void L1GctInternJetData::setCapIndex ( uint16_t  capIndex) [inline]

set cap index

Definition at line 138 of file L1GctInternJetData.h.

References capIndex(), and capIndex_.

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

{ 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 135 of file L1GctInternJetData.cc.

References data_.

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

                                               {
  data_ = 0;
  data_ = rank & 0x3f;
  data_ |= (tauVeto & 0x1) << 6;
  data_ |= (phi & 0x1f) << 7;
  data_ |= (eta & 0xf) << 12;
  data_ |= (et & 0xfff) << 16;
  data_ |= (oflow & 0x1) << 28;
  data_ |= (sgnEta & 0x1) << 29;
}
void L1GctInternJetData::setRawData ( uint32_t  data) [inline]

set data

Definition at line 147 of file L1GctInternJetData.h.

References data, and data_.

Referenced by fromJetCluster().

{ data_ = data; }
void L1GctInternJetData::setRegionId ( L1CaloRegionDetId  rgn) [inline]

set region

Definition at line 132 of file L1GctInternJetData.h.

References regionId_.

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

{ regionId_ = rgn; }
void L1GctInternJetData::setType ( L1GctInternJetType  type) [inline]

set type

Definition at line 144 of file L1GctInternJetData.h.

References type(), and type_.

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

{ type_ = type; }
uint16_t L1GctInternJetData::sgnEta ( ) const [inline]

get sign of eta

Definition at line 126 of file L1GctInternJetData.h.

References data_.

{ return (data_>>29) & 0x1; }
uint16_t L1GctInternJetData::tauVeto ( ) const [inline]

get tau veto

Definition at line 111 of file L1GctInternJetData.h.

References data_.

Referenced by operator<<().

{ return (data_>>6) & 0x1; }
L1GctInternJetData::L1GctInternJetType L1GctInternJetData::type ( ) const [inline]

'type' of object

Definition at line 87 of file L1GctInternJetData.h.

References type_.

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

{ return type_; }

Member Data Documentation

int16_t L1GctInternJetData::bx_ [private]

Definition at line 176 of file L1GctInternJetData.h.

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

uint16_t L1GctInternJetData::capBlock_ [private]

Definition at line 174 of file L1GctInternJetData.h.

Referenced by capBlock(), and setCapBlock().

uint16_t L1GctInternJetData::capIndex_ [private]

Definition at line 175 of file L1GctInternJetData.h.

Referenced by capIndex(), and setCapIndex().

uint32_t L1GctInternJetData::data_ [private]

Definition at line 182 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 171 of file L1GctInternJetData.h.

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

L1GctInternJetType L1GctInternJetData::type_ [private]

Definition at line 179 of file L1GctInternJetData.h.

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

Generated for CMSSW Reference Manual by doxygen 1.7.3