HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » event_commands » Event Save TPR Signal
visual3d:documentation:pipeline:event_commands:event_save_tpr_signal

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:documentation:pipeline:event_commands:event_save_tpr_signal [2025/04/28 14:27] – [Dialog] wikisysopvisual3d:documentation:pipeline:event_commands:event_save_tpr_signal [2025/04/29 14:02] (current) – [Dialog] wikisysop
Line 1: Line 1:
 =====Event Save TPR Signal===== =====Event Save TPR Signal=====
  
-====Overview====+=====Overview=====
 The 'Event_Save_TPR_Signal' command is used to create and save a Target Pattern Recognition (TPR) file. This file captures the shape of a signal surrounding a specific event and is later used in pattern-matching commands like 'Event_TPR_Signal' or 'Event_TPR_File'. The 'Event_Save_TPR_Signal' command is used to create and save a Target Pattern Recognition (TPR) file. This file captures the shape of a signal surrounding a specific event and is later used in pattern-matching commands like 'Event_TPR_Signal' or 'Event_TPR_File'.
   * Works by taking a window frames around an event and saving that signal segment as a template than can be used for event detection in other tirals.   * Works by taking a window frames around an event and saving that signal segment as a template than can be used for event detection in other tirals.
Line 11: Line 11:
  
  
-====Pipeline Command====+=====Pipeline Command=====
 The pipeline command is shown below as seen in the Visual3D application: The pipeline command is shown below as seen in the Visual3D application:
  
Line 28: Line 28:
  
  
-====Command Parameters====+=====Command Parameters=====
  
 The following table shows the command parameters and descriptions: The following table shows the command parameters and descriptions:
Line 43: Line 43:
  
  
-====Dialog====+=====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. 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.
Line 49: Line 49:
 {{:visual3d:documentation:pipeline:event_commands:tpr_signal_save_dlg.png?400|}} {{:visual3d:documentation:pipeline:event_commands:tpr_signal_save_dlg.png?400|}}
  
-These options are reflected in the parameters table. +  * **File Name**: The name of the output where the TPR signal will be saved. 
-====Examples==== +  * **Pattern File**: File with applied TPR used to generate events in new signal. 
-===Simple example===+  * **Display Short Filenames**: If checked, shows abbreviated versions of file names in dropdowns. 
 +  * **Pattern Type**: The type of signal which the TPR algorithm is applied to (ANALOG, LINK_MODEL_BASED, etc.) 
 +  * **Pattern Folder**: Folder name where the pattern signal is stored. 
 +  * **Pattern Signal Name**: Name of signal which has the TPR algorithm applied to it. 
 +  * **Pattern Event**: Event which TPR algorithm bases off of. 
 +  * **Event Instance**: Specifies which instance of the event to label. 
 +  * **Radius Samples**: Defines the width of the matching window around the event in samples. 
 +=====Examples===== 
 +The following example shows the use of Event_Save_TPR_Signal command in the Visual3D application.
  
-Showing functionality of the command, using a diagram possibly to show output.+==== Example 1: Saving file for matching opposite-side Gait Events =====
  
-===Complex example===+On the [[visual3d:documentation:pipeline:event_commands:event_tpr_signal|Event_TPR_Signal]] command page, the example goes through applying the TPR signal to a certain pattern file to apply to another trial. 
  
-Combine with other commands and show step-by-step process for frequent use case+This command, **Event_Save_TPR_Signal** provides a way save that pattern file to serve as a **template** (e.g. you need to apply the command to multiple files to generate opposite side events).  
 + 
 +In the case of this example, the TPR signal used LHS events to determine RHS events from the opposite foot. So the process would be that you select a file with LHS Events, select a specific trial and fill in the other parameters the same way as the [[visual3d:documentation:pipeline:event_commands:event_tpr_signal|Event_TPR_Signal]] command. 
 + 
 +<code> 
 +Event_Save_TPR_Signal 
 +/FILE_NAME=C:/.../HeelStrikePattern.tpr 
 +/PATTERN_FILE= 
 +/SIGNAL_TYPES=LINK_MODEL_BASED 
 +! /SIGNAL_FOLDER=ORIGINAL 
 +/SIGNAL_NAMES=L Hip Angle 
 +/PATTERN_EVENT_NAME=LHS 
 +! /PATTERN_EVENT_INSTANCE=1 
 +! /TPR_RADIUS=7 
 +; 
 +</code> 
 + 
 +This can now be used as the pattern file when looking to specify right side events or apply LHS events to a file that does not have any yet. This file can be used via the [[visual3d:documentation:pipeline:event_commands:event_tpr_file|Event_TPR_File]] command.
  
-====Notes==== 
-- Important considerations (anything included in the page before the reformat) 
  
  
visual3d/documentation/pipeline/event_commands/event_save_tpr_signal.1745850454.txt.gz · Last modified: 2025/04/28 14:27 by wikisysop