Description of parameters used in JSF and Satellites job

Parameter name Default value Command option Description
JSF  
JSF.LoadLibraryMacro LoadLibraries.C   A name of macro file which includes a function, void LoadLibraries(JSFEnv*). This function is to load shared libraries in the constructor of JSFSteer. The default file will be found in the $JSFROOT/macro directory.
JSF.SharedLibraries undef   Semi-colon separated list of shared libraries which are loaded when JSFSteer object is created, i.e, at the begining of JSF command.
JSF.Chainfiles 1   According to the ROOT convension, if output data size exceeds a limit ( default is 2 GB ), the current file is closed and new file is open for subsequent output, where file name is postpend by _N. N is an integer number.

If JSF.ChainFiles is 1 and there exist file names consistent with the ROOT convension, those files are defined as a chain of root files. In this case, trees included separately in those files are treated as if they are single tree.

JSFEnv.Filter J4   This parameter specifies a colon(:) separated list of string which are used as a prefix of parameter names which are loaded into memory from a input file.

JSF parameters which are obtained from a file, jsf.conf or parameters of Jupiter which are obtained from a file defined by JSFJ4.ParameterTable are written in the output root file (File defined by JSFGUI.OutputFileName). The next job, which reads this file, loads those parameter values into the memory if the name of parameters is prefixed by the string given by this parameter, JSFEnv.Filter, so that they are used as default values. Unless they are further over-written by the input from the file, jsf.conf, parameters used by the previous job step are used.

JSF.EnvParameter.GetFromInput 1   If 1, load JSF parameters from a input ROOT file.
JSF.EnvParameter.Replace 0   If 1, parameters obtained from an input ROOT file overwrites parameters obtained from a file, jsf.conf. Note that the standard priority of parameter values are, (1) Those hard-coded in the program, (2) Those obtained from the input ROOT file, i.e, those given by jsf.conf or command arguments at the previous job, (3) Thoes obtained from a file, jsf.conf, (4) Those given by command arguments. where larger number means higher priority. If this parameter is 1, the priority order becomes 1 < 3 < 4 < 2.
JSFEnv.RecordDefault 0   If 1, JSF parameters used by a program are recorded in the data member of JSFEnv class, JSFEnv::fDefined. The function,JSFEnv::PrintDefined(), can be used to print out the recorded values at the end of the job. The output file name is set by the parameter JSFEnv.FileForDefaultValue.
JSFEnv.FileForDefaultValue default.conf   The file name where the function, JSFEnv.PrintDefined(), print the JSF Parameters defined during the job execution. This function is valid when JSFEnv.RecordDefault is set to 1.
JSF.Benchmark 1   If 1(0), (not) monitor CPU times of each modules and print them at the end of the job.
JSF.MakeJSFTree 1   If 1 (0), create (not create) a tree to write events to the output file. Use 0 only when you don't need JSF event tree in the output file.
JSFGUI  
JSFGUI.FirstEvent 1 1stevt Event number to start analysis. Valid when reading a file
JSFGUI.NEventsAnalize 10000 maxevt Number of events to analize
JSFGUI.SimulationType 1 simtype Type of simulation module
0 = Do not run simulation. Generator only
1 = Use Quick Simulator
3 = Use Jupiter simulation. Should be set when using JSFJ4.
JSFGUI.OutputFileName jsf.root OutputFile File name of output data (where event tree is written.) If the size of the output file exceeds about 1.9 GByte, the file is closed automatically and a new file is opened for subsequent output. The file name will be "jsf_1.root", "jsf_2.root", etc. Please see comments at TChain:Merge( ) for more information. The limit of the file size, i.e, 1.9 GByte, can be modified by TTree::SetMaxTreeSize()
JSFGUI.InputFileName   InputFile File name of input data. If there are files with names according to the multiple file convension as described above, they are read in automatically by including them in TChain definition.
JSFGUI.RunMode 1 runmode Specify run mode. The RunMode is a flag to select JSFModules defined in the Initialize() functions defined in the file, GUIMainMacro.C. It's meanings are
Valuemeanings
0Calls user defined function, UserModuleDefine(), to construct JSFModules and set their parameters. In this case, functions built in GUIMainMacro.C are not called. UserModuleDefine() should be defined in a file, UserAnalysis.C
1Generate events. A generator module is constructed.
2Read root file
3Read SIMDST fortran binary file
4Read JIM data (obsolute)
5Run JIM simulation (obsolute)
JSFGUI.EventType 0 eventype Select event generator module. Valid when RunMode=1
Valuemeanings
0Pythia generator
1Debug generator
2Bases/Spring generator
3Read parton data
4Read HEPEVT data. See parameters associated with JSFReadGenerator for related parameters.
JSFGUI.GUIMainMacro GUIMainMacro.C   A file name of GUIMainMacro file, which is loaded from the gui.C macro file. It should contains global functions such as Initialize(), GetEvent(), JobEnd(), etc. For details see comments in the file, GUIMainMacro.C.
JSFGUI.MacroFileName UserAnalysis.C macro A name of a macro file, which defines user analysis functions. See an example in $JSFROOT/macro/UserAnalysis.C in JSF distribution.
JSFGUI.InitPythiaMacro InitPythia.C   A name of a macro file, which define a function to initialize Pythia, void InitPythia(). See an example in $JSFROOT/macro/InitPythia.C in JSF distribution.
JSFGUI.ECM 300.0 ecm Center of mass energy in unit of GeV. This is used by PythiaGenerator.
JSFGUI.RunNo 1 runno Run number
JSFGUI.LastRunFile     A file name of previous run data, which is used to get seeds of random number at the end of last run.
JSFGUI.Spring.SharedLibrary ../FFbarSpring/
libFFbarSpring.so
  A name of shared library for event generation by Bases/Spring.
JSFGUI.Spring.ModuleName FFbarSpring   A module name of Spring
JSFGUI.Spring.BasesFile :../FFbarSpring/
bases.root
  A file name of bases data.
JSFGUI.SIMDST.Output No   Yes or 1 ( No or 0 ) to output (not output) SIMDST's fortran binary data.
JSFGUI.SIMDSTConversion 1   Create SIMDST objects when reading QuickSim data (1) or no(0)
JSFGUI.OutputEventData No   Yes or 1 ( No or 0 ) to output event data to the file.
JSFQuickSim.ParameterFile Undefined   A file name for Quick simulator's detector parameter. If it's "Undefined" ot not specified, a file, $LCLIBROOT/simjlc/parm/detect7.com is used.
JSFGUI.OptFunctions OptFunctions.C   The name of the file, which defines the global function, void DefineOptionalModules(). This function is called when the parameter JSFGUI.OptModules is 1, and used to construct objects required to run Satellites.
JSFGUI.OptModules 0   If 1, the function, DefineOptionalModules(), is called. It must be 1, when analizing the Jupiter output by Satellites.
Generator related  
PythiaGenerator.PrintStat 1   If 0, does not call PYSTAT at job termination. Otherwise, calls PYSTAT at job termination. The value of [PrintStat] is used as an argument of PYSTAT.
JSFGUI.Pythia.Decay.Z 0 zdecay Used to select decay mode of Z
Valuemeanings
-1Diable all Z decay mode
0Enable all Z decay mode
ndecay mode of n only is alloed, where n is
1=d-quark, 2=u-quark, 3=s-quark, 4=c-quark, 5=b-quark, 11=e, 12=nu_e, 13=mu, 14=nu_mu, 15=tau, 16=nu_tau
-2q qbar
-3ee/mumu
-4lepton lepton
-5nu nu
JSFGUI.Pythia.Decay.H 0 hdecay Used to select decay mode of H Meanings of values are; 0=all, 1=d dbar, 2=u ubar, 3=s sbar, 4=c cbar, 5=b bar, 6=t tbar, 9=e- e+, 10=mu- mu+, 11=tau- tau+, 13=g g, 14=gamma gamma, 15=gamma Z0, 16=Z0 Z0, 17=W+ W-
JSFGUI.Pythia.Decay.W 0 wdecay Used to select decay mode of W Meanings of values are; 1=dbar u 2=dbar c 3=dbar t 5=sbar u 6=sbar c 7=sbar t 9=bbar u 10=bbar c 11=bbar t 17=e+ nue 18=mu+ nu_mu 19=tau+ nu_tau -2=W->q qbar -3=W->e-nu_e/mu-nu_mu -4=W->lepton nu_lepton
JSFGUI.Pythia.Process.ZH 0 zh If 1, generate e+e- --> ZH process using Pythia. Pythia process ID numberis 24.
JSFGUI.Pythia.Process.ZZ 0 zz If 1, generate e+e- --> ZZ process using Pythia. Pythia process ID numberis 22.
JSFGUI.Pythia.Process.WW 0 ww If 1, generate e+e- --> WW process using Pythia. Pythia process ID numberis 25.
JSFGUI.Pythia.Process.enW 0 enw If 1, generate e+e- --> e nu W process using Pythia. Pythia process ID numberis 36.
JSFGUI.Pythia.Process.qq 0 qq If 1, generate e+e- --> gamma/Z --> q qbar process using Pythia. Pythia process ID numberis 1.
JSFGUI.Pythia.Process.enW 0 enw If 1, generate e+e- --> e nu W process using Pythia
JSFGUI.Pythia.Process.gammagammaH 0   If 1, generate e+e- --> e e H process ( through virtual gamma gamma H reaction ) using Pythia
JSFGUI.Pythia.Process.eeH 0   If 1, generate e+e- --> e e H (throug virtual Z Z H ) process using Pythia
JSFGUI.Pythia.Process.nnH 0   If 1, generate e+e- --> nu nu H process using Pythia
JSFGUI.Pythia.Process.twophoton 0   If 1, generate two-photon hadron production process using Pythia
JSFReadGenerator.DataFile genevent.dat   The input file name, which is used by JSFReadGenerator module.
JSFJ4  
JSFJ4.S4MacroFileName $SATELLITESROOT/
macros/S4Macros.C
  A name of a macro file, which contains a function to load libraries at the begining of JSF. It defines, at least, three global functions, void LoadS4Libraries(JSFEnv*), void ConstructS4Modules(), void S4Initialize(). LoadS4Libraries(JSFEnv*) is called from the function, LoadLibraries, to load libraries requred for Satellite job. ConstructS4Modules() create modules for Satellites jobs, and S4Initialize() is called during the initialization of modules related to the Satellites modules. These are called from Initialize() function defined in GUIMainMacro.C. Please modify these files if you'd like to define your own.
JSFJ4.PhysicsList J4PhysicsList   Geant4's Physics list used for Jupiter simulation. It can be either, J4PhysicsList, LCPhysicsList, QGSP, or LHEP
JSFJ4.UseJupiterGenerator 1   When it is 1, JSFJ4 uses a generator implemented in Jupiter, such as hepevt, cain, particle beam. In this case, parameters for the generator has to be specified from a Geant4 command file ( which is some times called as g4mac file.) Details of Jupiter commands will be found at here
JSFJ4.MacroFile run.mac   A file name, where Geant4 commands are obtained
JSFJ4.JupiterOut /dev/null   A file name to output Jupiter results by ASCII format, which is a default output stream when Jupiter is executed as an standalone application.
JSFJ4.VerboseLevel 8   Conrols preciseness of log message of Jupiter.
> 10 Write message every time new geometry is created.
5-10 Write message of geometry whose rank of geometry is less than N-4.
< 5 No message is written at the time of geometry creation.
JSFJ4.ParameterTable undef   A colon(:) separated list of file names, which are used to get parameters of Jupiter geometry definition. If they are not specified, values hard-coded in the source program is used. Values at the time of this writting is shown here. When JSFJ4 is executed, parameters specified by this file are saved in the jsf output file, as a JSF object at the conf directory. Those parameters whoes name is prefixed by "G4" are read into memory at the next job step so that subsequent Satellites modules can obtain parameter values by using JSFEnv::GetValue functions.
JSFJ4.S4Sequence     Define type of analysis performed by this job. It can be a colon(:) separated words consists of lcio, makers, analysis. If "lcio" is specified, libraries and modules required to produce LCIO output file is attached. If "makers" is specified, libraries and modules to create detector hits, clusters, tracks, hybrid tracks, PFO objects and Jets are attached. If "analysis" is specified, standard analysis modules are included.
JSFJ4.Output.Parameter.Filename undef   If it is other than "undef", parameter values used during the JSFJ4 job is written to a file, whoes name is given by this parameter.
JSFJ4.HasIR Yes hasir If yes, include IR in simulation
JSFJ4.HasBD Yes hasbd If yes, include BD in simulation
JSFJ4.HasIR Yes hasir If yes, include IR in simulation
JSFJ4.HasVTX Yes hasvtx If yes, include VTX in simulation
JSFJ4.HasIT Yes hasit If yes, include IT in simulation
JSFJ4.HasTPC Yes   If yes, include TPC in simulation
JSFJ4.HasCDC No hascdc If yes, include CDC in simulation
JSFJ4.HasCT No   If yes, include CT in simulation
JSFJ4.HasCAL Yes hascal If yes, include CAL in simulation
JSFJ4.HasSolenoid Yes   If yes, include Solenoid in simulation
JSFJ4.HasMUD Yes   If yes, include Muon detector in simulation
JSFJ4.CALHitMakingScheme 1   A scheme to make CAL Hits from exact hit information. If 1, CAL Hits consists of only 1 exact hits
J42LCIO/JSF2LCIO  
J42LCIO.DetectorName gld_v1   Detector name which is written to the LCIO file.
JSF2LCIO.OutputFileName jsf.slcio   File name to output data in LCIO format
JSFReadStdHep  
JSFReadStdHep.InputFileName     File name to get generator data in a STDHEP format.
JSFReadStdHep.Format 1   Format of StdHep generator data.
0   ASCII format. A file with this format can be created using a library in CLHEP's StdHep directory.
1   Binary format used at Fermilab and US people.