Differences

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

--- visual3d:documentation:pipeline:general_information:pipeline_commands_reference [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:general_information:pipeline_commands_reference [2024/10/09 15:53] (current) – Smoothed over formatting. wikisysop
@@ Line 1: / Line 1: @@
-here you will find a listing of the visual3d command categories, each with links to a full list of commands.
+====== Pipeline Commands Reference ======
-===== file commands =====
+Here you will find a listing of the Visual3D command categories, each with links to a full list of commands.
-a list of all commands are found here: **[[visual3d:documentation:pipeline:file_commands:file_commands_overview|file commands]]**
+==== 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:
+A list of all commands are found here: **[[Visual3D:Documentation:Pipeline:File_Commands:File_Commands_Overview|File Commands]]**
-  * [[visual3d:documentation:pipeline:file_commands:file_management_overview|file_management]]: commands that act on files
+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_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_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.
-  * [[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 ====
-===== event commands =====
+A list of all commands are found here: **[[Visual3D:Documentation:Pipeline:Event_Commands:Event_Commands_Overview|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:
-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.
-  * [[visual3d:documentation:pipeline:event_commands:event_commands_overview|event creation]]: commands for creating events.
+==== Force Commands ====
-  * [[visual3d:documentation:pipeline:event_commands:event_commands_overview|event management]]: commands for managing events, such as renaming, copying, deleting, etc.
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Force_Commands:Force_Commands_Review|Force Commands]]**
-===== force commands =====
+Force commands are used in the Visual3D pipeline to process force signals from c3d files. Force commands are separated into four categories:
-a list of all commands can be found here: **[[visual3d:documentation:pipeline:force_commands:force_commands_review|force commands]]**
+  * [[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
-force commands are used in the visual3d pipeline to process force signals from c3d files. force commands are separated into four categories:
+==== Metric Commands ====
-  * [[visual3d:documentation:pipeline:force_commands:force_commands_review|force platforms]]: commands for creating/modifying force platforms
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_Commands_Overview|Metric Commands]]**
-  * [[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 =====
+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:
-a list of all commands can be found here: **[[visual3d:documentation:pipeline:metric_commands:metric_commands_overview|metric commands]]**
+  * [[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.
-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:
+==== Signal Commands ====
-  * [[visual3d:documentation:pipeline:metric_commands:metric_commands_overview#metric_computation|metric computation]]: advanced computation commands.
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Signal_Commands:Signal_Commands_Overview|Signal 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 =====
+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:
-a list of all commands can be found here: **[[visual3d:documentation:pipeline:signal_commands:overview|signal commands]]**
+  * [[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.
-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:
+==== Model Commands ====
-  * [[visual3d:documentation:pipeline:signal_commands:overview#signal_math|signal math]]: mathematical commands for any signal (time-based or not).
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Model_Commands:Model_Commands_Overview|Model Commands]]**
-  * [[visual3d:documentation:pipeline:signal_commands:overview#signal/data_management|signal data/management]]: organizing signal folders, names, and data.
-  * [[visual3d:documentation:pipeline:signal_commands:overview#signal_filter|signal filter]]: filtering signals.
-  * [[visual3d:documentation:pipeline:signal_commands:overview#signal_process|signal process]]: other signal processing commands.
-===== model commands =====
+Model commands are used to build and modify models applied to c3d motion files. Model commands are separated into three main categories:
-a list of all commands can be found here: **[[visual3d:documentation:pipeline:model_commands:model_commands_overview|model commands]]**
+  * [[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]]
-model commands are used to build and modify models applied to c3d motion files. model commands are separated into three main categories:
+==== Real Time Commands ====
-  * [[visual3d:documentation:pipeline:model_commands:model_commands_overview#model_management|model management]]
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Other_Commands:Real_Time_Commands|Real Time Commands]]**
-  * [[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 =====
+==== Report Commands ====
-a list of all commands can be found here: **[[visual3d:documentation:pipeline:other_commands:real_time_commands|real time commands]]**
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Report_Commands:Report_Commands_Overview|Report Commands]]**
-===== report commands =====
+Report commands are used to control the 'Reports' page in the Visual3D workspace. Report commands are separated into three main categories:
-a list of all commands can be found here: **[[visual3d:documentation:pipeline:report_commands:report_commands_overview|report commands]]**
+  * [[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.
-report commands are used to control the 'reports' page in the visual3d workspace. report commands are separated into three main categories:
+==== Pipeline Control Commands ====
-  * [[visual3d:documentation:pipeline:report_commands:report_commands_overview|report format]]: modify the template of your report.
+A list of all commands can be found here: **[[Visual3D:Documentation:Pipeline:Pipeline_Commands:Pipeline_Control_Commands|Pipeline Control Commands]]**
-  * [[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 =====
+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.
-a list of all commands can be found here: **[[visual3d:documentation:pipeline:pipeline_commands:pipeline_control_commands|pipeline control commands]]**
+==== Model Based Data Computation ====
-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.
+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]]**
-===== model based data computation =====
+==== Other Commands ====
-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]]**
+A full list of miscellaneous commands can be found here: **[[Visual3D:Documentation:Pipeline:Other_Commands:Other_Commands|Other Commands]]**
-===== other commands =====
+==== Meta Commands ====
-a full list of miscellaneous commands can be found here: **[[visual3d:documentation:pipeline:other_commands:other_commands|other 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]]**.
-===== meta commands =====
+==== Plugins ====
-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]]**.
+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]]**
-===== 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]]**