Differences

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

--- visual3d:documentation:pipeline:general_information:pipeline_introduction [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:general_information:pipeline_introduction [2024/07/17 15:45] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{{{{{**this page is under construction! so it's still being developed, and is a combination of the following wiki pages:**
+====== Pipeline Introduction ======
-**https://www.c-motion.com/v3dwiki/index.php?title=tutorial:_command_pipeline#pipeline_command_syntax:**
+**THIS PAGE IS UNDER CONSTRUCTION! So it's still being developed, and is a combination of the following wiki pages:**
-**https://www.c-motion.com/v3dwiki/index.php?title=visual3d_pipeline**
+**https://www.c-motion.com/v3dwiki/index.php?title=Tutorial:_Command_Pipeline#Pipeline_Command_Syntax:**
-**https://www.c-motion.com/v3dwiki/index.php?title=pipeline_parameters**
+**https://www.c-motion.com/v3dwiki/index.php?title=Visual3D_Pipeline**
-**https://www.c-motion.com/v3dwiki/index.php?title=wildcard**
+**https://www.c-motion.com/v3dwiki/index.php?title=Pipeline_Parameters**
-====== introduction ======
+**https://www.c-motion.com/v3dwiki/index.php?title=Wildcard**
-every step you perform in visual3d through the user interface, can also be accomplished using a pipeline command. the pipeline commands are a way of automating the processing procedure.
+===== Introduction =====
-the pipeline is a command language, not a scripting language. this essentially means you have a series of commands that act as building blocks, you just have to string them together. for example, if you want to calculate range of motion of the ankle angle, you need to define the ankle angle, calculate the maximum of the ankle angle, calculate the minimum of the ankle angle, and subtract the min from the max.
+Every step you perform in Visual3D through the user interface, can also be accomplished using a pipeline command. The pipeline commands are a way of automating the processing procedure.
-once you have created a pipeline, it can be saved as a [[visual3d:documentation:definitions:v3s|v3s file]] so the processing procedure can be repeated for the next processing session.
+The pipeline is a command language, not a scripting language. This essentially means you have a series of commands that act as building blocks, you just have to string them together. For example, if you want to calculate range of motion of the ankle angle, you need to define the ankle angle, calculate the maximum of the ankle angle, calculate the minimum of the ankle angle, and subtract the min from the max.
-====== pipeline workshop ======
+Once you have created a pipeline, it can be saved as a [[Visual3D:Documentation:Definitions:V3S|V3S file]] so the processing procedure can be repeated for the next processing session.
-you can open the pipeline workshop by going to pipeline -> workshop or clicking on the button on the [[visual3d:overview:toolbar#visual3d_pipeline|toolbar]].
+===== Pipeline Workshop =====
-**the pipeline workshop has three sections:**
+You can open the pipeline workshop by going to Pipeline -> Workshop or clicking on the button on the [[Visual3D:Getting_Started:Toolbar#Visual3D_Pipeline|toolbar]].
-|pipelineworkshop.png  |* **left:**\\   * list of available commands\\ * **center:**\\   * main pipeline\\   * list of commands being used\\ * **right:**\\   * preview of selected command  |
+**The pipeline workshop has three sections:**
-commands can be moved into the main pipeline by using the add **>>** button. command can be reordered in any sequence using the up/down arrows. pipelines can be saved to be used again so processing is consistent between subjects.
+|{{:PipelineWorkshop.png}}  |* **Left:**\\   * List of available commands\\ * **Center:**\\   * Main Pipeline\\   * List of commands being used\\ * **Right:**\\   * Preview of selected command  |
-===== editing a command =====
+Commands can be moved into the Main Pipeline by using the Add **>>** button. Command can be reordered in any sequence using the up/down arrows. Pipelines can be saved to be used again so processing is consistent between subjects.
-|pipelineworkshop_editgui.png      |when you highlight a command in the **main pipeline** and click **edit** a dialog will appear to edit the command.    |
+==== Editing a Command ====
-|pipelineworkshop_textedit.png  |when you highlight a command in the **main pipeline** and click **text** a text box will appear to edit the command.  |
-====== pipeline command ======
+|{{:PipelineWorkshop_EditGUI.png}}      |When you highlight a command in the **Main Pipeline** and click **Edit** a dialog will appear to edit the command.    |
+|{{:PipelineWorkshop_TextEdit.png}}  |When you highlight a command in the **Main Pipeline** and click **Text** a text box will appear to edit the command.  |
-every pipeline command has a text edit option (not all commands have gui - or user interface). the command text is always set up as follows:
+===== Pipeline Command =====
-**command name**\\
+Every pipeline command has a text edit option (not all commands have GUI - or user interface). The command text is always set up as follows:
-**/parameter=**\\
-**! /default_parameter=**\\
+**Command Name**\\
+**/PARAMETER=**\\
+**! /DEFAULT_PARAMETER=**\\
 **;**\\
-the command name will always appear first, and the semicolon defines the end of the pipeline command. the body of the command contains the parameters.
+The command name will always appear first, and the semicolon defines the end of the pipeline command. The body of the command contains the parameters.
-any line that starts with an exclamation point ! is not read, it is seen as a comment line. if a parameter is has an exclamation point in front of it, the default value will be used. to change the default value, you must delete the exclamation point and type the desired value to the right of the equals sign for that parameter.
+Any line that starts with an exclamation point ! is not read, it is seen as a comment line. If a parameter is has an exclamation point in front of it, the default value will be used. To change the default value, you must delete the exclamation point and type the desired value to the right of the equals sign for that parameter.
-any line that does not start with an exclamation point defines a required parameter.
+Any line that does not start with an exclamation point defines a required parameter.
-each parameter must start with a slash.
+Each parameter must start with a slash.
-==== special characters ====
+=== Special Characters ===
-  * **!** - if this is the first character of a line, the line is considered a comment. if the ! is at the beginning of a variable name, the default value of the variable is used
+  * **!** - if this is the first character of a line, the line is considered a comment. If the ! is at the beginning of a variable name, the default value of the variable is used
   * **/** - indicates a command variable
-  * **+** - is a delimeter separating entries. for example, 1+2 indicates that the variable as two values (1 and 2).
+  * **+** - is a delimeter separating entries. For example, 1+2 indicates that the variable as two values (1 and 2).
-  * **&** - indicates a concatenation. for example, this&that will be interpreted in the pipeline as thisthat
+  * **&** - indicates a concatenation. For example, this&that will be interpreted in the pipeline as thisthat
   * ***** - indicates a [[|wildcard]] (or multiplication)
-when defining signal names or pipeline parameters, never use a mathematical operator or a special character in the signal name. it's also best to avoid spaces (use an underscore **_** instead).
+When defining signal names or pipeline parameters, NEVER use a mathematical operator or a special character in the signal name. It's also best to avoid spaces (use an underscore **_** instead).
-====== pipeline parameters ======
+===== Pipeline Parameters =====
-pipeline parameters can be used to pass data from one command to another. they can be used in many different ways.
+Pipeline parameters can be used to pass data from one command to another. They can be used in many different ways.
-a pipeline parameter is a way to store a text string for use in pipeline commands. it is similar to specifying a global variable, such as body weight, that could be used in computations. it is actually much more flexible than that in the pipeline. the visual3d pipeline commands permit multiple entries on a single line, and since the entire line can be represented as a string, a single pipeline parameter can represent multiple entries.
+A PIPELINE PARAMETER is a way to store a text string for use in Pipeline commands. It is similar to specifying a global variable, such as body weight, that could be used in computations. It is actually much more flexible than that in the pipeline. The Visual3D pipeline commands permit multiple entries on a single line, and since the entire line can be represented as a string, a single PIPELINE PARAMETER can represent multiple entries.
-a simple example is to prompt the user for a folder path, then export data to that folder path:
+A simple example is to prompt the user for a folder path, then export data to that folder path:
-first the user is prompted for the folder path:
+First the user is prompted for the folder path:
-**[[visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter_to_folder_path|set_pipeline_parameter_to_folder_path]]**\\
+**[[Visual3D:Documentation:Pipeline:Pipeline_Commands:Set_Pipeline_Parameter_To_Folder_Path|Set_Pipeline_Parameter_To_Folder_Path]]**\\
-**/parameter_name=**export_folder\\
+**/PARAMETER_NAME=**EXPORT_FOLDER\\
-**/parameter_value=**\\
+**/PARAMETER_VALUE=**\\
 **;**\\
-the user has defined the parameter name as export_folder. for this command, if the parameter_value is set blank, it will prompt the user for a folder location. then everywhere it says export_folder in the rest of the script, the text will be replaced with the folder path.
+The user has defined the parameter name as EXPORT_FOLDER. For this command, if the PARAMETER_VALUE is set blank, it will prompt the user for a folder location. Then everywhere it says EXPORT_FOLDER in the rest of the script, the text will be replaced with the folder path.
-**[[visual3d:documentation:pipeline:file_commands:export_data_to_ascii_file|export_data_to_ascii_file]]**\\
+**[[Visual3D:Documentation:Pipeline:File_Commands:Export_Data_To_ASCII_File|Export_Data_To_Ascii_File]]**\\
-**/file_name=::export_folder&**lankleangle.txt\\
+**/FILE_NAME=::EXPORT_FOLDER&**LAnkleAngle.txt\\
 ...\\
 **;**\\
-when referencing a pipeline parameter in a script, you must type two colons before the parameter. if you are concatenating the pipeline parameter with a string (such as lankleangle.txt), you must type an ampersand & after the pipeline parameter.
+When referencing a pipeline parameter in a script, you must type two colons before the parameter. If you are concatenating the pipeline parameter with a string (such as LAnkleAngle.txt), you must type an ampersand & after the pipeline parameter.
-note sure if an ampersand is necessary? it's always safe to include it anyway **&::export_folder&** will always work
+Note sure if an ampersand is necessary? It's always safe to include it anyway **&::EXPORT_FOLDER&** will always work
-|notes:                                                                                                                                                                                                                                                                                                             |
+|NOTES:                                                                                                                                                                                                                                                                                                             |
-|* different commands have different behavior depending on what they are intended to do. in another command, leaving a parameter blank will not necessarily bring up a prompt.\\ * the "..." is just skipping over other pipeline parameters for the purpose of this tutorial, do not do this in an actual script.  |
+|* Different commands have different behavior depending on what they are intended to do. In another command, leaving a parameter blank will not necessarily bring up a prompt.\\ * The "..." is just skipping over other pipeline parameters for the purpose of this tutorial, do not do this in an actual script.  |
-====== expressions ======
+===== Expressions =====
-the [[visual3d:documentation:pipeline:expressions:overview|evaluate_expression]] command allows you to type out an expression using mathematical operators. it's probably the most powerful pipeline command in visual3d, but it takes time to learn the syntax. the full syntax available within [[visual3d:documentation:pipeline:expressions:overview|evaluate_expression]] is described [[visual3d:documentation:pipeline:expressions:overview|here]].
+The [[Visual3D:Documentation:Pipeline:Expressions:Expressions_Overview|Evaluate_Expression]] command allows you to type out an expression using mathematical operators. It's probably the most powerful pipeline command in Visual3D, but it takes time to learn the syntax. The full syntax available within [[Visual3D:Documentation:Pipeline:Expressions:Expressions_Overview|Evaluate_Expression]] is described [[Visual3D:Documentation:Pipeline:Expressions:Expressions_Overview|here]].
-many commands have pipeline parameters that accept expressions using the same syntax as the [[visual3d:documentation:pipeline:expressions:overview|evaluate_expression]] command.
+Many commands have pipeline parameters that accept expressions using the same syntax as the [[Visual3D:Documentation:Pipeline:Expressions:Expressions_Overview|Evaluate_Expression]] command.
-===== signal names =====
+==== Signal Names ====
-==== signal names as expressions ====
+=== Signal Names as Expressions ===
-**in an [[visual3d:documentation:pipeline:expressions:overview|expression]], a signal is referenced by signal type, signal folder, signal name, and component.**
+**In an [[Visual3D:Documentation:Pipeline:Expressions:Expressions_Overview|expression]], a signal is referenced by Signal Type, Signal Folder, Signal Name, and component.**
-**signals are referenced by signal_type::signal_folder::signal_name**
+**Signals are referenced by SIGNAL_TYPE::SIGNAL_FOLDER::SIGNAL_NAME**
-|**this signal would be referenced derived::inverse_kinematics::lft_rot1**\\ \\ if you look at the data tree in signals and events, you will see the highest level folders are the signal type. the type is defined in visual3d, and you cannot create your own type. example: derived\\ \\ the sub folder is the signal folder. for most types you can defined your own folder names (as opposed to the default, ex. event_label can only have the folder original). example: inverse_kinematics\\ \\ each folder contains signals, they're considered the signal name. example: lft_rot1|datatree_pipeline.png|
+|**This signal would be referenced DERIVED::INVERSE_KINEMATICS::LFT_Rot1**\\ \\ If you look at the data tree in Signals and Events, you will see the highest level folders are the Signal Type. The Type is defined in Visual3D, and you cannot create your own Type. Example: DERIVED\\ \\ The sub folder is the Signal Folder. For most Types you can defined your own folder names (as opposed to the default, ex. Event_Label can only have the Folder ORIGINAL). Example: INVERSE_KINEMATICS\\ \\ Each folder contains signals, they're considered the Signal Name. Example: LFT_Rot1|{{:DataTree_Pipeline.png}}|
-**important:** you will notice there are two colons in between the type, folder and signal name. two colons are also used to represent a pipeline parameter, but they mean different things.
+**Important:** You will notice there are two colons in between the type, folder and signal name. Two colons are also used to represent a pipeline parameter, but they mean different things.
-==== signal names as parameters ====
+=== Signal Names as Parameters ===
-many commands have the following parameters
+Many commands have the following parameters
 <code>
-/signal_types= the types of the signals
+/Signal_Types= The types of the signals
-/signal_folder= the name of the signal folder
+/Signal_Folder= The name of the signal folder
-/signal_names= the names of the signals
+/Signal_Names= The names of the signals
 </code>
-this means the command requires the type, folder and signal names specified in these parameters (instead of using the expression syntax).
+This means the command requires the type, folder and signal names specified in these parameters (instead of using the Expression syntax).
+===== FAQ =====
-====== faq ======
+|Frequently Asked Questions:                                                                                                                                                                                                                                                                                                                                                 |
+|You cannot create your own parameters for a command. For example, the default parameters for the Automatic Gait Events command are the following:\\ \\ Automatic_Gait_Events\\ \\ ! /FRAME_WINDOW=8\\ \\ ! /USE_TPR=TRUE\\ \\ ;\\ \\ You **CANNOT** add a parameter:\\ \\ Automatic_Gait_Events\\ \\ ! /FRAME_WINDOW=8\\ \\ ! /USE_TPR=TRUE\\ \\ **/EVENT_NAME=TEST**\\ \\ ;|
-|frequently asked questions:                                                                                                                                                                                                                                                                                                                                                 |
-|you cannot create your own parameters for a command. for example, the default parameters for the automatic gait events command are the following:\\ \\ automatic_gait_events\\ \\ ! /frame_window=8\\ \\ ! /use_tpr=true\\ \\ ;\\ \\ you **cannot** add a parameter:\\ \\ automatic_gait_events\\ \\ ! /frame_window=8\\ \\ ! /use_tpr=true\\ \\ **/event_name=test**\\ \\ ;|
-}}}}}}}}