ref:measure

Differences

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


—ref:measure [2023/12/14 16:03] (current) – created - external edit 127.0.0.1
Line 1: Line 1:
 +====== Measure ======
 +Base class for Measures. 
 +
 +**Inherits from** [[controller|Controller]].
 +
 +**Inherited by** [[balance_measure|BalanceMeasure]], [[body_measure|BodyMeasure]], [[composite_measure|CompositeMeasure]], [[dof_limit_measure|DofLimitMeasure]], [[dof_measure|DofMeasure]], [[effort_measure|EffortMeasure]], [[gait_cycle_measure|GaitCycleMeasure]], [[gait_measure|GaitMeasure]], [[height_measure|HeightMeasure]], [[joint_load_measure|JointLoadMeasure]], [[jump_measure|JumpMeasure]], [[mimic_measure|MimicMeasure]], [[muscle_measure|MuscleMeasure]], [[reaction_force_measure|ReactionForceMeasure]], [[script_measure|ScriptMeasure]], [[simulation_measure|SimulationMeasure]], [[step_measure|StepMeasure]].
 +
 +==== 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. |
 +^ 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>