Differences

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

--- visual3d:documentation:pipeline:plugins:plugins_overview [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:plugins:plugins_overview [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{==== plugins overview ====
+====== Plugins Overview ======
-visual3d has a modest scripting language that allows automated processing of data. using scripts, custom data processing (that is not available through the graphical user interface) has been implemented for selected customers.
+=== Plugins Overview ===
-functionality includes executing user defined .exe files and user defined .dll's. this provides users with the ability to generate custom analyses while also taking advantage of the data visualization and reporting capabilities of visual3d.
+Visual3D has a modest scripting language that allows automated processing of data. Using scripts, custom data processing (that is not available through the graphical user interface) has been implemented for selected customers.
-in many cases, however, custom plugins have been written by c-motion for specific customers. if you are eligible to download a plugin, you will find it on your downloads page on our website.
+Functionality includes executing user defined .exe files and user defined .dll's. This provides users with the ability to generate custom analyses while also taking advantage of the data visualization and reporting capabilities of Visual3D.
-=== finding the plugin in the pipeline command tree ===
+In many cases, however, custom plugins have been written by C-Motion for specific customers. If you are eligible to download a plugin, you will find it on your downloads page on our Website.
-the visual3d properties contains the folder path for the plugins. check to see that the plugin folder is pointed to the folder on disk containing your plugins.
+== Finding the plugin in the Pipeline Command Tree ==
-==== compute 3pt angle ====
+The Visual3D properties contains the Folder path for the plugins. Check to see that the Plugin Folder is pointed to the folder on disk containing your plugins.
-compute an angle when 3 markers are in space, assuming that one of the markers is the vertex of the angle. in the following example 1 marker is attached to the shank, 1 marker is attached at the knee, and 1 marker is attached to the thigh; presumably all markers are placed laterally on the leg.
+=== Compute 3pt Angle ===
-**compute 3pt angle**
+Compute an angle when 3 markers are in space, assuming that one of the markers is the vertex of the angle. In the following example 1 marker is attached to the Shank, 1 marker is attached at the knee, and 1 marker is attached to the thigh; presumably all markers are placed laterally on the leg.
-**/signal_types**=target+target+target
-**/signal_names**=rsk1+rknee+rth1
+**Compute 3pt Angle**
-**/signal_folder**=original+original+original
+**/SIGNAL_TYPES**=TARGET+TARGET+TARGET
-**/plugin_result_signal_name**=knee_angle
+**/SIGNAL_NAMES**=RSK1+RKNEE+RTH1
-**/plugin_result_signal_type**=derived
+**/SIGNAL_FOLDER**=ORIGINAL+ORIGINAL+ORIGINAL
-**/projection_plane**=3d
+**/PLUGIN_RESULT_SIGNAL_NAME**=KNEE_ANGLE
-**/use_right_hand_rule**=true
+**/PLUGIN_RESULT_SIGNAL_TYPE**=DERIVED
-**/use_0_to_360_degrees**=true
+**/PROJECTION_PLANE**=3D
-**/bypass_dialog**=false
+**/USE_RIGHT_HAND_RULE**=TRUE
+**/USE_0_TO_360_DEGREES**=TRUE
+**/BYPASS_DIALOG**=FALSE
 **;**
-if the dialog has not been bypassed, the following will appear revealing the options for the command.
+If the dialog has not been bypassed, the following will appear revealing the options for the command.
-ptangledialog.gif
+{{:3ptAngleDialog.gif}}
-  - the angle can be projected onto one of the three principal planes or can be left in 3d space.
+  - The angle can be projected onto one of the three principal planes or can be left in 3D space.
-  - the angle can be represented from plus/minus 180 degrees or 0 to 360 degrees
+  - The angle can be represented from plus/minus 180 degrees or 0 to 360 degrees
-  - the angle can use either a right hand or left hand convention
+  - The angle can use either a right hand or left hand convention
-==== compute 4pt angle ====
+=== Compute 4pt Angle ===
-compute an angle when 2 markers are attached to one segment and 2 markers are attached to another segment. in the following example 2 markers are attached to the shank and 2 markers are attached to the thigh; presumably all markers are placed laterally on the leg.
+Compute an angle when 2 markers are attached to one segment and 2 markers are attached to another segment. In the following example 2 markers are attached to the Shank and 2 markers are attached to the thigh; presumably all markers are placed laterally on the leg.
-**compute 4pt angle**
+**Compute 4pt Angle**
-**/signal_types**=target+target+target+target
+**/SIGNAL_TYPES**=TARGET+TARGET+TARGET+TARGET
-**/signal_names**=rsk1+rsk2+rth1+rth2
+**/SIGNAL_NAMES**=RSK1+RSK2+RTH1+RTH2
-**/signal_folder**=original+original+original+original
+**/SIGNAL_FOLDER**=ORIGINAL+ORIGINAL+ORIGINAL+ORIGINAL
-**/plugin_result_signal_name**=knee_angle
+**/PLUGIN_RESULT_SIGNAL_NAME**=KNEE_ANGLE
-**/plugin_result_signal_type**=derived
+**/PLUGIN_RESULT_SIGNAL_TYPE**=DERIVED
-**/projection_plane**=3d
+**/PROJECTION_PLANE**=3D
-**/use_right_hand_rule**=true
+**/USE_RIGHT_HAND_RULE**=TRUE
-**/use_0_to_360_degrees**=true
+**/USE_0_TO_360_DEGREES**=TRUE
-**/bypass_dialog**=false
+**/BYPASS_DIALOG**=FALSE
 **;**
-if the dialog has not been bypassed, the following will appear revealing the options for the command.
+If the dialog has not been bypassed, the following will appear revealing the options for the command.
-ptangledialog.gif
+{{:4ptAngleDialog.gif}}
-  - the angle can be projected onto one of the three principal planes or can be left in 3d space.
+  - The angle can be projected onto one of the three principal planes or can be left in 3D space.
-  - the angle can be represented from plus/minus 180 degrees or 0 to 360 degrees
+  - The angle can be represented from plus/minus 180 degrees or 0 to 360 degrees
-  - the angle can use either a right hand or left hand convention
+  - The angle can use either a right hand or left hand convention
-==== plugin average selected signals ====
+=== Plugin Average Selected Signals ===
-this is a plugin used to demonstrate the construction of plug-ins to visual3d; plugins need to be downloaded separately. visual3d plugin that finds the average of the selected signal. it will process x, y, and z components. script parameter description and values:
+This is a plugin used to demonstrate the construction of plug-ins to Visual3D; plugins need to be downloaded separately. Visual3D plugin that finds the average of the selected signal. It will process X, Y, and Z components. Script Parameter Description and Values:
-**plugin average selected signals**
+**Plugin Average Selected Signals**
-**/signal_types=** the top level folder in the data tree is named with the ”type” of signal. this parameter identifies the signal to be processed. (example: analog, target, etc.)
+**/SIGNAL_TYPES=** The top level folder in the data tree is named with the ”type” of signal. This parameter identifies the signal to be processed. (Example: Analog, Target, etc.)
-**/signal_folder=**original subfolder location of the signal to be processed.
+**/SIGNAL_FOLDER=**ORIGINAL Subfolder location of the signal to be processed.
-**/signal_names=** specific signal in the signal folder to process. default is all signals in the specified type and signal folder.
+**/SIGNAL_NAMES=** Specific signal in the signal folder to process. Default is all signals in the specified type and signal folder.
-**/plugin_result_signal_type**=derived name where results will be placed.
+**/PLUGIN_RESULT_SIGNAL_TYPE**=DERIVED Name where results will be placed.
-**/plugin_result_signal_name=** name of the resulting signal.
+**/PLUGIN_RESULT_SIGNAL_NAME=** Name of the resulting signal.
-note: this plugin supports & rdquor;import checked signals from tree” for example, to average 3 targets
+Note: this plugin supports & rdquor;Import Checked Signals from Tree” For example, to average 3 targets
-**plugin average selected signals**
+**Plugin Average Selected Signals**
-**/signal_types**=target+target+target
+**/SIGNAL_TYPES**=TARGET+TARGET+TARGET
-**/signal_names**=rft1+rft2+rft3
+**/SIGNAL_NAMES**=RFT1+RFT2+RFT3
-**/signal_folder**=original
+**/SIGNAL_FOLDER**=ORIGINAL
-**/plugin_result_signal_name**=rft_avg
+**/PLUGIN_RESULT_SIGNAL_NAME**=RFT_AVG
-**/plugin_result_signal_type**=derived
+**/PLUGIN_RESULT_SIGNAL_TYPE**=DERIVED
 **;**
-}}}}