Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_frames_between_events [2024/06/17 18:20] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_frames_between_events [2025/09/18 18:00] (current) – wikisysop
@@ Line 1: / Line 1: @@
+====== Metric Frames Between Events ======
+====Overview====
+The **Metric Frames Between Events** computes the number of frames between events (or start and end of a sequence of events) as a metric. This can be useful in determining time between events when frame rate is known. The **Metric Event Count** command can be found in the **Pipeline Workshop** under the **Metric** folder.
+**Note that the frames will be at the POINT RATE because Visual3D computes Events at POINT RATE.**
+====Pipeline Command====
-Computes the number of frames between events (or start and end of a sequence of events) as a metric. For example, consider Right_Terminal_Double_Limb_Support.
+The command can be found in the workshop as so:
-**Note that the frames will be at the POINT RATE because Visual3D computes Events at POINT RATE.**
-\\
 <code>
-Frames_Between_Events
+Metric_Frames_Between_Events
-/Event_Sequence=    A list of events (separated by "+" signs). For example, LHS+RTO
+! /RESULT_METRIC_FOLDER=PROCESSED
-/Exclude_Events=    This Event_Sequence must not be during the sequence requested. For example, LTO_RHS
+/RESULT_METRIC_NAME=
-/Metric_Name= The name of the metric signal. For example, Right_Terminal_Double_Limb_Support
+/EVENT_SEQUENCE=
-/Generate_Mean_And_StdDev=(True or False)Generate the mean and standard deviation for all of the metrics created
+/EXCLUDE_EVENTS=
-/Append to Existing Values=(True or False)Append this list of metrics to an existing metric of the same result name
+! /GENERATE_MEAN_AND_STDDEV=TRUE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+;
 </code>
-\\
+====Command Parameters====
-\\
-Dialog that pops up when pipeline selection is edited by double clicking with the left mouse button.\\
-[[MetricTimeBtwnEventsDlg.jpg]]\\
-\\
+The following table shows the command parameters seen above and their descriptions:
-====== Example ======
+|**RESULT_METRIC_FOLDER**|**The name of the result signal folder**|
+|**RESULT_METRIC_NAME**|**The name of the result signal**|
+|**EVENT_SEQUENCE**|** A list of events (separated by "+" signs). For example, LHS+RTO**|
+|**EXCLUDE_EVENTS**|**This Event Sequence must not be during the sequence requested. For example, LTO_RHS**|
+|**GENERATE_MEAN_AND_STDDEV**|**(True or False)Generate the mean and standard deviation for all of the metrics created**|
+|**APPEND_TO_EXISTING_VALUES**|**(True or False)Append this list of metrics to an existing metric of the same result name**|
+====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.
+{{:MetricTimeBtwnEventsDlg.jpg}}
+The dialog box allows you to assign values to the command parameters outlined above.
+===== Example =====
 \\
-|<code>\\ Metric_Frames_Between_Events\\ /RESULT_METRIC_NAME=Right_Terminal_Double_Limb_Support\\ ! /RESULT_METRIC_FOLDER=PROCESSED\\ /EVENT_SEQUENCE=LHS+RTO\\ /EXCLUDE_EVENTS=LTO+RHS\\ ! /GENERATE_MEAN_AND_STDDEV=TRUE\\ ! /APPEND_TO_EXISTING_VALUES=FALSE\\ ;\\ </code>  |  [[MetricTimeBtwnEventsDlg_Example.jpg]]|
+|<code>\\ Metric_Frames_Between_Events\\ /RESULT_METRIC_NAME=Right_Terminal_Double_Limb_Support\\ ! /RESULT_METRIC_FOLDER=PROCESSED\\ /EVENT_SEQUENCE=LHS+RTO\\ /EXCLUDE_EVENTS=LTO+RHS\\ ! /GENERATE_MEAN_AND_STDDEV=TRUE\\ ! /APPEND_TO_EXISTING_VALUES=FALSE\\ ;\\ </code>  |  {{:MetricTimeBtwnEventsDlg_Example.jpg}}|
-===== Visual3D Versions supporting Subject Prefixes =====
+==== Visual3D Versions supporting Subject Prefixes ====
 NOTE: When using events in a command, the commands will iterate across subjects contained in the current workspace. As such, events and sequences listed as command parameters should NOT contain a prefix. As each subject is processed, the event range/sequence specified will automatically use the specific events prefixed for each subject as they are processed.