Differences

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

--- visual3d:documentation:pipeline:other_commands:highlight_golf_features [2024/07/17 15:46] – created sgranger
+++ visual3d:documentation:pipeline:other_commands:highlight_golf_features [2024/11/15 19:50] (current) – [Example] wikisysop
@@ Line 1: / Line 1: @@
-====== Highlight Golf Features ======
+===== Highlight Golf Features =====
-This command highlights features of the gold swing in the animation viewer.
+This command allows users to control which gold swing features are highlighted in the animation viewer.
-===== Pipeline Command Dialog =====
+<code>
+Highlight_Golf_Features
+! /CALIBRATION_FILE=
+! /X_FACTOR=RPV::X+RTA::X
+! /CLUB_PATH=TARGET::ORIGINAL::CLUB_HEAD
+! /BALL_PATH=TARGET::ORIGINAL::BALL
+! /STANCE_PLANE=METRIC::GOLF::STANCE_PLANE
+! /SWING_PLANE=METRIC::GOLF::SWING_PLANE
+! /SWING_PLANE_ORIGIN=METRIC::GOLF::SWING_PLANE_ORIGIN
+! /HIGHLIGHT_X_FACTOR=FALSE
+! /HIGHLIGHT_CLUB_PATH=FALSE
+! /HIGHLIGHT_BALL_PATH=FALSE
+! /HIGHLIGHT_STANCE_PLANE=FALSE
+! /HIGHLIGHT_SWING_PLANE=FALSE
+;
+</code>
+==== Parameters ====
+^ Parameter ^ Description ^
+| CALIBRATION_FILE | The movement file to reference for the X-Factor. |
+| X_FACTOR | Takes two segments, a reference segment and the other segment. By default this is the Thorax relative to the Pelvis. |
+| CLUB_PATH | Takes a target representing the path of the club head. |
+| BALL_PATH | Takes a target representing the path of the ball. |
+| STANCE_PLANE | Takes a metric representing the normal vector defining the stance plane. Will accept an expression that evaluates to a 3-component vector. See also [[visual3d:documentation:pipeline:metric_commands:metric_golf_swing_plane|Metric_Golf_Swing_Plane]]. |
+| SWING_PLANE| Takes a metric representing the normal vector defining the swing plane. Will accept an expression that evaluates to a 3-component vector. See also [[visual3d:documentation:pipeline:metric_commands:metric_golf_swing_plane|Metric_Golf_Swing_Plane]]. |
+| SWING_PLANE_ORIGIN| Takes a metric representing the point of transition between stance and swing phases. |
+| HIGHLIGHT_X_FACTOR| If true, then the X-Factor will be highlighted on the animation viewer. |
+| HIGHLIGHT_CLUB_PATH| If true, then the Club Path will be highlighted on the animation viewer. |
+| HIGHLIGHT_BALL_PATH| If true, then the Ball Path will be highlighted on the animation viewer. |
+| HIGHLIGHT_STANCE_PLANE| If true, then the Stance Plane will be highlighted on the animation viewer. |
+| HIGHLIGHT_SWING_PLANE | If true, then the Swing Plane will be highlighted on the animation viewer. |
+==== Dialog ====
+This pipeline command can also be edited via the associated dialog.
 {{:GolfHighlightsDialog.jpg}}
-===== Pipeline Command =====
+==== Example ====
-**Highlight_Golf_Features**
+It is possible to use the [[visual3d:documentation:pipeline:expressions:expressions_overview|Evaluate_Expression]] command's [[visual3d:documentation:pipeline:expressions:least_squares_fitting_of_data#best_fit_plane|best_fit_plane]] and [[visual3d:documentation:pipeline:expressions:intersection_functions#project_point_on_plane|project_point_on_plane]] functions to provide parameter values for this command.
-! /CALIBRATION_FILE=
-! /X_FACTOR=RPV::X+RTA::X
-! /CLUB_PATH=TARGET::ORIGINAL::CLUB_HEAD
-! /BALL_PATH=TARGET::ORIGINAL::BALL
-! /STANCE_PLANE=METRIC::GOLF::STANCE_PLANE
-! /SWING_PLANE=METRIC::GOLF::SWING_PLANE
-! /SWING_PLANE_ORIGIN=METRIC::GOLF::SWING_PLANE_ORIGIN
-! /HIGHLIGHT_X_FACTOR=FALSE
-! /HIGHLIGHT_CLUB_PATH=FALSE
-! /HIGHLIGHT_BALL_PATH=FALSE
-! /HIGHLIGHT_STANCE_PLANE=FALSE
-! /HIGHLIGHT_SWING_PLANE=FALSE
-**;**
-===== Example =====
-It is possible to take advantage of the evaluate_expression procedures for **best_fit_plane //and//** //project point on plate'//
+<code>
+Highlight_Golf_Features
+! /CALIBRATION_FILE=
+/X_FACTOR=RPV::X+RTA::X
+/CLUB_PATH=TARGET::ORIGINAL::CLUB
+/BALL_PATH=TARGET::ORIGINAL::BALL
+/STANCE_PLANE=BEST_FIT_PLANE(TARGET::ORIGINAL::CLUBSHAFT,EVENT_LABEL::ORIGINAL::TAKEAWAY,EVENT_LABEL::ORIGINAL::BACK)
+/SWING_PLANE=BEST_FIT_PLANE(TARGET::ORIGINAL::CLUBSHAFT,EVENT_LABEL::ORIGINAL::TOP,EVENT_LABEL::ORIGINAL::DOWN)
+/SWING_PLANE_ORIGIN=PROJECT_POINT_ON_PLANE(METRIC::GOLF::SWING_CLUB,KINETIC_KINEMATIC::RPV::ProxEndPos)
+/HIGHLIGHT_X_FACTOR=TRUE
+/HIGHLIGHT_CLUB_PATH=TRUE
+/HIGHLIGHT_BALL_PATH=TRUE
+/HIGHLIGHT_STANCE_PLANE=TRUE
+/HIGHLIGHT_SWING_PLANE=TRUE
+;
+</code>
-**Highlight_Golf_Features**
+{{:SwingPlaneImage.jpg}}
+<code>
+Example 2
+Highlight_Golf_Features
 ! /CALIBRATION_FILE=
-! /X_FACTOR=RPV::X+RTA::X
+/X_FACTOR=RPV::X+RTA::X
-/CLUB_PATH=TARGET::ORIGINAL::CLUB
+/CLUB_PATH=TARGET::ORIGINAL::CLUB_2
-! /BALL_PATH=TARGET::ORIGINAL::BALL
+/BALL_PATH=TARGET::ORIGINAL::BALL
-/STANCE_PLANE=BEST_FIT_PLANE(TARGET::ORIGINAL::CLUBSHAFT,EVENT_LABEL::ORIGINAL::TAKEAWAY,EVENT_LABEL::ORIGINAL::BACK)
+/STANCE_PLANE=BEST_FIT_PLANE(TARGET::ORIGINAL::CLUB_2,EVENT_LABEL::ORIGINAL::TAKEAWAY,EVENT_LABEL::ORIGINAL::CLUB_BACK)
-/SWING_PLANE=BEST_FIT_PLANE(TARGET::ORIGINAL::CLUBSHAFT,EVENT_LABEL::ORIGINAL::TOP,EVENT_LABEL::ORIGINAL::DOWN)
+/SWING_PLANE=BEST_FIT_PLANE(TARGET::ORIGINAL::CLUB_2,EVENT_LABEL::ORIGINAL::TOP,EVENT_LABEL::ORIGINAL::IMPACT)
-/SWING_PLANE_ORIGIN=PROJECT_POINT_ON_PLANE(METRIC::GOLF::SWING_CLUB,KINETIC_KINEMATIC::RPV::ProxEndPos)
+/SWING_PLANE_ORIGIN=PROJECT_POINT_ON_PLANE(METRIC::GOLF::SWING_PLANE,KINETIC_KINEMATIC::RPV::ProxEndPos)
 /HIGHLIGHT_X_FACTOR=TRUE
+/HIGHLIGHT_X_FACTOR_PROJECTION=TRUE
 /HIGHLIGHT_CLUB_PATH=TRUE
 /HIGHLIGHT_BALL_PATH=TRUE
 /HIGHLIGHT_STANCE_PLANE=TRUE
 /HIGHLIGHT_SWING_PLANE=TRUE
-**;**
+;
-\\
+</code>
-{{:SwingPlaneImage.jpg}}
+{{GolfSwingPlane2.png}}