HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » documentation » reports » Reports Overview
visual3d:documentation:reports:reports_overview

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:reports:reports_overview [2025/02/06 18:32] – [Generating Reports from a Pipeline] wikisysopvisual3d:documentation:reports:reports_overview [2025/04/29 13:15] (current) – Reordered sections and added links. wikisysop
Line 1: Line 1:
 ====== Reports Overview ====== ====== Reports Overview ======
  
-Visual3D creates a Workspace into which all data is stored, models are integrated, and reports are produced. The entire workspace can be saved and shared as a digital report in which all the underlying analysis, data, and models can be accessed.+Visual3D creates a Workspace into which all data is stored, models are integrated, and reports are produced. The entire workspace can be saved and shared as a digital report in which all the underlying analysis, data, and models can be accessed. Every Visual3D workspace includes **exactly one report**, which is initially blank, and to which you may add any number of distinct pages. In a sense, the entire workspace is itself a kind of extended electronic report, which contains not only the contents of the Reporting page but also all of the original data and records of all data-processing steps.
  
-Every Visual3D workspace includes **exactly one report**, which is initially blank, and to which you may add any number of distinct pages. In a sense, the entire workspace is itself a kind of extended electronic report, which contains not only the contents of the Reporting page but also all of the original data and records of all data-processing steps.+Every graph in a report can be exported as an image (jpg, png, gif, bmp, SVG, EMF) or as [[Visual3D:Documentation:Definitions:File_Formats:ASCII_Format|ASCII data]].
  
-Every graph in a report can also be exported as an image (jpg, png, gif, bmp, SVG, EMF) or as [[Visual3D:Documentation:Definitions:File_Formats:ASCII_Format|ASCII data]]. +===== Report Layout =====
- +
-==== Report Template ==== +
- +
-After you have created a report, you may choose to save a report template file, which saves not only the formal structure of the printed report, but actually the entire structure of the workspace (i.e. everything but the data). Provided you are consistent in using TAGS for the movement trials, you can re-use such templates for many experiments of the same type (e.g., same experimental protocol, multiple subjects). +
- +
-**NOTE**: The Report Template contains the [[Visual3D:Documentation:Pipeline:General_Information:RECALC_Pipeline|Recalc Pipeline]]. +
- +
-==== Generating Reports from a Pipeline ==== +
- +
-Report templates may also be created using the [[Visual3D:Documentation:Pipeline:Report_Commands:Make_Line_Graph|Make_Line_Graph]] pipeline command. In conjunction with this 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). An example of how to create a simple report template using a pipeline can be found [[Visual3D:Documentation:Reports:Scripting_Report_Templates|here]]. +
-\\ +
-**NOTE:** Using this method requires a prior knowledge of writing pipeline scripts, and it is suggested to complete the pipeline tutorials prior to testing this method. +
- +
-==== Using TAGS instead of file names ==== +
- +
-One of the "far reaching" decisions that we made in defining the specifications for the Visual3D reports was to make the graphs very general so that the report templates that store the report format can be applied to any data sets. A consequence of this decision is that it is not possible to use individual file names in a report graph because this would make the template specific to that data set. +
- +
-==== Report Layout ====+
  
 Visual3D reports are laid out according to a row/column structure. Each report page can have up to a maximum of 5 rows and 5 columns, and you can specify that certain items span multiple rows or columns. Items which can be included in reports include graphs, tables, graphical representations of metrics (e.g. gait analysis metrics such as step length and cycle time), subject and laboratory information, and bitmap images imported from other programs. Visual3D reports are laid out according to a row/column structure. Each report page can have up to a maximum of 5 rows and 5 columns, and you can specify that certain items span multiple rows or columns. Items which can be included in reports include graphs, tables, graphical representations of metrics (e.g. gait analysis metrics such as step length and cycle time), subject and laboratory information, and bitmap images imported from other programs.
  
-{{:ReportPP.jpg}}+{{:visual3d:documentation:reports:reports_tab_update.png?450|}}
  
-==== Edit Page Title ====+===== Report Items =====
  
-{{:ReportPageTitle.jpg}}+There are several items which can be added into the report. On the bottom right corner of the reports tab working space, a combo box is available that displays these items for you to choose from.
  
-In the Page Title Edit Box you can enter a Text String that will be displayed as the Title.+{{:visual3d:documentation:reports:reportitems_dropdown.png?500|}}
  
-If "Evaluate title as an expression before display" is checked, Visual3D searches for a [[Visual3D:Documentation:Visual3D_Signal_Types:TEXT_Data_Type|TEXT_DATA]] item in the Global Workspace and displays the text data.+==== Report 2D Graph ==== 
 +Adds a [[visual3d:documentation:reports:report_2d_graph|2D Graph]] to selected page of the report, the dialog box displays the settings which can be changed by the user.
  
-For example, create a TEXT_DATA item.+{{:visual3d:documentation:reports:add_new_2d_graphdialog.png?400|}}
  
-**Create_Text_Data** +It is also possible to add a Staggered 2D Graph to the selected page:
-/SIGNAL_FOLDER=TEST +
-SIGNAL_NAMES=GLOBAL::TITLE_TEXT +
-/TEXT_DATA=Hello World +
-**;** +
-{{:ReportPageTitle2.jpg}}+
  
-==== Search and Replace ====+{{:visual3d:documentation:reports:staggered2dgraph_dialog.png?400|}}
  
-At the bottom of the screen are the list of report pages.+==== Balloon Text ====
  
-{{:ReportPages.jpg}}+[[visual3d:tutorials:reports:creating_a_report#add_balloon_text|Balloon text]] can be added to act as an annotation:
  
-Selecting the Search/Replace button allows you to replace event labels and TAGS in the report graphs.+{{:visual3d:documentation:reports:balloontext_dialog.png?400|}}
  
-{{:ReportSearchReplace.jpg}}+==== Text Metric Table ====
  
-==== Report Items ====+Metrics can be reported using a [[visual3d:documentation:reports:text_metric_table|text-based table]]:
  
-There are several types of graphs. The graphs are specified by selecting the graph type from the combo box+{{:visual3d:documentation:reports:text_metric_table_dialog.png?400|}}
  
-{{:ReportItems.jpg}}+==== Temporal Distance Calculations ====
  
-\\+Create a chart containing [[visual3d:documentation:pipeline:metric_commands:temporal_distance_calculations_for_gait|temporal distance metrics]] for gait:
  
 +{{:visual3d:documentation:reports:temporal_distance_dialog.png?400|}}
  
-=== Report 2D Graph ===+==== Subject Information ====
  
-Create a line graph+Subject-specific information can be added to the report as well:
  
-{{:ReprotGraph1.jpg}}+{{:visual3d:documentation:reports:subjectinform_dialog.png?400|}}
  
-=== Staggered Graph Item ===+==== Image ====
  
-{{:StaggeredGraphItem.jpg}}+A still frame from the [[visual3d:documentation:reports:3d_animation_viewer|3D Animation Viewer]] can be added to a report, as well as any other image in a supported format:
  
-=== Subject Information Item ===+{{:visual3d:documentation:reports:image_dialog.png?400|}}
  
-{{:SubjectInformationItem.jpg}}+==== Laboratory Information ====
  
-=== Laboratory Information Item ===+Laboratory Information is filled out automatically based on what is listed in your dataset.
  
-{{:LabInformationItem.jpg}}+===== Report Template =====
  
-=== Temporal Distance Calculations ===+After you have created a report, you may choose to save a report template file, which saves not only the formal structure of the printed report, but actually the entire structure of the workspace (i.e. everything but the data). Provided you are consistent in using TAGS for the movement trials, you can re-use such templates for many experiments of the same type (e.g., same experimental protocol, multiple subjects).
  
-Create a table containing the temporal distance metrics+**NOTE**: The Report Template contains the [[Visual3D:Documentation:Pipeline:General_Information:RECALC_Pipeline|Recalc Pipeline]].
  
-{{:TemporalDistanceItem.jpg}}+===== Generating Reports from a Pipeline =====
  
-===  Text/Metric Table ===+Report templates may also be created using the [[Visual3D:Documentation:Pipeline:Report_Commands:Make_Line_Graph|Make_Line_Graph]] pipeline command. In conjunction with this 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. 
  
-create a table containing metrics+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). An example of how to create a simple report template using a pipeline can be found [[Visual3D:Documentation:Reports:Scripting_Report_Templates|here]].
  
-{{:Report5_1.jpg}}+**NOTE:** Using this method requires a prior knowledge of writing pipeline scripts, and it is suggested to complete the pipeline tutorials prior to testing this method.
  
-=== Report Image Item ===+===== Using TAGS instead of file names =====
  
-{{:ReportImageItem.jpg}} +One of the "far reaching" decisions that we made in defining the specifications for the Visual3D reports was to make the graphs very general so that the report templates that store the report format can be applied to any data sets. A consequence of this decision is that it is not possible to use individual file names in a report graph because this would make the template specific to that data set.
- +
-==== Report Examples ==== +
- +
-=== Changing the colors of lines in graphs === +
- +
-Changing the colors of lines in graphs. For example, plot both left and right knee flexion on the same graph but both sets of data should be different colors. +
-=== Explicit Settings for Report Graphs === +
- +
-Explicit Settings for Report Graphs +
-=== Graph mean and standard deviation from a p2d file === +
- +
-How do I graph the mean and standard deviation from a p2d file? +
-=== Adding an annotation at 60% along the x-axis === +
- +
-Adding an annotation at 60% along the x-axis +
-=== Adding text to a text/metric table === +
- +
-Adding text to a text/metric table in the report +
-=== Create a mean signal that contains data from both the left and right sides === +
- +
-Create a mean signal that contains data from both the left and right sides of the body. +
-=== Find the signal that is most representative of a set of signals === +
- +
-Find the signal that is most representative of a set of signals. This implementation is based on the following article: +
-Shadmehr R and Mussa-Ivaldi FA (1994) Adaptive Representation of Dynamics during Learning of a Motor Task. J. Neuroscience 14(5), pp 3208-3224. +
-=== Add an Image to a Report === +
- +
-A pipeline example of how to add images to a Visual3d report. The example adds an image from each of three sequential numbered trials with the images position on the page based on the number in the name of the c3d file+
  
 +The **Search/Replace** button in the Reports tab sidebar allows you to replace event labels and TAGS in the report graphs. You are given the option of replacing for the selected page OR the entire report.
  
 +{{:visual3d:documentation:reports:search_and_replace_dialog.png?400|}}
visual3d/documentation/reports/reports_overview.1738866750.txt.gz · Last modified: 2025/02/06 18:32 by wikisysop