HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » metric_commands » Metric Event Count
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 [2025/05/12 20:43] – Cleaned up page with section headers. wikisysopvisual3d:documentation:pipeline:metric_commands:metric_event_count [2025/09/23 19:38] (current) – [Example 2: Multiple Files] wikisysop
Line 1: Line 1:
 ====== Metric Event Count ====== ====== Metric Event Count ======
  
-This command creates a [[visual3d:documentation:visual3d_signal_types:metric_data_type|metric]] containing the number of [[visual3d:documentation:c3d_signal_types:event_label_data_type|events]] that occur during a specified time interval or [[visual3d:documentation:pipeline:event_commands:event_define_event_sequence|event sequence]].+====Overview==== 
 + 
 +This command creates a [[visual3d:documentation:visual3d_signal_types:metric_data_type|metric]] containing the number of [[visual3d:documentation:c3d_signal_types:event_label_data_type|events]] that occur during a specified time interval or [[visual3d:documentation:pipeline:event_commands:event_define_event_sequence|event sequence]]. This can come in use when trying to identify the frequency or number of occurrences of a certain movement pattern. You must first define this event by adding an event in your pipeline before you can count it. The **Metric Event Count** command can be found in the **Pipeline Workshop** under the **Metric** folder.  
 + 
 +====Pipeline Command==== 
 + 
 +The command can be found in the workshop as so:
  
 <code> <code>
 Metric_Event_Count Metric_Event_Count
 +! /RESULT_METRIC_FOLDER=PROCESSED
 /RESULT_METRIC_NAME= /RESULT_METRIC_NAME=
-/RESULT_METRIC_FOLDER=PROCESSED +/EVENT_TO_COUNT= 
-/EVENT_NAME= +! /TIME_INTERVAL= 
-/TIME_INTERVAL= +! /EVENT_SEQUENCE= 
-/EVENT_SEQUENCE= +! /EXCLUDE_EVENTS= 
-/EXCLUDE_EVENTS= +! /GENERATE_COUNT_TOTAL_IN_GLOBAL=TRUE
-/GENERATE_COUNT_TOTAL_IN_GLOBAL=TRUE+
 ; ;
 </code> </code>
  
-{{:MetricEventCountDialog.png}}+====Command Parameters====
  
-==== Parameters ====+The following table shows the command parameters seen above and their descriptions: 
 + 
 +|**RESULT_METRIC_FOLDER**|**The name of the result signal folder**| 
 +|**RESULT_METRIC_NAME**|**The name of the result signal**| 
 +|**EVENT_TO_COUNT**|**Specify the name of the event that is being counted**| 
 +|**TIME_INTERVAL**|**The time interval over which events will be counted**| 
 +|**EVENT_SEQUENCE**|**Defining a specific sequence of events to be counted**| 
 +|**EXCLUDE_EVENTS**|**Defining events within the sequence to be excluded**| 
 +|**GENERATE_COUNT_TOTAL_IN_GLOBAL**|**(True/False) counting the total occurrences of an event in the workspace**|
  
 If the user specifies an **Event_Sequence/Exclude Sequence** then the count of the specified event includes all sequences in the file. If the user specifies an **Event_Sequence/Exclude Sequence** then the count of the specified event includes all sequences in the file.
Line 24: Line 38:
  
 As of Visual3D v5.00.29, 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 populated (a number or expression) the start time is the first event in the event_sequence. As of Visual3D v5.00.29, 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 populated (a number or expression) the start time is the first event in the event_sequence.
 +
 +====Dialog====
 +
 +The command can be edited in a text editor or in a dialog form. To edit in the dialog pop up form either click on the **Edit** button in the pipeline workshop or double-click on the pipeline command. The dialog is shown below.
 +
 +{{:MetricEventCountDialog.png}}
 +
 +
 +The dialog box allows you to assign values to the command parameters outlined above.
  
 ===== Example 1: Basic Metric Event Count ===== ===== Example 1: Basic Metric Event Count =====
Line 48: Line 71:
 ===== Example 2: Multiple Files ===== ===== Example 2: Multiple Files =====
  
-This example shows three ways the Metric_Event_Count command can be used. All three consider a set of 5 files containing the following event LHS.**+This example shows three ways the Metric_Event_Count command can be used. All three consider a set of 5 files containing the following event LHS.
  
 ^ File ^ LHS Event Times ^ ^ File ^ LHS Event Times ^
Line 195: Line 218:
 Global_Event_Count= 3 Global_Event_Count= 3
 </code> </code>
 +
 +====Example 3: Defining and Counting Gait Events====
 +Here we will use **Automatic Gait Events** to define a series of events during a gait cycle trial, and then count those events using the **Metric Event Count** command.
 +
 +Once you have loaded in a gait trial to your Visual3D, use **Automatic Gait Events** to identify the core gait events like so:
 +
 +<code>
 +Automatic_Gait_Events
 +! /FRAME_WINDOW=8
 +! /USE_TPR=TRUE
 +! /TPR_EVENT_INSTANCE=1
 +;
 +</code>
 +
 +Now we can use **Metric Event Count** to count the number of left heel strikes during each trial. The command should look like so:
 +
 +<code>
 +Metric_Event_Count
 +/RESULT_METRIC_FOLDER=PROCESSED_events
 +/RESULT_METRIC_NAME=Event_Count
 +/EVENT_TO_COUNT=LHS
 +! /TIME_INTERVAL=
 +! /EVENT_SEQUENCE=
 +! /EXCLUDE_EVENTS=
 +! /GENERATE_COUNT_TOTAL_IN_GLOBAL=TRUE
 +;
 +</code>
 +
 +A new folder containing the counts named **PROCESSED_events** can now be found within the **Metric** folder.
visual3d/documentation/pipeline/metric_commands/metric_event_count.1747082597.txt.gz · Last modified: 2025/05/12 20:43 by wikisysop