HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » reports » Scripting Report Templates
visual3d:documentation:reports:scripting_report_templates

Differences

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

Link to this comparison view

Next revision		Previous revision
visual3d:documentation:reports:scripting_report_templates [2024/06/14 17:30] – created sgrangervisual3d:documentation:reports:scripting_report_templates [2024/07/17 15:46] (current) – created sgranger
Line 1: Line 1:
-|**Language:**|** English**  • [[index.php?title=Reporting_Example_6:_Scripting/fr&action=edit&redlink=1|français]] • [[index.php?title=Reporting_Example_6:_Scripting/it&action=edit&redlink=1|italiano]] • [[index.php?title=Reporting_Example_6:_Scripting/pt&action=edit&redlink=1|português]] • [[index.php?title=Reporting_Example_6:_Scripting/es&action=edit&redlink=1|español]] ****|+====== Scripting Report Templates ======
  
-|===== Contents =====\\ \\ \\ \\ * [[#Scripting_Report_Templates|1 Scripting Report Templates]]\\   * [[#Introduction|1.1 Introduction]]\\   * [[#Download|1.2 Download]]\\ * [[#Using_the_Script|2 Using the Script]]\\   * [[#Naming_Convention|2.1 Naming Convention]]\\   * [[#Example_1:_Kinematics|2.2 Example 1: Kinematics]]\\   * [[#Example_2:_Kinetics|2.3 Example 2: Kinetics]]| +===== Scripting Report Templates =====
- +
-====== Scripting Report Templates ======+
  
-===== Introduction =====+==== Introduction ====
  
 Report templates may also be created using the [[Visual3D:Documentation:Pipeline:Report_Commands:Make_Line_Graph|Make_Line_Graph]] pipeline command. In conjunction with the Make_Line_Graph command, [[Visual3D:Documentation:Pipeline:Pipeline_Commands:For_Each_and_End_For_Each|For_Each]] loops can be used to create a report template in a few steps. Before creating a Report Template from a script, it is important to understand that the [[Visual3D:Documentation:Pipeline:General_Information:RECALC_Pipeline|RECALC pipeline]] (which saves the [[Visual3D:Documentation:Visual3D_Signal_Types:LINK_MODEL_BASED_Data_Type|COMPUTE_MODEL_BASED_DATA]] commands) is also saved in the .rgt file (the report template file).\\ Report templates may also be created using the [[Visual3D:Documentation:Pipeline:Report_Commands:Make_Line_Graph|Make_Line_Graph]] pipeline command. In conjunction with the Make_Line_Graph command, [[Visual3D:Documentation:Pipeline:Pipeline_Commands:For_Each_and_End_For_Each|For_Each]] loops can be used to create a report template in a few steps. Before creating a Report Template from a script, it is important to understand that the [[Visual3D:Documentation:Pipeline:General_Information:RECALC_Pipeline|RECALC pipeline]] (which saves the [[Visual3D:Documentation:Visual3D_Signal_Types:LINK_MODEL_BASED_Data_Type|COMPUTE_MODEL_BASED_DATA]] commands) is also saved in the .rgt file (the report template file).\\
Line 12: Line 10:
  
  
-===== Download =====+==== Download ====
  
 **You may download the sample reporting script and sample data files [[https://www.has-motion.com/download/examples/ScriptingReportTemplate/ScriptingTemplate.zip|here]].** **You may download the sample reporting script and sample data files [[https://www.has-motion.com/download/examples/ScriptingReportTemplate/ScriptingTemplate.zip|here]].**
Line 18: Line 16:
 **The entire script may also be seen [[Visual3D:Documentation:Reports:Scripting_Report_Templates_Example|here]].** **The entire script may also be seen [[Visual3D:Documentation:Reports:Scripting_Report_Templates_Example|here]].**
  
-====== Using the Script ======+===== Using the Script =====
  
-===== Naming Convention =====+==== Naming Convention ====
  
 This example is meant to serve as a starting point for others to work off. The sample script will create a report template for signals following this naming convention:\\ This example is meant to serve as a starting point for others to work off. The sample script will create a report template for signals following this naming convention:\\
Line 34: Line 32:
  
  
-===== Example 1: Kinematics =====+==== Example 1: Kinematics ====
  
 To plot kinematics, the signals LAnkleAngle, RAnkleAngle, LKneeAngle, RKneeAngle, LHipAngle, and RHipAngle will be plotted in the report template starting at page 1. Each Joint (Ankle, Knee and Hip) will be graphed on a new page, and each side (L/R) will be plotted in separate columns using different colors. The signals will be normalized as a percent of the gait cycle (HS to HS).\\ To plot kinematics, the signals LAnkleAngle, RAnkleAngle, LKneeAngle, RKneeAngle, LHipAngle, and RHipAngle will be plotted in the report template starting at page 1. Each Joint (Ankle, Knee and Hip) will be graphed on a new page, and each side (L/R) will be plotted in separate columns using different colors. The signals will be normalized as a percent of the gait cycle (HS to HS).\\
Line 69: Line 67:
 The previous commands prompt the user for the graph parameters and the signals to be graphed: The previous commands prompt the user for the graph parameters and the signals to be graphed:
  
-|  [[File:SetPipelineParameter_Kinematics_GraphParameters.png|{{/images/thumb/b/bf/SetPipelineParameter_Kinematics_GraphParameters.png/350px-SetPipelineParameter_Kinematics_GraphParameters.png?350x304}}]]\\   |  [[File:SetPipelineParameter_Kinematics.png|{{/images/thumb/4/48/SetPipelineParameter_Kinematics.png/350px-SetPipelineParameter_Kinematics.png?350x228}}]]\\   |+|  {{:SetPipelineParameter_Kinematics_GraphParameters.png}}\\   |  {{:SetPipelineParameter_Kinematics.png}}\\   |
  
-===== Example 2: Kinetics =====+==== Example 2: Kinetics ====
  
 To plot kinetics, the signals LAnkleMoment, RAnkleMoment, LKneeMoment, RKneeMoment, LHipMoment, RHipMoment, LAnklePower, RAnklePower, LKneePower, RKneePower, LHipPower, and RHipPower will be plotted in the report template starting at page 4. Each Joint (Ankle, Knee and Hip) will be graphed on a new page, and each side (L/R) will be plotted in separate columns using different colors. The signals will be normalized as a percent of the gait cycle (ON to HS).\\ To plot kinetics, the signals LAnkleMoment, RAnkleMoment, LKneeMoment, RKneeMoment, LHipMoment, RHipMoment, LAnklePower, RAnklePower, LKneePower, RKneePower, LHipPower, and RHipPower will be plotted in the report template starting at page 4. Each Joint (Ankle, Knee and Hip) will be graphed on a new page, and each side (L/R) will be plotted in separate columns using different colors. The signals will be normalized as a percent of the gait cycle (ON to HS).\\
Line 106: Line 104:
 The previous commands prompt the user for the graph parameters and the signals to be graphed: The previous commands prompt the user for the graph parameters and the signals to be graphed:
  
-|  [[File:SetPipelineParameter_Kinetics_GraphParameters.png|{{/images/thumb/7/79/SetPipelineParameter_Kinetics_GraphParameters.png/350px-SetPipelineParameter_Kinetics_GraphParameters.png?350x304}}]]\\   |  [[File:SetPipelineParameter_Kinetics.png|{{/images/thumb/9/96/SetPipelineParameter_Kinetics.png/350px-SetPipelineParameter_Kinetics.png?350x227}}]]\\   | +|  {{:SetPipelineParameter_Kinetics_GraphParameters.png}}\\   |  {{:SetPipelineParameter_Kinetics.png}}\\   |
  
-Retrieved from "" 
  
  
visual3d/documentation/reports/scripting_report_templates.1718386257.txt.gz · Last modified: 2024/06/14 17:30 by sgranger