Skip to content

Commit bacf83e

Browse files
dweindldilpath
andcommitted
Clarify implications of 'parameterScale' (#547)
Co-authored-by: Dilan Pathirana <59329744+dilpath@users.noreply.github.com>
1 parent 88c6605 commit bacf83e

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

doc/documentation_data_format.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -501,23 +501,36 @@ Detailed field description
501501

502502
Scale of the parameter to be used during parameter estimation.
503503

504+
``lin``
505+
Use the parameter value, ``lowerBound``, ``upperBound``, and
506+
``nominalValue`` without transformation.
507+
``log``
508+
Take the natural logarithm of the parameter value, ``lowerBound``,
509+
``upperBound``, and ``nominalValue`` during parameter estimation.
510+
``log10``
511+
Take the logarithm to base 10 of the parameter value, ``lowerBound``,
512+
``upperBound``, and ``nominalValue`` during parameter estimation.
513+
504514
- ``lowerBound`` [NUMERIC]
505515

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

510521
- ``upperBound`` [NUMERIC]
511522

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

516528
- ``nominalValue`` [NUMERIC]
517529

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

523536
- ``estimate`` [BOOL 0|1]

0 commit comments

Comments
 (0)