Differences

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

--- visual3d:documentation:pipeline:force_commands:fp_auto_baseline [2024/06/19 12:50] – sgranger
+++ visual3d:documentation:pipeline:force_commands:fp_auto_baseline [2024/11/15 16:36] (current) – sgranger
@@ Line 1: / Line 1: @@
-{{===== introduction =====
+====== FP Auto Baseline ======
+==== Introduction ====
 \\
-setting the [[https://www.c-motion.com/v3dwiki/index.php/fp_zero|force platform zero]] parameters for instrumented treadmills can be quite challenging because the unloaded frames aren't readily identified automatically, and one would prefer to use all of the unloaded frames for determining the zero range.\\
+Setting the [[visual3d:documentation:pipeline:force_commands:fp_zero]] parameters for Instrumented Treadmills can be quite challenging because the unloaded frames aren't readily identified automatically, and one would prefer to use all of the unloaded frames for determining the zero range.\\
 \\
-**for visual3d version 6 we have introduced a new pipeline command:**\\
+**For Visual3D Version 6 we have introduced a new pipeline command:**\\
 \\
-|<code>\\ fp_auto_baseline\\ ! /fp_number=\\ ! /auto_zero=true\\ ! /auto_fp_minimum=true\\ ! /use_reduced_fp_minimum_around_force=true\\ ! /reduced_fp_minimum=5.0\\ ;\\ </code>  |fp_auto_baseline1.png  |
+|<code>FP_Auto_Baseline
+ ! /FP_NUMBER=
+ ! /AUTO_ZERO=TRUE
+ ! /AUTO_FP_MINIMUM=TRUE
+ ! /USE_REDUCED_FP_MINIMUM_AROUND_FORCE=TRUE
+ ! /REDUCED_FP_MINIMUM=5.0
+ ; </code> |{{:FP_Auto_Baseline1.png}}  |
-===== background =====
+==== Background ====
-this command does three things:
+This command does three things:
-  - zeros the force signal without having to specify a [[visual3d:tutorials:kinematics_and_kinetics:force_platforms#compute_baselines|frame range]] (auto_zero)
+  - Zeros the force signal without having to specify a [[Visual3D:Tutorials:Kinematics_and_Kinetics:Force_Platforms#Compute_Baselines|frame range]] (AUTO_ZERO)
-  - defines the [[visual3d:documentation:kinematics_and_kinetics:external_forces:force_platforms#minimum_force|minimum force platform value]] based on the noise in the signal (auto_fp_minimum)
+  - Defines the [[Visual3D:Documentation:Kinematics_and_Kinetics:External_Forces:Force_Platforms#Minimum_Force|minimum force platform value]] based on the noise in the signal (AUTO_FP_MINIMUM)
-  - looks at the before/after the signal loaded - and finds when the signal crosses the reduced fp minimum to ensure as much of the signal is used as possible (use_reduced_fp_minimum_around_force)
+  - Looks at the before/after the signal loaded - and finds when the signal crosses the reduced FP minimum to ensure as much of the signal is used as possible (USE_REDUCED_FP_MINIMUM_AROUND_FORCE)
-the [[visual3d:documentation:kinematics_and_kinetics:external_forces:force_platforms#minimum_force|minimum force platform value]] is determined by identifying the values of the plate during all the periods where the plate is unloaded. each force component is used to determine the set of frames containing median values for each component, and a single representative minimum force frame is determined from these values.\\
+The [[Visual3D:Documentation:Kinematics_and_Kinetics:External_Forces:Force_Platforms#Minimum_Force|minimum force platform value]] is determined by identifying the values of the plate during all the periods where the plate is unloaded. Each force component is used to determine the set of frames containing median values for each component, and a single representative minimum force frame is determined from these values.\\
-===== parameters =====
+==== Parameters ====
-==== fp number ====
+=== FP Number ===
 \\
-**fp_number=** an empty parameter will work on all plates in the c3d file. or you can specify individual plate numbers, separated by a plus sign (ex. /fp_number=1+3).\\
+**FP_NUMBER=** An empty parameter will work on all plates in the C3D file. Or you can specify individual plate numbers, separated by a plus sign (ex. /FP_NUMBER=1+3).\\
 \\
-==== auto zero ====
+=== Auto Zero ===
 \\
-**auto_zero=** this parameter is used to zero the signal. the value of the zero baseline is stored in the c3d parameter force_platform::baselines\\
+**AUTO_ZERO=** This parameter is used to zero the signal. The value of the zero baseline is stored in the C3D parameter FORCE_PLATFORM::BASELINES\\
 \\
-this parameter would be used in place of the [[visual3d:tutorials:kinematics_and_kinetics:force_platforms#compute_baselines|baseline parameter]] in the force platform parameters.\\
+This parameter would be used in place of the [[Visual3D:Tutorials:Kinematics_and_Kinetics:Force_Platforms#Compute_Baselines|baseline parameter]] in the force platform parameters.\\
 \\
-==== auto fp minimum ====
+=== Auto FP Minimum ===
 \\
-**auto_fp_minimum=** visual3d determines the [[visual3d:documentation:kinematics_and_kinetics:external_forces:force_platforms#minimum_force|minimum force platform value]] by finding when the platform is unloaded and the maximum noise value is found. this ensures the minimum value is used, and less data is lost compared to setting an arbitrary [[visual3d:documentation:kinematics_and_kinetics:external_forces:force_platforms#minimum_force|minimum force platform value]].\\
+**AUTO_FP_MINIMUM=** Visual3D determines the [[Visual3D:Documentation:Kinematics_and_Kinetics:External_Forces:Force_Platforms#Minimum_Force|minimum force platform value]] by finding when the platform is unloaded and the maximum noise value is found. This ensures the minimum value is used, and less data is lost compared to setting an arbitrary [[Visual3D:Documentation:Kinematics_and_Kinetics:External_Forces:Force_Platforms#Minimum_Force|minimum force platform value]].\\
 \\
-to see what value is picked, after running the command, select an individual c3d file, and go to force-> modify minimum force platform value. the "current minimum" will reflect the value found by the command.\\
+To see what value is picked, after running the command, select an individual C3D file, and go to Force-> Modify Minimum Force Platform Value. The "Current Minimum" will reflect the value found by the command.\\
 \\
-==== reduced fp minimum around force ====
+=== Reduced FP Minimum Around Force ===
 \\
-**use_reduced_fp_minimum_around_force=** visual3d determines when the force platform is loaded, and finds when the signal drops below the specified minimum value (reduced_fp_minimum).\\
+**USE_REDUCED_FP_MINIMUM_AROUND_FORCE=** Visual3D determines when the force platform is loaded, and finds when the signal drops below the specified minimum value (REDUCED_FP_MINIMUM).\\
 \\
-**reduced_fp_minimum =** used when use_reduced_fp_minimum_around_force parameter is set to true\\
+**REDUCED_FP_MINIMUM =** Used when USE_REDUCED_FP_MINIMUM_AROUND_FORCE parameter is set to TRUE\\
 \\
-**why is this parameter so important?** when there are two platforms in the treadmill there may be times when one foot is on two platforms (the other foot is not). the transitions from one foot on one platform to two platforms (or vice-versa) often causes an artifact (sudden change) in the force signal that is about the magnitude of the minimum force threshold. this artifact is most commonly seen with a front to back treadmill than a side to side. this parameter is used to resolve this discontinuity by using an alternate minimum force surrounding known contiguous force intervals to include relevant force readings that may be below the noise threshold, but still rising or lowering from the reduced_fp_minimum value. this avoids the fp minimum value discontinuity when fp transitions occur and combines the two signals into one force and cop signal, then reapplies the force minimum threshold.\\
+**Why is this parameter so important?**
+When there are two platforms in the treadmill there may be times when one foot is on two platforms (the other foot is not). The transitions from one foot on one platform to two platforms (or vice-versa) often causes an artifact (sudden change) in the force signal that is about the magnitude of the minimum force threshold. This artifact is most commonly seen with a front to back treadmill than a side to side. This parameter is used to resolve this discontinuity by using an alternate minimum force surrounding known contiguous force intervals to include relevant force readings that may be below the noise threshold, but still rising or lowering from the REDUCED_FP_MINIMUM value. This avoids the FP Minimum value discontinuity when FP transitions occur and combines the two signals into one force and cop signal, then reapplies the force minimum threshold.\\
 \\
-}}