LumiSummary Class Reference

#include <LumiSummary.h>

Classes
class	HLT
class	L1

Public Member Functions
float	avgInsDelLumi () const
float	avgInsDelLumiErr () const
float	avgInsRecLumi () const
float	avgInsRecLumiErr () const
unsigned long long	bitzerocount () const
void	copyHLTData (const std::vector< HLT > &hltdata)
void	copyL1Data (const std::vector< L1 > &l1data)
unsigned long long	deadcount () const
float	deadFrac () const
HLT	hltinfo (unsigned int idx) const
float	intgDelLumi () const
float	intgRecLumi () const
bool	isProductEqual (LumiSummary const &next) const
bool	isValid () const
L1	l1info (unsigned int idx) const
float	liveFrac () const
unsigned int	lsNumber () const
short	lumiSecQual () const
float	lumiSectionLength () const
	LumiSummary ()
	default constructor More...
	LumiSummary (float avginsdellumi, float avginsdellumierr, short lumisecqual, unsigned long long deadcount, unsigned long long bitzerocount, unsigned int lsnumber, const std::vector< L1 > &l1in, const std::vector< HLT > &hltin, unsigned int startorbit, unsigned int numorbit, const std::string &lumiversion)
	set default constructor More...
std::string	lumiVersion () const
size_t	nHLTPath () const
size_t	nTriggerLine () const
unsigned int	numOrbit () const
void	setBitZeroCount (unsigned long long bitzerocount)
void	setDeadCount (unsigned long long deadcount)
void	setlsnumber (unsigned int lsnumber)
void	setLumiData (float instlumi, float instlumierr, short lumiquality)
void	setLumiVersion (const std::string &lumiversion)
void	setOrbitData (unsigned int startorbit, unsigned int numorbit)
unsigned int	startOrbit () const
void	swapHLTData (std::vector< HLT > &hltdata)
void	swapL1Data (std::vector< L1 > &l1data)
	~LumiSummary ()
	destructor More...

Private Attributes
float	avginsdellumi_
float	avginsdellumierr_
unsigned long long	bitzerocount_
unsigned long long	deadcount_
std::vector< HLT >	hltdata_
std::vector< L1 >	l1data_
unsigned int	lsnumber_
short	lumisecqual_
std::string	lumiversion_
unsigned int	numorbit_
unsigned int	startorbit_

Detailed Description

LumiSummary holds Summary information averaged over all bunch crossings for the given luminosity section LS

Author

Valerie Halyo David Dagenhart Zhen Xie

Version

1st Version June 7 2007

Definition at line 20 of file LumiSummary.h.

Constructor & Destructor Documentation

LumiSummary() [1/2]

LumiSummary::LumiSummary ( )

inline

default constructor

Definition at line 37 of file LumiSummary.h.

References hltdata_, and l1data_.

      : lumiversion_("-1"),
        avginsdellumi_(0.0),
        avginsdellumierr_(0.0),
        lumisecqual_(0),
        deadcount_(0),
        bitzerocount_(),
        lsnumber_(0),
        startorbit_(0),
        numorbit_(0) {
    hltdata_.reserve(100);
    l1data_.reserve(192);
  }

LumiSummary() [2/2]

LumiSummary::LumiSummary ( float  avginsdellumi, float  avginsdellumierr, short  lumisecqual, unsigned long long  deadcount, unsigned long long  bitzerocount, unsigned int  lsnumber, const std::vector< L1 > &  l1in, const std::vector< HLT > &  hltin, unsigned int  startorbit, unsigned int  numorbit, const std::string &  lumiversion  )

inline

set default constructor

Definition at line 52 of file LumiSummary.h.

      : lumiversion_(lumiversion),
        avginsdellumi_(avginsdellumi),
        avginsdellumierr_(avginsdellumierr),
        lumisecqual_(lumisecqual),
        deadcount_(deadcount),
        bitzerocount_(bitzerocount),
        lsnumber_(lsnumber),
        hltdata_(hltin),
        l1data_(l1in),
        startorbit_(startorbit),
        numorbit_(numorbit) {}

~LumiSummary()

LumiSummary::~LumiSummary ( )

inline

destructor

Definition at line 76 of file LumiSummary.h.

{}

Member Function Documentation

avgInsDelLumi()

float LumiSummary::avgInsDelLumi

(

)

const

average inst lumi,delivered, unit Hz/ub, uncalibrated for lumiversion v2

Definition at line 8 of file LumiSummary.cc.

References avginsdellumi_, and lumiversion_.

Referenced by avgInsRecLumi(), GetLumi::getRawValue(), and intgDelLumi().

                                       {
  size_t iIndex = lumiversion_.rfind('v');
  //i.e. not "-1" and not "DIP", "-1" and "DIP" lumi are already corrected and unit conversion included in the raw data.
  if (iIndex != std::string::npos) {
    return avginsdellumi_ * 1000.0;
  }
  return avginsdellumi_;
}

avgInsDelLumiErr()

float LumiSummary::avgInsDelLumiErr

(

)

const

average inst lumi error, empty for lumiversion v2

Definition at line 17 of file LumiSummary.cc.

References avginsdellumierr_.

{ return avginsdellumierr_; }

avgInsRecLumi()

float LumiSummary::avgInsRecLumi

(

)

const

avg inst lumi corrected by deadtime

Definition at line 55 of file LumiSummary.cc.

References avgInsDelLumi(), and liveFrac().

Referenced by intgRecLumi().

{ return this->avgInsDelLumi() * liveFrac(); }

avgInsRecLumiErr()

float LumiSummary::avgInsRecLumiErr

(

)

const

avg inst lumi error corrected by deadtime

Definition at line 56 of file LumiSummary.cc.

References avginsdellumierr_, and liveFrac().

{ return avginsdellumierr_ * liveFrac(); }

bitzerocount()

unsigned long long LumiSummary::bitzerocount

(

)

const

trigger normalization bit count*prescale

Definition at line 21 of file LumiSummary.cc.

References bitzerocount_.

Referenced by setBitZeroCount().

{ return bitzerocount_; }

copyHLTData()

void LumiSummary::copyHLTData

(

const std::vector< HLT > &

hltdata

)

Definition at line 80 of file LumiSummary.cc.

References hltdata_.

{ hltdata_.assign(hltdata.begin(), hltdata.end()); }

copyL1Data()

void LumiSummary::copyL1Data

(

const std::vector< L1 > &

l1data

)

Definition at line 79 of file LumiSummary.cc.

References l1data_.

{ l1data_.assign(l1data.begin(), l1data.end()); }

deadcount()

unsigned long long LumiSummary::deadcount

(

)

const

trigger DeadtimeBeamActive count

Definition at line 20 of file LumiSummary.cc.

References deadcount_.

Referenced by setDeadCount().

{ return deadcount_; }

deadFrac()

float LumiSummary::deadFrac

(

)

const

the fraction trigger is not active= trigger DeadtimeBeamActive/BitZero special values: if trigger data absent for this LS, return deadfraction 1.0 if bitzero=0 return -1.0 meaning no beam

Definition at line 22 of file LumiSummary.cc.

References bitzerocount_, deadcount_, nano_mu_digi_cff::float, l1data_, and lumiversion_.

Referenced by liveFrac().

                                  {
  //definition: deadcount/bitzerocount
  //if no trigger data, return deadfraction 1.0,mask out this LS
  //if bitzerocount=0, return -1.0 meaning no beam
  if (lumiversion_ == "DIP") {
    return float(deadcount_) / float(bitzerocount_);
  }
  if (l1data_.empty())
    return 1.0;
  if (bitzerocount_ == 0)
    return -1.0;
  return float(deadcount_) / float(bitzerocount_);
}

hltinfo()

LumiSummary::HLT LumiSummary::hltinfo

(

unsigned int

idx

)

const

Definition at line 52 of file LumiSummary.cc.

References hltdata_, and heavyIonCSV_trainingSettings::idx.

{ return hltdata_.at(idx); }

intgDelLumi()

float LumiSummary::intgDelLumi

(

)

const

delivered luminosity integrated over LS , unit /ub,
uncalibrated for lumiversion v2

Definition at line 16 of file LumiSummary.cc.

References avgInsDelLumi(), nano_mu_digi_cff::float, and lumiSectionLength().

Referenced by DQMLumiMonitor::endLuminosityBlock(), and GetLumi::getRawValue().

{ return this->avgInsDelLumi() * float(this->lumiSectionLength()); }

intgRecLumi()

float LumiSummary::intgRecLumi

(

)

const

recorded luminosity integrated over LS

Definition at line 18 of file LumiSummary.cc.

References avgInsRecLumi(), nano_mu_digi_cff::float, and lumiSectionLength().

{ return this->avgInsRecLumi() * float(this->lumiSectionLength()); }

isProductEqual()

bool LumiSummary::isProductEqual

(

LumiSummary const &

next

)

const

Definition at line 57 of file LumiSummary.cc.

References avginsdellumi_, avginsdellumierr_, deadcount_, hltdata_, l1data_, lsnumber_, lumisecqual_, lumiversion_, GetRecoTauVFromDQM_MC_cff::next, numorbit_, and startorbit_.

                                                              {
  return (avginsdellumi_ == next.avginsdellumi_ && avginsdellumierr_ == next.avginsdellumierr_ &&
          lumisecqual_ == next.lumisecqual_ && deadcount_ == next.deadcount_ && lsnumber_ == next.lsnumber_ &&
          startorbit_ == next.startorbit_ && numorbit_ == next.numorbit_ && l1data_.size() == next.l1data_.size() &&
          hltdata_.size() == next.hltdata_.size() && lumiversion_ == next.lumiversion_);
}

isValid()

bool LumiSummary::isValid

(

void

)

const

data are valid only if run exists from all sources lumi,trg ,hlt

Definition at line 50 of file LumiSummary.cc.

References avginsdellumi_.

Referenced by ntupleDataFormat._Object::_checkIsValid(), DQMLumiMonitor::endLuminosityBlock(), GetLumi::getRawValue(), and core.AutoHandle.AutoHandle::ReallyLoad().

{ return avginsdellumi_ > 0; }

l1info()

LumiSummary::L1 LumiSummary::l1info

(

unsigned int

idx

)

const

Definition at line 51 of file LumiSummary.cc.

References heavyIonCSV_trainingSettings::idx, and l1data_.

{ return l1data_.at(idx); }

liveFrac()

float LumiSummary::liveFrac

(

)

const

the fraction trigger is active= 1-deadfraction special values: if deadfraction<0(no beam) livefraction=0

Definition at line 35 of file LumiSummary.cc.

References deadFrac().

Referenced by avgInsRecLumi(), and avgInsRecLumiErr().

                                  {
  //1-deadfraction
  //else if deadfraction<0 meaning no beam, live fraction=0
  //
  if (deadFrac() < 0)
    return 0;
  return 1 - deadFrac();
}

lsNumber()

unsigned int LumiSummary::lsNumber

(

)

const

Definition at line 47 of file LumiSummary.cc.

References lsnumber_.

{ return lsnumber_; }

lumiSecQual()

short LumiSummary::lumiSecQual

(

)

const

Definition at line 19 of file LumiSummary.cc.

References lumisecqual_.

{ return lumisecqual_; }

lumiSectionLength()

float LumiSummary::lumiSectionLength

(

)

const

lumi section length in seconds numorbits*3564*25e-09

Definition at line 43 of file LumiSummary.cc.

References numorbit_.

Referenced by intgDelLumi(), and intgRecLumi().

                                           {
  //numorbits*3564*24.95e-09
  return numorbit_ * 3564.0 * 24.95e-9;
}

lumiVersion()

std::string LumiSummary::lumiVersion

(

)

const

lumi data version. special values: "-1" means not all lumi,trigger,hlt data exist, therefore invalid

Definition at line 63 of file LumiSummary.cc.

References lumiversion_.

{ return lumiversion_; }

nHLTPath()

size_t LumiSummary::nHLTPath

(

)

const

Definition at line 54 of file LumiSummary.cc.

References hltdata_.

{ return hltdata_.size(); }

nTriggerLine()

size_t LumiSummary::nTriggerLine

(

)

const

Definition at line 53 of file LumiSummary.cc.

References l1data_.

{ return l1data_.size(); }

numOrbit()

unsigned int LumiSummary::numOrbit

(

)

const

Definition at line 49 of file LumiSummary.cc.

References numorbit_.

{ return numorbit_; }

setBitZeroCount()

void LumiSummary::setBitZeroCount

(

unsigned long long

bitzerocount

)

Definition at line 71 of file LumiSummary.cc.

References bitzerocount(), and bitzerocount_.

{ bitzerocount_ = bitzerocount; }

setDeadCount()

void LumiSummary::setDeadCount

(

unsigned long long

deadcount

)

Definition at line 70 of file LumiSummary.cc.

References deadcount(), and deadcount_.

{ deadcount_ = deadcount; }

setlsnumber()

void LumiSummary::setlsnumber

(

unsigned int

lsnumber

)

Definition at line 72 of file LumiSummary.cc.

References lsnumber_.

{ lsnumber_ = lsnumber; }

setLumiData()

void LumiSummary::setLumiData	(	float	instlumi,
		float	instlumierr,
		short	lumiquality
	)

Definition at line 65 of file LumiSummary.cc.

References avginsdellumi_, avginsdellumierr_, and lumisecqual_.

                                                                                  {
  avginsdellumi_ = instlumi;
  avginsdellumierr_ = instlumierr;
  lumisecqual_ = lumiquality;
}

setLumiVersion()

void LumiSummary::setLumiVersion

(

const std::string &

lumiversion

)

Definition at line 64 of file LumiSummary.cc.

References FastTimerService_cff::lumiversion, and lumiversion_.

{ lumiversion_ = lumiversion; }

setOrbitData()

void LumiSummary::setOrbitData	(	unsigned int	startorbit,
		unsigned int	numorbit
	)

Definition at line 73 of file LumiSummary.cc.

References numorbit_, and startorbit_.

                                                                             {
  startorbit_ = startorbit;
  numorbit_ = numorbit;
}

startOrbit()

unsigned int LumiSummary::startOrbit

(

)

const

Definition at line 48 of file LumiSummary.cc.

References startorbit_.

{ return startorbit_; }

swapHLTData()

void LumiSummary::swapHLTData

(

std::vector< HLT > &

hltdata

)

Definition at line 78 of file LumiSummary.cc.

References hltdata_.

{ hltdata_.swap(hltdata); }

swapL1Data()

void LumiSummary::swapL1Data

(

std::vector< L1 > &

l1data

)

Definition at line 77 of file LumiSummary.cc.

References l1data_.

{ l1data_.swap(l1data); }

Member Data Documentation

avginsdellumi_

float LumiSummary::avginsdellumi_

private

Definition at line 160 of file LumiSummary.h.

Referenced by avgInsDelLumi(), isProductEqual(), isValid(), and setLumiData().

avginsdellumierr_

float LumiSummary::avginsdellumierr_

private

Definition at line 162 of file LumiSummary.h.

Referenced by avgInsDelLumiErr(), avgInsRecLumiErr(), isProductEqual(), and setLumiData().

bitzerocount_

unsigned long long LumiSummary::bitzerocount_

private

Definition at line 166 of file LumiSummary.h.

Referenced by bitzerocount(), deadFrac(), and setBitZeroCount().

deadcount_

unsigned long long LumiSummary::deadcount_

private

Definition at line 165 of file LumiSummary.h.

Referenced by deadcount(), deadFrac(), isProductEqual(), and setDeadCount().

hltdata_

std::vector<HLT> LumiSummary::hltdata_

private

Definition at line 169 of file LumiSummary.h.

Referenced by copyHLTData(), hltinfo(), isProductEqual(), LumiSummary(), nHLTPath(), and swapHLTData().

l1data_

std::vector<L1> LumiSummary::l1data_

private

Definition at line 171 of file LumiSummary.h.

Referenced by copyL1Data(), deadFrac(), isProductEqual(), l1info(), LumiSummary(), nTriggerLine(), and swapL1Data().

lsnumber_

unsigned int LumiSummary::lsnumber_

private

Definition at line 167 of file LumiSummary.h.

Referenced by isProductEqual(), lsNumber(), and setlsnumber().

lumisecqual_

short LumiSummary::lumisecqual_

private

Definition at line 164 of file LumiSummary.h.

Referenced by isProductEqual(), lumiSecQual(), and setLumiData().

lumiversion_

std::string LumiSummary::lumiversion_

private

Definition at line 158 of file LumiSummary.h.

Referenced by avgInsDelLumi(), deadFrac(), isProductEqual(), lumiVersion(), and setLumiVersion().

numorbit_

unsigned int LumiSummary::numorbit_

private

Definition at line 175 of file LumiSummary.h.

Referenced by isProductEqual(), lumiSectionLength(), numOrbit(), and setOrbitData().

startorbit_

unsigned int LumiSummary::startorbit_

private

Definition at line 173 of file LumiSummary.h.

Referenced by isProductEqual(), setOrbitData(), and startOrbit().