Differences

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

--- visual3d:documentation:pipeline:force_commands:fp_zero [2024/06/19 12:50] – sgranger
+++ visual3d:documentation:pipeline:force_commands:fp_zero [2024/07/17 15:45] (current) – created sgranger
@@ Line 1: / Line 1: @@
-this page is about the c3d parameter force_platform:zero. for visual3d's ability to track different baseline frames for different force platforms see [[visual3d:documentation:pipeline:force_commands:fp_zeros|fp_zeros]].
+====== FP ZERO ======
-the force_platform:zero c3d parameter defines the range of frames used to calculate an average baseline value for each analog signal that is then subtracted from every frame. this does not affect the analog signals (as seen in the data tree), this processing takes place when the force platform signals are computed.
+This page is about the C3D Parameter FORCE_PLATFORM:ZERO. For Visual3D's ability to track different baseline frames for different force platforms see [[Visual3D:Documentation:Pipeline:Force_Commands:FP_ZEROS|FP_ZEROS]].
-note that most of the manufacturers arbitrarily set the range to be the first 10 frames of the trial. if the force platform is loaded during these first 10 frames, the ground reaction force signals will be incorrect; in this case the user should either set the frames to 0,0 so that no baseline is subtracted, or should select frames in which the force platform is unloaded.
+The FORCE_PLATFORM:ZERO C3D parameter defines the range of frames used to calculate an average baseline value for each ANALOG signal that is then subtracted from every frame. This does not affect the ANALOG signals (as seen in the data tree), this processing takes place when the Force Platform signals are computed.
+Note that most of the manufacturers arbitrarily set the range to be the first 10 frames of the trial. If the force platform is loaded during these first 10 frames, the ground reaction force signals will be incorrect; in this case the user should either set the frames to 0,0 so that no baseline is subtracted, or should select frames in which the force platform is unloaded.
 \\
-===== exceptions =====
+==== Exceptions ====
-in some cases it is not feasible to use the zero parameter to define a baseline for each signal. all force platform signals have some drift in the amplifiers, so it isn't a good idea to simply set the zero parameter to 0,0 so that no baseline is subtracted. the following two examples demonstrate alternatives to using the zero parameter to remove a baseline.
+In some cases it is not feasible to use the ZERO parameter to define a BASELINE for each signal. All force platform signals have some drift in the amplifiers, so it isn't a good idea to simply set the ZERO parameter to 0,0 so that no baseline is subtracted. The following two examples demonstrate alternatives to using the ZERO parameter to remove a baseline.
-in all 3 examples the zero parameter should be set to 0,0 so that no inadvertent baseline is removed.
+In all 3 examples the ZERO parameter should be set to 0,0 so that no inadvertent baseline is removed.
-==== example 1 ====
+=== Example 1 ===
-. subtracting the mean value from several ranges from each analog signal
+. Subtracting the mean value from several ranges from each analog signal
-consider a subject running on an instrumented treadmill. the mean value of each analog signal is determined when the subject is airborne (e.g. between lto and rhs) and a collection of these airborne phases are averaged. this overall mean value is to be subtracted from each analog signal. the option to use processed analog signals for the force platform calculations should be selected. the force_platform:zero parameter is set to (0,0) because it is to be ignored.
+Consider a subject running on an instrumented treadmill. The mean value of each ANALOG signal is determined when the subject is airborne (e.g. between LTO and RHS) and a collection of these airborne phases are averaged. This overall mean value is to be subtracted from each ANALOG signal. The option to use Processed Analog signals for the Force Platform calculations should be selected. The FORCE_PLATFORM:ZERO parameter is set to (0,0) because it is to be ignored.
-given 12 analog signals associated with a type 6 force platform:
+Given 12 ANALOG signals associated with a type 6 Force Platform:
-fx1,fy1,fz1,fx2,fy2,fz2,fx3,fy3,fz3,fx4,fy4,fz4
+FX1,FY1,FZ1,FX2,FY2,FZ2,FX3,FY3,FZ3,FX4,FY4,FZ4
-**for_each**
+**For_Each**
-/iteration_parameter_name= signal_index
+/Iteration_Parameter_Name= SIGNAL_INDEX
-/items= fx+fy+fz
+/Items= FX+FY+FZ
 **;**
-**for_each**
+**For_Each**
-/iteration_parameter_name= number
+/Iteration_Parameter_Name= NUMBER
-/items= 1+2+3+4
+/Items= 1+2+3+4
 **;**
-! compute the mean value of the airborne phases.
+! Compute the mean value of the airborne phases.
-**metric_mean**
+**Metric_Mean**
-/signal_types= analog
+/Signal_types= ANALOG
-/signal_names= ::signal_index&::number
+/Signal_Names= ::SIGNAL_INDEX&::NUMBER
-/signal_folder= original
+/Signal_Folder= ORIGINAL
-/signal_components= all_components
+/Signal_Components= ALL_COMPONENTS
-/event_sequence= lto+rhs
+/Event_Sequence= LTO+RHS
-/exclude_events=
+/Exclude_Events=
-/metric_name= _
+/Metric_Name= _
-/apply_as_suffix_to_signal_name= true
+/Apply_As_Suffix_To_Signal_Name= TRUE
-/generate_mean_and_stdev= true
+/Generate_Mean_And_STDEV= TRUE
-/append_to_existing_values= false
+/Append_To_Existing_Values= FALSE
 **;**
-**multiply_signals_by_constant**
+**Multiply_Signals_By_Constant**
-/signal_types= metric
+/Signal_types= METRIC
-/signal_names= ::signal_index&::number&%%__%%mean
+/Signal_Names= ::SIGNAL_INDEX&::NUMBER&%%__%%MEAN
-/signal_folder= processed
+/Signal_Folder= PROCESSED
-/result_names= offset
+/Result_Names= OFFSET
-/result_suffix=
+/Result_Suffix=
-/signal_components=
+/Signal_Components=
-/constant= -1
+/Constant= -1
 **;**
-**set_pipeline_parameter_to_data**
+**Set_Pipeline_Parameter_To_Data**
-/parameter_name= baseline
+/Parameter_Name= BASELINE
-/signal_types= metric
+/Signal_types= METRIC
-/signal_names= offset
+/Signal_Names= OFFSET
-/signal_folder= processed
+/Signal_Folder= PROCESSED
 **;**
-! **note** the following command creates an analog processed signal, not a derived processed signal.
+! **NOTE** The following command creates an ANALOG PROCESSED signal, not a DERIVED PROCESSED signal.
-**add_constant_to_signals**
+**Add_Constant_To_Signals**
-/signal_types= analog
+/Signal_types= ANALOG
-/signal_names= ::signal_index&::number
+/Signal_Names= ::SIGNAL_INDEX&::NUMBER
-/signal_folder= original
+/Signal_Folder= ORIGINAL
-/result_names=
+/Result_Names=
-/result_suffix=
+/Result_Suffix=
-/signal_components=
+/Signal_Components=
-/constant= ::baseline
+/Constant= ::BASELINE
 **;**
-**end_for_each**
+**End_For_Each**
-/iteration_parameter_name= number
+/Iteration_Parameter_Name= NUMBER
 **;**
-**end_for_each**
+**End_For_Each**
-/iteration_parameter_name= signal_index
+/Iteration_Parameter_Name= SIGNAL_INDEX
 **;**
-==== example 2 ====
+=== Example 2 ===
-subtracting the mean value from several ranges from each analog signal
+Subtracting the mean value from several ranges from each analog signal
-consider a subject running on an instrumented treadmill. the mean value of each analog signal is determined when the subject is airborne (e.g. between lto and rhs) and a collection of these airborne phases are averaged. this overall mean value is to be subtracted from each analog signal. the option to use processed analog signals for the force platform calculations should be selected. the force_platform:zero parameter is set to (0,0) because it is to be ignored.
+Consider a subject running on an instrumented treadmill. The mean value of each ANALOG signal is determined when the subject is airborne (e.g. between LTO and RHS) and a collection of these airborne phases are averaged. This overall mean value is to be subtracted from each ANALOG signal. The option to use Processed Analog signals for the Force Platform calculations should be selected. The FORCE_PLATFORM:ZERO parameter is set to (0,0) because it is to be ignored.
-given 12 analog signals associated with a type 6 force platform:
+Given 12 ANALOG signals associated with a type 6 Force Platform:
-fx1,fy1,fz1,fx2,fy2,fz2,fx3,fy3,fz3,fx4,fy4,fz4
+FX1,FY1,FZ1,FX2,FY2,FZ2,FX3,FY3,FZ3,FX4,FY4,FZ4
-! compute the mean values for all analog signals.
+! Compute the mean values for all ANALOG signals.
-**metric_mean**
+**Metric_Mean**
-/result_metric_name=_base
+/RESULT_METRIC_NAME=_BASE
-/apply_as_suffix_to_signal_name=true
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=analog
+/SIGNAL_TYPES=ANALOG
-! /signal_names=
+! /SIGNAL_NAMES=
-! /signal_folder=original
+! /SIGNAL_FOLDER=ORIGINAL
-! /signal_components=all_components
+! /SIGNAL_COMPONENTS=ALL_COMPONENTS
-/event_sequence=loff+ron
+/EVENT_SEQUENCE=LOFF+RON
-/exclude_events=
+/EXCLUDE_EVENTS=
-! /generate_mean_and_stddev=true
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
 **;**
-! setup a for each loop over the analog signals
+! Setup a for each loop over the ANALOG signals
-**for_each**
+**For_Each**
-/iteration_parameter_name=signal_index
+/ITERATION_PARAMETER_NAME=SIGNAL_INDEX
-/items=f1x1+f1y1+f1z1+f1x2+f1y2+f1z2+f1x3+f1y3+f1z3+f1x4+f1y4+f1z4
+/ITEMS=F1X1+F1Y1+F1Z1+F1X2+F1Y2+F1Z2+F1X3+F1Y3+F1Z3+F1X4+F1Y4+F1Z4
 **;**
-! subtract the mean value from each signal. this step is a little quirky because i chose to use the evaluate_expression to perform this task. unfortunately the (::) identified gets confused when four colons (e.g. ::::) are used in sequence. this forced me to define global parameters. this isn't actually a terrible thing because it was helpful when i was debugging the pipeline.
+! Subtract the mean value from each signal. This step is a little quirky because I chose to use the evaluate_expression to perform this task. Unfortunately the (::) identified gets confused when four colons (e.g. ::::) are used in sequence. This forced me to define Global Parameters. This isn't actually a terrible thing because it was helpful when I was debugging the pipeline.
-**set_pipeline_parameter**
+**Set_Pipeline_Parameter**
-/parameter_name=temp
+/PARAMETER_NAME=TEMP
-/parameter_value=analog::original::&::signal_index
+/PARAMETER_VALUE=ANALOG::ORIGINAL::&::SIGNAL_INDEX
 **;**
-**set_pipeline_parameter**
+**Set_Pipeline_Parameter**
-/parameter_name=base
+/PARAMETER_NAME=BASE
-/parameter_value=metric::processed::&::signal_index&_base_mean
+/PARAMETER_VALUE=METRIC::PROCESSED::&::SIGNAL_INDEX&_BASE_MEAN
 **;**
-**set_pipeline_parameter**
+**Set_Pipeline_Parameter**
-/parameter_name=expression
+/PARAMETER_NAME=EXPRESSION
-/parameter_value=::temp&-&::base
+/PARAMETER_VALUE=::TEMP&-&::BASE
 **;**
-! now we can evaluate the expression. note: that in version 3.69 (the time of writing this topic) the evaluate_expression command was quite slow because of the method used for parsing the expression.
+! Now we can evaluate the expression. Note: That in Version 3.69 (the time of writing this topic) the evaluate_expression command was quite slow because of the method used for parsing the expression.
-**evaluate_expression**
+**Evaluate_Expression**
-/expression=::expression
+/EXPRESSION=::EXPRESSION
-/result_name=::signal_index
+/RESULT_NAME=::SIGNAL_INDEX
-/result_type=analog
+/RESULT_TYPE=ANALOG
-/result_folder=processed
+/RESULT_FOLDER=PROCESSED
 **;**
-**end_for_each**
+**End_For_Each**
-/iteration_parameter_name=signal_index
+/ITERATION_PARAMETER_NAME=SIGNAL_INDEX
 **;**
-==== example 3 ====
+=== Example 3 ===
-computing mean values for the force platform analog signals in one trial, and then use these values in other trials
+Computing mean values for the force platform analog signals in one trial, and then use these values in other trials
-for this example assume that:
+For this example assume that:
-  - one of the files has tag=walk.
+  - one of the files has TAG=walk.
-  - there are two amti force platforms
+  - there are two AMTI force platforms
   - the force platforms are unloaded for the first 50 frames
-! create events to identify frame 1 and frame 50 in the file with tag=walk
+! Create events to identify Frame 1 and Frame 50 in the file with TAG=walk
-**select_active_file**
+**Select_Active_File**
-/file_name=walk
+/FILE_NAME=walk
-! /query=
+! /QUERY=
 **;**
-**explicit**
+**Explicit**
-/event_name=frame1
+/EVENT_NAME=FRAME1
-/frame=1
+/FRAME=1
 **;**
-**explicit**
+**Explicit**
-/event_name=frame50
+/EVENT_NAME=FRAME50
-/frame=50
+/FRAME=50
 **;**
-! compute the mean value of the force platform analog signals
+! Compute the mean value of the force platform ANALOG signals
-**metric_mean**
+**Metric_Mean**
-/result_metric_name=_
+/RESULT_METRIC_NAME=_
-/apply_as_suffix_to_signal_name=true
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
-! /result_metric_folder=processed
+! /RESULT_METRIC_FOLDER=PROCESSED
-/signal_types=analog+analog+analog+analog+analog+analog+analog+analog+analog+analog+analog+analog
+/SIGNAL_TYPES=ANALOG+ANALOG+ANALOG+ANALOG+ANALOG+ANALOG+ANALOG+ANALOG+ANALOG+ANALOG+ANALOG+ANALOG
-/signal_names=f1x+f1y+f1z+f2x+f2y+f2z+m1x+m1y+m1z+m2x+m2y+m2z
+/SIGNAL_NAMES=F1X+F1Y+F1Z+F2X+F2Y+F2Z+M1X+M1Y+M1Z+M2X+M2Y+M2Z
-/signal_folder=original+original+original+original+original+original+original+original+original+original+original+original
+/SIGNAL_FOLDER=ORIGINAL+ORIGINAL+ORIGINAL+ORIGINAL+ORIGINAL+ORIGINAL+ORIGINAL+ORIGINAL+ORIGINAL+ORIGINAL+ORIGINAL+ORIGINAL
-/signal_components=x
+/SIGNAL_COMPONENTS=X
-/event_sequence=frame1+frame50
+/EVENT_SEQUENCE=FRAME1+FRAME50
-/exclude_events=
+/EXCLUDE_EVENTS=
-! /generate_mean_and_stddev=true
+! /GENERATE_MEAN_AND_STDDEV=TRUE
-! /append_to_existing_values=false
+! /APPEND_TO_EXISTING_VALUES=FALSE
 **;**
-! construct a for_each loop to process each analog signal independently
+! Construct a For_Each loop to process each ANALOG signal independently
-**for_each**
+**For_Each**
-/iteration_parameter_name=sig
+/ITERATION_PARAMETER_NAME=SIG
-/items=f1x+f1y+f1z+m1x+m1y+m1z+f2x+f2y+f2z+m2x+m2y+m2z
+/ITEMS=F1X+F1Y+F1Z+M1X+M1Y+M1Z+F2X+F2Y+F2Z+M2X+M2Y+M2Z
 **;**
-! set the active folder to global and create a pipeline parameter for appropriate mean signal
+! Set the active folder to GLOBAL and create a pipeline parameter for appropriate MEAN signal
-**select_active_file**
+**Select_Active_File**
-/file_name=global
+/FILE_NAME=GLOBAL
-! /query=
+! /QUERY=
 **;**
-**set_pipeline_parameter_to_data_value**
+**Set_Pipeline_Parameter_To_Data_Value**
-/parameter_name=temp
+/PARAMETER_NAME=TEMP
-/signal_types=metric
+/SIGNAL_TYPES=METRIC
-/signal_names=::sig&%%__%%mean
+/SIGNAL_NAMES=::SIG&%%__%%MEAN
-/signal_folder=processed
+/SIGNAL_FOLDER=PROCESSED
-! /index=
+! /INDEX=
 **;**
-! define a pipeline parameter to create the expression that we will evaluate in the next step. this is a little awkward but necessary because if we tried to use the evaluation expression with pipeline parameters it get's confused (maybe someday we will find a solution to this problem).
+! Define a pipeline parameter to create the expression that we will evaluate in the next step. This is a little awkward but necessary because if we tried to use the evaluation expression with pipeline parameters it get's confused (maybe someday we will find a solution to this problem).
-**set_pipeline_parameter**
+**Set_Pipeline_Parameter**
-/parameter_name=equation
+/PARAMETER_NAME=EQUATION
-/parameter_value=analog::original::&::sig&-&::temp
+/PARAMETER_VALUE=ANALOG::ORIGINAL::&::SIG&-&::TEMP
-! /parameter_value_search_for=
+! /PARAMETER_VALUE_SEARCH_FOR=
-! /parameter_value_replace_with=
+! /PARAMETER_VALUE_REPLACE_WITH=
-! /parameter_value_append=
+! /PARAMETER_VALUE_APPEND=
 **;**
-! make all of the files in the workspace active and subtract the global mean values from the signals.
+! Make all of the files in the Workspace active and subtract the GLOBAL mean values from the signals.
-**select_active_file**
+**Select_Active_File**
-/file_name=all_files
+/FILE_NAME=ALL_FILES
-! /query=
+! /QUERY=
 **;**
-**evaluate_expression**
+**Evaluate_Expression**
-/expression=::equation
+/EXPRESSION=::EQUATION
-/result_name=::sig
+/RESULT_NAME=::SIG
-/result_type=analog
+/RESULT_TYPE=ANALOG
-! /result_folder=processed
+! /RESULT_FOLDER=PROCESSED
 **;**
-! for example, the first time through the loop /expression= analog::original::f1x - ::sig%%__%%mean
+! For example, the first time through the loop /EXPRESSION= ANALOG::ORIGINAL::F1X - ::SIG%%__%%MEAN
-**end_for_each**
+**End_For_Each**
-/iteration_parameter_name=sig
+/ITERATION_PARAMETER_NAME=SIG
 **;**