Differences

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

--- visual3d:documentation:pipeline:signal_commands:rectify [2024/06/26 20:29] – created sgranger
+++ visual3d:documentation:pipeline:signal_commands:rectify [2026/01/09 15:10] (current) – wikisysop
@@ Line 1: / Line 1: @@
 ====== Rectify ======
+====Overview====
+Rectifying a signal is a simple process that involves taking the absolute value of a bipolar signal to output a unipolar version. The **Rectify** command can be used to compute the absolute value of every element of a signal for use cases that require entirely positive signals.
-||
+Visual3D calculates signal rectification using the following formula:
-{{RectifyDlg.png}}
+x(ti)= abs(x(ti))
-Rectify a signal. Takes the absolute value of every element of a signal.
+A visual example of what a rectified signal might look like:\\
+{{:visual3d:documentation:pipeline:signal_commands:rectify_example.png|}}
-**Rectify**
+====Pipeline Command====
-**/Signal_Types=** The type of signal to be processed
+The **Rectify** command can be found in the Pipeline Workshop within the Signal Math folder as so:
-**/Signal_Names=** The names of the signals to be processed
-"**/Signal_Folder=** The name of the signal folder
-**;**
-\\
+<code>
+Rectify
+! /SIGNAL_TYPES=
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /RESULT_TYPES=
+! /RESULT_FOLDERS=PROCESSED
+! /RESULT_NAME=
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=
+;
+</code>
-\\
+====Command Parameters====
-Visual3D calculates signal rectification using the following formula:
+The parameters that can be used to control the command are as follows:
+|**Signal Types**|The type of signal to be rectified|
+|**Signal Folder**|The name of the signal to be rectified|
+|**Signal Names**|The name of the signal folder|
+|**Result Types**|The type of the resulting signal|
+|**Result Folders**|The name of the resulting folder|
+|**Result Name**|The name of the resulting signal|
+|**Apply As Suffix To Signal Name**|Add a suffix to the signal name|
+====Command Dialog====
+The command can be edited via text editor or via a dialog. The details on the command and the dialog are found below:
+{{:RectifyDlg.png}}
+====Example: Rectifying Hip Moment Signal====
+This example shows how the Rectify command can be used on a hip moment signal to show only the absolute value of each component:
+<code>
+Rectify
+/SIGNAL_TYPES=LINK_MODEL_BASED
+! /SIGNAL_FOLDER=ORIGINAL
+ /SIGNAL_NAMES=LHipMoment
+ /RESULT_TYPES=LINK_MODEL_BASED
+! /RESULT_FOLDERS=PROCESSED
+ /RESULT_NAME=LHip_Rectified
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=
+;
+</code>
-x(ti)= abs(x(ti))