CMS 3D CMS Logo

List of all members | Public Member Functions | Public Attributes
lumiParameters.ParametersObject Class Reference
Inheritance diagram for lumiParameters.ParametersObject:

Public Member Functions

def __init__ (self)
 
def calculateTimeParameters (self)
 
def lslengthsec (self)
 
def setNumBx (self, numbx)
 
def setNumOrbit (self, numorbit)
 
def setRotationRate (self, rate)
 

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  def __init__ (self):
6  self.NBX = 3564 # number beam crossings
7  self.numorbit = 2**18 # 262144
8  self.rotationRate = 11245.613 # for 3.5 TeV Beam energy
9  self.rotationTime = 1 / self.rotationRate
11  ##self.minBiasXsec = 71300 # unit: microbarn
12 
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.

32  '''Given the rotation rate, calculate lumi section length and
33  rotation time. This should be called if rotationRate is
34  updated.
35  '''
36  self.rotationTime = 1 / self.rotationRate
37  self.lumiSectionLen = self.numorbit * self.rotationTime
38 
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  def lslengthsec(self):
40  '''
41  Calculate lslength in sec from number of orbit and BX
42  '''
43  return self.lumiSectionLen
44 
45 #=======================================================
46 # Unit Test
47 #=======================================================
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  def setNumBx(self,numbx):
26  '''
27  update the default number of BX
28  '''
29  self.NBX = numbx
30 
def lumiParameters.ParametersObject.setNumOrbit (   self,
  numorbit 
)

Definition at line 22 of file lumiParameters.py.

References lumiParameters.ParametersObject.numorbit.

22  def setNumOrbit(self,numorbit):
23  self.numorbit=numorbit
24 
def setNumOrbit(self, 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  def setRotationRate(self,rate):
15  '''
16  update the default LHC orbit frequency
17  Single beam energy of 450GeV: 11245.589
18  Single beam energy of 3.5TeV: 11245.613
19  '''
20  self.rotationRate =rate
21 

Member Data Documentation

lumiParameters.ParametersObject.lumiSectionLen
lumiParameters.ParametersObject.NBX

Definition at line 6 of file lumiParameters.py.

Referenced by lumiParameters.ParametersObject.setNumBx().

lumiParameters.ParametersObject.numorbit
lumiParameters.ParametersObject.rotationRate
lumiParameters.ParametersObject.rotationTime