Differences

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

--- visual3d:documentation:reports:reports_overview [2025/02/06 20:21] – [Report Examples] wikisysop
+++ visual3d:documentation:reports:reports_overview [2025/04/29 13:15] (current) – Reordered sections and added links. wikisysop
@@ Line 1: / Line 1: @@
 ====== 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 ====
+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.
-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).
+{{:visual3d:documentation:reports:reports_tab_update.png?450|}}
-**NOTE**: The Report Template contains the [[Visual3D:Documentation:Pipeline:General_Information:RECALC_Pipeline|Recalc Pipeline]].
+===== Report Items =====
-==== Generating Reports from a Pipeline ====
+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.
-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.
+{{:visual3d:documentation:reports:reportitems_dropdown.png?500|}}
-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]].
+==== 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.
-**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.
+{{:visual3d:documentation:reports:add_new_2d_graphdialog.png?400|}}
-==== Using TAGS instead of file names ====
+It is also possible to add a Staggered 2D Graph to the selected page:
-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.
+{{:visual3d:documentation:reports:staggered2dgraph_dialog.png?400|}}
-==== Report Layout ====
+==== Balloon Text ====
-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:tutorials:reports:creating_a_report#add_balloon_text|Balloon text]] can be added to act as an annotation:
-{{:visual3d:documentation:reports:reports_tab_update.png?450|}}
+{{:visual3d:documentation:reports:balloontext_dialog.png?400|}}
+==== Text Metric Table ====
-==== Search and Replace ====
+Metrics can be reported using a [[visual3d:documentation:reports:text_metric_table|text-based table]]:
-As you can see from the image above in the Reports Layout section, there is a sidebar with multiple buttons used to change the report. The **Search/Replace** button 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:text_metric_table_dialog.png?400|}}
-{{:visual3d:documentation:reports:search_and_replace_dialog.png?400|}}
+==== Temporal Distance Calculations ====
-==== Report Items ====
+Create a chart containing [[visual3d:documentation:pipeline:metric_commands:temporal_distance_calculations_for_gait|temporal distance metrics]] for gait:
-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.
+{{:visual3d:documentation:reports:temporal_distance_dialog.png?400|}}
-{{:visual3d:documentation:reports:reportitems_dropdown.png?500|}}
+==== Subject Information ====
-=== Report 2D Graph ===
+Subject-specific information can be added to the report as well:
-Adds 2D Graph to selected page of the report, the dialog box displays the settings which can be changed by the user.
-{{:visual3d:documentation:reports:add_new_2d_graphdialog.png?400|}}
+{{:visual3d:documentation:reports:subjectinform_dialog.png?400|}}
-=== Staggered 2D Graph ===
+==== Image ====
-{{:visual3d:documentation:reports:staggered2dgraph_dialog.png?400|}}
+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:
-=== Balloon Text ===
+{{:visual3d:documentation:reports:image_dialog.png?400|}}
-{{:visual3d:documentation:reports:balloontext_dialog.png?400|}}
+==== Laboratory Information ====
+Laboratory Information is filled out automatically based on what is listed in your dataset.
-=== Text/Metric Table ===
+===== Report Template =====
-{{:visual3d:documentation:reports:text_metric_table_dialog.png?400|}}
+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).
-=== Temporal Distance Calculations ===
+**NOTE**: The Report Template contains the [[Visual3D:Documentation:Pipeline:General_Information:RECALC_Pipeline|Recalc Pipeline]].
-Create a chart containing the temporal distance metrics.
+===== Generating Reports from a Pipeline =====
-{{:visual3d:documentation:reports:temporal_distance_dialog.png?400|}}
+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.
-=== Subject Information ===
+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]].
-{{:visual3d:documentation:reports:subjectinform_dialog.png?400|}}
+**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.
-=== Image ===
+===== Using TAGS instead of file names =====
-{{:visual3d:documentation:reports:image_dialog.png?400|}}
+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.
-=== Laboratory Information ===
-Laboratory Information is filled out automatically based on what is listed in your dataset.
+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|}}