Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_frames_between_events [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_frames_between_events [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{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.
+====== Metric Frames Between Events ======
-**note that the frames will be at the point rate because visual3d computes events at point rate.**
+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
+Frames_Between_Events
-/event_sequence=    a list of events (separated by "+" signs). for example, lhs+rto
+/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
+/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
+/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
+/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
+/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.\\
+Dialog that pops up when pipeline selection is edited by double clicking with the left mouse button.\\
-metrictimebtwneventsdlg.jpg\\
+{{:MetricTimeBtwnEventsDlg.jpg}}\\
 \\
-====== example ======
+===== 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.
-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.
-}}}}