/*! @page commands Commands
Previous: @ref
Up: @ref
Next: @ref
We present here the most useful commands to run the simulation. Some additional commands can be accessed entering help in the run terminal or on the web. We do not put them here because they are not necessary for the \lemu simulation.
\section coms_config UI control commands
* - /control/execute macrofile : execute a macro file. The macro files are edited as a list of commands.
*
* - /control/verbose : set the verbose level
*
* - /control/shell : access the shell
*
* - /help : call interactive help with all the commands.
\section coms_run Run control commands
* - /run/beamOn #n : simulate n particles
*
* - /run/verbose : set the verbose level
\section coms_det Geometry control commands
\subsection com_Mode Detector Mode
* - /Detector/Mode [cryo/mcp] :
*
* - /Detector/CfoilThickness [\f$ \mu g / cm^{2}\f$] : set the thickness of the carbon foil
*
* - /Detector/MaxStepInField [\f$ mm \f$] : set a cut on the maximal step size in the regions with field.
*
\subsection com_sample Sample Specifications
* - /Detector/Sample/Grid [on/off] : NB! the command is not working because no field map was generated for this case.
*
* - /Detector/Sample/Guards [on/off] : enable or disable the guard rings in sample cryostat
*
* - /Detector/Sample/HolderMaterial [material] : to change the material of the sample holder plate.
*
\subsection com_volt Electric Fields and Voltage Settings
* - /Detector/ElectricField [on/off] : 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.
* - /Detector/Voltage/ThirdLens [Third Lens Voltage kV] : Third lens voltage in kilovolt
*
* - /Detector/Voltage/ConicalAnode [RA-Left Voltage [kV]] [RA-Right Voltage [kV]] [Build] : 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.
*
* - /Detector/Voltage/Cryo [kV] : Sample voltage in kilovolt
*
\subsection com_mag Magnetic Field
* - /Detector/MagneticField [Gauss] : set the value of the magnetic field
*
\subsection com_vis Visualization Mode
* - /Detector/View [total/half/quarter] : build the detector with half cut or quarter cut. The detector must be built in total view to run the simulation.
\section coms_pga Particle gun control commands
* - /lemuGun/gunPosition [X [cm]] [Y [cm]] [Z [cm]] : the gun position in centimeters. Note that the origin of the geometry is the mcp detector and the carbon foil is at -113.7cm
*
* - /lemuGun/MomentumDirection [momX ] [momY ] [momZ ] : a unitary vector for the particles momentum direction.
*
* - /lemuGun/particle particle : Particle types: mu+/Mu or other.
*
* - /lemuGun/scan/square [X Y B] : flat distribution of B bins in a rectangle 2X x 2Y. Distances are in centimeters.
*
* - /lemuGun/scan/circular [R N M] : circular distribution with N steps along the radius R and M steps along the \f$ 2\pi\f$ angle. Radius in cemtimeters.
*
* - /lemuGun/gauss : gaussian distribution of x and y.
*
* - /lemuGun/reset : 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:
*
* -# /vis/scene/create : to create a scene to draw.
*
* -# /vis/open [vis_engine] : to open the visualisation engine vis_engine (recommended OGLIX for x-window or DAWNFILE for *.eps file and DANW *.prim file output).
*
* -# /vis/sceneHandler/attach : to link the scene the the engine.
*
* -# /vis/viewer/flush : to draw the geometry.
*.
* The visualization angles and camera position can be set in many different ways. The command should be accessed entering in the terminal. Among those commands one would find:
*
* - /vis/viewer/set/viewpointThetaPhi \f$ \alpha \ \beta \f$ : set camera angle in deg.
*
* - /vis/viewer/refresh : to redraw the geometry.
*
* - /vis/drawTree : print out the hierarchical tree of the geometry. If a physical volume name is specified, the tree will be printed from the correspondant volume.
*
* - /vis/ASCITree/verbose [level] : set verbose level for the /vis/drawTree command. The verbose level goes from 0 to 15.
\section coms_sensidet Sensitive detection control commands
*
* - /hits/list : get the list of the different sensitive detectors available
*
* - /hits/activate [sd_name] : activate the sensitive detector sd_name
*
* - /hits/inactivate [sd_name] : inactivate the sensitive detector sd_name
*
* - /hits/verbose [level] : set the verbose level.
\section coms_misc Miscanellous control commands
*
* - /tracking/storeTrajectory 1 : to store the trajectories in order to be able to plot them in the visualisation for example.
*
* - /process/(in)activate [particle_name] : (in)activate the particle particle_name
*
* - /particle/(in)activate [process_name] : (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 (string, double, int ...), is the argument ommitable etc.).
A comprehensive list of all the commands can be found in the annexe @ref annexe_commands.
*/