Differences

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

--- visual3d:documentation:pipeline:signal_commands:computing_the_range_of_motion [2024/06/19 12:53] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:computing_the_range_of_motion [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-===== background =====
+====== Computing the Range of Motion ======
-there are several steps required to determine the range of motion. this page details three examples:
+==== Background ====
-  * example 1 uses events to defined maximum and minimum joint angles. finds the signal value at these events and computes the range from there.
+There are several steps required to determine the range of motion. This page details three examples:
-  * example 2 computes the range by finding the maximum and minimum joint angle and using the evaluate expression command to calculate the difference (range)
-  * example 3 computes a cummulative range of motion
-===== example 1: compute range of motion from events =====
+  * Example 1 uses events to defined maximum and minimum joint angles. Finds the signal value at these events and computes the range from there.
+  * Example 2 computes the range by finding the maximum and minimum joint angle and using the evaluate expression command to calculate the difference (range)
+  * Example 3 computes a cummulative range of motion
-consider the right knee angle angle expressed as "right knee ang". compute the range of motion over all frames in the file using events. the result is named "right knee ang rom".
+==== Example 1: Compute Range of Motion from events ====
-  * compute start and end events
+Consider the right knee angle angle expressed as "Right Knee Ang". Compute the range of motion over all frames in the file using events. The result is named "Right Knee Ang ROM".
-  * compute the desired joint angle "right knee ang rom"
-  * use the pipeline command for the event_global_maximum to determine the frame at which the maximum joint angle occurs during the range of interest (e.g. start and end event labels); this will create an event label. **note: you will have to select the component of the signal to use. for the default visual3d segment coordinate system flexion/extension will be the x-component of the joint angle.**
-  * use the pipeline command metric_signal_value_at_event to create a metric value containing the joint angle at the "maximum" event.
-  * use the pipeline command for the event_global_minimum to determine the frame at which the minimum joint angle occurs during the range of interest (e.g. start and end event labels); this will create an event label. **note: you will have to select the component of the signal to use. for the default visual3d segment coordinate system flexion/extension will be the x-component of the joint angle.**
-  * use the pipeline command metric_signal_value_at_event to create a metric value containing the joint angle at the "minimum" event.
-  * use the pipeline command for evaluate_expression to subtract the minimum value from the maximum value. **note: in the expression you will have to select the component of the signal to use. for the default visual3d segment coordinate system flexion/extension will be the x-component of the joint angle.**
-  * the metric "right knee ang rom" created in the previous step is the range of motion for the component of the joint angle selected.
-the script from the above steps can be found below:
+  * Compute START and END events
+  * Compute the desired joint angle "Right Knee Ang ROM"
+  * Use the pipeline command for the EVENT_GLOBAL_MAXIMUM to determine the Frame at which the maximum joint angle occurs during the range of interest (e.g. Start and End Event Labels); This will create an Event Label. **Note: you will have to select the component of the signal to use. For the default Visual3D segment coordinate system flexion/extension will be the x-component of the joint angle.**
+  * Use the pipeline command Metric_Signal_Value_At_Event to create a metric value containing the joint angle at the "maximum" event.
+  * Use the pipeline command for the EVENT_GLOBAL_MINIMUM to determine the Frame at which the minimum joint angle occurs during the range of interest (e.g. Start and End Event Labels); This will create an Event Label. **Note: you will have to select the component of the signal to use. For the default Visual3D segment coordinate system flexion/extension will be the x-component of the joint angle.**
+  * Use the pipeline command Metric_Signal_Value_At_Event to create a metric value containing the joint angle at the "minimum" event.
+  * Use the pipeline command for Evaluate_Expression to subtract the minimum value from the maximum value. **Note: in the expression you will have to select the component of the signal to use. For the default Visual3D segment coordinate system flexion/extension will be the x-component of the joint angle.**
+  * The metric "Right Knee Ang ROM" created in the previous step is the range of motion for the component of the joint angle selected.
+The script from the above steps can be found below:
 <code>
-! define a start event
+! Define a START Event
-event_explicit
+Event_Explicit
-/event_name=start
+/EVENT_NAME=START
-/frame=1
+/FRAME=1
-! /time=
+! /TIME=
 ;
-! define a end event
+! Define a END Event
-event_explicit
+Event_Explicit
-/event_name=end
+/EVENT_NAME=END
-/frame=eof
+/FRAME=EOF
-! /time=
+! /TIME=
 ;
-compute_model_based_data
+Compute_Model_Based_Data
-/result_name=right knee ang
+/RESULT_NAME=Right Knee Ang
-/function=joint_angle
+/FUNCTION=JOINT_ANGLE
-/segment=rsk
+/SEGMENT=RSK
-/reference_segment=rth
+/REFERENCE_SEGMENT=RTH
-/resolution_coordinate_system=
+/RESOLUTION_COORDINATE_SYSTEM=
-! /use_cardan_sequence=false
+! /USE_CARDAN_SEQUENCE=FALSE
-! /normalization=false
+! /NORMALIZATION=FALSE
-! /normalization_method=
+! /NORMALIZATION_METHOD=
-! /normalization_metric=
+! /NORMALIZATION_METRIC=
-! /negatex=false
+! /NEGATEX=FALSE
-! /negatey=false
+! /NEGATEY=FALSE
-! /negatez=false
+! /NEGATEZ=FALSE
-! /axis1=x
+! /AXIS1=X
-! /axis2=y
+! /AXIS2=Y
-! /axis3=z
+! /AXIS3=Z
 ;
-! calculate an event max at the maximum joint angle
+! Calculate an event MAX at the Maximum joint angle
-event_global_maximum
+Event_Global_Maximum
-/signal_types=link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED
-/signal_names=right knee ang
+/SIGNAL_NAMES=Right Knee Ang
-/signal_folder=original
+/SIGNAL_FOLDER=ORIGINAL
-/event_name=max
+/EVENT_NAME=MAX
-/select_x=true
+/SELECT_X=TRUE
-! /select_y=false
+! /SELECT_Y=FALSE
-! /select_z=false
+! /SELECT_Z=FALSE
-! /event_sequence=
+! /EVENT_SEQUENCE=
-! /exclude_events=
+! /EXCLUDE_EVENTS=
-/start_at_event=start
+/START_AT_EVENT=START
-/end_at_event=end
+/END_AT_EVENT=END
 ;
-! find the joint angle at event max
+! Find the joint angle at event MAX
-metric_signal_value_at_event
+Metric_Signal_Value_At_Event
-/result_metric_name=right knee ang_max
+/RESULT_METRIC_NAME=Right Knee Ang_MAX
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED
-/signal_names=right knee ang
+/SIGNAL_NAMES=Right Knee Ang
-/signal_folder=original
+/SIGNAL_FOLDER=ORIGINAL
-/event_name=max
+/EVENT_NAME=MAX
-/generate_mean_and_stddev=false
+/GENERATE_MEAN_AND_STDDEV=FALSE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
-! /generate_vector_length_metric=false
+! /GENERATE_VECTOR_LENGTH_METRIC=FALSE
-! /retain_no_data_values=false
+! /RETAIN_NO_DATA_VALUES=FALSE
 ;
-! calculate an event min at the minimum joint angle
+! Calculate an event MIN at the Minimum joint angle
-event_global_minimum
+Event_Global_Minimum
-/signal_types=link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED
-/signal_names=right knee ang
+/SIGNAL_NAMES=Right Knee Ang
-/signal_folder=original
+/SIGNAL_FOLDER=ORIGINAL
-/event_name=min
+/EVENT_NAME=MIN
-/select_x=true
+/SELECT_X=TRUE
-! /select_y=false
+! /SELECT_Y=FALSE
-! /select_z=false
+! /SELECT_Z=FALSE
-! /event_sequence=
+! /EVENT_SEQUENCE=
-! /exclude_events=
+! /EXCLUDE_EVENTS=
-/start_at_event=start
+/START_AT_EVENT=START
-/end_at_event=end
+/END_AT_EVENT=END
 ;
-! find the joint angle at event min
+! Find the joint angle at event MIN
-metric_signal_value_at_event
+Metric_Signal_Value_At_Event
-/result_metric_name=right knee ang_min
+/RESULT_METRIC_NAME=Right Knee Ang_MIN
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED
-/signal_names=right knee ang
+/SIGNAL_NAMES=Right Knee Ang
-/signal_folder=original
+/SIGNAL_FOLDER=ORIGINAL
-/event_name=min
+/EVENT_NAME=MIN
-/generate_mean_and_stddev=false
+/GENERATE_MEAN_AND_STDDEV=FALSE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
-! /generate_vector_length_metric=false
+! /GENERATE_VECTOR_LENGTH_METRIC=FALSE
-! /retain_no_data_values=false
+! /RETAIN_NO_DATA_VALUES=FALSE
 ;
-! subtract the minimum value from the maximum value.
+! Subtract the minimum value from the maximum value.
-! the metric created is the range of motion for the component of the joint angle selected.
+! The metric created is the range of motion for the component of the joint angle selected.
-evaluate_expression
+Evaluate_Expression
-/expression=metric::processed::right knee ang_max::x-metric::processed::right knee ang_min::x
+/EXPRESSION=METRIC::PROCESSED::Right Knee Ang_MAX::X-METRIC::PROCESSED::Right Knee Ang_MIN::X
-/result_type=metric
+/RESULT_TYPE=METRIC
-/result_name=right knee ang rom
+/RESULT_NAME=Right Knee Ang ROM
-! /result_folder=processed
+! /RESULT_FOLDER=PROCESSED
 ;
 </code>
-===== example 2: compute range of motion over all frames =====
+==== Example 2: Compute Range of Motion over all frames ====
-consider the right knee angle angle expressed as "right knee ang". compute the range of motion over all frames in the file. the result is named "right knee ang rom".
+Consider the right knee angle angle expressed as "Right Knee Ang". Compute the range of motion over all frames in the file. The result is named "Right Knee Ang ROM".
 <code>
-! find the maximum value of all 3 components
+! Find the maximum value of all 3 components
-metric_maximum
+Metric_Maximum
-/result_metric_name=_max
+/RESULT_METRIC_NAME=_MAX
-/apply_as_suffix_to_signal_name=true
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED
-/signal_names=right knee ang
+/SIGNAL_NAMES=Right Knee Ang
-! /signal_folder=original
+! /SIGNAL_FOLDER=ORIGINAL
-! /signal_components=all_components
+! /SIGNAL_COMPONENTS=ALL_COMPONENTS
-/event_sequence=
+/EVENT_SEQUENCE=
-/exclude_events=
+/EXCLUDE_EVENTS=
-/generate_mean_and_stddev=false
+/GENERATE_MEAN_AND_STDDEV=FALSE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
-! /create_global_maximum=false
+! /CREATE_GLOBAL_MAXIMUM=FALSE
 ;
-! find the minimum value of all 3 components
+! Find the minimum value of all 3 components
-metric_minimum
+Metric_Minimum
-/result_metric_name=_min
+/RESULT_METRIC_NAME=_MIN
-/apply_as_suffix_to_signal_name=true
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED
-/signal_names=right knee ang
+/SIGNAL_NAMES=Right Knee Ang
-! /signal_folder=original
+! /SIGNAL_FOLDER=ORIGINAL
-! /signal_components=all_components
+! /SIGNAL_COMPONENTS=ALL_COMPONENTS
-/event_sequence=
+/EVENT_SEQUENCE=
-/exclude_events=
+/EXCLUDE_EVENTS=
-/generate_mean_and_stddev=false
+/GENERATE_MEAN_AND_STDDEV=FALSE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
-! /create_global_minimum=false
+! /CREATE_GLOBAL_MINIMUM=FALSE
 ;
-! the range of motion can be estimated as the difference between max and min
+! The range of motion can be estimated as the difference between max and min
-! note: that this isn't quite true because angles are not vectors
+! Note: that this isn't quite true because angles are not vectors
-evaluate_expression
+Evaluate_Expression
-/expression=metric::processed::right knee ang_max-metric::processed::right knee ang_min
+/EXPRESSION=METRIC::PROCESSED::Right Knee Ang_MAX-METRIC::PROCESSED::Right Knee Ang_MIN
-/result_name=right knee ang rom
+/RESULT_NAME=Right Knee Ang ROM
-/result_type=metric
+/RESULT_TYPE=METRIC
-! /result_folder=processed
+! /RESULT_FOLDER=PROCESSED
 ;
 </code>
-===== example 3: computing the cumulative range of motion =====
+==== Example 3: Computing the cumulative range of motion ====
-one may want to calculate the cummulative amount of a certain movement occurring at a joint during a task. for example, consider hip flexion range of motion for 2 subjects:
+One may want to calculate the cummulative amount of a certain movement occurring at a joint during a task. For example, consider hip flexion range of motion for 2 subjects:
-  * subject 1 - reaches 40° of flexion from 0°
+  * Subject 1 - reaches 40° of flexion from 0°
-  * subject 2 - starts from 0° and reaches 20° then comes back to 15° and then reaches 40°
+  * Subject 2 - starts from 0° and reaches 20° then comes back to 15° and then reaches 40°
-the range is the same (40°) for both subjects but the amount of movement is different. subject 1 moves directly and his cumulative amount of movement is 40°. however, subject 2's movement is not direct and the cumulative amount of movement is 20 + 5 + 25 = 50°
+The range is the same (40°) for both subjects but the amount of movement is different. Subject 1 moves directly and his cumulative amount of movement is 40°. However, Subject 2's movement is not direct and the cumulative amount of movement is 20 + 5 + 25 = 50°
-the following set of pipeline commands will compute this cumulative range.
+The following set of pipeline commands will compute this cumulative range.
 <code>
-! compute the velocity of the signal (in this case rknee_angle)
+! Compute the velocity of the signal (in this case RKNEE_ANGLE)
-first_derivative
+First_Derivative
-/signal_types=link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED
-/signal_names=rknee_angle
+/SIGNAL_NAMES=RKNEE_ANGLE
-! /signal_folder=original
+! /SIGNAL_FOLDER=ORIGINAL
-/result_suffix=_vel
+/RESULT_SUFFIX=_VEL
-/result_folder=velocity
+/RESULT_FOLDER=VELOCITY
 ;
-! rectify the velocity
+! Rectify the velocity
-evaluate_expression
+Evaluate_Expression
-/expression=abs(link_model_based::velocity::rknee_angle_vel)
+/EXPRESSION=ABS(LINK_MODEL_BASED::VELOCITY::RKNEE_ANGLE_VEL)
-/result_name=rknee_angle_vel
+/RESULT_NAME=RKNEE_ANGLE_VEL
-/result_type=link_model_based
+/RESULT_TYPE=LINK_MODEL_BASED
-/result_folder=rectified_velocity
+/RESULT_FOLDER=RECTIFIED_VELOCITY
 ;
-! integrate the rectified velocity from start to stop
+! Integrate the rectified velocity from START to STOP
-metric_integrate
+Metric_Integrate
-/result_metric_name=range
+/RESULT_METRIC_NAME=RANGE
-! /apply_as_suffix_to_signal_name=false
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=link_model_based
+/SIGNAL_TYPES=LINK_MODEL_BASED
-/signal_names=rknee_angle_vel
+/SIGNAL_NAMES=RKNEE_ANGLE_VEL
-/signal_folder=rectified_velocity
+/SIGNAL_FOLDER=RECTIFIED_VELOCITY
-/signal_components=x
+/SIGNAL_COMPONENTS=X
-/event_sequence=start+stop
+/EVENT_SEQUENCE=START+STOP
-/exclude_events=
+/EXCLUDE_EVENTS=
-/generate_mean_and_stddev=false
+/GENERATE_MEAN_AND_STDDEV=FALSE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
 ;
 </code>