User Tools

Site Tools


visual3d:documentation:pipeline:event_commands:event_global_maximum

Event Global Maximum

Overview

This command identifies the global maximum of a specified signal within a given time range and creates an event at that peak value. This command is useful for detecting peak joint angles, force plate data peaks, or maximum velocity in motion capture trials.

Pipeline Command

The following command shows the most recent update, Version 6.

Event_Global_Maximum
/RESULT_EVENT_NAME=
! /SIGNAL_TYPES=
! /SIGNAL_FOLDER=ORIGINAL
! /SIGNAL_NAMES=
! /SIGNAL_COMPONENTS=
! /FRAME_OFFSET=0
! /TIME_OFFSET=
! /EVENT_SEQUENCE=
! /EXCLUDE_EVENTS=
! /EVENT_SEQUENCE_INSTANCE=0
! /EVENT_SUBSEQUENCE=
! /SUBSEQUENCE_EXCLUDE_EVENTS=
! /EVENT_SUBSEQUENCE_INSTANCE=0
! /THRESHOLD=
;

Command Parameters

The following table shows the command parameters and descriptions:

/RESULT_EVENT_NAME= Specifies the name of the event created at the peak signal value.
! /SIGNAL_TYPES= Type of signal from which the maximum value will be extracted (Target, Analog, etc.)
! /SIGNAL_FOLDER=ORIGINAL Folder within signal type.
! /SIGNAL_NAMES= Defines the signal from which the maximum value will be extracted.
! /SIGNAL_COMPONENTS= Component of the named signal which the maximum value will be found in (X, Y, Z)


Specify an Event Label(s) at the Global Maximum of a signal.

The result will be one maximum value over the range.

If the local maxima are needed, see the Event_Maximum command

To review the difference between local and global maximum values please see here.

Version 6

The Event_Global_Maximum command may be used to place an event at the Global maximum value of a signal. If Threshold has a value or expression only global maximum greater than the threshold will be identified.


Version 5

The Event_Global_Maximum command may be used to place an event label at the Global Maximum value of a signal.

Event_Global_Maximum
/RESULT_EVENT_NAME=
! /SIGNAL_TYPES=
! /SIGNAL_NAMES=
! /SIGNAL_FOLDER= ORIGINAL
! /SIGNAL_COMPONENTS=
! /FRAME_OFFSET= 0
! /TIME_OFFSET=
! /EVENT_SEQUENCE=
! /EXCLUDE_EVENTS=
! /EVENT_SEQUENCE_INSTANCE= 0
! /EVENT_SUBSEQUENCE=
! /SUBSEQUENCE_EXCLUDE_EVENTS=
! /EVENT_SUBSEQUENCE_INSTANCE= 0
! /EVENT_INSTANCE=  0
! /SELECT_X= 
! /SELECT_Y= 
! /SELECT_Z= 
! /SELECT_RESIDUAL= 
! /START_AT_EVENT= 
! /END_AT_EVENT=
;

event_global_maximum.jpg

Examples

This command may be used to create an event, RKFlex_Max, at the GLOBAL maximum value of a signal.
1) The maximum value of the signal may be over the entire signal
2) The maximum value of the signal may be during an event sequence
3) A specific event sequence may be excluded


Create an event RKFlex_Max at the maximum knee flexion angle during the gait cycle. The gait cycle is indicated by the RHS events.
NOTE: If no events are specified in the Event Sequence, a global maximum over the whole trial will be created.

One event will be created during each gait cycle.
Event_Maximum command may be used to create multiple maximum events during an event sequence.

Example - Dialog Box

To create the RKFlex_Max event using the Event_Global_Maximum dialog box:


1. Enter information into dialog box:

Event_Name: RKFlex_Max

Select Frame Offset:0

Signal Components:X

Select an event sequence and Instance for the range:

Event Sequence Instance:0

Defined Events:RHS + RHS

Click OK
event_global_max_rkflex_max.jpg


2. Select desired signal:

Select signal from data tree Right_Knee_Angle

Click Import Selected Signals
event_global_max_rkflex_max_import.jpg

Two instances of RKFlex_Max were created, one in between each sequence of RHS+RHS.

event_global_max_rkflex_max_graph.jpg



Example - Exclude Sequence

Exclude Sequences containing these events can be used to exclude a specific sequence. In this example an event BAD was created between one sequence of RHS + RHS.

Using the same parameters as the previous example, set the Exclude Sequences containing events parameter to BAD
event_global_max_rkflex_max_exclude.jpg

Only one RKFlex_Max event was created because the second sequence containing the event BAD was excluded:

event_global_max_rkflex_max_exclude_graph.jpg



Example - Subsequence

Subsequences can be used to create an event that occurs within a sequence within a sequence. In this example RKFlex_Max was created as the maximum value between LTO + LHS when these events feel between the RHS events.

Using the same parameters as the previous example, set the Subsqeuence parameter to LTO + LHS
event_global_max_rkflex_max_subsequence.jpg

RKFlex_Max event was created between RHS events that contained the LTO to LHS subsequence.

event_global_max_rkflex_max_subsequence_graph.jpg



Version 4

Event_Global_Maximum
/Signal_Types= The type of signal to be evaluated
/Signal_Names= The names of the signals to be evaluated
/Signal_Folder= The name of the signal folder
/Event_Name= The name to be given to the threshold event
/Select_X= (True or False)Use this component of the signal
/Select_Y= (True or False)Use this component of the signal
/Select_Z= (True or False)Use this component of the signal
/Radius= The range of frames of data that must be below the maximum
/Start_At_Event= The search begins from the start event
/End_At_Event= The search ends at the end event

Dialog that pops up when pipeline selection is edited by double clicking with the left mouse button.

visual3d/documentation/pipeline/event_commands/event_global_maximum.txt · Last modified: 2025/02/20 20:59 by wikisysop