Differences

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

--- sift:command_line [2025/09/12 19:29] – sgranger
+++ sift:command_line [2025/09/23 18:33] (current) – [-RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics] wikisysop
@@ Line 1751: / Line 1751: @@
 Immediatly launch a background instance of Sift in the system tray.
 <code> -LaunchBackgroundInstance</code>
+----
+==== -RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics ====
+----
+Compute Summary Metrics
+=== Parameters ===
+__**EventIndex **__ \\
+Index Event to compute Metrics at.
+  * **Data Type:** String
+  * **Default Value:** NULL
+__**GlobalMax **__ \\
+Compute Global Max.
+  * **Data Type:** Boolean (True / False)
+  * **Default Value:** false
+__**GlobalMin **__ \\
+Compute Global Min.
+  * **Data Type:** Boolean (True / False)
+  * **Default Value:** false
+__**Group (REQUIRED) **__ \\
+The group you will calculate metrics for.
+  * **Data Type:** String
+  * **Default Value:** N/A
+__**LocalMax **__ \\
+Compute Local Max.
+  * **Data Type:** Boolean (True / False)
+  * **Default Value:** false
+__**LocalMaxEnd **__ \\
+Local Max End Range.
+  * **Data Type:** Integer
+  * **Default Value:** 0
+__**LocalMaxStart **__ \\
+Local Max Start Range.
+  * **Data Type:** Integer
+  * **Default Value:** 0
+__**LocalMin **__ \\
+Compute Local Min.
+  * **Data Type:** Boolean (True / False)
+  * **Default Value:** false
+__**LocalMinEnd **__ \\
+Local Min End Range.
+  * **Data Type:** Integer
+  * **Default Value:** 0
+__**LocalMinStart **__ \\
+Local Min Start Range.
+  * **Data Type:** Integer
+  * **Default Value:** 0
+__**MaxBetweenEvents **__ \\
+Compute Maximum Between Events.
+  * **Data Type:** Boolean (True / False)
+  * **Default Value:** false
+__**MaxEventEndIndex **__ \\
+Index of End Event for Maximum Between Events.
+  * **Data Type:** String
+  * **Default Value:** NULL
+__**MaxEventStartIndex **__ \\
+Index of Start Event for Maximum Between Events.
+  * **Data Type:** String
+  * **Default Value:** NULL
+__**Mean **__ \\
+Compute Mean.
+  * **Data Type:** Boolean (True / False)
+  * **Default Value:** false
+__**MetricAtEvent **__ \\
+Compute Metric at Event.
+  * **Data Type:** Boolean (True / False)
+  * **Default Value:** false
+__**MinBetweenEvents **__ \\
+Compute Minimum Between Events.
+  * **Data Type:** Boolean (True / False)
+  * **Default Value:** false
+__**MinEventEndIndex **__ \\
+Index of End Event for Minimum Between Events.
+  * **Data Type:** String
+  * **Default Value:** NULL
+__**MinEventStartIndex **__ \\
+Index of Start Event for Minimum Between Events.
+  * **Data Type:** String
+  * **Default Value:** NULL
+__**StandardDeviation **__ \\
+Compute Standard Deviation.
+  * **Data Type:** Boolean (True / False)
+  * **Default Value:** false
+__**StandardError **__ \\
+Compute Standard Error.
+  * **Data Type:** Boolean (True / False)
+  * **Default Value:** false
+__**UseExcludedData **__ \\
+Use Excluded Data to compute metrics.
+  * **Data Type:** Boolean (True / False)
+  * **Default Value:** false
+__**Workspaces **__ \\
+Workspaces you will calculate metrics for. If left blank all workspaces will be used.
+  * **Data Type:** List
+  * **Default Value:** NULL
+<code>
+-RunSummaryMetrics Group "AnkleAngleX" Mean StandardDeviation StandardError GlobalMax GlobalMin</code>
 ----