CMS 3D CMS Logo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Public Attributes
lumiParameters.ParametersObject Class Reference
Inheritance diagram for lumiParameters.ParametersObject:

Public Member Functions

def __init__
 
def calculateTimeParameters
 
def lslengthsec
 
def setNumBx
 
def setNumOrbit
 
def setRotationRate
 

Public Attributes

 lumiSectionLen
 
 NBX
 
 numorbit
 
 rotationRate
 
 rotationTime
 

Detailed Description

collection of constants used in lumi related calculation

Definition at line 1 of file lumiParameters.py.

Constructor & Destructor Documentation

def lumiParameters.ParametersObject.__init__ (   self)

Definition at line 5 of file lumiParameters.py.

5 
6  def __init__ (self):
7  self.NBX = 3564 # number beam crossings
8  self.numorbit = 2**18 # 262144
9  self.rotationRate = 11245.613 # for 3.5 TeV Beam energy
10  self.rotationTime = 1 / self.rotationRate
11  self.lumiSectionLen = self.numorbit * self.rotationTime
12  ##self.minBiasXsec = 71300 # unit: microbarn
13 

Member Function Documentation

def lumiParameters.ParametersObject.calculateTimeParameters (   self) 
Given the rotation rate, calculate lumi section length and
rotation time.  This should be called if rotationRate is
updated.

Definition at line 31 of file lumiParameters.py.

References lumiParameters.ParametersObject.lumiSectionLen, lumiParameters.ParametersObject.numorbit, lumiParameters.ParametersObject.rotationRate, and lumiParameters.ParametersObject.rotationTime.

31 
32  def calculateTimeParameters(self):
33  '''Given the rotation rate, calculate lumi section length and
34  rotation time. This should be called if rotationRate is
35  updated.
36  '''
37  self.rotationTime = 1 / self.rotationRate
38  self.lumiSectionLen = self.numorbit * self.rotationTime
def lumiParameters.ParametersObject.lslengthsec (   self) 
Calculate lslength in sec from number of orbit and BX

Definition at line 39 of file lumiParameters.py.

References lumiParameters.ParametersObject.lumiSectionLen.

39 
40  def lslengthsec(self):
41  '''
42  Calculate lslength in sec from number of orbit and BX
43  '''
44  return self.lumiSectionLen
45 
46 #=======================================================
47 # Unit Test
#=======================================================
def lumiParameters.ParametersObject.setNumBx (   self,
  numbx 
) 
update the default number of BX

Definition at line 25 of file lumiParameters.py.

References lumiParameters.ParametersObject.NBX.

25 
26  def setNumBx(self,numbx):
27  '''
28  update the default number of BX
29  '''
30  self.NBX = numbx
def lumiParameters.ParametersObject.setNumOrbit (   self,
  numorbit 
)

Definition at line 22 of file lumiParameters.py.

References lumiParameters.ParametersObject.numorbit.

22 
23  def setNumOrbit(self,numorbit):
24  self.numorbit=numorbit
def lumiParameters.ParametersObject.setRotationRate (   self,
  rate 
) 
update the default LHC orbit frequency
Single beam energy of 450GeV:  11245.589
Single beam energy of 3.5TeV: 11245.613

Definition at line 14 of file lumiParameters.py.

References lumiParameters.ParametersObject.rotationRate.

14 
15  def setRotationRate(self,rate):
16  '''
17  update the default LHC orbit frequency
18  Single beam energy of 450GeV: 11245.589
19  Single beam energy of 3.5TeV: 11245.613
20  '''
21  self.rotationRate =rate

Member Data Documentation

lumiParameters.ParametersObject.lumiSectionLen

Definition at line 10 of file lumiParameters.py.

Referenced by lumiParameters.ParametersObject.calculateTimeParameters(), and lumiParameters.ParametersObject.lslengthsec().

lumiParameters.ParametersObject.NBX

Definition at line 6 of file lumiParameters.py.

Referenced by lumiParameters.ParametersObject.setNumBx().

lumiParameters.ParametersObject.numorbit

Definition at line 7 of file lumiParameters.py.

Referenced by lumiParameters.ParametersObject.calculateTimeParameters(), and lumiParameters.ParametersObject.setNumOrbit().

lumiParameters.ParametersObject.rotationRate

Definition at line 8 of file lumiParameters.py.

Referenced by lumiParameters.ParametersObject.calculateTimeParameters(), and lumiParameters.ParametersObject.setRotationRate().

lumiParameters.ParametersObject.rotationTime

Definition at line 9 of file lumiParameters.py.

Referenced by lumiParameters.ParametersObject.calculateTimeParameters().

Generated for CMSSW Reference Manual by doxygen 1.8.5