Differences

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

--- visual3d:documentation:pipeline:expressions:metric_functions [2024/07/16 16:58] – removed 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 ====
+Minimum within each event_sequence
+<code>
+Metric_Minimum(target::processed::rft1)
+  returns the Minimum value across all frames
+Metric_Minimum(target::processed::rft1, event_label::original::rhs)
+  returns the Minimum value at the event rhs
+Metric_Minimum(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
+  returns the Minimum value between the events rhs and rto
+</code>
+==== Metric Maximum ====
+Maximum within each event_sequence.
+<code>
+Metric_Maximum(target::processed::rft1)
+  returns the maximum value across all frames
+Metric_Maximum(target::processed::rft1, event_label::original::rhs)
+  returns the maximum value at the event rhs
+Metric_Maximum(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
+  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)
+  returns the range across all frames
+Metric_Maximum(target::processed::rft1, event_label::original::rhs)
+  returns the range value at the event rhs
+Metric_Maximum(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
+  returns the range value between the events rhs and rto
+</code>
+==== Metric Mean ====
+Mean within each event_sequence
+<code>
+Metric_Mean(target::processed::rft1)
+  returns the Mean value across all frames
+Metric_Mean(target::processed::rft1, event_label::original::rhs)
+  returns the Mean value at the event rhs
+Metric_Mean(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
+  returns the Mean value between the events rhs and rto
+</code>
+==== Metric Median ====
+Median within each event_sequence.
+**Metric_Median**(target::processed::rft1)
+returns the Median value across all frames
+**Metric_Median**(target::processed::rft1, event_label::original::rhs)
+returns the Median value at the event rhs
+**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 ====
+Standard Deviation within each event_sequence.
+**Metric_StdDev**(target::processed::rft1)
+returns the Standard Deviation value across all frames
+**Metric_StdDev**(target::processed::rft1, event_label::original::rhs)
+returns the Standard Deviation value at the event rhs
+**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 ====
+Root-Mean-Squared within each event_sequence.
+**Metric_RMS**(target::processed::rft1)
+returns the RMS value across all frames
+**Metric_RMS**(target::processed::rft1, event_label::original::rhs)
+returns the RMS value at the event rhs
+**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 ====
+Inter Quartile Range: [[https://en.wikipedia.org/wiki/Interquartile_range|Interquartile Definition]]
+Example:
+**Metric_InterQuartile**(target::processed::rft1, event_label::original::rhs, event_label::original::rto)
+The resulting signal as 3 components, and interquartile for each of the 3 components of RFT1
+==== Cross Correlation ====
+Cross Correlation between two signals.
+**Cross_Correlation**(signal1, signal2, Wrap, Max_Delay)
+The parameters are consistent with the [[Visual3D:Documentation:Pipeline:Signal_Commands:Cross_Correlation|Cross_Correlation]] Pipeline Command
+==== 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 ====
+Integral of a signal: [[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_Integrate|See Pipeline Command Metric_Integrate]]
+Example;
+**Metric_Integrate**(target::processed::rft1)
+**Metric_Integrate**(target::processed::rft1, event_label::original::rhs)
+**Metric_Integrate**(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**