Differences

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

--- visual3d:documentation:pipeline:expressions:metric_functions [2024/06/19 13:59] – created sgranger
+++ visual3d:documentation:pipeline:expressions:metric_functions [2025/01/28 11:35] (current) – [Metric Sum] wikisysop
@@ Line 1: / Line 1: @@
+====== Metric Functions ======
 This page contains a list of all functions that can be applied to signals and result in a metric.
-===== Metric Minimum =====
+==== Metric Minimum ====
 Minimum within each event_sequence
+<code>
-**Metric_Minimum**(target::processed::rft1)
+Metric_Minimum(target::processed::rft1)
-returns the Minimum value across all frames
+  returns the Minimum value across all frames
-**Metric_Minimum**(target::processed::rft1, event_label::original::rhs)
+Metric_Minimum(target::processed::rft1, event_label::original::rhs)
-returns the Minimum value at the event rhs
+  returns the Minimum value at the event rhs
-**Metric_Minimum**(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
+Metric_Minimum(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
-returns the Minimum value between the events rhs and rto
+  returns the Minimum value between the events rhs and rto
-===== Metric Maximum =====
+</code>
+==== Metric Maximum ====
 Maximum within each event_sequence.
-**Metric_Maximum**(target::processed::rft1)
+<code>
-returns the maximum value across all frames
+Metric_Maximum(target::processed::rft1)
-**Metric_Maximum**(target::processed::rft1, event_label::original::rhs)
+  returns the maximum value across all frames
-returns the maximum value at the event rhs
+Metric_Maximum(target::processed::rft1, event_label::original::rhs)
-**Metric_Maximum**(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
+  returns the maximum value at the event rhs
-returns the maximum value between the events rhs and rto
+Metric_Maximum(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
-===== Metric Range =====
+  returns the maximum value between the events rhs and rto
+</code>
+==== Metric Range ====
 Range = Maximum - Minimum within each event_sequence.
+<code>
-**Metric_Range**(target::processed::rft1)
+Metric_Range(target::processed::rft1)
-returns the range across all frames
+  returns the range across all frames
-**Metric_Maximum**(target::processed::rft1, event_label::original::rhs)
+Metric_Maximum(target::processed::rft1, event_label::original::rhs)
-returns the range value at the event rhs
+  returns the range value at the event rhs
-**Metric_Maximum**(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
+Metric_Maximum(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
-returns the range value between the events rhs and rto
+  returns the range value between the events rhs and rto
-===== Metric Mean =====
+</code>
+==== Metric Mean ====
 Mean within each event_sequence
+<code>
-**Metric_Mean**(target::processed::rft1)
+Metric_Mean(target::processed::rft1)
-returns the Mean value across all frames
+  returns the Mean value across all frames
-**Metric_Mean**(target::processed::rft1, event_label::original::rhs)
+Metric_Mean(target::processed::rft1, event_label::original::rhs)
-returns the Mean value at the event rhs
+  returns the Mean value at the event rhs
-**Metric_Mean**(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
+Metric_Mean(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
-returns the Mean value between the events rhs and rto
+  returns the Mean value between the events rhs and rto
-===== Metric Median =====
+</code>
+==== Metric Median ====
 Median within each event_sequence.
@@ Line 51: / Line 58: @@
 **Metric_Median**(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
 returns the Median value between the events rhs and rto
-===== Metric StdDev =====
+==== Metric StdDev ====
 Standard Deviation within each event_sequence.
@@ Line 61: / Line 68: @@
 **Metric_StdDev**(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
 returns the Standard Deviation value between the events rhs and rto
-===== Metric RMS =====
+==== Metric RMS ====
 Root-Mean-Squared within each event_sequence.
@@ Line 71: / Line 78: @@
 **Metric_RMS**(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
 returns the RMS value between the events rhs and rto
-===== Metric InterQuartile =====
+==== Metric InterQuartile ====
 Inter Quartile Range: [[https://en.wikipedia.org/wiki/Interquartile_range|Interquartile Definition]]
@@ Line 79: / Line 86: @@
 The resulting signal as 3 components, and interquartile for each of the 3 components of RFT1
-===== Cross Correlation =====
+==== Cross Correlation ====
 Cross Correlation between two signals.
@@ Line 86: / Line 93: @@
 The parameters are consistent with the [[Visual3D:Documentation:Pipeline:Signal_Commands:Cross_Correlation|Cross_Correlation]] Pipeline Command
-===== Metric Sum =====
+==== Metric Sum ====
 **Metric_Sum**(signal, start_event, end_event) - where start_event and end_event are optional
 **Metric_Sum**(target::processed::rft1)
 **Metric_Sum**(target::processed::rft1, event_label::original::rhs)
 **Metric_Sum**(target::processed::rft1, event_label::sequence::rcycle)
 **Metric_Sum**(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
 **Note that the event label requires the full signal path. i.e. event_label::original::rhs not just rhs**
-===== Metric Integrate =====
+==== Metric Integrate ====
 Integral of a signal: [[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_Integrate|See Pipeline Command Metric_Integrate]]