HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » tutorials » pipeline » Advanced Pipeline Commands
visual3d:tutorials:pipeline:advanced_pipeline_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:tutorials:pipeline:advanced_pipeline_commands [2024/11/29 19:50] – [Include comments] wikisysopvisual3d:tutorials:pipeline:advanced_pipeline_commands [2024/11/29 20:58] (current) – [Summary] wikisysop
Line 123: Line 123:
 ==== Develop your script by sections ==== ==== Develop your script by sections ====
  
-We recommend developing your script in section form with comments added for documentation and clarification. Open the example script "?.v3s" in pipeline.+We recommend developing your script in section form with comments added for documentation and clarification.
  
   * The first section in your script should include your lab name, date of revision, the model used, and the purpose of the script. Lines starting with ! are comment lines.   * The first section in your script should include your lab name, date of revision, the model used, and the purpose of the script. Lines starting with ! are comment lines.
Line 144: Line 144:
 </code> </code>
  
-Continue to make sections for file import/export (more here)+Continue to make sections for file import/export, etc. after this
  
 ===== Define global parameters ===== ===== Define global parameters =====
Line 239: Line 239:
 === Pulldown prompts === === Pulldown prompts ===
  
-A user can be prompted to select a value via a pulldown menu of predefined values. Instructions can be added to the top of the pulldown dialog menu to assist the user in their selection. Below is an example of a prompt with a pulldown menu that will ask the user to select 1 for the right side and -1 for the left side. This can be used to negate (multiply by -1) a signal that may depend on side such as output from a Biodex torque signal.+A user can be prompted to select a value via a pulldown menu of predefined values. This is done by specifying multiple "DEFAULT_VALUE"'s. Instructions can be added to the top of the pulldown dialog menu to assist the user in their selection. Below is an example of a prompt with a pulldown menu that will ask the user to select 1 for the right side and -1 for the left side. This can be used to negate (multiply by -1) a signal that may depend on side such as output from a Biodex torque signal.
  
 <code> <code>
Line 850: Line 850:
 ==== Signal Math ==== ==== Signal Math ====
  
-There are many pipeline commands for signal math. One of the most powerful and useful commands is **Evaluate_Expression**. Rather than repeat content here, please go to the [[Visual3D:Documentation:Pipeline:Expressions:Expressions_Overview|Expressions]] page for more details on this command and several very good examples. Another great example can be found here https://www.c-motion.com/v3dwiki/index.php?title=Pipeline_Script_examples#Example_Script+There are many pipeline commands for signal math. One of the most powerful and useful commands is **Evaluate_Expression**. Rather than repeat content here, please go to the [[Visual3D:Documentation:Pipeline:Expressions:Expressions_Overview|Expressions]] page for more details on this command and several very good examples.
  
 ===== Model Creation ===== ===== Model Creation =====
Line 864: Line 864:
   * [[Visual3D:Documentation:Pipeline:Model_Commands:Set_Subject_Weight|Set_Subject_Weight]]   * [[Visual3D:Documentation:Pipeline:Model_Commands:Set_Subject_Weight|Set_Subject_Weight]]
  
-Users can be prompted to enter in values (see example in previous section https://www.c-motion.com/v3dwiki/index.php?title=Tutorial:_Advanced_Command_Pipeline#Direct_input_prompts or this page for another example [[Visual3D:Tutorials:Pipeline:Basic_Pipeline_for_Processing_a_Session|Tutorial Basic Pipeline For Processing A Session]]). Both [[Visual3D:Documentation:Pipeline:Model_Commands:Set_Subject_Height|Set_Subject_Height]] and [[Visual3D:Documentation:Pipeline:Model_Commands:Set_Subject_Weight|Set_Subject_Weight]] pages show how expressions can be used in the model metric command. The [[Visual3D:Documentation:Pipeline:Model_Commands:Set_Subject_Weight|Set_Subject_Weight]] page shows an example of how one would calculate subject weight based on the force platform signal and set the metric subject weight.+Users can be prompted to enter in values (see example in previous section [[visual3d:tutorials:pipeline:advanced_pipeline_commands#user_prompts|Direct Input Prompts]] or on page [[Visual3D:Tutorials:Pipeline:Basic_Pipeline_for_Processing_a_Session|Tutorial Basic Pipeline For Processing A Session]]). Both [[Visual3D:Documentation:Pipeline:Model_Commands:Set_Subject_Height|Set_Subject_Height]] and [[Visual3D:Documentation:Pipeline:Model_Commands:Set_Subject_Weight|Set_Subject_Weight]] pages show how expressions can be used in the model metric command. The [[Visual3D:Documentation:Pipeline:Model_Commands:Set_Subject_Weight|Set_Subject_Weight]] page shows an example of how one would calculate subject weight based on the force platform signal and set the metric subject weight.
  
 Refer to his page [[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_From_Parameter|Metric From Parameter]] for an example of pulling in height, weight, etc that was saved in a C3D parameter section by the motion system. Refer to his page [[Visual3D:Documentation:Pipeline:Metric_Commands:Metric_From_Parameter|Metric From Parameter]] for an example of pulling in height, weight, etc that was saved in a C3D parameter section by the motion system.
Line 903: Line 903:
 ==== Using commands to apply an already constructed model template ==== ==== Using commands to apply an already constructed model template ====
  
-Typically a model is defined manualy and a model template is saved for that model. Commands can be used to [[Visual3D:Documentation:Pipeline:Model_Commands:Apply_Model_Template|Apply Model Template]] to the static and [[Visual3D:Documentation:Pipeline:Model_Commands:Assign_Model_File|Assign Model File]] to the movement files. A great example can be found on [[|Pipeline Processing Example 2]]. [[|Pipeline Processing Example 6]] expands on this to apply a model template to multiple conditions. +Typically a model is defined manualy and a model template is saved for that model. Commands can be used to [[Visual3D:Documentation:Pipeline:Model_Commands:Apply_Model_Template|Apply Model Template]] to the static and [[Visual3D:Documentation:Pipeline:Model_Commands:Assign_Model_File|Assign Model File]] to the movement files. A great example can be found on [[visual3d:documentation:pipeline:general_information:pipeline_examples|Pipeline Examples]]. 
 ==== Using commands to modify a model ==== ==== Using commands to modify a model ====
  
Line 913: Line 912:
 Landmarks can be added and modified using the [[Visual3D:Documentation:Pipeline:Model_Commands:Add_Landmark|Add_Landmark]] and [[Visual3D:Documentation:Pipeline:Model_Commands:Modify_Landmark|Modify_Landmark]] commands. Landmarks can be added and modified using the [[Visual3D:Documentation:Pipeline:Model_Commands:Add_Landmark|Add_Landmark]] and [[Visual3D:Documentation:Pipeline:Model_Commands:Modify_Landmark|Modify_Landmark]] commands.
  
-There is an example on https://www.c-motion.com/v3dwiki/index.php?title=Static_Trial#Multiple_Static_trials_using_a_Pipeline where one or more markers are used to define a segment that is obscured. The pipeline script will create a segment and add a landmark.+There is an example on [[visual3d:documentation:definitions:static_trial#Multiple_Static_trials_using_a_Pipeline|Our Website]] where one or more markers are used to define a segment that is obscured. The pipeline script will create a segment and add a landmark.
  
 Another great example can be seen on [[Visual3D:Documentation:Modeling:Landmarks:Example_-_Landmarks_from_Motion_File|Landmarks From Motion File]]. This example creates landmarks from a set of stairs. Another great example can be seen on [[Visual3D:Documentation:Modeling:Landmarks:Example_-_Landmarks_from_Motion_File|Landmarks From Motion File]]. This example creates landmarks from a set of stairs.
Line 925: Line 924:
 ===== Compute Link based Model ===== ===== Compute Link based Model =====
  
-The command [[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:Compute_Model_Based_Data|Compute Model Based Data]] will +The command [[Visual3D:Documentation:Pipeline:Model_Based_Data_Commands:Compute_Model_Based_Data|Compute Model Based Data]] will compute a signal using a model's segment Kinetic_Kinematic data.
- +
-==== Joint Angles ====+
  
 ==== Joint Moments ==== ==== Joint Moments ====
Line 1053: Line 1050:
   * [[Visual3D:Documentation:Pipeline:Event_Commands:Example_-_Event_Threshold_to_create_10%_increments|Events:Example 4]] uses **Event_Threshold** command to create 10% increments of the range of motion of a signal.   * [[Visual3D:Documentation:Pipeline:Event_Commands:Example_-_Event_Threshold_to_create_10%_increments|Events:Example 4]] uses **Event_Threshold** command to create 10% increments of the range of motion of a signal.
   * [[Visual3D:Documentation:Pipeline:Event_Commands:Example_-_Event_Threshold_using_height_of_a_segment_|Events:Example 5]] uses the **Event_Threshold** command to compute an event based on the height of the hand relative to the height of the acromium.   * [[Visual3D:Documentation:Pipeline:Event_Commands:Example_-_Event_Threshold_using_height_of_a_segment_|Events:Example 5]] uses the **Event_Threshold** command to compute an event based on the height of the hand relative to the height of the acromium.
-  * [[Visual3D:Documentation:EMG:Filtering:Linear_Envelope|EMG_Onset]] uses the **Event_Threshold** command to compute the onset of EMG activity.+  * [[Visual3D:Documentation:EMG:Filtering:Linear_Envelope|Linear Envelope]] uses the **Event_Threshold** command to compute the onset of EMG activity.
  
 ==== Event_Onset ==== ==== Event_Onset ====
Line 1767: Line 1764:
  
 ===== Export and Import ===== ===== Export and Import =====
 +
  
 ==== Export Graphs ==== ==== Export Graphs ====
- +[[visual3d:documentation:pipeline:report_commands:export_graph|Export_Graph]]
-==== Export Images ====+
  
   * An example of exporting graphs and metrics and screen shot images is there. We prefer actually building a report in V3D and exporting graphs as SVG or PNG images rather than exporting raw ASCII data for consistency and easy error checking reasons.   * An example of exporting graphs and metrics and screen shot images is there. We prefer actually building a report in V3D and exporting graphs as SVG or PNG images rather than exporting raw ASCII data for consistency and easy error checking reasons.
Line 1787: Line 1784:
  
 Meta-Commands are used for complex functions or general processing. 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. For a more detailed discussion on meta-commands go to the [[Visual3D:Documentation:Pipeline:Meta_Commands:Meta_Commands_Overview|Pipeline Commands:Meta Commands]] page. Meta-Commands are used for complex functions or general processing. 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. For a more detailed discussion on meta-commands go to the [[Visual3D:Documentation:Pipeline:Meta_Commands:Meta_Commands_Overview|Pipeline Commands:Meta Commands]] page.
- 
-===== Summary ===== 
- 
  
  
visual3d/tutorials/pipeline/advanced_pipeline_commands.1732909840.txt.gz · Last modified: 2024/11/29 19:50 by wikisysop