User Tools

Site Tools


visual3d:documentation:pipeline:metric_commands:metric_integrate

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
visual3d:documentation:pipeline:metric_commands:metric_integrate [2024/08/28 13:31] – [Command] wikisysopvisual3d:documentation:pipeline:metric_commands:metric_integrate [2025/09/18 18:06] (current) wikisysop
Line 1: Line 1:
 ====== Metric Integrate ====== ====== Metric Integrate ======
  
-===== Introduction =====+=====Overview=====
  
-Integrate a signal between events using the trapezoidal rule.+The command **Metric Integrate** is used to integrate a signal between events using the trapezoidal rule.
  
 http://en.wikipedia.org/wiki/Trapezoidal_rule http://en.wikipedia.org/wiki/Trapezoidal_rule
Line 10: Line 10:
  
 where T= time between frames where T= time between frames
-===== Command ===== 
  
-Metric_Integrate = Sum of the integral for all frames in the range.+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> <code>
 Metric_Integrate Metric_Integrate
-/RESULT_METRIC_NAME= 
-/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE 
 ! /RESULT_METRIC_FOLDER=PROCESSED ! /RESULT_METRIC_FOLDER=PROCESSED
 +/RESULT_METRIC_NAME=
 +! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
 /SIGNAL_TYPES= /SIGNAL_TYPES=
 +! /SIGNAL_FOLDER=ORIGINAL
 ! /SIGNAL_NAMES= ! /SIGNAL_NAMES=
-/SIGNAL_FOLDER= +! /COMPONENT_SEQUENCE=
-! /SIGNAL_COMPONENTS=ALL_COMPONENTS+
 /EVENT_SEQUENCE= /EVENT_SEQUENCE=
 /EXCLUDE_EVENTS= /EXCLUDE_EVENTS=
-/GENERATE_MEAN_AND_STDDEV=FALSE+/GENERATE_MEAN_AND_STDDEV=TRUE 
 +! /GENERATE_MEAN_AND_STDDEV_ACROSS_SUBJECTS=FALSE
 ! /APPEND_TO_EXISTING_VALUES=FALSE ! /APPEND_TO_EXISTING_VALUES=FALSE
- 
 </code>   </code>  
  
- {{:Metric_Integrate_Dlg.jpg}}|+====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 ===== ===== Example =====
visual3d/documentation/pipeline/metric_commands/metric_integrate.1724851904.txt.gz · Last modified: 2024/08/28 13:31 by wikisysop