Differences

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

Link to this comparison view

ref:reaction_force_measure [2019/10/23 15:06]
ref:reaction_force_measure [2019/11/12 15:29] (current)
Line 1: Line 1:
 +====== ReactionForceMeasure ======
 +[[measure|Measure]] that penalizes ground reaction forces above a certain threshold. ​
 +
 +See [[range_penalty|RangePenalty]] for details on how to set range, abs_penalty and squared_penalty. ​
 +
 +**Inherits from** [[measure|Measure]],​ [[range_penalty|RangePenalty<​ Real >]].
 +
 +==== 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. |
 +^ range | Range< Real > | Specify the valid range, set through parameters '​min'​ and '​max';​ defaults to { min = -inf max = inf }. |
 +^ abs_penalty | Real | Absolute penalty factor when value is out of range; default = 0. |
 +^ squared_penalty | Real | Squared penalty factor when value out of range; default = 0. |
 +^ mode_ | penalty_mode | Use the peek range violation instead of average range violation; default = 0. |
 +
 +<​sub>​Converted from doxygen using [[https://​github.com/​tgeijten/​dokugen|dokugen]]</​sub>​