Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_event_sequence_count [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_event_sequence_count [2024/12/10 16:47] (current) – [Time_Interval] wikisysop
@@ Line 1: / Line 1: @@
-{{{{{{creates a metric containing the number of event sequences.
+====== Metric Event Sequence Count ======
-|<code>\\ metric_event_sequence_count\\ ! /result_metric_folder=the resulting folder of the metric \\ /result_metric_name= the resulting name of the metric \\ ! /time_interval= the number of event sequences which occur\\   within a time interval\\ /event_sequence= the event sequence to search for and count \\ /exclude_events= don't count a sequence that contains this \\  event \\ ! /generate_count_total_in_global= create a global count\\   over the active files\\ ;\\ </code>  |  eventssequencecountdlg.png|
+Creates a metric containing the number of Event Sequences.
-\\
+<code>
-\\
+Metric_Event_Sequence_Count
+! /RESULT_METRIC_FOLDER=The resulting folder of the metric
+/RESULT_METRIC_NAME= The resulting name of the metric
+/TIME_INTERVAL= The number of event sequences which occur within a time interval
+/EVENT_SEQUENCE= The event sequence to search for and count
+/EXCLUDE_EVENTS= Don't count a sequence that contains this event
+! /GENERATE_COUNT_TOTAL_IN_GLOBAL= Create a global count over the active files
+;
+</code>
+{{:EventsSequenceCountDlg.png}}
-===== time_interval =====
+==== Time_Interval ====
-**the time_interval parameter can be used to count the number of events that occur within a specific interval.**
+**The Time_Interval parameter can be used to count the number of events that occur within a specific interval.**
-==== command setup ====
+=== Command Setup ===
-**if a trial is 20 seconds long, and a 5.0 second interval is specified, the result will be 4 metrics. each metric will contain the number of event sequences which occur within each 5.0 second window.**
+**If a trial is 20 seconds long, and a 5.0 second interval is specified, the result will be 4 metrics. Each metric will contain the number of event sequences which occur within each 5.0 second window.**
-|<code>\\ metric_event_sequence_count\\ ! /result_metric_folder= processed\\ /result_metric_name= lswing_count_int\\ /time_interval= 5.0\\ /event_sequence= the event sequence to search for and count \\ /exclude_events= don't count a sequence that contains this \\  event \\ ! /generate_count_total_in_global= create a global count\\   over the active files\\ ;\\ </code>  |  eventssequencecount_interval.png|
+<code>
+Metric_Event_Sequence_Count
+! /RESULT_METRIC_FOLDER= PROCESSED
+/RESULT_METRIC_NAME= LSWING_COUNT_INT
+/TIME_INTERVAL= 5.0
+/EVENT_SEQUENCE= The event sequence to search for and count
+/EXCLUDE_EVENTS= Don't count a sequence that contains this event
+! /GENERATE_COUNT_TOTAL_IN_GLOBAL= Create a global count over the active files
+;
+</code>
-==== result ====
+{{:EventsSequenceCount_Interval.png}}|
+=== Result ===
+|**When using a 5 second interval on a 20 second trial, the result will be four metrics (20/5).**\\ \\ (1) The first metric will contain the number of times the sequence occurs during the first 5 seconds of the trial\\ (2) The second metric will contain the number of times the sequence occurs during the 5 - 10 second interval of the trial\\ (3) The third metric will contain the number of times the sequence occurs during the 10 - 15 second interval of the trial\\ (4) The fourth metric will contain the number of times the sequence occurs during the 15 - 20 second interval of the trial\\ \\ **NOTE:** If the event sequence occurs between two intervals (LTO occurs at 4 sec and LHS occurs at 6 sec), this sequence will be included in Interval 1.  |  {{:EventsSequenceCount_Interval_Result.png}}|
-|**when using a 5 second interval on a 20 second trial, the result will be four metrics (20/5).**\\ \\ (1) the first metric will contain the number of times the sequence occurs during the first 5 seconds of the trial\\ (2) the second metric will contain the number of times the sequence occurs during the 5 - 10 second interval of the trial\\ (3) the third metric will contain the number of times the sequence occurs during the 10 - 15 second interval of the trial\\ (4) the fourth metric will contain the number of times the sequence occurs during the 15 - 20 second interval of the trial\\ \\ **note:** if the event sequence occurs between two intervals (lto occurs at 4 sec and lhs occurs at 6 sec), this sequence will be included in interval 1.  |  eventssequencecount_interval_result.png|
-}}}}}}