Table of Contents

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

The command can be found in the workshop as so: 

Metric_Frames_Between_Events
! /RESULT_METRIC_FOLDER=PROCESSED
/RESULT_METRIC_NAME=
/EVENT_SEQUENCE=
/EXCLUDE_EVENTS=
! /GENERATE_MEAN_AND_STDDEV=TRUE
! /APPEND_TO_EXISTING_VALUES=FALSE
;

Command Parameters

The following table shows the command parameters seen above and their descriptions:

RESULT_METRIC_FOLDERThe name of the result signal folder
RESULT_METRIC_NAMEThe name of the result signal
EVENT_SEQUENCE A list of events (separated by “+” signs). For example, LHS+RTO
EXCLUDE_EVENTSThis 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


\\ 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\\ ;\\
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.