Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_integrate [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_integrate [2025/09/18 18:06] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{====== introduction ======
+====== Metric Integrate ======
-integrate a signal between events using the trapezoidal rule.
+=====Overview=====
-http://en.wikipedia.org/wiki/trapezoidal_rule
+The command **Metric Integrate** is used to integrate a signal between events using the trapezoidal rule.
-the integral between two frames += ( (valueatframe1+valueatframe2)*deltat / 2 )
+http://en.wikipedia.org/wiki/Trapezoidal_rule
-where t= time between frames
+The integral between two frames += ( (ValueAtFrame1+ValueAtFrame2)*DeltaT / 2 )
-====== command ======
-metric_integrate = sum of the integral for all frames in the range.\\
+where T= time between frames
-\\
+This command can be useful when it is necessary to compute a value, like displacement or work, for which integration is needed.
-|<code>\\ metric_integrate\\ /result_metric_name=\\ /apply_as_suffix_to_signal_name=false\\ ! /result_metric_folder=processed\\ /signal_types=\\ ! /signal_names=\\ /signal_folder=\\ ! /signal_components=all_components\\ /event_sequence=\\ /exclude_events= \\ /generate_mean_and_stddev=false\\ ! /append_to_existing_values=false\\ ;\\ </code>  |  metric_integrate_dlg.jpg|
+=====Pipeline Command=====
-====== example ======
+The command can be found in the **Pipeline Workshop** under **Metric** as so:
-  * [[visual3d:documentation:pipeline:signal_commands:impulse|impulse]]
+<code>
-  * [[visual3d:documentation:pipeline:model_based_data_commands:joint_work|joint_work]]
+Metric_Integrate
+! /RESULT_METRIC_FOLDER=PROCESSED
+/RESULT_METRIC_NAME=
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
+/SIGNAL_TYPES=
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /COMPONENT_SEQUENCE=
+/EVENT_SEQUENCE=
+/EXCLUDE_EVENTS=
+! /GENERATE_MEAN_AND_STDDEV=TRUE
+! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+</code>
+====Command Parameters====
+The following table shows the command parameters seen above and their descriptions:
+|**RESULT_METRIC_FOLDER**|**The name of the result signal folder**|
+|**RESULT_METRIC_NAME**|**The name of the result signal**|
+|**EVENT_SEQUENCE**|** A list of events (separated by "+" signs). For example, LHS+RTO**|
+====Dialog=====
+The command can be edited in a text editor or in a dialog form. To edit in the dialog pop up form either click on the **Edit** button in the pipeline workshop or double-click on the pipeline command. The dialog is shown below
+ {{:Metric_Integrate_Dlg.jpg}}
+The dialog box allows you to assign values to the command parameters outlined above.
+===== Example =====
+  * [[Visual3D:Documentation:Pipeline:Signal_Commands:Impulse|Impulse]]
+  * [[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:Joint_Work|Joint_Work]]
 \\
-**note:** when using the metric_integrate dialog box, don't forget to import the desired signals.
+**NOTE:** When using the Metric_Integrate dialog box, don't forget to Import the desired signals.
-}}