ref:muscle_measure

Differences

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


ref:muscle_measure [2023/12/14 16:03] (current) – created - external edit 127.0.0.1
Line 1: Line 1:
 +====== MuscleMeasure ======
 +[[measure|Measure]] for penalizing specific muscle quantities. 
 +
 +Penalties can be based on muscle input, activation, length and velocity. Example: <code>MuscleMeasure {
 +    muscle = gastroc
 +    activation { max = 0 squared_penalty = 1 } # penalize squared activation
 +    length { max = 1 abs_penalty = 1 } # Penalize when ( length > optimized fiber length )
 +}
 +</code>
 +
 +**Inherits from** [[measure|Measure]].
 +
 +==== Public Attributes ====
 +^ Parameter ^ Type ^ Description ^
 +^ muscle | Muscle & | Muscle to which to apply the penalty to. |
 +^ input | [[range_penalty|RangePenalty]]< Real > | Penalty for when the muscle input [0..1] is out of range. |
 +^ activation | [[range_penalty|RangePenalty]]< Real > | Penalty for when the normalized muscle activation [0..1] is out of range. |
 +^ length | [[range_penalty|RangePenalty]]< Real > | Penalty for when the normalized muscle length [L_opt] is out of range. |
 +^ velocity | [[range_penalty|RangePenalty]]< Real > | Penalty for when the normalized muscle contraction velocity [L_opt/s] is out of range. |
 +^ force | [[range_penalty|RangePenalty]]< Real > | Penalty for when the normalized muscle force [N/max_isometric_force] is out of range. |
 +^ 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. |
 +^ threshold_transition | Real | Transition range above ''threshold'' between which the measure linearly decreases to zero; default = 0. |
 +^ result_offset | Real | Offset added to measure result; default = 0. |
 +^ minimize | bool | Indicate whether this measure should be minimized; default value depends on the measure type (usually true). |
 +^ 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. |
 +^ signature | String | Set custom signature and omit the auto-generated signature. |
 +
 +<sub>Converted from doxygen using [[https://github.com/tgeijten/dokugen|dokugen]]</sub>