Differences

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

--- visual3d:documentation:pipeline:general_information:pipeline_commands_reference [2024/07/17 15:42] – removed sgranger
+++ visual3d:documentation:pipeline:general_information:pipeline_commands_reference [2024/10/09 15:53] (current) – Smoothed over formatting. wikisysop
@@ Line 1: / Line 1: @@
+====== Pipeline Commands Reference ======
+Here you will find a listing of the Visual3D command categories, each with links to a full list of commands.
+==== File Commands ====
+A list of all commands are found here: **[[Visual3D:Documentation:Pipeline:File_Commands:File_Commands_Overview|File Commands]]**
+File commands are used on any files within the workspace or referenced by the pipeline. file commands are organized based on three categories:
+  * [[Visual3D:Documentation:Pipeline:File_Commands:File_Management_Overview|File_Management]]: Commands that act on Files
+  * [[Visual3D:Documentation:Pipeline:File_Commands:File_Open_and_Import_Commands|File Open/Import]]:Commands for opening data files and command for importing signals into existing data files.
+  * [[Visual3D:Documentation:Pipeline:File_Commands:File_Save_and_Export_Commands|File Save/Export]]: Commands for saving the Visual3D Workspace and commands for exporting c3d files and signals.
+==== Event Commands ====
+A list of all commands are found here: **[[Visual3D:Documentation:Pipeline:Event_Commands:Event_Commands_Overview|Event Commands]]**
+Event commands are used in the Visual3D pipeline to identify and manage signal events in your data. Event commands are separated into two categories:
+  * [[Visual3D:Documentation:Pipeline:Event_Commands:Event_Commands_Overview|Event Creation]]: Commands for creating events.
+  * [[Visual3D:Documentation:Pipeline:Event_Commands:Event_Commands_Overview|Event Management]]: Commands for managing events, such as renaming, copying, deleting, etc.
+==== Force Commands ====
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Force_Commands:Force_Commands_Review|Force Commands]]**
+Force commands are used in the Visual3D pipeline to process force signals from c3d files. Force commands are separated into four categories:
+  * [[Visual3D:Documentation:Pipeline:Force_Commands:Force_Commands_Review|Force Platforms]]: Commands for creating/modifying Force Platforms
+  * [[Visual3D:Documentation:Pipeline:Force_Commands:Force_Commands_Review|Force Structures]]: Commands for creating/modifying Force Structures
+  * [[Visual3D:Documentation:Pipeline:Force_Commands:Force_Commands_Review|Force Assignment]]: Commands for creating/modifying Force Assignments
+  * [[Visual3D:Documentation:Pipeline:Force_Commands:Force_Commands_Review|Miscellaneous]]: additional force commands
+==== Metric Commands ====
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_Commands_Overview|Metric Commands]]**
+Metric commands are used in the Visual3D pipeline to calculate, compute, and find discrete quantitative values, known as metrics. These commands are separated into four categories:
+  * [[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_Commands_Overview#Metric_Computation|Metric Computation]]: Advanced computation commands.
+  * [[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_Commands_Overview#Metric_Math|Metric Math]]: mathematical commands.
+  * [[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_Commands_Overview#Metric_Events|Metric Events]]: Metric values about events, or found at or between events.
+  * [[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_Commands_Overview#Miscellaneous|Miscellanous]]: other metric commands.
+==== Signal Commands ====
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Signal_Commands:Signal_Commands_Overview|Signal Commands]]**
+Signal commands can be used in the Visual3D pipeline on all signal types (eg., forces, linke_model_based, etc.), when specified in the command. Signal commands are separated into four main categories:
+  * [[Visual3D:Documentation:Pipeline:Signal_Commands:Signal_Commands_Overview#Signal_Math|Signal Math]]: mathematical commands for any signal (time-based or not).
+  * [[Visual3D:Documentation:Pipeline:Signal_Commands:Signal_Commands_Overview#Signal/Data_Management|Signal Data/Management]]: Organizing signal folders, names, and data.
+  * [[Visual3D:Documentation:Pipeline:Signal_Commands:Signal_Commands_Overview#Signal_Filter|Signal Filter]]: Filtering signals.
+  * [[Visual3D:Documentation:Pipeline:Signal_Commands:Signal_Commands_Overview#Signal_Process|Signal Process]]: other signal processing commands.
+==== Model Commands ====
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Model_Commands:Model_Commands_Overview|Model Commands]]**
+Model commands are used to build and modify models applied to c3d motion files. Model commands are separated into three main categories:
+  * [[Visual3D:Documentation:Pipeline:Model_Commands:Model_Commands_Overview#Model_Management|Model Management]]
+  * [[Visual3D:Documentation:Pipeline:Model_Commands:Model_Commands_Overview#Model_Building|Model Building]]
+  * [[Visual3D:Documentation:Pipeline:Model_Commands:Model_Commands_Overview#Model_Based_Data_Computation|Model Based Data Computation]]
+==== Real Time Commands ====
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Other_Commands:Real_Time_Commands|Real Time Commands]]**
+==== Report Commands ====
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Report_Commands:Report_Commands_Overview|Report Commands]]**
+Report commands are used to control the 'Reports' page in the Visual3D workspace. Report commands are separated into three main categories:
+  * [[Visual3D:Documentation:Pipeline:Report_Commands:Report_Commands_Overview|Report Format]]: modify the template of your report.
+  * [[Visual3D:Documentation:Pipeline:Report_Commands:Report_Commands_Overview|Report Graph Format]]: modify the data and format in reported graphs.
+  * [[Visual3D:Documentation:Pipeline:Report_Commands:Report_Commands_Overview|Export Data]]: Exporting data, graphs, templates and reports.
+==== Pipeline Control Commands ====
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Pipeline_Commands:Pipeline_Control_Commands|Pipeline Control Commands]]**
+Pipeline control commands mainly use parameters to store multiple text strings or numerical values, making it easy to loop through different signals or files for a series of commands. These control commands set, prompt, and read parameters for easy pipeline control.
+==== Model Based Data Computation ====
+The command Compute_Model_Based_Data will compute a signal using a model's segment, Kinetic_Kinematic data. Details and examples of this command can be found here: **[[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:Compute_Model_Based_Data|Compute_Model_Based_Data]]**
+==== Other Commands ====
+A full list of miscellaneous commands can be found here: **[[Visual3D:Documentation:Pipeline:Other_Commands:Other_Commands|Other Commands]]**
+==== Meta Commands ====
+A meta-command is a Visual3D pipeline into which Parameters can be passed. The meta-command should be stored in a folder labeled Meta-Commands, which is located in the Visual3D Plugins Folder. The header in the meta-command defines the data that should be passed. For more details and examples, see here: **[[Visual3D:Documentation:Pipeline:Meta_Commands:Meta_Commands_Overview|Meta Commands]]**.
+==== Plugins ====
+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. These are placed in the Plugins folder in Visual3D's program files. More details about Plugins are found here: **[[Visual3D:Documentation:Pipeline:Plugins:Plugins_Overview|Pipeline Commands:Plugins]]**