====== Metric Integrate ======

=====Overview=====

The command **Metric Integrate** is used to integrate a signal between events using the trapezoidal rule.

http://en.wikipedia.org/wiki/Trapezoidal_rule

The integral between two frames += ( (ValueAtFrame1+ValueAtFrame2)*DeltaT / 2 )

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. 

=====Pipeline Command=====

The command can be found in the **Pipeline Workshop** under **Metric** as so:

<code>
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.