Differences

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

--- visual3d:documentation:pipeline:event_commands:event_save_tpr_signal [2024/06/19 12:49] – sgranger
+++ visual3d:documentation:pipeline:event_commands:event_save_tpr_signal [2025/04/17 15:48] (current) – wikisysop
@@ Line 1: / Line 1: @@
-under construction...
+=====Event TPR Signal=====
+====Overview====
+- Describe the functionality of the command
+- Placement within pipeline folders
+- Use cases
+- Requirements for use (i.e gait event labels can only be used if force assignments exist)
+====Pipeline Command====
+<code>
+Event_TPR_Signal
+/SIGNAL_TYPES=
+! /SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=
+! /PATTERN_FILE=
+! /PATTERN_TYPE=
+! /PATTERN_FOLDER=ORIGINAL
+! /PATTERN_SIGNAL=
+/PATTERN_EVENT_NAME=
+! /PATTERN_EVENT_INSTANCE=1
+! /SELECT_X=FALSE
+! /SELECT_Y=FALSE
+! /SELECT_Z=FALSE
+! /TPR_WINDOW=7
+! /TOLERANCE=20.0
+/EVENT_NAME=
+;
+</code>
+====Command Parameters====
+The following table shows the command parameters and descriptions:
+|**Parameter**   |**Description**|
+|**/SIGNAL_TYPE=**|Specifies the type of signal being analyzed (Analog, Link Model Based, etc.)|
+|**! /SIGNAL_FOLDER=ORIGINAL**|The folder where the signal is stored.|
+|**/SIGNAL_NAMES=**|Defines the specific signal name within the selected type|
+|**! /PATTERN_FILE=**|...|
+|**! /PATTERN_TYPE=**|...|
+|**! /PATTERN_FOLDER=ORIGINAL**|...|
+|**! /PATTERN_SIGNAL=**|...|
+|**/PATTERN_EVENT_NAME=**|...|
+|**! /PATTERN_EVENT_ISNTANCE=1**|...|
+|**! /SELECT_(X,Y,Z)=FALSE**|Determines which component of the signal should be evaluated (TRUE/FALSE)|
+|**! /TPR_WINDOW=7**|Set number of windows which the TPR algorithm will base it's predictions off of.|
+|**! /TOLERANCE=20.0**|"Goodness of fit" for the match.|
+|**/EVENT_NAME=**|The Event Name to be placed on the labels for the generated events.|
+====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.
+{{:visual3d:documentation:pipeline:event_commands:event_tpr_signal_dialog_box.png?400|}}
+====Examples====
+===Simple example===
+Showing functionality of the command, using a diagram possibly to show output.
+===Complex example===
+Combine with other commands and show step-by-step process for frequent use case
+====Notes====
+- Important considerations (anything included in the page before the reformat)