Skip to content

Commit

Permalink
Clarify implications of 'parameterScale' (#547)
Browse files Browse the repository at this point in the history

Co-authored-by: Dilan Pathirana <[email protected]>
  • Loading branch information
dweindl and dilpath committed Mar 10, 2023
1 parent ff31205 commit ff435d0
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions doc/documentation_data_format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -495,23 +495,36 @@ Detailed field description

Scale of the parameter to be used during parameter estimation.

``lin``
Use the parameter value, ``lowerBound``, ``upperBound``, and
``nominalValue`` without transformation.
``log``
Take the natural logarithm of the parameter value, ``lowerBound``,
``upperBound``, and ``nominalValue`` during parameter estimation.
``log10``
Take the logarithm to base 10 of the parameter value, ``lowerBound``,
``upperBound``, and ``nominalValue`` during parameter estimation.

- ``lowerBound`` [NUMERIC]

Lower bound of the parameter used for estimation.
Optional, if ``estimate==0``.
Must be provided in linear space, independent of ``parameterScale``.
The provided value should be untransformed, as it will be transformed
according to ``parameterScale`` during parameter estimation.

- ``upperBound`` [NUMERIC]

Upper bound of the parameter used for estimation.
Optional, if ``estimate==0``.
Must be provided in linear space, independent of ``parameterScale``.
The provided value should be untransformed, as it will be transformed
according to ``parameterScale`` during parameter estimation.

- ``nominalValue`` [NUMERIC]

Some parameter value to be used if
the parameter is not subject to estimation (see ``estimate`` below).
Must be provided in linear space, independent of ``parameterScale``.
The provided value should be untransformed, as it will be transformed
according to ``parameterScale`` during parameter estimation.
Optional, unless ``estimate==0``.

- ``estimate`` [BOOL 0|1]
Expand Down

0 comments on commit ff435d0

Please sign in to comment.