LumiInfo.h

Go to the documentation of this file.

#ifndef DataFormats_Luminosity_LumiInfo_h
#define DataFormats_Luminosity_LumiInfo_h
 
#include <vector>
#include <iosfwd>
#include <string>
#include "DataFormats/Luminosity/interface/LumiConstants.h"

class LumiInfo {
public:
  LumiInfo():
  deadtimeFraction_(0)
  { 
    instLumiByBX_.assign(LumiConstants::numBX, 0.0);
  } 
  
 LumiInfo(float deadtimeFraction,
      const std::vector<float>& instLumiByBX):
  deadtimeFraction_(deadtimeFraction)
  {
    instLumiByBX_.assign(instLumiByBX.begin(), instLumiByBX.end());
  }

  ~LumiInfo(){}

  // Instantaneous luminosity (in Hz/ub)
  float instLuminosity() const;

  // Integrated (delivered) luminosity (in ub^-1)
  float integLuminosity() const;

  // Recorded (integrated) luminosity (in ub^-1)
  // (==integLuminosity * (1-deadtimeFraction))
  float recordedLuminosity() const;

  // Deadtime/livetime fraction
  float deadFraction() const { return deadtimeFraction_; }
  float liveFraction() const { return 1-deadtimeFraction_; }

  // lumi section length in seconds = numorbits*3564*25e-09
  float lumiSectionLength() const;

  // Inst lumi by bunch
  float getInstLumiBX(int bx) const { return instLumiByBX_.at(bx); }
  const std::vector<float>& getInstLumiAllBX() const { return instLumiByBX_; }

  bool isProductEqual(LumiInfo const& next) const;

  //
  //setters
  //

  void setDeadFraction(float deadtimeFraction) { deadtimeFraction_ = deadtimeFraction; }
  // fill inst lumi
  void fill(const std::vector<float>& instLumiByBX);
  // synonym for above
  void fillInstLumi(const std::vector<float>& instLumiByBX);

private:
  float deadtimeFraction_;
  std::vector<float> instLumiByBX_;
}; 

std::ostream& operator<<(std::ostream& s, const LumiInfo& lumiInfo);

#endif // DataFormats_Luminosity_LumiInfo_h