musrsim/geant4/LEMuSR/doc/commands.dox
2006-02-23 17:30:21 +00:00

133 lines
5.8 KiB
Plaintext

/*! @page commands Commands
<BR>
<B> Previous:</B> @ref
<B> Up:</B> @ref
<B> Next:</B> @ref
<BR>
<HR>
We present here the most useful commands to run the simulation. Some additional commands can be accessed entering <b>help</b> in the run terminal or on the <A href="http://geant4.web.cern.ch/geant4/G4UsersDocuments/UsersGuides/ForApplicationDeveloper/html/Control/UIcommands/_.html">web</A>. We do not put them here because they are not necessary for the \lemu simulation.
\section coms_config UI control commands
* - <b>/control/execute macrofile </b> : execute a macro file. The macro files are edited as a list of commands.
*
* - <b>/control/verbose </b> : set the verbose level
*
* - <b>/control/shell </b> : access the shell
*
* - <b>/help </b> : call interactive help with all the commands.
\section coms_run Run control commands
* - <b>/run/beamOn #n</b> : simulate n particles
*
* - <b>/run/verbose </b> : set the verbose level
\section coms_det Geometry control commands
\subsection com_Mode Detector Mode
* - <b>/Detector/Mode [cryo/mcp] </b> :
*
* - <b>/Detector/CfoilThickness [\f$ \mu g / cm^{2}\f$] </b> : set the thickness of the carbon foil
*
* - <b>/Detector/MaxStepInField [\f$ mm \f$]</b> : set a cut on the maximal step size in the regions with field.
*
\subsection com_sample Sample Specifications
* - <b>/Detector/Sample/Grid [on/off]</b> : <b>NB!</b> the command is not working because no field map was generated for this case.
*
* - <b>/Detector/Sample/Guards [on/off]</b> : enable or disable the guard rings in sample cryostat
*
* - <b>/Detector/Sample/HolderMaterial [material]</b> : to change the material of the sample holder plate.
*
\subsection com_volt Electric Fields and Voltage Settings
* - <b>/Detector/ElectricField [on/off]</b> : enables fiels at trigger detector or disables all electric fields.
*
In order to set the electric field for the third lense and the conical anode one should enter a voltage value. The fields maps were generated for 1 kV. During the initialization they are scaled according to the entered voltage.
* - <b>/Detector/Voltage/ThirdLens [Third Lens Voltage kV]</b> : Third lens voltage in kilovolt
*
* - <b>/Detector/Voltage/ConicalAnode [RA-Left Voltage [kV]] [RA-Right Voltage [kV]] [Build]</b> : Ring anode voltage in kilovolt. The built variable is 1 or 0 and specifies if the detector is rebuilt after the values are changed or later.
*
* - <b>/Detector/Voltage/Cryo [kV]</b> : Sample voltage in kilovolt
*
\subsection com_mag Magnetic Field
* - <b>/Detector/MagneticField [Gauss] </b> : set the value of the magnetic field
*
\subsection com_vis Visualization Mode
* - <b>/Detector/View [total/half/quarter]</b> : build the detector with half cut or quarter cut. <i>The detector must be built in total view to run the simulation.</i>
\section coms_pga Particle gun control commands
* - <b>/lemuGun/gunPosition [X [cm]] [Y [cm]] [Z [cm]]</b> : the gun position in centimeters. Note that the origin of the geometry is the mcp detector and the carbon foil is at -113.7cm
*
* - <b>/lemuGun/MomentumDirection [momX ] [momY ] [momZ ] </b> : a unitary vector for the particles momentum direction.
*
* - <b>/lemuGun/particle particle </b> : Particle types: mu+/Mu or other.
*
* - <b>/lemuGun/scan/square [X Y B]</b> : flat distribution of B bins in a rectangle 2X x 2Y. Distances are in centimeters.
*
* - <b>/lemuGun/scan/circular [R N M] </b> : circular distribution with N steps along the radius R and M steps along the \f$ 2\pi\f$ angle. Radius in cemtimeters.
*
* - <b>/lemuGun/gauss </b> : gaussian distribution of x and y.
*
* - <b>/lemuGun/reset </b> : reset the counters for the scan mode.
\section coms_vis Visualization control commands
To start a visualization driver and draw the geometry one may follow the following four step procedure:
*
* -# <b>/vis/scene/create </b> : to create a scene to draw.
*
* -# <b>/vis/open [vis_engine] </b> : to open the visualisation engine vis_engine (recommended OGLIX for x-window or DAWNFILE for *.eps file and DANW *.prim file output).
*
* -# <b>/vis/sceneHandler/attach </b> : to link the scene the the engine.
*
* -# <b>/vis/viewer/flush </b> : to draw the geometry.
*.
* The visualization angles and camera position can be set in many different ways. The command should be accessed entering <tt<help</tt> in the terminal. Among those commands one would find:
*
* - <b>/vis/viewer/set/viewpointThetaPhi \f$ \alpha \ \beta \f$ </b> : set camera angle in deg.
*
* - <b>/vis/viewer/refresh </b> : to redraw the geometry.
*
* - <b>/vis/drawTree </b> : print out the hierarchical tree of the geometry. If a physical volume name is specified, the tree will be printed from the correspondant volume.
*
* - <b>/vis/ASCITree/verbose [level]</b> : set verbose level for the <b>/vis/drawTree </b> command. The verbose level goes from 0 to 15.
\section coms_sensidet Sensitive detection control commands
*
* - <b>/hits/list </b> : get the list of the different sensitive detectors available
*
* - <b>/hits/activate [sd_name]</b> : activate the sensitive detector sd_name
*
* - <b>/hits/inactivate [sd_name] </b> : inactivate the sensitive detector sd_name
*
* - <b>/hits/verbose [level]</b> : set the verbose level.
\section coms_misc Miscanellous control commands
*
* - <b>/tracking/storeTrajectory 1 </b> : to store the trajectories in order to be able to plot them in the visualisation for example.
*
* - <b>/process/(in)activate [particle_name]</b> : (in)activate the particle particle_name
*
* - <b>/particle/(in)activate [process_name]</b> : (in)activate the process process_name.
*
*.
In the help directory, one would find some guidance providing the use of the command with the arguments description: what argument to enter, which unit, which format (<b>s</b>tring, <b>d</b>ouble, <b>i</b>nt ...), is the argument ommitable etc.).
A comprehensive list of all the commands can be found in the annexe @ref annexe_commands.
*/