HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » pipeline » pipeline_commands » Pipeline Control Commands
visual3d:documentation:pipeline:pipeline_commands:pipeline_control_commands

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:documentation:pipeline:pipeline_commands:pipeline_control_commands [2025/05/28 14:48] – wikisysopvisual3d:documentation:pipeline:pipeline_commands:pipeline_control_commands [2025/05/28 15:03] (current) – wikisysop
Line 1: Line 1:
 ====== Pipeline Control Commands ====== ====== Pipeline Control Commands ======
  
-==== Parameter Commands ====+===== Parameter Commands =====
 An important feature of the pipeline is the ability to create and use Pipeline Parameters. An important feature of the pipeline is the ability to create and use Pipeline Parameters.
  
 A Pipeline PARAMETER is a way to store a text string for use in Pipeline commands. In one sense 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 signals. A Pipeline PARAMETER is a way to store a text string for use in Pipeline commands. In one sense 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 signals.
  
-=== Set_Pipeline_Parameter ===+==== Set_Pipeline_Parameter ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter|Set_Pipeline_Parameter]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:set_pipeline_parameter|Set_Pipeline_Parameter]]
Line 12: Line 12:
 Pipeline parameters can be created in the pipeline and used as variables in other commands in the same pipeline. Pipeline parameters can be created in the pipeline and used as variables in other commands in the same pipeline.
  
-=== Set_Pipeline_Parameter_To_Folder_Path ===+==== Set_Pipeline_Parameter_To_Folder_Path ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_Folder_Path|Set_Pipeline_Parameter_To_Folder_Path]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_Folder_Path|Set_Pipeline_Parameter_To_Folder_Path]]
Line 18: Line 18:
 Set a pipeline parameter to be the Folder path. Set a pipeline parameter to be the Folder path.
  
-=== Set_Pipeline_Parameter_To_List_Of_Tagged_Files ===+==== Set_Pipeline_Parameter_To_List_Of_Tagged_Files ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_List_Of_Tagged_Files|Set_Pipeline_Parameter_To_List_Of_Tagged_Files]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_List_Of_Tagged_Files|Set_Pipeline_Parameter_To_List_Of_Tagged_Files]]
Line 24: Line 24:
 Creates a pipeline parameter containing the names of the TAGGED files. Creates a pipeline parameter containing the names of the TAGGED files.
  
-=== Set_Pipeline_Parameter_To_List_Of_Files ===+==== Set_Pipeline_Parameter_To_List_Of_Files ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_List_Of_Files|Set_Pipeline_Parameter_To_List_Of_Files]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_List_Of_Files|Set_Pipeline_Parameter_To_List_Of_Files]]
Line 30: Line 30:
 In order to process multiple files it can be useful to identify all of the files in a folder path and assign the names to a pipeline parameter. In order to process multiple files it can be useful to identify all of the files in a folder path and assign the names to a pipeline parameter.
  
-=== Set_Pipeline_Parameter_To_List_Of_Signal_Names ===+==== Set_Pipeline_Parameter_To_List_Of_Signal_Names ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_List_Of_Signal_Names|Set_Pipeline_Parameter_To_List_Of_Signal_Names]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_List_Of_Signal_Names|Set_Pipeline_Parameter_To_List_Of_Signal_Names]]
Line 36: Line 36:
 In order to process multiple signals it can be useful to identify all of the signals of a given type. In order to process multiple signals it can be useful to identify all of the signals of a given type.
  
-=== Set_Pipeline_Parameter_To_Data_Value ===+==== Set_Pipeline_Parameter_To_Data_Value ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_Data_Value|Set_Pipeline_Parameter_To_Data_Value]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_To_Data_Value|Set_Pipeline_Parameter_To_Data_Value]]
Line 42: Line 42:
 Create a pipeline parameter with the values of a signal Create a pipeline parameter with the values of a signal
  
-=== Set_Pipeline_Parameter_From_Expression ===+==== Set_Pipeline_Parameter_From_Expression ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_From_Expression|Set_Pipeline_Parameter_From_Expression]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_From_Expression|Set_Pipeline_Parameter_From_Expression]]
Line 48: Line 48:
 Create a pipeline parameter from an expression Create a pipeline parameter from an expression
  
-=== Set_Pipeline_Parameter_From_For_Loop ===+==== Set_Pipeline_Parameter_From_For_Loop ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_From_For_Loop|Set_Pipeline_Parameter_From_For_Loop]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Set_Pipeline_Parameter_From_For_Loop|Set_Pipeline_Parameter_From_For_Loop]]
Line 54: Line 54:
 Create a pipeline parameter to mimic a traditional for loop. Create a pipeline parameter to mimic a traditional for loop.
  
-=== Prompt_For_Pipeline_Parameter_Value ===+==== Prompt_For_Pipeline_Parameter_Value ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Prompt_For_Pipeline_Parameter_Value|Prompt_For_Pipeline_Parameter_Value]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Prompt_For_Pipeline_Parameter_Value|Prompt_For_Pipeline_Parameter_Value]]
Line 60: Line 60:
 Prompts a dialog for user to create a pipeline parameter with the specified parameter value. Prompts a dialog for user to create a pipeline parameter with the specified parameter value.
  
-=== Prompt_For_Multiple_Pipeline_Parameter_Values ===+==== Prompt_For_Multiple_Pipeline_Parameter_Values ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Prompt_For_Multiple_Pipeline_Parameter_Values|Prompt_For_Multiple_Pipeline_Parameter_Values]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Prompt_For_Multiple_Pipeline_Parameter_Values|Prompt_For_Multiple_Pipeline_Parameter_Values]]
Line 66: Line 66:
 Prompts a dialog for user to create multiple pipeline parameters with the specified parameter values. Prompts a dialog for user to create multiple pipeline parameters with the specified parameter values.
  
-=== Get_Pipeline_Parameter_Count ===+==== Get_Pipeline_Parameter_Count ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Get_Pipeline_Parameter_Count|Get_Pipeline_Parameter_Count]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Get_Pipeline_Parameter_Count|Get_Pipeline_Parameter_Count]]
Line 72: Line 72:
 Get a count of the number of parameter values in a parameter Get a count of the number of parameter values in a parameter
  
-=== Get_Pipeline_Parameter_Index_Value ===+==== Get_Pipeline_Parameter_Index_Value ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Get_Pipeline_Parameter_Index_Value|Get_Pipeline_Parameter_Index_Value]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Get_Pipeline_Parameter_Index_Value|Get_Pipeline_Parameter_Index_Value]]
Line 78: Line 78:
 Create a pipeline parameter containing the value of one component (e.g. index) from another parameter. Create a pipeline parameter containing the value of one component (e.g. index) from another parameter.
  
-=== For_Each and End_For_Each ===+===== Control Commands ===== 
 +==== For_Each and End_For_Each ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|for_each_and_end_for_each]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|for_each_and_end_for_each]]
Line 84: Line 85:
 Executes pipeline commands multiple times for each item in a list of items. It is not identical with a "for loop" or "do loop" in a programming language because the items must be explicitly defined as ITEMS in the command. This has some powerful consequences because it means that you can "loop" through disconnected items or strings as easily as using a structured list. Executes pipeline commands multiple times for each item in a list of items. It is not identical with a "for loop" or "do loop" in a programming language because the items must be explicitly defined as ITEMS in the command. This has some powerful consequences because it means that you can "loop" through disconnected items or strings as easily as using a structured list.
  
-=== Conditional_Statement and Conditional_Statement_End ===+==== Conditional_Statement and Conditional_Statement_End ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Conditional_Statement|Conditional_Statement]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Conditional_Statement|Conditional_Statement]]
Line 90: Line 91:
 Executes pipeline commands that occur between Conditional_Statement and Conditional_Statement_End. The intermediate commands will only be executed if the EXPRESSION in the Conditional_Statement command is TRUE (returns any value other than 0). Executes pipeline commands that occur between Conditional_Statement and Conditional_Statement_End. The intermediate commands will only be executed if the EXPRESSION in the Conditional_Statement command is TRUE (returns any value other than 0).
  
-=== Halt_Pipeline_On_Error ===+==== Halt_Pipeline_On_Error ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Halt_Pipeline_On_Error|Halt_Pipeline_On_Error]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Halt_Pipeline_On_Error|Halt_Pipeline_On_Error]]
Line 96: Line 97:
 Another debugging feature of the Pipeline Workshop is the ability to halt execution of commands on the "first error". When the first error occurs, commands will stop executing and the errors and warnings will appear in the processing results window. Another debugging feature of the Pipeline Workshop is the ability to halt execution of commands on the "first error". When the first error occurs, commands will stop executing and the errors and warnings will appear in the processing results window.
  
-=== Pipeline_Breakpoint ===+==== Pipeline_Breakpoint ====
  
 [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Pipeline_Breakpoint|Pipeline_Breakpoint]] [[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Pipeline_Breakpoint|Pipeline_Breakpoint]]
Line 102: Line 103:
 This command will place a breakpoint in the pipeline that will allow the user to review the results from the previous pipeline commands and resume when you feel you are ready to resume or halt if you are not. This command will place a breakpoint in the pipeline that will allow the user to review the results from the previous pipeline commands and resume when you feel you are ready to resume or halt if you are not.
  
-=== Comment ===+==== Comment ====
  
 <HTML><ul></HTML> <HTML><ul></HTML>
Line 112: Line 113:
 **;** **;**
  
-=== Manage File Merge ===+==== Manage File Merge ====
  
 +[[https://wiki.has-motion.com/doku.php?id=visual3d:documentation:pipeline:pipeline_commands:Manage_File_Merge|Manage_File_Merge]]
 +
 +This command merges multiple files together, such as motion capture files with force plate recordings from the same trial. 
visual3d/documentation/pipeline/pipeline_commands/pipeline_control_commands.1748443727.txt.gz · Last modified: 2025/05/28 14:48 by wikisysop