LumiInfo Class Reference

#include <LumiInfo.h>

Public Member Functions
float	deadFraction () const
void	fill (const std::vector< float > &instLumiByBX)
void	fillInstLumi (const std::vector< float > &instLumiByBX)
const std::vector< float > &	getInstLumiAllBX () const
float	getInstLumiBX (int bx) const
float	instLuminosity () const
float	integLuminosity () const
bool	isProductEqual (LumiInfo const &next) const
float	liveFraction () const
	LumiInfo ()
	default constructor More...
	LumiInfo (float deadtimeFraction, const std::vector< float > &instLumiByBX)
	constructor with fill More...
float	lumiSectionLength () const
float	recordedLuminosity () const
void	setDeadFraction (float deadtimeFraction)
	~LumiInfo ()
	destructor More...

Private Attributes
float	deadtimeFraction_
std::vector< float >	instLumiByBX_

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

Definition at line 26 of file LumiInfo.h.

Constructor & Destructor Documentation

LumiInfo::LumiInfo ( )

inline

default constructor

Definition at line 29 of file LumiInfo.h.

References instLumiByBX_, and LumiConstants::numBX.

            :
  deadtimeFraction_(0)
  { 
    instLumiByBX_.assign(LumiConstants::numBX, 0.0);
  } 

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

inline

constructor with fill

Definition at line 36 of file LumiInfo.h.

References instLumiByBX_.

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

LumiInfo::~LumiInfo ( )

inline

destructor

Definition at line 44 of file LumiInfo.h.

{}

Member Function Documentation

float LumiInfo::deadFraction ( ) const

inline

Definition at line 57 of file LumiInfo.h.

References deadtimeFraction_.

Referenced by operator<<().

{ return deadtimeFraction_; }

void LumiInfo::fill

(

const std::vector< float > &

instLumiByBX

)

Definition at line 38 of file LumiInfo.cc.

References fillInstLumi().

                                                        {
  fillInstLumi(instLumiByBX);
}

void LumiInfo::fillInstLumi

(

const std::vector< float > &

instLumiByBX

)

Definition at line 34 of file LumiInfo.cc.

References instLumiByBX_.

Referenced by fill().

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

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

inline

Definition at line 65 of file LumiInfo.h.

References instLumiByBX_.

Referenced by operator<<().

{ return instLumiByBX_; }

float LumiInfo::getInstLumiBX ( int  bx ) const

inline

Definition at line 64 of file LumiInfo.h.

References instLumiByBX_.

{ return instLumiByBX_.at(bx); }

float LumiInfo::instLuminosity

(

)

const

Definition at line 7 of file LumiInfo.cc.

References instLumiByBX_.

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

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

float LumiInfo::integLuminosity

(

)

const

Definition at line 16 of file LumiInfo.cc.

References instLuminosity(), and lumiSectionLength().

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

                                      {
  return instLuminosity()*lumiSectionLength();
}

bool LumiInfo::isProductEqual

(

LumiInfo const &

next

)

const

Definition at line 29 of file LumiInfo.cc.

References deadtimeFraction_, and instLumiByBX_.

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

float LumiInfo::liveFraction ( ) const

inline

Definition at line 58 of file LumiInfo.h.

References deadtimeFraction_.

{ return 1-deadtimeFraction_; }

float LumiInfo::lumiSectionLength

(

)

const

Definition at line 24 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;
}

float LumiInfo::recordedLuminosity

(

)

const

Definition at line 20 of file LumiInfo.cc.

References deadtimeFraction_, and integLuminosity().

Referenced by operator<<().

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

void LumiInfo::setDeadFraction ( float  deadtimeFraction )

inline

Definition at line 73 of file LumiInfo.h.

References deadtimeFraction_.

{ deadtimeFraction_ = deadtimeFraction; }

Member Data Documentation

float LumiInfo::deadtimeFraction_

private

Definition at line 80 of file LumiInfo.h.

Referenced by deadFraction(), isProductEqual(), liveFraction(), recordedLuminosity(), and setDeadFraction().

std::vector<float> LumiInfo::instLumiByBX_

private

Definition at line 81 of file LumiInfo.h.

Referenced by fillInstLumi(), getInstLumiAllBX(), getInstLumiBX(), instLuminosity(), isProductEqual(), and LumiInfo().