CSCALCTDigi Class Reference

#include <CSCALCTDigi.h>

Public Types
enum	Version { Version::Legacy = 0, Version::Run3 }
typedef std::vector < std::vector< uint16_t > >	WireContainer

Public Member Functions
void	clear ()
	clear this ALCT More...
	CSCALCTDigi (const uint16_t valid, const uint16_t quality, const uint16_t accel, const uint16_t patternb, const uint16_t keywire, const uint16_t bx, const uint16_t trknmb=0, const uint16_t hmt=0, const Version version=Version::Legacy)
	Constructors. More...
	CSCALCTDigi ()
	default More...
uint16_t	getAccelerator () const
uint16_t	getBX () const
	return BX - five low bits of BXN counter tagged by the ALCT More...
uint16_t	getCollisionB () const
uint16_t	getFullBX () const
	return 12-bit full BX. More...
const WireContainer &	getHits () const
uint16_t	getHMT () const
	return the high multiplicity bits More...
uint16_t	getKeyWG () const
	return key wire group More...
uint16_t	getQuality () const
	return quality of a pattern More...
uint16_t	getTrknmb () const
	return track number (1,2) More...
bool	isRun3 () const
	Distinguish Run-1/2 from Run-3. More...
bool	isValid () const
	check ALCT validity (1 - valid ALCT) More...
bool	operator!= (const CSCALCTDigi &) const
	True if the preceding one is false. More...
bool	operator== (const CSCALCTDigi &) const
	True if all members (except the number) of both ALCTs are equal. More...
bool	operator> (const CSCALCTDigi &) const
void	print () const
	Print content of digi. More...
void	setAccelerator (const uint16_t accelerator)
	set accelerator bit More...
void	setBX (const uint16_t BX)
	set BX More...
void	setCollisionB (const uint16_t collision)
	set Collision Pattern B bit More...
void	setFullBX (const uint16_t fullbx)
	Set 12-bit full BX. More...
void	setHits (const WireContainer &hits)
void	setHMT (const uint16_t hmt)
	set the high multiplicity bits More...
void	setKeyWG (const uint16_t keyWG)
	set key wire group More...
void	setQuality (const uint16_t quality)
	set quality More...
void	setRun3 (const bool isRun3)
void	setTrknmb (const uint16_t number)
	Set track number (1,2) after sorting ALCTs. More...
void	setValid (const uint16_t valid)
	set valid More...
void	setWireGroup (uint16_t wiregroup)
	set wiregroup number More...

Static Private Member Functions
static const WireContainer &	emptyContainer ()

Private Attributes
uint16_t	accel_
uint16_t	bx_
uint16_t	fullbx_
WireContainer	hits_
uint16_t	hmt_
uint16_t	keywire_
uint16_t	patternb_
uint16_t	quality_
uint16_t	trknmb_
uint16_t	valid_
Version	version_

Detailed Description

Digi for ALCT trigger primitives.

Author

N. Terentiev, CMU

Definition at line 17 of file CSCALCTDigi.h.

Member Typedef Documentation

typedef std::vector<std::vector<uint16_t> > CSCALCTDigi::WireContainer

Definition at line 21 of file CSCALCTDigi.h.

Member Enumeration Documentation

enum CSCALCTDigi::Version

strong

Enumerator
Legacy
Run3

Definition at line 19 of file CSCALCTDigi.h.

{ Legacy = 0, Run3 };

Constructor & Destructor Documentation

CSCALCTDigi::CSCALCTDigi	(	const uint16_t	valid,
		const uint16_t	quality,
		const uint16_t	accel,
		const uint16_t	patternb,
		const uint16_t	keywire,
		const uint16_t	bx,
		const uint16_t	trknmb = 0,
		const uint16_t	hmt = 0,
		const Version	version = Version::Legacy
	)

Constructors.

Definition at line 35 of file CSCALCTDigi.cc.

    : valid_(valid),
      quality_(quality),
      accel_(accel),
      patternb_(patternb),
      keywire_(keywire),
      bx_(bx),
      trknmb_(trknmb),
      hmt_(hmt),
      version_(version) {}

CSCALCTDigi::CSCALCTDigi

(

)

default

Default.

Definition at line 55 of file CSCALCTDigi.cc.

References clear().

                         {
  clear();  // set contents to zero
}

Member Function Documentation

void CSCALCTDigi::clear

(

void

)

clear this ALCT

Clears this ALCT.

Definition at line 60 of file CSCALCTDigi.cc.

References accel_, bx_, fullbx_, hits_, hmt_, keywire_, Legacy, patternb_, quality_, trknmb_, valid_, and version_.

Referenced by CSCCorrelatedLCTDigi::clear(), CSCAnodeLCTProcessor::clear(), CSCGEMMotherboard::correlateLCTsGEM(), CSCALCTDigi(), CSCGEMMotherboard::dropLowQualityALCTNoClusters(), and BeautifulSoup.Tag::setString().

                        {
  valid_ = 0;
  quality_ = 0;
  accel_ = 0;
  patternb_ = 0;
  keywire_ = 0;
  bx_ = 0;
  trknmb_ = 0;
  fullbx_ = 0;
  hmt_ = 0;
  hits_.clear();
  version_ = Version::Legacy;
}

CSCALCTDigi::WireContainer const & CSCALCTDigi::emptyContainer ( )

staticprivate

Definition at line 29 of file CSCALCTDigi.cc.

Referenced by getHits().

                                                            {
  static WireContainer const s_container = makeEmptyContainer();
  return s_container;
}

uint16_t CSCALCTDigi::getAccelerator ( ) const

inline

return Accelerator bit 1-Accelerator pattern, 0-CollisionA or CollisionB pattern

Definition at line 53 of file CSCALCTDigi.h.

References accel_.

Referenced by CSCALCTs2006::addALCT0(), CSCALCTs2006::addALCT1(), LCTQualityAssignment::findQualityGEMv1(), LCTQualityAssignment::findQualityRun2(), CSCAnodeLCTProcessor::isBetterALCT(), operator<<(), operator==(), and print().

{ return accel_; }

uint16_t CSCALCTDigi::getBX ( ) const

inline

return BX - five low bits of BXN counter tagged by the ALCT

Definition at line 73 of file CSCALCTDigi.h.

References bx_.

Referenced by CSCALCTs2006::addALCT0(), CSCALCTs2006::addALCT1(), LCTQualityControl::checkValid(), CSCMotherboard::constructLCTs(), CSCGEMMotherboard::constructLCTsGEM(), CSCMotherboard::getBXShiftedALCT(), CSCAnodeLCTProcessor::isBetterALCT(), CSCGEMMatcher::matchingClustersBX(), operator<<(), operator==(), operator>(), and print().

{ return bx_; }

uint16_t CSCALCTDigi::getCollisionB ( ) const

inline

return Collision Pattern B bit 1-CollisionB pattern (accel_ = 0), 0-CollisionA pattern (accel_ = 0)

Definition at line 61 of file CSCALCTDigi.h.

References patternb_.

Referenced by CSCALCTs2006::addALCT0(), CSCALCTs2006::addALCT1(), LCTQualityControl::checkValid(), operator<<(), operator==(), and print().

{ return patternb_; }

uint16_t CSCALCTDigi::getFullBX ( ) const

inline

return 12-bit full BX.

Definition at line 85 of file CSCALCTDigi.h.

References fullbx_.

Referenced by CSCAnodeLCTProcessor::lctSearch(), and print().

{ return fullbx_; }

const WireContainer& CSCALCTDigi::getHits ( ) const

inline

Definition at line 118 of file CSCALCTDigi.h.

References emptyContainer(), and hits_.

{ return hits_.empty() ? emptyContainer() : hits_; }

uint16_t CSCALCTDigi::getHMT

(

)

const

return the high multiplicity bits

Definition at line 74 of file CSCALCTDigi.cc.

References hmt_, isRun3(), and SiStripPI::max.

{ return (isRun3() ? hmt_ : std::numeric_limits<uint16_t>::max()); }

uint16_t CSCALCTDigi::getKeyWG ( ) const

inline

return key wire group

Definition at line 67 of file CSCALCTDigi.h.

References keywire_.

Referenced by CSCALCTs2006::addALCT0(), CSCALCTs2006::addALCT1(), CSCAnodeLCTProcessor::bestTrackSelector(), LCTQualityControl::checkValid(), CSCMotherboard::constructLCTs(), CSCGEMMotherboard::constructLCTsGEM(), CSCALCTCrossCLCT::doesALCTCrossCLCT(), CSCGEMMatcher::matchingClustersLoc(), operator<<(), operator==(), operator>(), and print().

{ return keywire_; }

uint16_t CSCALCTDigi::getQuality ( ) const

inline

return quality of a pattern

Definition at line 46 of file CSCALCTDigi.h.

References quality_.

Referenced by CSCALCTs2006::addALCT0(), CSCALCTs2006::addALCT1(), CSCAnodeLCTProcessor::bestTrackSelector(), LCTQualityControl::checkValid(), CSCGEMMotherboard::dropLowQualityALCTNoClusters(), LCTQualityAssignment::findQualityGEMv1(), LCTQualityAssignment::findQualityRun2(), LCTQualityAssignment::findQualityRun3(), CSCAnodeLCTProcessor::isBetterALCT(), operator<<(), operator==(), operator>(), print(), and L1TMuon::TriggerPrimitive::TriggerPrimitive().

{ return quality_; }

uint16_t CSCALCTDigi::getTrknmb ( ) const

inline

return track number (1,2)

Definition at line 79 of file CSCALCTDigi.h.

References trknmb_.

Referenced by LCTQualityControl::checkValid(), operator<<(), and print().

{ return trknmb_; }

bool CSCALCTDigi::isRun3 ( ) const

inline

Distinguish Run-1/2 from Run-3.

Definition at line 113 of file CSCALCTDigi.h.

References Run3, and version_.

Referenced by getHMT(), and setHMT().

{ return version_ == Version::Run3; }

bool CSCALCTDigi::isValid ( void  ) const

inline

check ALCT validity (1 - valid ALCT)

Definition at line 40 of file CSCALCTDigi.h.

References valid_.

Referenced by ntupleDataFormat._Object::_checkIsValid(), CSCALCTs2006::addALCT0(), CSCALCTs2006::addALCT1(), CSCGEMMatcher::bestClusterBXLoc(), CSCAnodeLCTProcessor::bestTrackSelector(), LCTQualityControl::checkValid(), CSCMotherboard::constructLCTs(), CSCMotherboard::copyValidToInValid(), CSCMotherboard::correlateLCTs(), CSCGEMMotherboard::correlateLCTsGEM(), CSCALCTCrossCLCT::doesALCTCrossCLCT(), LCTQualityAssignment::findQualityGEMv1(), LCTQualityAssignment::findQualityGEMv2(), LCTQualityAssignment::findQualityRun2(), LCTQualityAssignment::findQualityRun3(), CSCAnodeLCTProcessor::isBetterALCT(), CSCGEMMatcher::matchingClustersBX(), CSCGEMMatcher::matchingClustersBXLoc(), CSCGEMMatcher::matchingClustersLoc(), operator<<(), operator==(), print(), and core.AutoHandle.AutoHandle::ReallyLoad().

{ return valid_; }

bool CSCALCTDigi::operator!=

(

const CSCALCTDigi &

rhs

)

const

True if the preceding one is false.

Definition at line 114 of file CSCALCTDigi.cc.

                                                         {
  // True if == is false.
  bool returnValue = true;
  if ((*this) == rhs)
    returnValue = false;
  return returnValue;
}

bool CSCALCTDigi::operator==

(

const CSCALCTDigi &

rhs

)

const

True if all members (except the number) of both ALCTs are equal.

Definition at line 104 of file CSCALCTDigi.cc.

References getAccelerator(), getBX(), getCollisionB(), getKeyWG(), getQuality(), and isValid().

                                                         {
  // Exact equality.
  bool returnValue = false;
  if (isValid() == rhs.isValid() && getQuality() == rhs.getQuality() && getAccelerator() == rhs.getAccelerator() &&
      getCollisionB() == rhs.getCollisionB() && getKeyWG() == rhs.getKeyWG() && getBX() == rhs.getBX()) {
    returnValue = true;
  }
  return returnValue;
}

bool CSCALCTDigi::operator>

(

const CSCALCTDigi &

rhs

)

const

True if the first ALCT has a larger quality, or if it has the same quality but a larger wire group.

Definition at line 80 of file CSCALCTDigi.cc.

References getBX(), getKeyWG(), and getQuality().

                                                        {
  bool returnValue = false;

  // Early ALCTs are always preferred to the ones found at later bx's.
  if (getBX() < rhs.getBX()) {
    returnValue = true;
  }
  if (getBX() != rhs.getBX()) {
    return returnValue;
  }

  // The > operator then checks the quality of ALCTs.
  // If two qualities are equal, the ALCT furthest from the beam axis
  // (lowest eta, highest wire group number) is selected.
  uint16_t quality1 = getQuality();
  uint16_t quality2 = rhs.getQuality();
  if (quality1 > quality2) {
    returnValue = true;
  } else if (quality1 == quality2 && getKeyWG() > rhs.getKeyWG()) {
    returnValue = true;
  }
  return returnValue;
}

void CSCALCTDigi::print

(

void

)

const

Print content of digi.

Debug.

Definition at line 123 of file CSCALCTDigi.cc.

References getAccelerator(), getBX(), getCollisionB(), getFullBX(), getKeyWG(), getQuality(), getTrknmb(), and isValid().

                              {
  if (isValid()) {
    edm::LogVerbatim("CSCDigi") << "CSC ALCT #" << setw(1) << getTrknmb() << ": Valid = " << setw(1) << isValid()
                                << " Quality = " << setw(2) << getQuality() << " Accel. = " << setw(1)
                                << getAccelerator() << " PatternB = " << setw(1) << getCollisionB()
                                << " Key wire group = " << setw(3) << getKeyWG() << " BX = " << setw(2) << getBX()
                                << " Full BX = " << std::setw(1) << getFullBX();
  } else {
    edm::LogVerbatim("CSCDigi") << "Not a valid Anode LCT.";
  }
}

void CSCALCTDigi::setAccelerator ( const uint16_t  accelerator )

inline

set accelerator bit

Definition at line 56 of file CSCALCTDigi.h.

References accel_.

{ accel_ = accelerator; }

void CSCALCTDigi::setBX ( const uint16_t  BX )

inline

set BX

Definition at line 76 of file CSCALCTDigi.h.

References L1TStage2uGTEmulatorClient_cff::BX, and bx_.

Referenced by CSCMotherboard::getBXShiftedALCT().

{ bx_ = BX; }

void CSCALCTDigi::setCollisionB ( const uint16_t  collision )

inline

set Collision Pattern B bit

Definition at line 64 of file CSCALCTDigi.h.

References patternb_.

{ patternb_ = collision; }

void CSCALCTDigi::setFullBX ( const uint16_t  fullbx )

inline

Set 12-bit full BX.

Definition at line 88 of file CSCALCTDigi.h.

References fullbx_.

{ fullbx_ = fullbx; }

void CSCALCTDigi::setHits ( const WireContainer &  hits )

inline

Definition at line 120 of file CSCALCTDigi.h.

References hits_.

Referenced by CSCAnodeLCTProcessor::setWireContainer().

{ hits_ = hits; }

void CSCALCTDigi::setHMT

(

const uint16_t

hmt

)

set the high multiplicity bits

Definition at line 76 of file CSCALCTDigi.cc.

References hmt_, isRun3(), and SiStripPI::max.

{ hmt_ = isRun3() ? h : std::numeric_limits<uint16_t>::max(); }

void CSCALCTDigi::setKeyWG ( const uint16_t  keyWG )

inline

set key wire group

Definition at line 70 of file CSCALCTDigi.h.

References keywire_.

{ keywire_ = keyWG; }

void CSCALCTDigi::setQuality ( const uint16_t  quality )

inline

set quality

Definition at line 49 of file CSCALCTDigi.h.

References quality, and quality_.

{ quality_ = quality; }

void CSCALCTDigi::setRun3

(

const bool

isRun3

)

Definition at line 78 of file CSCALCTDigi.cc.

References Legacy, Run3, and version_.

{ version_ = isRun3 ? Version::Run3 : Version::Legacy; }

void CSCALCTDigi::setTrknmb ( const uint16_t  number )

inline

Set track number (1,2) after sorting ALCTs.

Definition at line 82 of file CSCALCTDigi.h.

References contentValuesFiles::number, and trknmb_.

Referenced by CSCAnodeLCTProcessor::lctSearch().

{ trknmb_ = number; }

void CSCALCTDigi::setValid ( const uint16_t  valid )

inline

set valid

Definition at line 43 of file CSCALCTDigi.h.

References valid_.

{ valid_ = valid; }

void CSCALCTDigi::setWireGroup ( uint16_t  wiregroup )

inline

set wiregroup number

Definition at line 110 of file CSCALCTDigi.h.

References keywire_.

{ keywire_ = wiregroup; }

Member Data Documentation

uint16_t CSCALCTDigi::accel_

private

Definition at line 126 of file CSCALCTDigi.h.

Referenced by clear(), getAccelerator(), and setAccelerator().

uint16_t CSCALCTDigi::bx_

private

Definition at line 129 of file CSCALCTDigi.h.

Referenced by clear(), getBX(), and setBX().

uint16_t CSCALCTDigi::fullbx_

private

Definition at line 131 of file CSCALCTDigi.h.

Referenced by clear(), getFullBX(), and setFullBX().

WireContainer CSCALCTDigi::hits_

private

Definition at line 140 of file CSCALCTDigi.h.

Referenced by clear(), getHits(), and setHits().

uint16_t CSCALCTDigi::hmt_

private

Definition at line 136 of file CSCALCTDigi.h.

Referenced by clear(), getHMT(), and setHMT().

uint16_t CSCALCTDigi::keywire_

private

Definition at line 128 of file CSCALCTDigi.h.

Referenced by clear(), getKeyWG(), setKeyWG(), and setWireGroup().

uint16_t CSCALCTDigi::patternb_

private

Definition at line 127 of file CSCALCTDigi.h.

Referenced by clear(), getCollisionB(), and setCollisionB().

uint16_t CSCALCTDigi::quality_

private

Definition at line 125 of file CSCALCTDigi.h.

Referenced by clear(), getQuality(), and setQuality().

uint16_t CSCALCTDigi::trknmb_

private

Definition at line 130 of file CSCALCTDigi.h.

Referenced by clear(), getTrknmb(), and setTrknmb().

uint16_t CSCALCTDigi::valid_

private

Definition at line 124 of file CSCALCTDigi.h.

Referenced by clear(), isValid(), and setValid().

Version CSCALCTDigi::version_

private

Definition at line 138 of file CSCALCTDigi.h.

Referenced by clear(), isRun3(), and setRun3().