Skip to content

Commit 11f8e88

Browse files
sebaperssondilpath
andauthored
Clarify interpretation of noise distributions (#656)
* Clarify interpretation of noise distributions * Apply suggestions from code review Co-authored-by: Dilan Pathirana <59329744+dilpath@users.noreply.github.com> * Clairfy noise parameter, and format table * Apply suggestions from code review --------- Co-authored-by: Dilan Pathirana <59329744+dilpath@users.noreply.github.com>
1 parent c167df3 commit 11f8e88

1 file changed

Lines changed: 16 additions & 11 deletions

File tree

doc/v2/documentation_data_format.rst

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -746,13 +746,12 @@ Detailed field description
746746
Noise distributions
747747
~~~~~~~~~~~~~~~~~~~
748748

749-
Denote by :math:`m` the measured value,
750-
:math:`y:=\text{observableFormula}` the simulated value
751-
(the location parameter of the noise distribution),
752-
and :math:`\sigma` the scale parameter of the noise distribution
753-
as given via the ``noiseFormula`` field (the standard deviation of a normal,
754-
or the scale parameter of a Laplace model).
755-
Then we have the following effective noise distributions:
749+
Let :math:`m` denote the measured value,
750+
:math:`y := \text{observableFormula}` the simulated value (the median of
751+
the noise distribution), and :math:`\sigma := \text{noiseFormula}` the
752+
noise parameter (the standard deviation and the scale parameter for the
753+
Normal and Laplace distributions, respectively). Then we have the following
754+
effective noise distributions:
756755

757756
.. list-table::
758757
:header-rows: 1
@@ -761,25 +760,31 @@ Then we have the following effective noise distributions:
761760
* - Type
762761
- ``noiseDistribution``
763762
- Probability density function (PDF)
764-
* - Gaussian distribution
763+
* - | Gaussian distribution
764+
| (i.e., :math:`m \sim \mathcal{N}(y, \sigma^2)`)
765765
- ``normal``
766766
- .. math::
767767
\pi(m|y,\sigma) = \frac{1}{\sqrt{2\pi}\sigma}\exp\left(-\frac{(m-y)^2}{2\sigma^2}\right)
768768
* - | Log-normal distribution
769-
| (i.e., :math:`\log(m)` is normally distributed)
769+
| (i.e., :math:`\log(m) \sim \mathcal{N}(\log(y), \sigma^2)`)
770770
- ``log-normal``
771771
- .. math::
772772
\pi(m|y,\sigma) = \frac{1}{\sqrt{2\pi}\sigma m}\exp\left(-\frac{(\log m - \log y)^2}{2\sigma^2}\right)
773-
* - Laplace distribution
773+
* - | Laplace distribution
774+
| (i.e., :math:`m \sim \mathrm{Laplace}(y, \sigma)`)
774775
- ``laplace``
775776
- .. math::
776777
\pi(m|y,\sigma) = \frac{1}{2\sigma}\exp\left(-\frac{|m-y|}{\sigma}\right)
777778
* - | Log-Laplace distribution
778-
| (i.e., :math:`\log(m)` is Laplace distributed)
779+
| (i.e., :math:`\log(m) \sim \mathrm{Laplace}(\log(y), \sigma)`)
779780
- ``log-laplace``
780781
- .. math::
781782
\pi(m|y,\sigma) = \frac{1}{2\sigma m}\exp\left(-\frac{|\log m - \log y|}{\sigma}\right)
782783

784+
Note that, for all PEtab noise distributions, the simulated value is modeled
785+
as the median of the noise distribution; i.e., measurements are assumed to
786+
be equally likely to lie above or below the model output.
787+
783788
The distributions above are for a single data point.
784789
For a collection :math:`D=\{m_i\}_i` of data points and corresponding
785790
simulations :math:`Y=\{y_i\}_i`

0 commit comments

Comments
 (0)