ROTPRBIN

Summary

Sets the amount of storage and the storage precision for binnings (single or double). Sets also the correspondence between rotations/translations and binnings (USRBIN or EVENTBIN), as well as density-correction factors for user binnings (see CORRFACT). ​​ ​​​ ​

See also USRBIN, EVENTBIN, ROT–DEFIni, CORRFACT.
For SDUM = RHO-FACT:
WHAT(1) :

Sets density-correction-factor options:

= 0:

ignored.

< -1:

reset the density to be used to default (that is density correction factors for all user binnings apart 252 (DOSE-H2O), 253 (ALPHA-D), and 254 (SQBETA-D), where dE/dx correction factors are the default).

= 1:

use density correction factors.

= 2:

use dE/dx correction factors.

= -1:

use density correction factors for all other processes.

WHAT(2) :

not used

WHAT(3) :

not used

For all other SDUM:

WHAT(1) :

sets the run-time storage precision of binnings:

= 0 ignored.

≤ -1.0: resets the storage precision to default (double). All bins printed always.

= xxz01: sets the storage precision to single (see Note 2).

= xxz0y: sets the storage to only a fraction of the required memory, that is only xx.z percent of the required memory for this binning is actually allocated (see Note 3).

= uxxz0y: u\(>0\) makes the binning info printed only if non zero bins exist.

Default

: double precision storage and full memory allocation​

WHAT(2) :

index (or name) of the rotation/translation matrix (defined by a ROT-DEFIni card) which is associated to the binning(s) indicated by WHAT(4)…WHAT(6) (see Note 4)​

= 0.0: ignored

\(>100000\): (in absolute value), resets the associated rotation/translation to identity (transformation index = 0).

WHAT(3) :

define number of events after which to print EVENTBIN results

= 0.0:

ignored.

≤ -1.0:

reset the number of events after which EVENTBIN results must be printed to the default (\(=1\)).

≥ 1.0:

number of events after which EVENTBIN results must be printed for the binnings given by WHAT(4–6).

Default

= 1.0

SDUM

: possible index or name of a 2nd transformation associated with these binnings. Exceptionally, here SDUM can contain an integer number, in free format, following any of the strings “ROT#”, “Rot#”, “rot#”, “RO#”, “Ro#”, “ro#”. If any one of such strings is present, an integer identifying the associated roto-translation is read in the following characters. Otherwise if a name is present, it is supposed to be the (character) name (with sign) of the associated roto-translation. The roto-translation order is such that the one associated with WHAT(2) is the innermost (first applied) one

For all SDUM:

WHAT(4) =
lower index bound of binnings in which the requested storage precision and/or transformation must be applied
(“From binning ``WHAT(4)``…”)
Default

= 1.0

WHAT(5) =
upper index bound of binnings in which the requested storage precision and/or transformation must be applied
(“…to binning ``WHAT(5)``…”)
Default

= WHAT(4)

WHAT(6) =
step length in assigning indices.
(“…in steps of ``WHAT(6)`` ”)
Default

= 1.0

Default

(option ROTPRBIN not given): binning data are stored in double precision, and no rotation/translation is applied

Notes

  1. Command ROTPRBIN can be used for three different tasks, all related to binnings requested by the user by means of EVENTBIN or USRBIN:

    1. to define the precision used at run-time to store the accumulated scores of selected binnings

    2. to allocate a reduced amount of memory as a storage for selected binnings​

    3. to set the correspondence between the index of a transformation (rotation/translation as defined by command ROT–DEFIni, see) and the index of selected binnings.

  2. The USRBIN/EVENTBIN output values are always in single precision​, regardless of the run-time storage precision used. Run-time storage precision, which is double by default, should never be changed for binnings defined by USRBIN to prevent severe loss of data (adding small amounts in the rounding can result in values no longer increasing with the number of primary particles). However, this is unlikely to happen with EVENTBIN binnings, which are reset at the end of each history.

  3. In many cases, binnings defined by EVENTBIN result in a number of sparse “hit” cells​, while all other bins are empty (scoring zero). In such cases, it is convenient to allocate less storage than required by the whole binning structure. See also Note 2 to option EVENTBIN.

  4. Binning space transformations (rotations and translations) are those defined by a ROT–DEFIni card. That is, the variables used for scoring are the primed one (\(x',y',z'\)) (see Notes 4 and 5 to option ROT–DEFIni)​.

Example 1:

*...+....1....+....2....+....3....+....4....+....5....+....6....+....7...+...8
ROTPRBIN      85500.       0.0       0.0       2.0       6.0       2.0
*  Allocate only 85.5% of the memory normally required for binnings 2, 4 and 6

Example 2:

*...+....1....+....2....+....3....+....4....+....5....+....6....+....7...+...8
ROTPRBIN      10001.       0.0       0.0       3.0       5.0       0.0
*  Set single storage precision for binnings 3, 4 and 5

Example 3:

*...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+...
ROTPRBIN              myMatrix             energyA   HEhadrA
*...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+...
ROT-DEFIni       44.        0.        0.        0.        0.   -16000.myMatrix
ROT-DEFIni      244.        0.       10.        0.        0.        0.myMatrix
ROT-DEFIni       44.        0.        0.        0.    10000.    10000.myMatrix
*...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+...
USRBIN           11.    ENERGY      -21.        1.        5.      50. energyA
USRBIN           -1.       -1.       -5.       10.       10.      50.   &
USRBIN           11.      DOSE      -21.        1.        5.      50. doseA
USRBIN           -1.       -1.       -5.       10.       10.      50.   &
USRBIN           11.  HADGT20M      -21.        1.        5.      50. HEhadrA
USRBIN           -1.       -1.       -5.       10.       10.      50.   &
*...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+...
* Associate the "myMatrix" ROT-DEFIni to the "energyA", "doseA" and "HEhadrA"
* USRBINS