Reset

class zgoubidoo.commands.commands.Reset(label1: str = '', label2: str = '', *params, **kwargs)[source]

Bases: zgoubidoo.commands.commands.Command

Reset counters and flags.

Zgoubi manual description

Piling up problems in zgoubi input data file is allowed, with normally no particular precaution, except that each new problem must begin with a new object definition (using MCOBJET, OBJET). Nevertheless, when calling upon certain keywords, then, flags, counters or other integrating procedures may be involved. It may therefore be necessary to reset them. This is the purpose of RESET which normally appears right before the object definition and causes each problem to be treated as a new and independent one.

The keywords or procedures of concern and the effect of RESET are the following:

  • CHAMBR: number of stopped particles reset to 0 ; CHAMBR option switched off

  • COLLIMA: number of stopped particles reset to 0

  • HISTO: histograms are emptied

  • INTEG: number of particles out of field map boundaries reset to 0

  • MCDESINT: decay in flight option switched off, counter reset

  • PICKUPS: pick-up signal calculation switched off

  • SCALING: scaling functions disabled

  • SPNTRK: spin tracking option switched off

Zgoubidoo usage and example

>>> Reset()

Command attributes

LABEL1=''

Primary label for the Zgoubi command (default: auto-generated hash).

Type

str

LABEL2=''

Secondary label for the Zgoubi command.

Type

str

Default initializer for all Commands.

Attributes Summary

KEYWORD

Keyword of the command used for the Zgoubi input data.

PARAMETERS

Attributes Documentation

KEYWORD: str = 'RESET'

Keyword of the command used for the Zgoubi input data.

PARAMETERS: dict = {'LABEL1': ('', 'Primary label for the Zgoubi command (default: auto-generated hash).'), 'LABEL2': ('', 'Secondary label for the Zgoubi command.')}