Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_frames_between_events [2024/06/26 20:06] – removed sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_frames_between_events [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
+====== Metric Frames Between Events ======
+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.
+**Note that the frames will be at the POINT RATE because Visual3D computes Events at POINT RATE.**
+\\
+<code>
+Frames_Between_Events
+/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
+/Metric_Name= The name of the metric signal. For example, Right_Terminal_Double_Limb_Support
+/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
+</code>
+\\
+\\
+Dialog that pops up when pipeline selection is edited by double clicking with the left mouse button.\\
+{{:MetricTimeBtwnEventsDlg.jpg}}\\
+\\
+===== 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}}|
+==== 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.