Differences

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

--- visual3d:documentation:pipeline:signal_commands:indefinite_integral [2024/07/17 15:46] – created 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: @@
 ====== Indefinite Integral ======
-===== Introduction =====
+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]].
-Compute an indefinite integral from the start event to the stop event.
+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>
-This is a cumulative integral, starting from an initial value (and a start event). Each frame is computed from the previous frame as follows:
+integral (t) = integral (t-1) + ((s(t)+s(t-1))* T / 2)
+</code>
-integral (t) = integral (t-1) + x(t) * dt
-\\
-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 )
 where T = time between frames (this is the data rate)
-The [[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_Integrate|Metric_Integrate]] command will return the integral as a metric.
 ===== Command =====
@@ Line 20: / Line 14: @@
 The command can be edited via text editor. The details on the command are found below:
-|  |<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>  |
+<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>
-Result_Types are restricted by the Signal_Types
+==== Notes ====
-If the Signal_Types= TARGET, the result type can only be TARGET, DERIVED, or METRIC
+The [[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_Integrate|Metric_Integrate]] command will return the integral as a metric.
-The Initial_Value is a signal expression that can return multiple components.
-The same Initial_Value expression is used for all signals.
+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]].
-----
+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.
 ==== Examples ====
@@ Line 93: / Line 100: @@
 ==== 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>