Differences

This shows you the differences between two versions of the page.

Link to this comparison view

ref:script_measure [2019/10/23 15:06]
ref:script_measure [2019/11/12 15:29] (current)
Line 1: Line 1:
 +====== ScriptMeasure ======
 +[[measure|Measure]] defined through a Lua script. ​
 +
 +Example: <​code>#​ Measure based on lua script
 +ScriptMeasure {
 +    minimize = 0 # let the optimizer know we want to maximize this measure
 +    target_body = "​toes_r"​ # this parameter will be used in the script
 +    script_file = "​data/​ScriptMeasureJump.lua"​
 +}
 +</​code>​ See Tutorial 6a and 6b for more examples. ​
 +
 +**Inherits from** [[measure|Measure]].
 +
 +==== Public Attributes ====
 +^ Parameter ^ Type ^ Description ^
 +^ name | String | Name of the [[measure|Measure]],​ to be used in reporting; defaults to measure type. |
 +^ weight | Real | Weighting factor applied to the result of the measure; default = 1. |
 +^ threshold | Real | Threshold above / below which the measure becomes zero; default = 0. |
 +^ result_offset | Real | Offset added to measure result; default = 0. |
 +^ minimize | bool | Indicate whether this measure should be minimized; is set correctly by default. |
 +^ start_time | TimeInSeconds | Time [s] at which [[controller|Controller]] becomes active; default = 0. |
 +^ stop_time | TimeInSeconds | Time [s] at which [[controller|Controller]] becomes inactive; default = until simulation ends. |
 +^ signature_prefix | String | Prefix signature with custom string. Special tags: DATE_TIME, DATE_TIME_EXACT,​ SCONE_VERSION. |
 +^ signature_postfix | String | Append custom string to signature. Special tags: DATE_TIME, DATE_TIME_EXACT,​ SCONE_VERSION. |
 +
 +<​sub>​Converted from doxygen using [[https://​github.com/​tgeijten/​dokugen|dokugen]]</​sub>​