User Tools

Site Tools


visual3d:documentation:pipeline:metric_commands:metric_event_count

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
visual3d:documentation:pipeline:metric_commands:metric_event_count [2024/06/19 12:51] sgrangervisual3d:documentation:pipeline:metric_commands:metric_event_count [2024/07/17 15:46] (current) – created sgranger
Line 1: Line 1:
-{{creates a metric containing the number of events that occur in an event sequence or time interval.+====== Metric Event Count ======
  
-**metric_event_count** +Creates a metric containing the number of events that occur in an event sequence or time interval. 
-/result_metric_name+ 
-/result_metric_folder=processed +**Metric_Event_Count** 
-/event_name+/RESULT_METRIC_NAME
-/time_interval+/RESULT_METRIC_FOLDER=PROCESSED 
-/event_sequence+/EVENT_NAME
-/exclude_events+/TIME_INTERVAL
-/generate_count_total_in_global=true+/EVENT_SEQUENCE
 +/EXCLUDE_EVENTS
 +/GENERATE_COUNT_TOTAL_IN_GLOBAL=TRUE
 **;** **;**
-===== prior to version 5.00.29 =====+==== Prior to Version 5.00.29 ====
  
-the user could select "either" an **event_sequence/exclude sequence** or a **time_interval** +the user could select "either" an **Event_Sequence/Exclude Sequence** or a **Time_Interval** 
-if **event_sequence/exclude sequence** +if **Event_Sequence/Exclude Sequence** 
-the count of the specified event includes all sequences in the file +The count of the specified Event includes all sequences in the file 
-if **time_interval** (specified as a number) +if **Time_Interval** (specified as a number) 
-count of events within each time interval (starting from time=0) is specified as a separate frame. +count of events within each time interval (starting from Time=0) is specified as a separate frame. 
-for example, if there were three ranges defined by the time sequence, there would be 3 frames of data in the resulting metric. +For example, if there were three ranges defined by the time sequence, there would be 3 frames of data in the resulting metric. 
-===== starting in version 5.00.29 =====+==== Starting in Version 5.00.29 ====
  
-the user can select both an **event_sequence/exclude sequence** and a **time_interval** but only the first event_sequence is used. +the user can select both an **Event_Sequence/Exclude Sequence** and a **Time_Interval** but only the first Event_Sequence is used. 
-if the **time_interval** is empty the command behaves as before. +If the **Time_Interval** is empty the command behaves as before. 
-if the **time_interval** is populated (a number or expression) the start time is the first event in the event_sequence.+If the **Time_Interval** is populated (a number or expression) the start time is the first event in the event_sequence.
 \\ \\
-as of visual3dv5.00.29 this command must be edited manually.+As of Visual3Dv5.00.29 this command must be edited manually.
  
-===== user dialog starting in version 5.01.14 =====+==== User Dialog Starting in Version 5.01.14 ====
  
-|in visual3d v5.01.14 the user dialog was introduced. the command works the same as described in v5.00.29, however the user may now modify the command using the gui interface.  |  metriceventcountdialog.png|+|In Visual3D v5.01.14 the user dialog was introduced. The command works the same as described in v5.00.29, however the user may now modify the command using the GUI interface.  |  {{:MetricEventCountDialog.png}}|
  
-===== example_1 =====+==== Example_1 ====
  
-**select_active_file** +**Select_Active_File** 
-**/file_name=** all_files +**/FILE_NAME=** ALL_FILES 
-**! /query=**+**! /QUERY=**
 **;** **;**
-**metric_event_count** +**Metric_Event_Count** 
-**/result_metric_folder=**processed +**/RESULT_METRIC_FOLDER=**PROCESSED 
-**/result_metric_name=**lon_count +**/RESULT_METRIC_NAME=**LON_COUNT 
-**/event_name=**lon +**/EVENT_NAME=**LON 
-**/time_interval=** +**/TIME_INTERVAL=** 
-**/event_sequence=** +**/EVENT_SEQUENCE=** 
-**/exclude_events=** +**/EXCLUDE_EVENTS=** 
-**/generate_count_total_in_global=** true+**/GENERATE_COUNT_TOTAL_IN_GLOBAL=** TRUE
 **;** **;**
 \\ \\
  
  
-==== result ====+=== Result ===
  
-lon_count will count all events in the file and a metric value lon_count will be created in the metric::processed folder.+LON_COUNT will count all events in the file and a metric value LON_COUNT will be created in the METRIC::PROCESSED folder.
  
-"since generate_count_total_in_global is set to true, the total number of lon events in the workspace will be created.+"Since GENERATE_COUNT_TOTAL_IN_GLOBAL is set to TRUE, the total number of LON events in the workspace will be created.
  
-to see this value set the active file to global and a metric value lon_count will be created in the metric::processed folder. +To see this value set the Active File to GLOBAL and a metric value LON_COUNT will be created in the METRIC::PROCESSED folder. 
-===== example_2 =====+==== Example_2 ====
  
-**this example shows 3 ways the metric_event_count command can be used.**+**This example shows 3 ways the Metric_Event_Count command can be used.**
  
-**consider a set of 5 files containing the following event lhs.**+**Consider a set of 5 files containing the following event LHS.**
  
-event lhs+Event LHS
 mvc004.c3d mvc004.c3d
 0.960000 0.960000
Line 78: Line 80:
 2.140000 2.140000
 3.360000 3.360000
-==== count events across entire file ====+=== Count events across entire file ===
  
-**count across the entire file** +**Count across the entire file** 
-**metric_event_count** +**Metric_Event_Count** 
-/result_metric_name=lhs_count +/RESULT_METRIC_NAME=LHS_COUNT 
-/result_metric_folder=processed +/RESULT_METRIC_FOLDER=PROCESSED 
-/event_name=lhs +/EVENT_NAME=LHS 
-/time_interval+/TIME_INTERVAL
-/event_sequence+/EVENT_SEQUENCE
-/exclude_events+/EXCLUDE_EVENTS
-/generate_count_total_in_global=true+/GENERATE_COUNT_TOTAL_IN_GLOBAL=TRUE
 **;** **;**
-**result**+**Result**
 mvc005.c3d mvc005.c3d
-event_count= 3+Event_Count= 3
 mvc002.c3d mvc002.c3d
-event_count= 3+Event_Count= 3
 mvc003.c3d mvc003.c3d
-event_count= 3+Event_Count= 3
 mvc004.c3d mvc004.c3d
-event_count= 3 +Event_Count= 3 
-global_event_count= 12 +Global_Event_Count= 12 
-==== count events across entire file in time intervals ====+=== Count events across entire file in time intervals ===
  
-**count across the entire file at 1 second intervals** +**Count across the entire file at 1 second intervals** 
-**metric_event_count** +**Metric_Event_Count** 
-/result_metric_name=lhs_count +/RESULT_METRIC_NAME=LHS_COUNT 
-/result_metric_folder=processed +/RESULT_METRIC_FOLDER=PROCESSED 
-/event_name=lhs +/EVENT_NAME=LHS 
-/time_interval=1 +/TIME_INTERVAL=1 
-/event_sequence+/EVENT_SEQUENCE
-/exclude_events+/EXCLUDE_EVENTS
-/generate_count_total_in_global=true+/GENERATE_COUNT_TOTAL_IN_GLOBAL=TRUE
 **;** **;**
-**result**+**Result**
 mvc005.c3d mvc005.c3d
-interval= 0.000000 to 1.000000 event_count= 1 +Interval= 0.000000 to 1.000000 Event_Count= 1 
-interval= 1.000000 to 2.000000 event_count= 0 +Interval= 1.000000 to 2.000000 Event_Count= 0 
-interval= 2.000000 to 3.000000 event_count= 1 +Interval= 2.000000 to 3.000000 Event_Count= 1 
-interval= 3.000000 to 4.000000 event_count= 1 +Interval= 3.000000 to 4.000000 Event_Count= 1 
-interval= 4.000000 to 4.200000 event_count= 0+Interval= 4.000000 to 4.200000 Event_Count= 0
 mvc002.c3d mvc002.c3d
-interval= 0.000000 to 1.000000 event_count= 0 +Interval= 0.000000 to 1.000000 Event_Count= 0 
-interval= 1.000000 to 2.000000 event_count= 1 +Interval= 1.000000 to 2.000000 Event_Count= 1 
-interval= 2.000000 to 3.000000 event_count= 1 +Interval= 2.000000 to 3.000000 Event_Count= 1 
-interval= 3.000000 to 4.000000 event_count= 1 +Interval= 3.000000 to 4.000000 Event_Count= 1 
-interval= 4.000000 to 4.580000 event_count= 0+Interval= 4.000000 to 4.580000 Event_Count= 0
 mvc003.c3d mvc003.c3d
-interval= 0.000000 to 1.000000 event_count= 1 +Interval= 0.000000 to 1.000000 Event_Count= 1 
-interval= 1.000000 to 2.000000 event_count= 0 +Interval= 1.000000 to 2.000000 Event_Count= 0 
-interval= 2.000000 to 3.000000 event_count= 1 +Interval= 2.000000 to 3.000000 Event_Count= 1 
-interval= 3.000000 to 4.000000 event_count= 1 +Interval= 3.000000 to 4.000000 Event_Count= 1 
-interval= 4.000000 to 4.600000 event_count= 0+Interval= 4.000000 to 4.600000 Event_Count= 0
 mvc004.c3d mvc004.c3d
-interval= 0.000000 to 1.000000 event_count= 1 +Interval= 0.000000 to 1.000000 Event_Count= 1 
-interval= 1.000000 to 2.000000 event_count= 0 +Interval= 1.000000 to 2.000000 Event_Count= 0 
-interval= 2.000000 to 3.000000 event_count= 1 +Interval= 2.000000 to 3.000000 Event_Count= 1 
-interval= 3.000000 to 4.000000 event_count= 1 +Interval= 3.000000 to 4.000000 Event_Count= 1 
-interval= 4.000000 to 4.380000 event_count= 0 +Interval= 4.000000 to 4.380000 Event_Count= 0 
-global_event_counts +Global_Event_Counts 
-global_event_count= 3 +Global_Event_Count= 3 
-global_event_count= 1 +Global_Event_Count= 1 
-global_event_count= 4 +Global_Event_Count= 4 
-global_event_count= 4 +Global_Event_Count= 4 
-global_event_count= 0 +Global_Event_Count= 0 
-==== count events in a set number of intervals across entire file ====+=== Count events in a set number of intervals across entire file ===
  
-**count over 5 intervals from the event_sequence start+end**+**Count over 5 intervals from the event_sequence START+END**
 **** ****
-**where start=1.0 and end=4.0 for all files** +**Where START=1.0 and END=4.0 for all files** 
-**metric_event_count** +**Metric_Event_Count** 
-/result_metric_name=lhs_count +/RESULT_METRIC_NAME=LHS_COUNT 
-/result_metric_folder=processed +/RESULT_METRIC_FOLDER=PROCESSED 
-/event_name=lhs +/EVENT_NAME=LHS 
-/time_interval=(event_label::original::end-event_label::original::start)/5 +/TIME_INTERVAL=(EVENT_LABEL::ORIGINAL::END-EVENT_LABEL::ORIGINAL::START)/5 
-/event_sequence=start+end +/EVENT_SEQUENCE=START+END 
-/exclude_events+/EXCLUDE_EVENTS
-/generate_count_total_in_global=true+/GENERATE_COUNT_TOTAL_IN_GLOBAL=TRUE
 **;** **;**
-**result**+**Result**
 mvc005.c3d mvc005.c3d
-interval= 1.000000 to 1.600000 event_count= 0 +Interval= 1.000000 to 1.600000 Event_Count= 0 
-interval= 1.600000 to 2.200000 event_count= 1 +Interval= 1.600000 to 2.200000 Event_Count= 1 
-interval= 2.200000 to 2.800000 event_count= 0 +Interval= 2.200000 to 2.800000 Event_Count= 0 
-interval= 2.800000 to 3.400000 event_count= 1 +Interval= 2.800000 to 3.400000 Event_Count= 1 
-interval= 3.400000 to 4.000000 event_count= 0+Interval= 3.400000 to 4.000000 Event_Count= 0
 mvc002.c3d mvc002.c3d
-interval= 1.000000 to 1.600000 event_count= 1 +Interval= 1.000000 to 1.600000 Event_Count= 1 
-interval= 1.600000 to 2.200000 event_count= 0 +Interval= 1.600000 to 2.200000 Event_Count= 0 
-interval= 2.200000 to 2.800000 event_count= 1 +Interval= 2.200000 to 2.800000 Event_Count= 1 
-interval= 2.800000 to 3.400000 event_count= 0 +Interval= 2.800000 to 3.400000 Event_Count= 0 
-interval= 3.400000 to 4.000000 event_count= 1+Interval= 3.400000 to 4.000000 Event_Count= 1
 mvc003.c3d mvc003.c3d
-interval= 1.000000 to 1.600000 event_count= 0 +Interval= 1.000000 to 1.600000 Event_Count= 0 
-interval= 1.600000 to 2.200000 event_count= 0 +Interval= 1.600000 to 2.200000 Event_Count= 0 
-interval= 2.200000 to 2.800000 event_count= 1 +Interval= 2.200000 to 2.800000 Event_Count= 1 
-interval= 2.800000 to 3.400000 event_count= 0 +Interval= 2.800000 to 3.400000 Event_Count= 0 
-interval= 3.400000 to 4.000000 event_count= 1+Interval= 3.400000 to 4.000000 Event_Count= 1
 mvc004.c3d mvc004.c3d
-interval= 1.000000 to 1.600000 event_count= 0 +Interval= 1.000000 to 1.600000 Event_Count= 0 
-interval= 1.600000 to 2.200000 event_count= 0 +Interval= 1.600000 to 2.200000 Event_Count= 0 
-interval= 2.200000 to 2.800000 event_count= 1 +Interval= 2.200000 to 2.800000 Event_Count= 1 
-interval= 2.800000 to 3.400000 event_count= 0 +Interval= 2.800000 to 3.400000 Event_Count= 0 
-interval= 3.400000 to 4.000000 event_count= 1 +Interval= 3.400000 to 4.000000 Event_Count= 1 
-global_event_counts +Global_Event_Counts 
-global_event_count= 1 +Global_Event_Count= 1 
-global_event_count= 1 +Global_Event_Count= 1 
-global_event_count= 3 +Global_Event_Count= 3 
-global_event_count= 1 +Global_Event_Count= 1 
-global_event_count= 3+Global_Event_Count= 3 
  
-}} 
visual3d/documentation/pipeline/metric_commands/metric_event_count.1718801478.txt.gz · Last modified: 2024/06/19 12:51 by sgranger