HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » tutorials » pipeline » Command Pipeline
visual3d:tutorials:pipeline:command_pipeline

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:tutorials:pipeline:command_pipeline [2024/07/26 19:01] – [Syntax for using a Pipeline Parameter in a another Pipeline Command:] wikisysopvisual3d:tutorials:pipeline:command_pipeline [2025/01/15 19:30] (current) – [Prerequisites] wikisysop
Line 3: Line 3:
 ===== Objectives ===== ===== Objectives =====
  
-The objective of this Tutorial is to demonstrate the [[Visual3D:Documentation:Pipeline:Pipeline_Overview|Command Processing Pipeline]]. Tutorial #3 has two main objectives:+The main objective of this tutorial is to demonstrate Visual3D's [[Visual3D:Documentation:Pipeline:Pipeline_Overview|Command Processing Pipeline]]. You will learn how to:
  
-  * Teach you how to use the command processing pipeline. +  * Use the command processing pipeline; and 
-  * Introduce you to working with Visual3D pipeline commands.+  * Work with Visual3D pipeline commands.
  
 +If you prefer, a video tutorial is available outlining the same process. It is available at this link: [[https://youtu.be/K0tWmFYWpGc?feature=shared|Visual3D Tutorial Video 3: Command Pipeline]]
 ===== Overview ===== ===== Overview =====
  
-The Command Processing Pipeline provides access to the core of Visual3D’s functionality by providing a command line interface into all of Visual3D's functions. The Pipeline is typically used to automate processing steps, which is useful for multiple, repeated tasks. The Pipeline is a set of Visual3D commands that are processed in sequence. The Pipeline has the ability to manage files, define events, execute signal processing computations, create and edit models, and, create and modify reports. The pipeline processor can be launched from the Pipeline menu option or from the Visual3D toolbar. It is not a scripting language nor a programming language, so no special scripting or programming experience is required to use the Pipeline. It is simply a series of commands that are run sequentially.+The Command Processing Pipeline allows users to access the core of Visual3D’s functionality by providing a command line interface into all of Visual3D's functions. The Pipeline is typically used to automate processing steps, which is useful for multiple, repeated tasks. With the Pipeline, users can manage files, define events, execute signal processing computations, create and edit models, and, create and modify reports. The Pipeline is a set of Visual3D commands that are processed in sequence. It is not a scripting language nor a programming language, so no special scripting or programming experience is required to use the Pipeline. It is simply a series of commands that are run sequentially.
  
-Any pipeline command that can be run interactively through the pipeline processor may be saved to a text file. This file may be reloaded later, or combined with other command files to build a more complex pipeline. The Pipeline dialog (or any text processor) can be used to create the pipeline.+The pipeline processor can be launched from the Pipeline menu option or from the Visual3D toolbar. Any pipeline command that can be run interactively through the pipeline processor may be saved to a text file. This file may be reloaded later, or combined with other command files to build a more complex pipeline. The Pipeline dialog (or any text processor) can be used to create the pipeline.
  
 ===== Prerequisites ===== ===== Prerequisites =====
  
-This tutorial assumes that Visual3D has been installed and that a model has been created and movement data has been applied to the model. It is suggested that you first complete the previous [[Visual3D:Tutorials:Reports:Visualizing_Data_|Tutorial: Visualizing Data]]; the file [[https://www.has-motion.com/download/examples/Tutorial2.cmo|Tutorial2.cmo]] contains the results from that previous tutorial and can be used as the starting material here. +This tutorial assumes that Visual3D has been installed and that a model has been created and movement data has been applied to the model. It is suggested that you first complete the previous [[Visual3D:Tutorials:Reports:Visualizing_Data_|Tutorial: Visualizing Data]]; the ZIP file [[https://has-motion.com/download/YouTubeTutorial/Visual3D Tutorial 3 Command Pipeline.zip|Visual3D Tutorial 3 Sample Data]] can be downloaded for this tutorial. This contains: 
 +  * **Tutorial3_Start.cmz**: The starting file for this tutorial, developed from the previous tutorial, Visualizing Data 
 +  * **Tutoria3_Final.cmz**: The motion file with applied pipeline commands from examples in this tutorial. 
 +  * **Tutorial3_CommandPipeline_Script.v3s**: Pipeline script with preset commands which can be loaded in through the workshop dialog box. 
 +  * **Walking Trial 1.c3d**: Uncorrected movement trial from start of Tutorial 2. 
 +  * **Corrected Walking Trial 1.c3d**: Corrected movement trial from Tutorial 2
 ===== Preparation ===== ===== Preparation =====
  
-  - In the File menu, select Open and select Tutorial2.cmo. This is the file resulting from Tutorial #2, which you either created through Tutorial #2 the file in the Prerequisites section.+  - In the File menu, select Open and select Tutorial3_Start.cmz. 
   - Click on Signal and Event Processing to visualize the animation of the model based on the movement data and the model that was applied to it. If the animation does not appear in the 3D Animation viewer, check the active file combo box on the toolbar. It should read 'Walking Trial 1.c3d' rather than ALL_FILES   - Click on Signal and Event Processing to visualize the animation of the model based on the movement data and the model that was applied to it. If the animation does not appear in the 3D Animation viewer, check the active file combo box on the toolbar. It should read 'Walking Trial 1.c3d' rather than ALL_FILES
   - If the animation is not playing, click on the PLAY button of the VCR controls at the bottom of the screen.   - If the animation is not playing, click on the PLAY button of the VCR controls at the bottom of the screen.
-  - There are many viewing options for the Animation viewer available under the View Menu item or by clicking with the Right Mouse Button in the Animation Viewer itself. You should play around with these options to see the effects they have; most of the effects are intuitively obvious.+  - There are many viewing options for the Animation viewer available under the View Menu item or by clicking with the Right Mouse Button in the Animation Viewer itself. You should play around with these options to see the effects they have; most of the effects are intuitive.
  
 ===== Overview of Command Menu ===== ===== Overview of Command Menu =====
  
-To open the command menu, click on the "Pipeline" button on the toolbar or select "workshop" from the Pipeline Menu.+To open the command menu, click on the "Pipeline" button on the toolbar or select "Workshop" from the Pipeline Menu.
  
 The pipeline workshop will open. To orient you, commands are located in the left column. The commands are organized into folders for: The pipeline workshop will open. To orient you, commands are located in the left column. The commands are organized into folders for:
Line 110: Line 115:
  
   * Click **Execute Pipeline**   * Click **Execute Pipeline**
-  * The **Open Movement Files** dialog will appear. Browse and select a c3d file of your choice. The c3d file will be opened in the workspace and the processing results window will show you that the pipeline was processed with out error.+  * The **Open Movement Files** dialog will appear. Browse and select a c3d file of your choice, the **Corrected Walking Trial 1.c3d** is included within the ZIP file for you to use. The c3d file will be opened in the workspace and the processing results window will show you that the pipeline was processed with out error.
  
 {{:Tutorial4_2.jpg}} {{:Tutorial4_2.jpg}}
Line 135: Line 140:
 {{:Tutorial4_5.jpg}} {{:Tutorial4_5.jpg}}
  
-==== "Active Files" Selection in the Combo Box ====+==== Selecting Active Files in the Combo Box ====
  
-  * If only one file is selected in the file selection box, the pipeline, when executed, will perform actions only on the data from that file. (i.e. walk1.c3d)+  * If only one file is selected in the file selection box, the pipeline, when executed, will perform actions only on the data from that file. (i.e. Walking Trial 1.c3d)
   * If **ALL_FILES** is selected, the script will perform actions on every file individually, as if the script had been run sequentially for each file.   * If **ALL_FILES** is selected, the script will perform actions on every file individually, as if the script had been run sequentially for each file.
-  * If a **TAG** (see next section) is selected, the script will perform actions on every file with that TAG individually, as if the script had been run sequentially for each file. (i.e. backward)+  * If a **TAG** (see next section) is selected, the script will perform actions on every file with that TAG individually, as if the script had been run sequentially for each file. (i.e. all files with the tag **sample tag**)
  
-==== "Active Files" Selection by Command Parameter ====+==== Selecting Active Files as a Command Parameter ====
  
   * Commands that include the parameter **FILE_NAME** explicitly act on that file rather the Active Files.   * Commands that include the parameter **FILE_NAME** explicitly act on that file rather the Active Files.
Line 149: Line 154:
 ; ;
 </code> </code>
-  * The user can control the Active Files in the Pipeline by adding the command **Select_Active_File** to the Pipeline. Example 3 will illustrate.+  * The user can control the Active Files in the Pipeline by adding the command [[visual3d:documentation:pipeline:file_commands:select_active_file|Select_Active_File]] to the Pipeline. Example 3 will illustrate.
  
 ==== Example 3 - Select_Active_File Command ==== ==== Example 3 - Select_Active_File Command ====
Line 164: Line 169:
   * To edit the **Select_Active_File** command. Select the **Select_Active_File** command in the main pipeline and click on the **Edit** button below the parameter frame.   * To edit the **Select_Active_File** command. Select the **Select_Active_File** command in the main pipeline and click on the **Edit** button below the parameter frame.
   * In the Edit window, remove the leading exclaimation point from the **/FILE_NAME** parameter.   * In the Edit window, remove the leading exclaimation point from the **/FILE_NAME** parameter.
-  * To the **/FILE_NAME** parameter add a specific file name with the path as shown below. For example C:\demo files\tutorials\Walking Trial 1.c3d and not just Walking Trial 1.c3d.+  * To the **/FILE_NAME** parameter add a specific file name with the path as shown below. For example C:\Users\Documents\Visual3D Tutorial ZIP Files\Visual3D Tutorial3 Command Pipeline\Walking Trial 1.c3d and not just Walking Trial 1.c3d.
  
-{{:Tutorial4_7.jpg}}+{{:visual3d:tutorials:pipeline:commandeditor_dialog.png?700|}}
  
-  * For this tutorial, add C:\demo files\tutorials\Walking Trial 1.c3d to the **/FILE_NAME** parameter.+  * Add C:\Users\Documents\Visual3D Tutorial ZIP Files\Visual3D Tutorial3 Command Pipeline\Walking Trial 1.c3d to the **/FILE_NAME** parameter.
   * Click **OK.**   * Click **OK.**
   * Click **Execute Pipeline.**   * Click **Execute Pipeline.**
-  * This time select **Tutorial2.cmo** when prompted to select the motion file.+  * This time select **Tutorial3_Start.cmz** when prompted to select the motion file.
   * If you get a file selection error or it appears that the file was not selected as requested, see the explanation below.   * If you get a file selection error or it appears that the file was not selected as requested, see the explanation below.
  
 ===== Challenges with identifying files ===== ===== Challenges with identifying files =====
  
-This is a potentially frustrating issue related to the Select_Active_File command (and many other commands), which is worth discussing before moving on because it confuses many users. The Filename must be the complete Filename as seen in the Visual3D Workspace. In Visual3D the complete Filename includes the path to the file. Visual3D uses the path to the file to determine the uniqueness of a file that is loaded in the Workspace. This allows users to use the same filenames for every data collection session (e.g. static, trial1, trial2, etc), distinguishing the files by the folder in which the files are stored on disk.+This is a potentially frustrating issue related to the Select_Active_File command (and many other commands), which is worth discussing before moving on because it confuses many users. Filenames must be the complete filename as seen in the Visual3D Workspace. In Visual3D the complete filename includes the entire path to the file on disk. Visual3D uses the path to the file to determine the uniqueness of a file that is loaded in the Workspace. This allows users to use the same filenames for every data collection session (e.g. static, trial1, trial2, etc), distinguishing the files by the folder in which the files are stored on disk.
  
-To cope with this difficulty add a path (show in italics) before the file name as shown below:+Ensure that you add the entire path (show in italics) before the file name as shown below:
  
 <code> <code>
Line 186: Line 191:
 </code> </code>
  
-Many commands, however, allow the use of a wildcard that can circumvent the problem with the complete specification of the path. For example, the following change to the previous command will find all files whose name ends with Trial 1.c3d+Many commands, however, allow the use of a [[visual3d:documentation:pipeline:file_commands:file_names#wildcard|wildcard]] that can circumvent the problem with the complete specification of the path. For example, the following change to the previous command will find all files whose name ends with Trial 1.c3d
  
 <code> <code>
Line 194: Line 199:
 </code> </code>
  
-===== Workspace TAGS =====+===== Workspace Tags=====
  
 A tag is simply a user defined file attribute. Tags are provided as a method of classifying (or categorizing) files. A tag is simply a user defined file attribute. Tags are provided as a method of classifying (or categorizing) files.
Line 217: Line 222:
 As was mentioned before, if you make only these files active then they will be affected by the Pipeline. This greatly increases the processing power of Visual3D as you are allowed to selectively eliminate and choose various trials to process based on various attributes. As was mentioned before, if you make only these files active then they will be affected by the Pipeline. This greatly increases the processing power of Visual3D as you are allowed to selectively eliminate and choose various trials to process based on various attributes.
  
-==== To assign a tag to a file via Workspace: ====+==== Assign a tag to a file via Workspace: ====
  
   * Open the **Workspace Status** Tab   * Open the **Workspace Status** Tab
Line 244: Line 249:
   * Click **OK.**   * Click **OK.**
   * Click **Execute Pipeline.**   * Click **Execute Pipeline.**
-  * This time select //Tutorial2.cmo// when prompted to select the motion file. The end result will be that the file Walking Trial 1.c3d will be tagged //Walk//+  * This time select //Tutorial3_Start.cmz// when prompted to select the motion file. The end result will be that the file Walking Trial 1.c3d will be tagged //Walk//
  
 ==== Deleting Tags ==== ==== Deleting Tags ====
Line 250: Line 255:
 The mechanism for deleting file tags is not always intuitive: if no files are checked in a tag’s column, the tag will be deleted as soon as you switch to a different page. If you accidentally delete a tag in this way, you can just create it again using the **Add New File Tag** button on the Workspace Status page. The mechanism for deleting file tags is not always intuitive: if no files are checked in a tag’s column, the tag will be deleted as soon as you switch to a different page. If you accidentally delete a tag in this way, you can just create it again using the **Add New File Tag** button on the Workspace Status page.
  
-===== Pipeline PARAMETERS =====+===== Pipeline Parameters =====
  
-An important feature of the pipeline is the ability to create and use global parameters. A global 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 in a scripting language, 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 global parameter can represent multiple entries. The use of global parameters will be described by example.+An important feature of the pipeline is the ability to create and use global parameters. A global 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 in a scripting language, such as body weight, that could be used in computations. The Visual3D pipeline is even more flexible and permits multiple entries on a single line. Since the entire line can be represented as a string, a single global parameter can represent multiple entries.
  
 ==== Example 5 - Set_Pipeline_Parameter_to_Folder_Path Command ==== ==== Example 5 - Set_Pipeline_Parameter_to_Folder_Path Command ====
Line 293: Line 298:
 A folder is really a special case of a global parameter because it is used so often. If the PARAMETER_VALUE is left blank, on execution a browse dialog will appear to allow you to browse and select the folder. This eliminates the need to type in the FOLDER parameter for every subject. Through judicious use of parameter and wildcards very general pipelines can be developed that can be used as batch processing scripts for every day processing of data. A folder is really a special case of a global parameter because it is used so often. If the PARAMETER_VALUE is left blank, on execution a browse dialog will appear to allow you to browse and select the folder. This eliminates the need to type in the FOLDER parameter for every subject. Through judicious use of parameter and wildcards very general pipelines can be developed that can be used as batch processing scripts for every day processing of data.
  
-===== Pipeline SIGNAL PROCESSING =====+===== Pipeline Signal Processing =====
  
-Signal and event processing will be covered in much greater detail in the next tutorial but we begin looking at it now because much Signal and Event Processing in Visual3D is done using the pipeline. For example a very common process in treating Motion Capture data is to Interpolate missing frames of data, then smooth the resulting signal. The next example will demonstrate this using the Pipeline.+Signal and event processing will be covered in much greater detail in the next tutorial but we begin looking at it now because much Signal and Event Processing in Visual3D is done using the pipeline. For example a very common process in preparing motion capture data for analysis is to interpolate any missing frames of data, then smooth the resulting signal. The next example demonstrates how to accomplish these steps using the Pipeline.
  
 ==== Example 6 - Interpolate and Low Pass Filter Commands ==== ==== Example 6 - Interpolate and Low Pass Filter Commands ====
Line 307: Line 312:
 {{:GraphXHighlight.jpg}} {{:GraphXHighlight.jpg}}
  
-  * the main toolbar, click on the Pipeline button to Pipeline Processing Dialog.+  * In the main toolbar, click on the Pipeline button to Pipeline Processing Dialog.
  
 {{:PipelineHighlightV6.png}} {{:PipelineHighlightV6.png}}
visual3d/tutorials/pipeline/command_pipeline.1722020468.txt.gz · Last modified: 2024/07/26 19:01 by wikisysop