Skip to content

Commit

Permalink
Update intro.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
jiperl committed Feb 25, 2021
1 parent 7872ae4 commit ebaa808
Showing 1 changed file with 21 additions and 18 deletions.
39 changes: 21 additions & 18 deletions parameters/scoring/intro.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
Introduction
------------

There are two basic classes of scorers:

* :ref:`scoring_volume` (e.g. Energy or Dose)
* :ref:`scoring_surface` (e.g. Track Count or Phase Space)

Most scorers output overall quantities that are accumulated over many particles (counts and averages), but other scorers can output specific information per particle (in an n-tuple format).

You can have any number of scorers. A scorer is defined when you have a line that ends with ``Quantity``, such as::

s:Sc/MyScorer/Quantity = "DoseToMedium"

When your scoring component is the Parent of other components, you have the option to set scoring to record particles note only in the parent component, but also in its children.
b:Sc/MyScorer/PropagateToChildren = "True"This action is recursive to all levels of subcomponents.

You may write your own additional scorers (see :ref:`extension_scoring`).
Introduction
------------

There are two basic classes of scorers:

* :ref:`scoring_volume` (e.g. Energy or Dose)
* :ref:`scoring_surface` (e.g. Track Count or Phase Space)

Most scorers output overall quantities that are accumulated over many particles (counts and averages), but other scorers can output specific information per particle (in an n-tuple format).

You can have any number of scorers. A scorer is defined when you have a line that ends with ``Quantity``, such as::

s:Sc/MyScorer/Quantity = "DoseToMedium"

When your scoring component is the Parent of other components, you have the option to set scoring to record particles not only in the parent component, but also in its children.

b:Sc/MyScorer/PropagateToChildren = "True"

This action is recursive to all levels of subcomponents.

You may write your own additional scorers (see :ref:`extension_scoring`).

0 comments on commit ebaa808

Please sign in to comment.