Differences

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

--- visual3d:documentation:pipeline:signal_commands:subtract_signals [2024/06/19 12:53] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:subtract_signals [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{subtract the components of the specified signals.
+====== Subtract Signals ======
-**note: signals must be at the same sampling rate. if your signals are a different rate, you can use the [[visual3d:documentation:pipeline:expressions:overview|evaluate_expression]] command, which determines an appropriate rate automatically.**
+Subtract the components of the specified signals.
-the command can be edited via text editor and dialog. the details on the dialog and command are found below:
+**Note: Signals must be at the same sampling rate. If your signals are a different rate, you can use the [[Visual3D:Documentation:Pipeline:Expressions:Expressions_Overview|Evaluate_Expression]] command, which determines an appropriate rate automatically.**
-|subtract_signals.png  |<code>\\ subtract_signals\\ /signal_types=the type of signal to be evaluated\\ /signal_names=the name of the signal to be evaluated\\ /signal_folder=the name of the signal folder\\ /result_folder= the name of the resulting folder\\ /result_names=the name of the resulting signal \\ /component_sequence= the component (x,y.z) of the signal to be used.\\ </code>  |
+The command can be edited via text editor and dialog. The details on the dialog and command are found below:
+|{{:Subtract_Signals.png}}  |<code>\\ Subtract_Signals\\ /Signal_Types=The type of signal to be evaluated\\ /Signal_Names=The name of the signal to be evaluated\\ /Signal_Folder=The name of the signal folder\\ /Result_Folder= The name of the resulting folder\\ /Result_Names=The name of the resulting signal \\ /COMPONENT_SEQUENCE= The component (X,Y.Z) of the signal to be used.\\ </code>  |
 ----
-===== examples =====
+==== Examples ====
-here you will find three examples:
+Here you will find three examples:
-==== example 1: subtract two target signals ====
+=== Example 1: Subtract two target signals ===
 <code>
 !***********************************
-! distance between heel markers
+! Distance between heel markers
 !***********************************
-subtract_signals
+Subtract_Signals
-/signal_types=target+target
+/SIGNAL_TYPES=TARGET+TARGET
-/signal_names=lhee+rhee
+/SIGNAL_NAMES=LHEE+RHEE
-/signal_folder=processed+processed
+/SIGNAL_FOLDER=PROCESSED+PROCESSED
-/result_name=heel_distance
+/RESULT_NAME=Heel_Distance
-! /result_folder=processed
+! /RESULT_FOLDER=PROCESSED
 ;
 </code>
-==== example 2: subtract a signal and a metric ====
+=== Example 2: Subtract a signal and a metric ===
 <code>
 !******************************************************
-! take the vertical grf, subtract the body weight, and divide the result by body mass to
+! Take the vertical GRF, subtract the body weight, and divide the result by body mass to
-! get the vertical com acceleration
+! get the vertical CoM acceleration
 !******************************************************
 </code>
 <code>
-! add the two signals from f1 and f2 - end result is grf for both plates
+! Add the two signals from F1 and F2 - end result is GRF for both plates
-add_signals
+Add_Signals
-/signal_types=force+force
+/SIGNAL_TYPES=FORCE+FORCE
-/signal_names=fp1+fp2
+/SIGNAL_NAMES=FP1+FP2
-/signal_folder=processed+processed
+/SIGNAL_FOLDER=PROCESSED+PROCESSED
-/result_name=grf
+/RESULT_NAME=GRF
-/result_folder=processed
+/RESULT_FOLDER=PROCESSED
 ;
-! subtract the body weight in n
+! Subtract the body weight in N
-subtract_signals
+Subtract_Signals
-/signal_types=derived+metric
+/SIGNAL_TYPES=DERIVED+METRIC
-/signal_folder=processed
+/SIGNAL_FOLDER=PROCESSED
-/signal_names=grf+mass_n
+/SIGNAL_NAMES=GRF+MASS_N
-/component_sequence=z, all
+/COMPONENT_SEQUENCE=Z, ALL
-/result_name=grf_r
+/RESULT_NAME=GRF_R
-! /result_folder=processed
+! /RESULT_FOLDER=PROCESSED
 ;
-! divide the result by body mass to get the vertical com acceleration
+! Divide the result by body mass to get the vertical CoM acceleration
-divide_signals
+Divide_Signals
-/signal_types=derived+metric
+/SIGNAL_TYPES=DERIVED+METRIC
-/signal_folder=processed
+/SIGNAL_FOLDER=PROCESSED
-/signal_names=grf_r+mass
+/SIGNAL_NAMES=GRF_R+MASS
-/component_sequence=all
+/COMPONENT_SEQUENCE=ALL
-/result_name=com_grf_z_accel
+/RESULT_NAME=COM_GRF_Z_ACCEL
-! /result_folder=processed
+! /RESULT_FOLDER=PROCESSED
 ;
 </code>
-==== example 3: subtract two metrics ====
+=== Example 3: Subtract two metrics ===
 <code>
 !******************************************************
-! subtract two metrics to calculate leg length
+! Subtract two metrics to calculate Leg length
 !******************************************************
-! mean for left medial ankle standing height
+! Mean for Left Medial Ankle Standing Height
-metric_mean
+Metric_Mean
-/result_metric_name=lmma_height
+/RESULT_METRIC_NAME=LMMA_Height
-! /apply_as_suffix_to_signal_name=false
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=target
+/SIGNAL_TYPES=TARGET
-/signal_names=l_mank
+/SIGNAL_NAMES=L_MANK
-/signal_folder=processed
+/SIGNAL_FOLDER=PROCESSED
-/signal_components=z
+/SIGNAL_COMPONENTS=Z
-/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
 ;
-! mean for right medial ankle standing height
+! Mean for Right Medial Ankle Standing Height
-metric_mean
+Metric_Mean
-/result_metric_name=rmma_height
+/RESULT_METRIC_NAME=RMMA_Height
-! /apply_as_suffix_to_signal_name=false
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=target
+/SIGNAL_TYPES=TARGET
-/signal_names=r_mank
+/SIGNAL_NAMES=R_MANK
-/signal_folder=processed
+/SIGNAL_FOLDER=PROCESSED
-/signal_components=z
+/SIGNAL_COMPONENTS=Z
-/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
 ;
-! left leg length - distance between lasis and lmma heights
+! Left Leg Length - Distance between LASIS and LMMA heights
-subtract_signals
+Subtract_Signals
-/signal_types=metric+metric
+/SIGNAL_TYPES=METRIC+METRIC
-/signal_names=lasis_height+lmma_height
+/SIGNAL_NAMES=LASIS_Height+LMMA_Height
-/signal_folder=processed+processed
+/SIGNAL_FOLDER=PROCESSED+PROCESSED
-/result_name=left_leg_length
+/RESULT_NAME=Left_Leg_Length
-! /result_folder=processed
+! /RESULT_FOLDER=PROCESSED
 ;
 </code>
-}}