Skip to content

Clarify implications of 'parameterScale' #547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dweindl merged 4 commits into from
Mar 10, 2023
Merged

Clarify implications of 'parameterScale' #547

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
361826a
Clarify implications of 'parameterScale'
dweindl Jun 27, 2022
d39f9f6
Update doc/documentation_data_format.rst
dweindl Jun 27, 2022
7465589
Update doc/documentation_data_format.rst
dweindl Mar 10, 2023
8fee996
..
dweindl Mar 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions doc/documentation_data_format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,23 +494,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