Differences

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

--- visual3d:documentation:pipeline:signal_commands:signal_magnitude [2024/06/19 12:53] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:signal_magnitude [2025/08/08 20:29] (current) – Added an example and noted that the result appears as a DERIVED signal. wikisysop
@@ Line 1: / Line 1: @@
-under construction...
+====== Signal Magnitude ======
+The Signal_Magnitude command computes the vector magnitude of a multi-component signal for each frame of data. Concretely, given a 3-component vector V = (x, y, z) its magnitude is:
+<code>
+|V| = √(x^2 + y^2 + z^2).
+</code>
+===== Pipeline Command =====
+<code>
+Signal_Magnitude
+! /SIGNAL_TYPES=
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /RESULT_FOLDERS=PROCESSED
+! /RESULT_NAME=
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=
+;
+</code>
+The resulting signal will be a [[visual3d:documentation:visual3d_signal_types:derived_data_type|DERIVED]] signal and will be placed into the /RESULT_FOLDERS with /RESULT_NAME.
+==== Example ====
+The speed of the model's COG can be computed as the magnitude of its [[visual3d:documentation:pipeline:model_based_data_commands:model_cog_velocity|velocity signal]].
+<code>
+Signal_Magnitude
+/SIGNAL_TYPES=LINK_MODEL_BASED
+/SIGNAL_FOLDER=ORIGINAL
+/SIGNAL_NAMES=COG_Velocity
+! /RESULT_FOLDERS=PROCESSED
+/RESULT_NAME=_Magnitude
+/APPLY_AS_SUFFIX_TO_SIGNAL_NAME=TRUE
+;
+</code>
+The resulting signal will then be available as DERIVED::PROCESSED::COG_Velocity_Magnitude.
+===== See Also =====
+Go back to [[visual3d:documentation:pipeline:signal_commands:signal_commands_overview|Signal Commands]].