Differences

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

--- visual3d:documentation:pipeline:metric_commands:metric_golf_swing_plane [2024/07/12 14:04] – created sgranger
+++ visual3d:documentation:pipeline:metric_commands:metric_golf_swing_plane [2025/08/11 16:34] (current) – wikisysop
@@ Line 1: / Line 1: @@
-====== Metric_Golf_Swing_Plane ======
+====== Metric Golf Swing Plane ======
-The golf swing plane is defined as the best fit plane to a time series of points of a TARGET or LANDMARK, usually defined within an event sequence.
+===== Overview =====
-The purpose of the event sequence is to allow the computation of different planes through the swing. For example, a plane during takeaway.
+The **Metric_Golf_Swing_Plane** command computes the best fit plane to the trajectory of a TARGET or LANDMARK signal, usually defined within a specific event sequence (e.g., the golf swing phase).
-**Metric_Golf_Swing_Plane**
+The underlying calculation uses Visual3D's [[visual3d:documentation:pipeline:expressions:least_squares_fitting_of_data|Best Fit Plane]] method- a least squares fitting procedure that determines a plane which best fits the path of a point from  a START event to an END event. This plane is defined by four coefficients (//a, b, c, and d//) in the equation.
+//ax + by + cz + d = 0, where (a, b, c) is the normal vector to the plane.//
+In a standard Best Fit Plane calculation, the normal vector can point in either of two opposite directions. In the case of this command, the calculation includes an additional check to ensure that the plane's normal always points away from the pelvis- providing a consistent and meaningful orientation for golf swing analysis.
+===== Pipeline Command =====
+The command below is as seen in the Visual3D application. Parameters allow you to control various details of the command.
+<code>
+Metric_Golf_Swing_Plane
+/SIGNAL_TYPES=
+! /SIGNAL_FOLDER=ORIGINAL
+! /SIGNAL_NAMES=
+! /RESULT_FOLDER=PROCESSED
+/RESULT_NAME=
+! /EVENT_SEQUENCE=
+! /EXCLUDE_EVENTS=
+;
+</code>
+===== Command Parameters =====
+The following table shows the command parameters and descriptions:
+|**Parameter**|**Description**|
+|**/SIGNAL_TYPES=**|Specifies the type of signal to use for the plane fitting (e.g. TARGET, LANDMARK)|
+|**! /SIGNAL_FOLDER=ORIGINAL**|The folder containing the input signal. Default is ORIGINAL.|
+|**! /SIGNAL_NAMES=**|Name of the signal (e.g., CLUB)|
+|**! /RESULT_FOLDER= PROCESSED**|Folder where the resulting metric will be stored. Default is PROCESSED.|
+|**/RESULT_NAME=**|Name assigned to the resulting swing plane metric.|
+|**!/ EVENT_SEQUENCE=**|Defines the start and end events for the swing segment to be analyzed (e.g., TAKEAWAY + BACK)|
+|**! /EXCLUDE_EVENTS=**|Events that should be excluded from the calculation.|
+===== Dialog =====
+This command can be edited in the text editor or in dialog form. To open the dialog, either click Edit in the Pipeline Workshop or double-click the command.
+{{:visual3d:documentation:pipeline:metric_commands:metric_golf_swing_plane_dlg.png?600|}}
+The dialog options are:
+  * **Result Name**: Name of the calculated swing plane metric.
+  * **Result Folder**: Destination folder for the result (default PROCESED).
+  * **Signal Type**: Choose TARGET or LANDMARK
+  * **Signal Folder**: Select the folder containing the signal.
+  * **Signal Name**: Specify the signal to analyze (e.g., CLUB)
+  * **Signal Component**: Choose the axis components (X, Y, Z, R) or ALL.
+  * **Defined Events**: List of available events.
+  * **Event Sequence**: Defines the sequence from start to end events for the plane fitting.
+  * **Exclude Events**: Events to be excluded from the analysis.
+===== Examples =====
+The following examples will go through the use of the **Metric_Golf_Swing_Plane** command in the Visual3D application.
+==== Example 1: Swing Plane during Takeaway ====
+This example computes the stance plane using the club's motion between the TAKEAWAY and BACK events.
+<code>
+Metric_Golf_Swing_Plane
 /SIGNAL_TYPES=TARGET
-SIGNAL_NAMES=CLUB
+/SIGNAL_NAMES=CLUB
 /SIGNAL_FOLDER=ORIGINAL
 /RESULT_NAME=STANCE_CLUB
-/RESULT_FOLDER=GOLF
 /EVENT_SEQUENCE=TAKEAWAY+BACK
 ! /EXCLUDE_EVENTS=
-**;**
+;
-or a plane at the beginning of the backswing.
+</code>
-**Metric_Golf_Swing_Plane**
+==== Example 2: Swing Plane at the Start of the Downswing ====
+This example computes the swing plane using the club's motion between the TOP and DOWN events.
+<code>
+Metric_Golf_Swing_Plane
 /SIGNAL_TYPES=TARGET
 /SIGNAL_NAMES=CLUB
@@ Line 24: / Line 90: @@
 /EVENT_SEQUENCE=TOP+DOWN
 ! /EXCLUDE_EVENTS=
-**;**
+;
-The dialog for this command is:
+</code>
-{{SwingPlaneDialog.jpg}}
+==== Workflow Extension Example: Displaying stance and swing planes ====
-\\
+Once you have calculated the stance and swing phase, you can use Highlight_Golf_Features to visualize them alongside other golf metrics.
-To display the two swing planes use the command Highlight_Golf_Features:
-**Highlight_Golf_Features**
+<code>
+Highlight_Golf_Features
 ! /CALIBRATION_FILE=
 ! /X_FACTOR=RPV::X+RTA::X
-CLUB_PATH=TARGET::ORIGINAL::CLUB
+/CLUB_PATH=TARGET::ORIGINAL::CLUB
-! /BALL_PATH=TARGET::ORIGINAL::BALL
+! /BALL_PATH+TARGET::ORIGINAL::BALL
 /STANCE_PLANE=METRIC::GOLF::STANCE_CLUB
 /SWING_PLANE=METRIC::GOLF::SWING_CLUB
@@ Line 44: / Line 110: @@
 /HIGHLIGHT_STANCE_PLANE=TRUE
 /HIGHLIGHT_SWING_PLANE=TRUE
-**;**
+;
-{{GolfHighlightsDialog.jpg}}
+</code>
+This is shown in dialog form below:
+{{:GolfHighlightsDialog.jpg}}
+Due to the dataset used for this example, it has been difficult to generalize a good view of the swing planes. An example image is shown here:
+{{:SwingPlaneImage.jpg?400}}
-\\
-Given the dataset, it has been difficult to generalize a good view of the swing planes. One image is below.
-{{SwingPlaneImage.jpg}}
+----
+[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]