Differences

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

--- visual3d:documentation:pipeline:signal_commands:distance_perpendicular_to_path [2024/07/17 15:23] – sgranger
+++ visual3d:documentation:pipeline:signal_commands:distance_perpendicular_to_path [2024/11/05 16:39] (current) – Cleaned up and working towards Pipeline Command template. wikisysop
@@ Line 1: / Line 1: @@
-====== Distance Perpendicular To Path ======
+===== Distance Perpendicular To Path =====
-||
+The command Distance_Perpendicular_To_Path computes the perpendicular distance from a point along a path (P in the figure below) to a straight path defined as the position at Event1 to position at Event2. In the figure below, the red line is the perpendicular distance from the point P.
-The command Distance_Perpendicular_To_Path computes the perpendicular distance from a point along a path (P in the figure above) to a straight path defined as the Position at Event1 to position at Event2.
 {{:On_off_axis_path.gif}}
-In the above figure, the red line is the perpendicular distance from the point P. For example:
+==== Example: Unnormalized Distance for Target ====
-\\
-**Distance_Perpendicular_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
+The pipeline command below will calculate the distance travelled by the MID_PSIS [[visual3d:documentation:c3d_signal_types:target_data_type|TARGET]] perpendicular to its path between the [[visual3d:documentation:c3d_signal_types:event_label_data_type|events]] START and STOP. This distance will not be normalized.
-**/NORMALIZE_TO_DISTANCE=**FALSE
+<code>
+Distance_Perpendicular_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 perpendicular distance to the distance along the straight path
+If the NORMALIZE_TO_DISTANCE parameter is true then the resulting perpendicular distance is divided by the distance along the straight path.
+==== See Also ===
+Visual3D also contains commands for the [[visual3d:documentation:pipeline:signal_commands:distance_parallel_to_path|Distance Parallel 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.