SCT parametric simulation

From Charm-Tau Detector
(Difference between revisions)
Jump to: navigation, search
(→‎Configure example)
(→‎SctParSim)
 
(18 intermediate revisions by one user not shown)
Line 1: Line 1:
 +
= How to run =
 +
 +
Login to stark or proxima machine.
 +
<pre>
 +
ssh stark -X
 +
setupSCTAU; asetup SCTauSim,master,latest
 +
mkdir workarea
 +
cd workarea
 +
mkdir run
 +
cd run
 +
cp /home/razuvaev/public/misc/pi_ms_f1_mppc2_px3_d200_mla4_graph2d.root .
 +
cp /home/razuvaev/public/misc/g4beamline_pi_plus_100k_parse.root .
 +
cp /home/razuvaev/public/misc/g4beamline_mu_plus_100k_parse.root .
 +
ctaurun SctParSimAlg/sctparsim_test_particle_gun.py
 +
</pre>
 +
 
= Configure example =
 
= Configure example =
  
−
There is an example of running the entire chain from generating particles to running an analysis tool. A more detailed description of the algorithms and their parameters is presented below.
+
There are some examples to run the parametric simulation
 +
{| class="wikitable"
 +
|-
 +
! Using tools
 +
! Link
 +
|-
 +
| Read from a ROOT-file, write to a ROOT-file
 +
| [https://git.inp.nsk.su/sctau/aurora/-/blob/master/Simulation/SctParSimAlg/jobOptions/sctparsim_test_read.py sctparsim_test_read.py]
 +
|-
 +
| Generate using the particle gun, write to a ROOT-file
 +
| [https://git.inp.nsk.su/sctau/aurora/-/blob/master/Simulation/SctParSimAlg/jobOptions/sctparsim_test_particle_gun.py sctparsim_test_particle_gun.py]
 +
|-
 +
| Generate using <code>EvtGen</code>, write to a ROOT-file
 +
| [https://git.inp.nsk.su/sctau/aurora/-/blob/master/Simulation/SctParSimAlg/jobOptions/sctparsim_test_evtgen.py sctparsim_test_evtgen.py]
 +
|-
 +
| Generate using <code>EvtGen</code>, use the analysis tool
 +
| [https://git.inp.nsk.su/sctau/aurora/-/blob/master/Simulation/SctParSimAlg/jobOptions/sct_run_test_analisis.py sct_run_test_analisis.py]
 +
|}
  
 +
== Event generation ==
 +
 +
The "Event generation" block may contain other options: to read a ROOT file, to generate using the particle gun tool and to generate using EvtGen.
 +
 +
=== Podio input ===
 +
 +
It is possible to read the particle parameters from a ROOT file.
 +
 +
You have to import the library
 
<pre>
 
<pre>
−
from Configurables import ApplicationMgr
+
from Configurables import PodioInput
 +
</pre>
  
−
from Gaudi.Configuration import *
+
and to create the algorithm instance
−
from Configurables import GenAlg, EvtGenInterface
+
<pre>
−
from Configurables import HepMCToEDMConverter
+
podioevent = ScTauDataSvc("EventDataSvc", input="fileName.root")
−
from Configurables import ScTauDataSvc
+
podioinput = PodioInput("PodioReader", OutputLevel=INFO, collections=['allGenParticles'])
 +
</pre>
  
−
from Configurables import PodioOutput
+
The reading algorithm has the following parameters:
 +
* input - an input file name
 +
* collections - a name of a branch with MC particles
  
−
from Configurables import SctParSimAlg
+
=== Particle gun ===
−
from Configurables import EventLoader
+
 
−
from Configurables import NtupleAlg, NTupleSvc
+
To use the particle gun algorithm, it is necessary to import the following libraries
−
from Configurables import ParticleCombinerAlg
+
<pre>
 +
from Configurables import ParticleGun
 +
from Configurables import GenAlg
 +
from Configurables import HepMCToEDMConverter
 +
from Configurables import HepMCFileWriter
  
 
from Configurables import Gaudi__ParticlePropertySvc
 
from Configurables import Gaudi__ParticlePropertySvc
 
from PathResolver import PathResolver
 
from PathResolver import PathResolver
 +
</pre>
  
−
ofile = 'sctparsim_out.root' # name of output file
+
and to write the following strings
−
eventNumber = 50000 # number of events
+
<pre>
−
 
+
−
############################
+
−
####  Event generation  ####
+
−
############################
+
−
podioevent = ScTauDataSvc("EventDataSvc")
+
−
 
+
−
# Particle service
+
 
particlePropertySvc = Gaudi__ParticlePropertySvc(
 
particlePropertySvc = Gaudi__ParticlePropertySvc(
 
     "ParticlePropertySvc",
 
     "ParticlePropertySvc",
Line 35: Line 79:
 
)
 
)
  
−
# EvtGen
+
from math import pi
−
evtgen = EvtGenInterface('SignalProvider')
+
guntool = ParticleGun("PdgCodes", PdgCodes=[211])
−
#evtgen.userdec = "./mydec.dec"
+
guntool.OutputLevel=DEBUG
−
#evtgen.rootParticle = "J/psi"
+
  
−
gen = GenAlg('EvtGenAlg', SignalProvider=evtgen)
+
guntool.MomentumMin = 0 * units.MeV
−
gen.hepmc.Path = 'hepmc'
+
guntool.MomentumMax = 4 * units.GeV
  
−
# HepMC3 to PODIO
+
guntool.ThetaMin = 0 * units.rad
−
edm = HepMCToEDMConverter("Converter")
+
guntool.ThetaMax = pi * units.rad
−
edm.hepmc.Path=gen.hepmc.Path
+
−
edm.genparticles.Path="allGenParticles"
+
−
edm.genvertices.Path="allGenVertices"
+
  
−
############################
+
guntool.PhiMin = 0 * units.rad
−
# SctParSim
+
guntool.PhiMax = 2 * pi * units.rad
−
############################
+
−
sct_alg = SctParSimAlg('SctAlg')
+
−
#sct_alg.CaloSystemTool.caloClSizeEGamma = 0.2 # Example how to change a subsystem parameter
+
  
−
############################
+
gun = GenAlg("ParticleGun", SignalProvider=guntool)
−
# Podio output
+
gun.hepmc.Path = "hepmc"
−
############################
+
−
out = PodioOutput('out', filename=ofile)
+
−
out.outputCommands = ["keep *"]
+
  
−
############################       
+
writer = HepMCFileWriter("HepMCFileWriter")
−
# Analisis                         
+
writer.hepmc.Path="hepmc"
−
############################
+
  
−
evlo = EventLoader('EvtLoader')
+
hepmc_converter = HepMCToEDMConverter("Converter")
−
evlo.pcl.Path = 'Particles' # Branch (in the input ROOT-file) for reading
+
hepmc_converter.hepmc.Path="hepmc"
−
evlo.pListMap.Path = 'Lists1'
+
hepmc_converter.genparticles.Path="allGenParticles"
−
evlo.plists = [['gamma']] # Partilce list for further analisis
+
hepmc_converter.genvertices.Path="allGenVertices"
 +
</pre>
  
−
# Select particle combinations     
+
Some parameters can be changed:
−
cmbr = ParticleCombinerAlg('Cmbr',
+
* PdgCodes - a list containing particles PDG codes to generate
−
    decStr = 'pi0 -> gamma gamma', # Investigated decay
+
* MomentumMin - a minimum particle momentum
−
    cutStr = 'E > 0.5', # Selection criteria
+
* MomentumMax - a maximum particle momentum
−
    selfConj = True # if neutral particle True, else False
+
* ThetaMin - a minimum theta angle
−
)
+
* ThetaMax - a maximum theta angle
 +
* PhiMin - a minimum phi angle
 +
* PhiMax - a maximum phi angle
  
−
cmbr.pListMapI = evlo.pListMap.Path
+
=== EvtGen ===
−
cmbr.pListMapO.Path = 'Lists2'
+
  
−
# Select variables to save to n-tuple
+
More information about EvtGen is [https://ctd.inp.nsk.su/wiki/index.php/Event_generators here].
−
tupl = NtupleAlg('piTuple')
+
−
tupl.listName = 'pi0'
+
−
tupl.fileName = 'scttuple/tup'
+
  
−
# List contains the particle parametes to write an output file
+
<code>EvtGen</code> interface has the following parameters:
−
tupl.vars = [['px_mc', 'py_mc', 'pz_mc', 'E', 'pi0 -> ^gamma ^gamma'],
+
* <code>dec</code> - EvtGen users decay file. It can be one of the included in Aurora files or absolute path to your own decay file. Inclusive MC generation does not require user decay file
−
    ['M', ''],
+
* <code>root</code> - root particle for EvtGen. <code>vpho</code> (virtual photon) should be used for non-resonant processes
−
]
+
** Acceptable root particles: <code>vpho</code>, <code>J/psi</code>, <code>psi(2S)</code>, <code>psi(3770)</code>, <code>psi(4040)</code>, <code>psi(4160)</code>, <code>psi(4415)</code>. For more details see Generation/GenTools/GenWrappers/python/EvtGenTools.py in Aurora.
 +
* <code>ecms</code> - center-of-mass energy (mass of the root particle). The parameter <code>ecms</code> must be set for virtual photon while for other root particles (<math>J/\psi</math>, <math>\psi(2S)</math>, ...) this parameter is optional. Mean mass of the root particle is adopted if <code>ecms</code> is omitted.
 +
* <code>nevt</code> - number if events to be gnerated
 +
* <code>ip</code> - uniform 3D smearing (in mm) for the primary vertex
 +
* <code>ofile</code> - output file name
 +
One can change these parameters to change behaviour of EvtGen and to produce arbitrary MC sample.
  
−
tupl.pListMapI.Path = cmbr.pListMapO.Path
+
== SctParSim ==
−
NTupleSvc(Output = ["scttuple DATAFILE='tup.root' OPT='NEW' TYP='ROOT'"])
+
  
−
options= {
+
To run the parametric simulation, the script has to have two lines:
−
    'TopAlg' : [gen, edm, sct_alg, evlo, cmbr, tupl, out],
+
<pre>
−
    'EvtSel' : 'NONE',
+
from Configurables import SctParSimAlg
−
    'ExtSvc' : [particlePropertySvc, podioevent],
+
sct_alg = SctParSimAlg('SctAlg')
−
    'EvtMax' : eventNumber,
+
</pre>
−
    'StatusCodeCheck' : True,
+
−
    'AuditAlgorithms' : True,
+
−
    'AuditTools'      : True,
+
−
    'AuditServices'  : True,
+
−
    'OutputLevel'    : INFO,
+
−
    'HistogramPersistency' : 'ROOT',
+
−
}
+
  
−
ApplicationMgr(**options)
+
To change some detector parameters, write strings of the following structure
 +
<pre>
 +
sct_alg.detectorSubsystemName.parameter = mean
 
</pre>
 
</pre>
  
−
== Event generation ==
+
The full parameters list is [https://ctd.inp.nsk.su/wiki/index.php/SctParSim_(Aurora) here].
−
=== Podio input ===
+
 
−
=== Particle gun ===
+
−
=== EvtGen ===
+
−
== SctParSim ==
+
 
== Analysis ==
 
== Analysis ==
 +
 +
The analysis tool has the following parameters:
 +
* EventLoader
 +
** pcl.Path - a branch (in the input ROOT-file) for reading
 +
** plists - a partilce list for further analisis. if it is necessary to consider not only positive, but also negative particles, the label "сс" is used. For example <code>[['K+ cc'], ['pi+ cc']]</code>. Also it is possible to write a kinematic constraint; for example <code>[['K+ cc', 'p > 0.5'], ['pi+ cc']]</code>  (kaons don't have the momentum less then 0.5 GeV)
 +
 +
* ParticleCombinerAlg
 +
** decStr - an investigated decay
 +
** cutStr - a selection criteria
 +
** selfConj - if neutral particle <code>True</code>, else <code>False</code>
 +
 +
* NtupleAlg
 +
** vars - a list contains the particle parameters to write an output file. A particle in the decay string can be selected using the "^" symbol. If a decay isn't written (<code>''</code>), the information about parameters will be about a parent particle.
 +
 +
More information about the analysis tool is [https://ctd.inp.nsk.su/wiki/index.php/Use_Analysis_package here].
 +
 
== Podio output ==
 
== Podio output ==
 +
 +
It is possible to write the particle parameters to a ROOT file.
 +
 +
You have to import the library
 +
<pre>
 +
from Configurables import PodioOutput
 +
</pre>
 +
 +
and to create the algorithm instance
 +
<pre>
 +
out = PodioOutput('out', filename=ofile)
 +
out.outputCommands = ["keep *"]
 +
</pre>
 +
 +
The reading algorithm has the parameter: filename - an output file name.
 +
 +
== Running algorithm ==
 +
 +
Some necessary parametrs to run the algorithms:
 +
* TopAlg - a list of the using algorithms
 +
* EvtMax - a number of events

Latest revision as of 13:34, 24 November 2021

Contents

[edit] How to run

Login to stark or proxima machine. 

ssh stark -X
setupSCTAU; asetup SCTauSim,master,latest
mkdir workarea
cd workarea
mkdir run
cd run
cp /home/razuvaev/public/misc/pi_ms_f1_mppc2_px3_d200_mla4_graph2d.root .
cp /home/razuvaev/public/misc/g4beamline_pi_plus_100k_parse.root .
cp /home/razuvaev/public/misc/g4beamline_mu_plus_100k_parse.root .
ctaurun SctParSimAlg/sctparsim_test_particle_gun.py

[edit] Configure example

There are some examples to run the parametric simulation

Using tools Link
Read from a ROOT-file, write to a ROOT-file sctparsim_test_read.py
Generate using the particle gun, write to a ROOT-file sctparsim_test_particle_gun.py
Generate using EvtGen, write to a ROOT-file sctparsim_test_evtgen.py
Generate using EvtGen, use the analysis tool sct_run_test_analisis.py

[edit] Event generation

The "Event generation" block may contain other options: to read a ROOT file, to generate using the particle gun tool and to generate using EvtGen.

[edit] Podio input

It is possible to read the particle parameters from a ROOT file.

You have to import the library 

from Configurables import PodioInput

and to create the algorithm instance 

podioevent = ScTauDataSvc("EventDataSvc", input="fileName.root")
podioinput = PodioInput("PodioReader", OutputLevel=INFO, collections=['allGenParticles'])

The reading algorithm has the following parameters:

  • input - an input file name
  • collections - a name of a branch with MC particles

[edit] Particle gun

To use the particle gun algorithm, it is necessary to import the following libraries 

from Configurables import ParticleGun
from Configurables import GenAlg
from Configurables import HepMCToEDMConverter
from Configurables import HepMCFileWriter

from Configurables import Gaudi__ParticlePropertySvc
from PathResolver import PathResolver

and to write the following strings 

particlePropertySvc = Gaudi__ParticlePropertySvc(
    "ParticlePropertySvc",
    ParticlePropertiesFile=PathResolver.FindDataFile('GenParticleData/ParticleTable.txt')
)

from math import pi
guntool = ParticleGun("PdgCodes", PdgCodes=[211])
guntool.OutputLevel=DEBUG

guntool.MomentumMin = 0 * units.MeV 
guntool.MomentumMax = 4 * units.GeV

guntool.ThetaMin = 0 * units.rad 
guntool.ThetaMax = pi * units.rad 

guntool.PhiMin = 0 * units.rad
guntool.PhiMax = 2 * pi * units.rad 

gun = GenAlg("ParticleGun", SignalProvider=guntool)
gun.hepmc.Path = "hepmc"

writer = HepMCFileWriter("HepMCFileWriter")
writer.hepmc.Path="hepmc"

hepmc_converter = HepMCToEDMConverter("Converter")
hepmc_converter.hepmc.Path="hepmc"
hepmc_converter.genparticles.Path="allGenParticles"
hepmc_converter.genvertices.Path="allGenVertices"

Some parameters can be changed:

  • PdgCodes - a list containing particles PDG codes to generate
  • MomentumMin - a minimum particle momentum
  • MomentumMax - a maximum particle momentum
  • ThetaMin - a minimum theta angle
  • ThetaMax - a maximum theta angle
  • PhiMin - a minimum phi angle
  • PhiMax - a maximum phi angle

[edit] EvtGen

More information about EvtGen is here.

EvtGen interface has the following parameters:

  • dec - EvtGen users decay file. It can be one of the included in Aurora files or absolute path to your own decay file. Inclusive MC generation does not require user decay file
  • root - root particle for EvtGen. vpho (virtual photon) should be used for non-resonant processes
    • Acceptable root particles: vpho, J/psi, psi(2S), psi(3770), psi(4040), psi(4160), psi(4415). For more details see Generation/GenTools/GenWrappers/python/EvtGenTools.py in Aurora.
  • ecms - center-of-mass energy (mass of the root particle). The parameter ecms must be set for virtual photon while for other root particles (J/\psi, \psi(2S), ...) this parameter is optional. Mean mass of the root particle is adopted if ecms is omitted.
  • nevt - number if events to be gnerated
  • ip - uniform 3D smearing (in mm) for the primary vertex
  • ofile - output file name

One can change these parameters to change behaviour of EvtGen and to produce arbitrary MC sample.

[edit] SctParSim

To run the parametric simulation, the script has to have two lines: 

from Configurables import SctParSimAlg
sct_alg = SctParSimAlg('SctAlg')

To change some detector parameters, write strings of the following structure 

sct_alg.detectorSubsystemName.parameter = mean

The full parameters list is here.

[edit] Analysis

The analysis tool has the following parameters:

  • EventLoader
    • pcl.Path - a branch (in the input ROOT-file) for reading
    • plists - a partilce list for further analisis. if it is necessary to consider not only positive, but also negative particles, the label "сс" is used. For example [['K+ cc'], ['pi+ cc']]. Also it is possible to write a kinematic constraint; for example [['K+ cc', 'p > 0.5'], ['pi+ cc']] (kaons don't have the momentum less then 0.5 GeV)
  • ParticleCombinerAlg
    • decStr - an investigated decay
    • cutStr - a selection criteria
    • selfConj - if neutral particle True, else False
  • NtupleAlg
    • vars - a list contains the particle parameters to write an output file. A particle in the decay string can be selected using the "^" symbol. If a decay isn't written (), the information about parameters will be about a parent particle.

More information about the analysis tool is here.

[edit] Podio output

It is possible to write the particle parameters to a ROOT file.

You have to import the library 

from Configurables import PodioOutput

and to create the algorithm instance 

out = PodioOutput('out', filename=ofile)
out.outputCommands = ["keep *"]

The reading algorithm has the parameter: filename - an output file name.

[edit] Running algorithm

Some necessary parametrs to run the algorithms:

  • TopAlg - a list of the using algorithms
  • EvtMax - a number of events
Retrieved from "https://ctd.inp.nsk.su/wiki/index.php?title=SCT_parametric_simulation&oldid=1315"
Personal tools