Differences

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

--- visual3d:documentation:pipeline:signal_commands:distance_parallel_to_path [2024/07/17 15:11] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:distance_parallel_to_path [2024/11/05 16:16] (current) – Cleaned up and working towards Pipeline Command template. wikisysop
@@ Line 1: / Line 1: @@
-====== Distance_Parallel_To_Path ======
+===== Distance Parallel To Path =====
-||
+The command Distance_Parallel_To_Path computes the dot product of a vector from the start to point p, with the straight line path defined as the position at Event1 to position at Event2. In the figure below, the blue line is the parallel distance from the point P.
-The command Distance_Parallel_To_Path computes the dot product of a vector from the start to point p, with the straight line path defined as the Position at Event1 to position at Event2
 {{:On_off_axis_path.gif}}
-In the above figure, the blue line is the parallel distance from the point P. For example:
+==== Example: Unnormalized Distance for Target ====
-\\
-**Distance_Parallel_To_Path**
-**/SIGNAL_TYPES=**TARGET
-**/SIGNAL_NAMES=**MID_PSIS
-**! /SIGNAL_FOLDER=**ORIGINAL
-**/RESULT_NAME=**PSIS_DISTANCE
-**! /RESULT_FOLDER=**PROCESSED
-**/EVENT_NAME_START=**START
-**/EVENT_NAME_STOP=**STOP
-**/NORMALIZE_TO_DISTANCE=**FALSE
+The pipeline command below will calculate the distance travelled by the MID_PSIS [[visual3d:documentation:c3d_signal_types:target_data_type|TARGET]] parallel to its path between the [[visual3d:documentation:c3d_signal_types:event_label_data_type|events]] START and STOP. This distance will not be normalized.
-**;**
+<code>
+Distance_Parallel_To_Path
+/SIGNAL_TYPES=TARGET
+/SIGNAL_NAMES=MID_PSIS
+! /SIGNAL_FOLDER=ORIGINAL
+/RESULT_NAME=PSIS_DISTANCE
+! /RESULT_FOLDER=PROCESSED
+/EVENT_NAME_START=START
+/EVENT_NAME_STOP=STOP
+/NORMALIZE_TO_DISTANCE=FALSE
+;
+</code>
-\\
+==== Notes ====
-Normalize to distance results in dividing the resulting parallel distance to the distance along the straight path.
+If the NORMALIZE_TO_DISTANCE parameter is true then the resulting parallel distance is divided by the distance along the straight path.
+==== See Also ===
+Visual3D also contains commands for the [[visual3d:documentation:pipeline:signal_commands:distance_perpendicular_to_path|Distance Perpendicular to Path]] and [[visual3d:documentation:pipeline:signal_commands:distance_along_path|Distance Along Path]]. Or return to the [[visual3d:documentation:pipeline:signal_commands:signal_commands_overview|Signal Commands]] overview.