Differences

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

--- visual3d:documentation:pipeline:event_commands:event_tpr_signal [2024/06/19 12:49] – sgranger
+++ visual3d:documentation:pipeline:event_commands:event_tpr_signal [2025/03/03 18:17] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{tpr signal is based on matching data from a range of frames against the same (or a different signal). when the two ranges match an event label is created at the midpoint of the range. for example, if one occurrence of heel strike has been identified, this command can be used to determine all other heel strike events in a file.
+====== Event TPR Signal ======
-a description of the use of tpr for determining gait events when a force platform signal is present is presented in the following article:
+==== Overview ====
+TPR signal is based on matching data from a range of frames against the same (or a different signal). When the two ranges match an Event Label is created at the midpoint of the range. For example, if one occurrence of heel strike has been identified, this command can be used to determine all other heel strike events in a file.
-**stanhope sj, kepple tm, mcguire da, roman nl.**(1990) "a kinematic-based technique for event time determination during gait." medical and biological engineering and computing 28:355-360.
+A description of the use of TPR for determining gait events when a force platform signal is present is presented in the following article:
-===== event tpr signal command details =====
+**Stanhope SJ, Kepple TM, McGuire DA, Roman NL.**(1990) "A Kinematic-Based Technique for Event Time Determination During Gait." Medical and Biological Engineering and Computing 28:355-360.
-the command details are below:
+==== Pipeline Command ====
-|**event_tpr_signal**        |                                                                                                              |
+<code>
-|**/pattern_file=**          |the file from which to find the pattern signal. if this is blank, the pattern signal is taken from each trial.|
+Event_TPR_Signal
-|**/pattern_type=**          |the type of signal used as the test signal.                                                                   |
+/SIGNAL_TYPES=
-|**/pattern_signal=**        |the names of the signals used as the test signal.                                                             |
+! /SIGNAL_FOLDER=ORIGINAL
-|**/pattern_folder=**        |the name of the signal folder used as the test signal.                                                        |
+/SIGNAL_NAMES=
-|**/signal_types=**          |the type of signal to be compared with the test signal.                                                       |
+! /PATTERN_FILE=
-|**/signal_names=**          |the names of the signals to be compared with the test signal.                                                 |
+! /PATTERN_TYPE=
-|**/signal_folder=**         |the name of the signal folder compared with the test signal.                                                  |
+! /PATTERN_FOLDER=ORIGINAL
-|**/pattern_event_name=**    |the event at which the pattern signal is centered.                                                            |
+! /PATTERN_SIGNAL=
-|**/pattern_event_instance=**|the occurence of the event at which the pattern signal is centered.                                           |
+/PATTERN_EVENT_NAME=
-|**/event_name=**            |the name to be given to the threshold event.                                                                  |
+! /PATTERN_EVENT_INSTANCE=1
-|**/select_x=**              |(true or false)use this component of the signals.                                                             |
+! /SELECT_X=FALSE
-|**/select_y=**              |(true or false)use this component of the signals.                                                             |
+! /SELECT_Y=FALSE
-|**/select_z=**              |(true or false)use this component of the signals.                                                             |
+! /SELECT_Z=FALSE
-|**/tpr_window=**            |the range of frames of data used for the comparison.                                                          |
+! /TPR_WINDOW=7
-|**/tolerance=**             |the "goodness of fit" for the match.                                                                          |
+! /TOLERANCE=20.0
+/EVENT_NAME=
+;
+</code>
+==== Event TPR Signal Command Details ====
+The command details are below:
+|**Event_TPR_Signal**        |                                                                                                              |
+|**/Pattern_File=**          |The file from which to find the pattern signal. If this is blank, the pattern signal is taken from each trial.|
+|**/Pattern_Type=**          |The type of signal used as the test signal.                                                                   |
+|**/Pattern_Signal=**        |The names of the signals used as the test signal.                                                             |
+|**/Pattern_Folder=**        |The name of the signal folder used as the test signal.                                                        |
+|**/Signal_Types=**          |The type of signal to be compared with the test signal.                                                       |
+|**/Signal_Names=**          |The names of the signals to be compared with the test signal.                                                 |
+|**/Signal_Folder=**         |The name of the signal folder compared with the test signal.                                                  |
+|**/Pattern_Event_Name=**    |The event at which the pattern signal is centered.                                                            |
+|**/Pattern_Event_Instance=**|The occurence of the event at which the pattern signal is centered.                                           |
+|**/Event_Name=**            |The name to be given to the threshold event.                                                                  |
+|**/Select_X=**              |(True or False)Use this component of the signals.                                                             |
+|**/Select_Y=**              |(True or False)Use this component of the signals.                                                             |
+|**/Select_Z=**              |(True or False)Use this component of the signals.                                                             |
+|**/TPR_Window=**            |The range of frames of data used for the comparison.                                                          |
+|**/Tolerance=**             |The "goodness of fit" for the match.                                                                          |
 \\
-a dialog will pop up when pipeline selection is edited by double clicking with the left mouse button (see diagram below).
+A dialog will pop up when pipeline selection is edited by double clicking with the left mouse button (see diagram below).
-eventtprdlg.jpg
+{{:Eventtprdlg.jpg}}
-a few points to consider when using this command:
+A few points to consider when using this command:
-  * the **pattern file** specifies the file that is to be used for the test signal.
+  * The **Pattern file** specifies the file that is to be used for the test signal.
-    * if **rotate through files** is selected then the test signal is created from each file and used for the tpr of that file.
+    * If **Rotate Through Files** is selected then the test signal is created from each file and used for the TPR of that file.
-    * if a file is specified then the test signal is defined from that one file and used for all other files.
+    * If a file is specified then the test signal is defined from that one file and used for all other files.
-  * changing the **radius** will change the number of frames used.
+  * Changing the **radius** will change the number of frames used.
-  * the parameter signal_types and signal_names are required parameters and need to be specified. this can be done by editing the command via the "text" button or importing the selected signals through the "import selected signals" button.
+  * The parameter SIGNAL_TYPES and SIGNAL_NAMES are required parameters and need to be specified. This can be done by editing the command via the "Text" button or importing the selected signals through the "Import Selected Signals" button.
-  * if you wish to save the tpr signal for further use in other cmo files for pattern matching, then use the dialog to set the parameters and then click **save tpr signal** button. the button will not appear until you have completed setting the parameters. after clicking the button, a browser will open and you can select a folder and filename for your tpr signal file. the file extension will be .tps. go to [[visual3d:documentation:pipeline:event_commands:event_tpr_file|event_tpr_file]] for details on the command to apply the saved .tps file.
+  * If you wish to save the TPR signal for further use in other cmo files for pattern matching, then use the dialog to set the parameters and then click **Save TPR Signal** button. The button will not appear until you have completed setting the parameters. After clicking the button, a browser will open and you can select a folder and filename for your TPR signal file. The file extension will be .tps. Go to [[Visual3D:Documentation:Pipeline:Event_Commands:Event_TPR_File|Event_TPR_File]] for details on the command to apply the saved .tps file.
-===== example =====
+==== Example ====
-below is an example script:
+Below is an example script:
 <code>
-! create a lhs event from a marker on the heel. we assume that one instance of lhs
+! Create a LHS event from a marker on the heel. We assume that one instance of LHS
-! has already been identified. the command will find the other instances of lhs
+! has already been identified. The command will find the other instances of LHS
 ! based on the pattern
-event_tpr_signal
+Event_TPR_Signal
-/pattern_file=c:\demo files\example 1\walk1.c3d
+/PATTERN_FILE=C:\demo files\Example 1\walk1.c3d
-/pattern_type=target
+/PATTERN_TYPE=TARGET
-/pattern_signal=lheel
+/PATTERN_SIGNAL=LHEEL
-! /pattern_folder=original
+! /PATTERN_FOLDER=ORIGINAL
-/pattern_event_name=lhs
+/PATTERN_EVENT_NAME=LHS
-! /pattern_event_instance=1
+! /PATTERN_EVENT_INSTANCE=1
-! /select_x=false
+! /SELECT_X=FALSE
-/select_y=true
+/SELECT_Y=TRUE
-/select_z=true
+/SELECT_Z=TRUE
-! /tpr_window=7
+! /TPR_WINDOW=7
-/tolerance=20
+/TOLERANCE=20
-/signal_types=target
+/SIGNAL_TYPES=TARGET
-/signal_names=lheel
+/SIGNAL_NAMES=LHEEL
-! /signal_folder=original
+! /SIGNAL_FOLDER=ORIGINAL
-/event_name=lhs
+/EVENT_NAME=LHS
 ;
 </code>
-}}