LumiInfo Class Reference

#include <LumiInfo.h>

Public Member Functions
float	getDeadFraction () const
const std::vector< float > &	getErrorLumiAllBX () const
const std::vector< float > &	getInstLumiAllBX () const
float	getInstLumiBX (int bx) const
float	getLiveFraction () const
float	getTotalInstLumi () const
float	getTotalInstStatError () const
float	instLuminosityBXSum () const
float	integLuminosity () const
bool	isProductEqual (LumiInfo const &next) const
	LumiInfo ()
	LumiInfo (float deadtimeFraction, const std::vector< float > &instLumiByBX)
	LumiInfo (float deadtimeFraction, const std::vector< float > &instLumiByBX, float totalInstLumi)
	LumiInfo (float deadtimeFraction, const std::vector< float > &instLumiByBX, float totalInstLumi, const std::vector< float > &instLumiErrByBX, float totalInstLumiErr)
float	lumiSectionLength () const
float	recordedLuminosity () const
void	setDeadFraction (float deadtimeFraction)
void	setErrorLumiAllBX (std::vector< float > &errLumiByBX)
void	setInstLumiAllBX (std::vector< float > &instLumiByBX)
void	setTotalInstLumi (float totalLumi)
void	setTotalInstStatError (float statError)
void	setTotalInstToBXSum ()
	~LumiInfo ()

Private Attributes
float	deadtimeFraction_
std::vector< float >	instLumiByBX_
std::vector< float >	instLumiStatErrByBX_
float	totalInstLuminosity_
float	totalInstLumiStatErr_

Detailed Description

LumiInfo has been created by merging the content of the old LumiSummary and LumiDetails classes to streamline the lumi information. Many old member variables have been removed.

Author

Valerie Halyo David Dagenhart Zhen Xie Paul Lujan

Version

1st Version June 7 2007, merged September 10 2014

October 2017 by Chris Palmer and Sam Higginbotham for PCC projects

Definition at line 28 of file LumiInfo.h.

Constructor & Destructor Documentation

LumiInfo() [1/4]

LumiInfo::LumiInfo ( )

inline

default constructor

Definition at line 33 of file LumiInfo.h.

References instLumiByBX_, instLumiStatErrByBX_, LumiConstants::numBX, totalInstLuminosity_, and totalInstLumiStatErr_.

             : deadtimeFraction_(0) {
    instLumiByBX_.assign(LumiConstants::numBX, 0.0);
    instLumiStatErrByBX_.assign(LumiConstants::numBX, 0.0);
    totalInstLuminosity_ = 0;
    totalInstLumiStatErr_ = 0;
  }

LumiInfo() [2/4]

LumiInfo::LumiInfo ( float  deadtimeFraction, const std::vector< float > &  instLumiByBX  )

inline

constructor with fill; if total algo is the same as summing

Definition at line 43 of file LumiInfo.h.

References instLumiStatErrByBX_, LumiConstants::numBX, setTotalInstToBXSum(), and totalInstLumiStatErr_.

      : deadtimeFraction_(deadtimeFraction), instLumiByBX_(instLumiByBX) {
    instLumiStatErrByBX_.assign(LumiConstants::numBX, 0.0);
    setTotalInstToBXSum();
    totalInstLumiStatErr_ = 0;
  }

LumiInfo() [3/4]

LumiInfo::LumiInfo ( float  deadtimeFraction, const std::vector< float > &  instLumiByBX, float  totalInstLumi  )

inline

constructor with fill; if total algo DIFFERS from summing

Definition at line 53 of file LumiInfo.h.

References instLumiStatErrByBX_, LumiConstants::numBX, and totalInstLumiStatErr_.

      : deadtimeFraction_(deadtimeFraction), totalInstLuminosity_(totalInstLumi), instLumiByBX_(instLumiByBX) {
    instLumiStatErrByBX_.assign(LumiConstants::numBX, 0.0);
    totalInstLumiStatErr_ = 0;
  }

LumiInfo() [4/4]

LumiInfo::LumiInfo ( float  deadtimeFraction, const std::vector< float > &  instLumiByBX, float  totalInstLumi, const std::vector< float > &  instLumiErrByBX, float  totalInstLumiErr  )

inline

constructor with fill; if total algo DIFFERS from summing and adding including stats

Definition at line 62 of file LumiInfo.h.

      : deadtimeFraction_(deadtimeFraction),
        totalInstLuminosity_(totalInstLumi),
        totalInstLumiStatErr_(totalInstLumiErr),
        instLumiByBX_(instLumiByBX),
        instLumiStatErrByBX_(instLumiErrByBX) {}

~LumiInfo()

LumiInfo::~LumiInfo ( )

inline

destructor

Definition at line 76 of file LumiInfo.h.

{}

Member Function Documentation

getDeadFraction()

float LumiInfo::getDeadFraction ( ) const

inline

Deadtime fraction

Definition at line 105 of file LumiInfo.h.

References deadtimeFraction_.

{ return deadtimeFraction_; }

getErrorLumiAllBX()

const std::vector<float>& LumiInfo::getErrorLumiAllBX ( ) const

inline

Returns statistical error of instantaneous luminosity for all bunches

Definition at line 97 of file LumiInfo.h.

References instLumiStatErrByBX_.

Referenced by CorrPCCProducer::endLuminosityBlock().

{ return instLumiStatErrByBX_; }

getInstLumiAllBX()

const std::vector<float>& LumiInfo::getInstLumiAllBX ( ) const

inline

Returns instantaneous luminosity of all bunches

Definition at line 93 of file LumiInfo.h.

References instLumiByBX_.

Referenced by CorrPCCProducer::endLuminosityBlock().

{ return instLumiByBX_; }

getInstLumiBX()

float LumiInfo::getInstLumiBX ( int  bx ) const

inline

Returns instantaneous luminosity of one bunch

Definition at line 101 of file LumiInfo.h.

References nano_mu_digi_cff::bx, and instLumiByBX_.

{ return instLumiByBX_.at(bx); }

getLiveFraction()

float LumiInfo::getLiveFraction ( ) const

inline

Livetime fraction (1-deadtime frac)

Definition at line 109 of file LumiInfo.h.

References deadtimeFraction_.

{ return 1 - deadtimeFraction_; }

getTotalInstLumi()

float LumiInfo::getTotalInstLumi ( ) const

inline

Returns total instantanious luminosity in hz/uB

Definition at line 85 of file LumiInfo.h.

References totalInstLuminosity_.

Referenced by integLuminosity().

{ return totalInstLuminosity_; }

getTotalInstStatError()

float LumiInfo::getTotalInstStatError ( ) const

inline

Returns statistical error on total instantanious luminosity in hz/uB

Definition at line 89 of file LumiInfo.h.

References totalInstLumiStatErr_.

{ return totalInstLumiStatErr_; }

instLuminosityBXSum()

float LumiInfo::instLuminosityBXSum

(

)

const

Returns the sum of the instantaneous luminosity in Hz/uB, which not always the same as totalInstLuminosity_.

Definition at line 8 of file LumiInfo.cc.

References instLumiByBX_, and ALPAKA_ACCELERATOR_NAMESPACE::vertexFinder::it.

Referenced by setTotalInstToBXSum().

                                          {
  float totLum = 0;
  for (std::vector<float>::const_iterator it = instLumiByBX_.begin(); it != instLumiByBX_.end(); ++it) {
    totLum += *it;
  }
  return totLum;
}

integLuminosity()

float LumiInfo::integLuminosity

(

)

const

Integrated (delivered) luminosity (in ub^-1)

Definition at line 16 of file LumiInfo.cc.

References getTotalInstLumi(), and lumiSectionLength().

Referenced by recordedLuminosity().

{ return getTotalInstLumi() * lumiSectionLength(); }

isProductEqual()

bool LumiInfo::isProductEqual

(

LumiInfo const &

next

)

const

This method checks if all the essential values of this LumiInfo are the same as the ones in the LumiInfo given as an argument.

Definition at line 27 of file LumiInfo.cc.

References deadtimeFraction_, instLumiByBX_, and GetRecoTauVFromDQM_MC_cff::next.

                                                        {
  return (deadtimeFraction_ == next.deadtimeFraction_ && instLumiByBX_ == next.instLumiByBX_);
}

lumiSectionLength()

float LumiInfo::lumiSectionLength

(

)

const

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

Definition at line 22 of file LumiInfo.cc.

References LumiConstants::bxSpacingExact, LumiConstants::numBX, and LumiConstants::numOrbits.

Referenced by integLuminosity().

                                        {
  // numorbits (262144)*numBX/orbit (3564)*bx spacing (24.95e-09)
  return LumiConstants::numOrbits * LumiConstants::numBX * LumiConstants::bxSpacingExact;
}

recordedLuminosity()

float LumiInfo::recordedLuminosity

(

)

const

Recorded (integrated) luminosity (in ub^-1) (==integLuminosity * (1-deadtimeFraction))

Definition at line 20 of file LumiInfo.cc.

References deadtimeFraction_, and integLuminosity().

{ return integLuminosity() * (1 - deadtimeFraction_); }

setDeadFraction()

void LumiInfo::setDeadFraction ( float  deadtimeFraction )

inline

Set the deadtime fraction

Definition at line 118 of file LumiInfo.h.

References deadtimeFraction_.

{ deadtimeFraction_ = deadtimeFraction; }

setErrorLumiAllBX()

void LumiInfo::setErrorLumiAllBX

(

std::vector< float > &

errLumiByBX

)

Set statistical error of instantaneous luminosity for all bunches

Definition at line 35 of file LumiInfo.cc.

References instLumiStatErrByBX_.

Referenced by RawPCCProducer::globalEndLuminosityBlockProduce().

                                                              {
  instLumiStatErrByBX_.assign(errLumiByBX.begin(), errLumiByBX.end());
}

setInstLumiAllBX()

void LumiInfo::setInstLumiAllBX

(

std::vector< float > &

instLumiByBX

)

Set statistical error of instantaneous luminosity for all bunches

Definition at line 31 of file LumiInfo.cc.

References instLumiByBX_.

Referenced by RawPCCProducer::globalEndLuminosityBlockProduce().

                                                              {
  instLumiByBX_.assign(instLumiByBX.begin(), instLumiByBX.end());
}

setTotalInstLumi()

void LumiInfo::setTotalInstLumi ( float  totalLumi )

inline

Set total instantanious luminosity in hz/uB

Definition at line 122 of file LumiInfo.h.

References totalInstLuminosity_.

Referenced by RawPCCProducer::globalEndLuminosityBlockProduce(), and setTotalInstToBXSum().

{ totalInstLuminosity_ = totalLumi; }

setTotalInstStatError()

void LumiInfo::setTotalInstStatError ( float  statError )

inline

Set statistical error on total instantanious luminosity in hz/uB

Definition at line 126 of file LumiInfo.h.

References totalInstLumiStatErr_.

Referenced by RawPCCProducer::globalEndLuminosityBlockProduce().

{ totalInstLumiStatErr_ = statError; }

setTotalInstToBXSum()

void LumiInfo::setTotalInstToBXSum

(

)

Resets totalInstLuminosity_ to be the sum of instantaneous luminosity

Definition at line 18 of file LumiInfo.cc.

References instLuminosityBXSum(), and setTotalInstLumi().

Referenced by LumiInfo().

{ setTotalInstLumi(instLuminosityBXSum()); }

Member Data Documentation

deadtimeFraction_

float LumiInfo::deadtimeFraction_

private

Definition at line 167 of file LumiInfo.h.

Referenced by getDeadFraction(), getLiveFraction(), isProductEqual(), recordedLuminosity(), and setDeadFraction().

instLumiByBX_

std::vector<float> LumiInfo::instLumiByBX_

private

Definition at line 170 of file LumiInfo.h.

Referenced by getInstLumiAllBX(), getInstLumiBX(), instLuminosityBXSum(), isProductEqual(), LumiInfo(), and setInstLumiAllBX().

instLumiStatErrByBX_

std::vector<float> LumiInfo::instLumiStatErrByBX_

private

Definition at line 171 of file LumiInfo.h.

Referenced by getErrorLumiAllBX(), LumiInfo(), and setErrorLumiAllBX().

totalInstLuminosity_

float LumiInfo::totalInstLuminosity_

private

Definition at line 168 of file LumiInfo.h.

Referenced by getTotalInstLumi(), LumiInfo(), and setTotalInstLumi().

totalInstLumiStatErr_

float LumiInfo::totalInstLumiStatErr_

private

Definition at line 169 of file LumiInfo.h.

Referenced by getTotalInstStatError(), LumiInfo(), and setTotalInstStatError().