Differences

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

--- visual3d:documentation:pipeline:signal_commands:indefinite_integral [2024/06/19 12:53] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:indefinite_integral [2024/09/09 20:09] (current) – Cleaned up the page and began applying the pipeline page format. wikisysop
@@ Line 1: / Line 1: @@
-====== introduction ======
+====== Indefinite Integral ======
-compute an indefinite integral from the start event to the stop event.
+This pipeline command computes an indefinite integral from the start event to the stop event. This is a cumulative integral, with the value of each frame indicating the cumulative sum from the start event's initial value. This cumulative sum process uses the [[http://en.wikipedia.org/wiki/Trapezoidal_rule|trapezoidal rule]].
-this is a cumulative integral, starting from an initial value (and a start event). each frame is computed from the previous frame as follows:
+For a given signal, s, the value of its integral at a given frame at time t is computed from the previous frame, at time t-1, as follows:
+<code>
+integral (t) = integral (t-1) + ((s(t)+s(t-1))* T / 2)
+</code>
-integral (t) = integral (t-1) + x(t) * dt
+where T = time between frames (this is the data rate)
-\\
-the command integrates a signal using the [[http://en.wikipedia.org/wiki/trapezoidal_rule|trapezoidal rule]].
-the integral between two frames += ( (valueatframe1+valueatframe2)*deltat / 2 )
+===== Command =====
-where t = time between frames (this is the data rate)
+The command can be edited via text editor. The details on the command are found below:
-the [[visual3d:documentation:pipeline:metric_commands:metric_integrate|metric_integrate]] command will return the integral as a metric.
-====== command ======
+<code>
+Indefinite_Integral
+/Signal_Types=The type of signal to be evaluated
+/Signal_Folder=The name of the signal folder
+/Signal_Names=The name of the signal to be evaluated
+/Result_Types=The type of signal to be evaluated
+/Result_Folder= The name of the resulting folder
+/Result_Names= The names of the resulting signal. If left blank the same number is used
+/Apply_As_Suffix_To_Signal_Name=The result is given the same name as the original signal with the suffix added
+/Event_Sequence= The event sequence
+/Exclude_Events= The exclude events
+/Event_Instance= The instance of the event sequence
+/Initial_Value= The value of the integral at the start event
+;
+</code>
-the command can be edited via text editor. the details on the command are found below:
+==== Notes ====
-|  |<code>\\ indefinite_integral\\ /signal_types=the type of signal to be evaluated\\ /signal_folder=the name of the signal folder\\ /signal_names=the name of the signal to be evaluated\\ /result_types=the type of signal to be evaluated\\ /result_folder= the name of the resulting folder \\ /result_names= the names of the resulting signal. if left blank the same number is used \\ /apply_as_suffix_to_signal_name= the result is given the same name as the original signal with the suffix added\\ /event_sequence= the event sequence\\ /exclude_events= the exclude events\\ /event_instance= the instance of the event sequence\\ /initial_value= the value of the integral at the start event\\ ;\\ </code>  |
+The [[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_Integrate|Metric_Integrate]] command will return the integral as a metric.
-result_types are restricted by the signal_types
+Valid Result_Types are restricted according to the Signal_Types that are input into the command. If the Signal_Types are from the [[visual3d:documentation:c3d_signal_types:target_data_type|TARGET]] data type, then the result type can only be [[visual3d:documentation:c3d_signal_types:target_data_type|TARGET]], [[visual3d:documentation:visual3d_signal_types:derived_data_type|DERIVED]], or [[visual3d:documentation:visual3d_signal_types:metric_data_type|METRIC]].
-if the signal_types= target, the result type can only be target, derived, or metric
+The Initial_Value parameter, if used, must be a signal expression that can return multiple components. The same Initial_Value expression is used for all signals.
-the initial_value is a signal expression that can return multiple components.
-the same initial_value expression is used for all signals.
+==== Examples ====
-----
+This example calculates the velocity of the center of mass from force platform data during a vertical jump using the **Indefinite_Integral** command. Constants of integration (initial value) must be determined. In this case, the initial value is the initial velocity at the start of the preparation for the jump which is zero.
-===== examples =====
+**Note:** This is only an example and you should check the constants of integration for your analysis.
-this example calculates the velocity of the center of mass from force platform data during a vertical jump using the **indefinite_integral** command. constants of integration (initial value) must be determined. in this case, the initial value is the initial velocity at the start of the preparation for the jump which is zero.
-**note:** this is only an example and you should check the constants of integration for your analysis.
 <code>
 !************************************************************************
-! take the vertical grf, subtract the body weight, and divide the
+! Take the vertical GRF, subtract the body weight, and divide the
-! result by body mass to get the vertical com acceleration
+! result by body mass to get the vertical CoM acceleration
 !************************************************************************
-! 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 - metric is mass_n
+! Subtract the body weight in N - Metric is MASS_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
 ;
 </code>
 <code>
-! 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
 ;
 !************************************************************
-! integrate the vertical com acceleration over time to get the
+! Integrate the vertical CoM acceleration over time to get the
-! change in vertical com velocity. initial value is zero
+! change in vertical CoM velocity. Initial value is zero
 !***********************************************************
-indefinite_integral
+Indefinite_Integral
-/signal_types=derived
+/SIGNAL_TYPES=DERIVED
-/signal_names=com_grf_z_accel
+/SIGNAL_NAMES=COM_GRF_Z_ACCEL
-/signal_folder=processed
+/SIGNAL_FOLDER=PROCESSED
-/result_suffix=_vel
+/RESULT_SUFFIX=_VEL
-! /result_folder=processed
+! /RESULT_FOLDER=PROCESSED
-! /start_at_event=
+! /START_AT_EVENT=
-! /end_at_event=
+! /END_AT_EVENT=
-! /initial_value=0
+! /INITIAL_VALUE=0
 ;
 </code>
-===== legacy parameters =====
+==== Legacy Parameters ====
-|  |<code>\\ indefinite_integral\\ /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_suffix= the result is given the same name as the original signal with the suffix added\\ /start_at_event= the event at the beginning of the range\\ /end_at_event= the event at the end of the range\\ /initial_value= the value of the integral at the start event\\ </code>  |
+Earlier versions of Visual3D accepted the following parameters for this command. These parameters are no longer supported.
+<code>
+Indefinite_Integral
+/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_Suffix= The result is given the same name as the original signal with the suffix added
+/Start_At_Event= The event at the beginning of the range
+/End_At_Event= The event at the end of the range
+/Initial_Value= The value of the integral at the start event
+</code>