Differences

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

--- visual3d:documentation:reports:report_2d_graph [2024/06/19 12:53] – sgranger
+++ visual3d:documentation:reports:report_2d_graph [2025/05/05 14:46] (current) – Cleaned up page, in progress. wikisysop
@@ Line 1: / Line 1: @@
-{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{the 2d graph reports allow the user to display any signal in the workspace against any other signal in the workspace.
+====== Report 2D Graph ======
-===== adding a 2d report graph =====
+D Graph reports allow the user to display any signal in the workspace against any other signal in the workspace (or against time).
-to add a 2d report graph, select 2d graph in the **items to add** combo box and select the **add button** reprotgraph1.jpg
+===== Adding a 2D Report graph =====
-===== 2d report graph dialog =====
+To add a 2D report graph, select 2D Graph in the **Items to add** combo box and select the **Add Button**.
-the following dialog will appear and should be populated.
+{{:ReprotGraph1.jpg}}
-reportgraph2.jpg\\
+===== 2D Report Graph Dialog =====
+The following dialog will appear and should be populated.
-this dialog has three sections to populate.
+{{:ReportGraph2.jpg}}
-==== section 1 ====
+This dialog is broken down into five sections to allow users precise control over which signals are plotted and how.
-graph title, font selection and size. (visual3d version 5.0 feature)
+==== Section 1: Graph Title ====
-reportgraph2a.jpg
+Graph title, font selection and size. (Visual3D Version 5.0 feature)
-==== section 2 ====
+{{:ReportGraph2a.jpg}}
-the basic graph properties
+==== Section 2: Graph Properties ====
-reportgraph3.jpg
+The basic graph properties
-in this example, the graph will be plotted on page 2, column 1, row 1
+{{:ReportGraph3.jpg}}
-=== files to graph ===
+in this example, the graph will be plotted on Page 2, Column 1, Row 1
-the **files to graph** combo allows the user to select all_files or any tag
+^ Parameter ^ Description ^
-=== line color and line style ===
+|Files to Graph | The **Files to Graph** combo allows the user to select ALL_FILES or any TAG. |
+|Line Color and Line Style | The top Line Color and Line Style refer to the signal lines drawn |
+| Mean and Standard Deviation | In this example, the check boxes **Graph Mean** and **Graph Standard Deviation** are checked, which means that the mean and standard deviation of the signal lines selected will be computed and displayed.|
+| Annotations | See also the associated Pipeline Command [[Visual3D:Documentation:Pipeline:Report_Commands:Add_Graph_Annotation|Add_Graph_Annotation]]. |
-the top line color and line style refer to the signal lines drawn
+=== Annotations Editor ===
-=== mean and standard deviation ===
-in this example, the check boxes **graph mean** and **graph standard deviation** are checked, which means that the mean and standard deviation of the signal lines selected will be computed and displayed.
+{{:AnnotationDlg1.jpg}}
-=== annotations ===
-see also the associated pipeline command [[visual3d:documentation:pipeline:report_commands:add_graph_annotation|add_graph_annotation]]
+  - Within the Annotations Editor select **Add** to add an annotation to the graph or select **Edit** to modify an existing annotation. {{:AnnotationDlg2.jpg}}
+  - The initial dialog for the annotation {{:AnnotationDlg3.jpg}}
+  - Select the parameters of the annotation.
+  - If All Graphs are selected an annotation is added for every occurrence of the Event for every graph. {{:AnnotationGraph1.jpg}}
+  - Notice the multiple vertical lines because there is an event for each graph. {{:AnnotationDlg4.jpg}}
+  - If Average Event or Numerical Value is selected, Visual3D interprets the edit box.
+  - For example, specifying the Event label T3 {{:AnnotationGraph2.jpg}}
+  - For example, in this case the average location of the Event is identified and drawn. {{:AnnotationDlg5.jpg}}
+  - If Average Event or Numerical Value is selected, Visual3D interprets the edit box.
+  - For example, specifying the Time 3 {{:AnnotationGraph3.jpg}}
+  - For example, in this case the annotation is drawn at 25% of the x-axis..
-annotationdlg1.jpg
+==== Section 3: X-Axis ====
-the initial dialog.
-select **add** to add an annotation to the graph
-select **edit** to modify an existing annotation.
-annotationdlg2.jpg
-the initial dialog for the annotation
-annotationdlg3.jpg
-select the parameters of the annotation.
-if all graphs are selected an annotation is added for every occurrence of the event for every graph.
-annotationgraph1.jpg
-notice the multiple vertical lines because there is an event for each graph.
-annotationdlg4.jpg
-if average event or numerical value is selected, visual3d interprets the edit box.
-for example, specifying the event label t3
-annotationgraph2.jpg
-for example, in this case the average location of the event is identified and drawn.
-annotationdlg5.jpg
-if average event or numerical value is selected, visual3d interprets the edit box.
-for example, specifying the time 3
-annotationgraph3.jpg
-for example, in this case the annotation is drawn at 25% of the x-axis..
-==== section 3 ====
-the signal used for the x-axis.
+The signal used for the x-axis.
-reportgraph4.jpg\\
+{{:ReportGraph4.jpg}}
+In this example, time is displayed on the x-axis.
-in this example, time is displayed on the x-axis.
+The signals in the Y-Axis properties for (File to graph and within a graph) that have occurrences of the range Range Begin to **Range End** will be drawn on the graph.
-the signals in the y-axis properties for (file to graph and within a graph) that have occurrences of the range range begin to **range end** will be drawn on the graph.
+If **Intermediate Events** are selected, only ranges from **Range Begin** to **Range End** that contain the **intermediate events** will be graphed.
-if **intermediate events** are selected, only ranges from **range begin** to **range end** that contain the **intermediate events** will be graphed.
+If Exclude sequences containing is populated, only ranges from **Range Begin** to **Range End** that do not contain the **excluded events** will be graphed
-if exclude sequences containing is populated, only ranges from **range begin** to **range end** that do not contain the **excluded events** will be graphed
+==== Section 4: Y-Axis ====
-==== section 4 ====
+The signal used for the y-axis
-the signal used for the y-axis
+{{:ReportGraph5.jpg}}
-reportgraph5.jpg
+In this example, the x-component of the Right Ankle Angle will be displayed.
-in this example, the x-component of the right ankle angle will be displayed.
+The range of the graph can be specified as:
-the range of the graph can be specified as:
+  - Normalize 0% to 100% - each range of data will be scaled from 0 to 100 percent
+  - Global Min to Max - the minimum and maximum value of the signals across all ranges is computed
+  - By Explicit Setting - The user can format the graph and specify an explicit range regardless of the signals selected.
-  - normalize 0% to 100% - each range of data will be scaled from 0 to 100 percent
+=== Defining an Explicit Range ===
-  - global min to max - the minimum and maximum value of the signals across all ranges is computed
-  - by explicit setting - the user can format the graph and specify an explicit range regardless of the signals selected.
-=== defining an explicit range ===
+Select a graph in the report. If the graph is selected you will see "handles"
-select a graph in the report. if the graph is selected you will see "handles"
+{{:ReportGraph6.jpg}}
-reportgraph6.jpg
+Move the cursor over the selected graph, and push the right mouse button. A menu will appear.
-move the cursor over the selected graph, and push the right mouse button. a menu will appear.
+{{:ReportGraph7.jpg}}
-reportgraph7.jpg
+Select Format Graph and a dialog will appear
-select format graph and a dialog will appear
+{{:ReportGraph8.jpg}}
-reportgraph8.jpg
+Select the Y Min and Y Max values and save these settings as the default. This means that these setting will be preserved in the Report Template.
-select the y min and y max values and save these settings as the default. this means that these setting will be preserved in the report template.
+{{:ReportGraph9.jpg}}
-reportgraph9.jpg
+==== Section 5: Legend ====
-==== section 5 ====
+=== Set the properties of the legend ===
-=== set the properties of the legend ===
+Move the cursor over the selected graph, and push the right mouse button. A menu will appear.
-move the cursor over the selected graph, and push the right mouse button. a menu will appear.
+{{:ReportGraph7.jpg}}
-reportgraph7.jpg
+Select Format Graph and a dialog will appear
-select format graph and a dialog will appear
+{{:ReportGraph8.jpg}}
-reportgraph8.jpg
+Select the option to display the legend.
-select the option to display the legend.
+Select the button to modify the legend
-select the button to modify the legend
+{{:ReportGraph12.jpg}}
-reportgraph12.jpg
+The legend can be placed at the Top Left, Top Right, Bottom Left, or Bottom Right.
-the legend can be placed at the top left, top right, bottom left, or bottom right.
 or more of the selections of the legend text can be selected.
-=== adding custom legend text ===
+=== Adding Custom Legend Text ===
-adding the text for the report legend.
+Adding the text for the Report Legend.
-reportgraph9a.jpg
+{{:ReportGraph9a.jpg}}
-if you have populated this dialog, you will not see the legend in the graph by default.
+If you have populated this dialog, you will not see the legend in the graph by default.
-if you have entered text in the graph format dialog, you need to select the option to display text in the "legend properties" dialog.
+If you have entered text in the graph format dialog, you need to select the option to display text in the "Legend Properties" dialog.
-===== adding more signals to the report graph =====
+===== Adding more signals to the Report Graph =====
-the report dialog acts on one report graph entity.
+The report dialog acts on one report graph entity.
-the graph that appears in the report, however, may contain many entities.
+The graph that appears in the report, however, may contain many entities.
-a second signal can be added to the graph in the report by adding another graph entity to the same location. each graph entity may contain its own graph properties.
+A second signal can be added to the graph in the report by adding another graph entity to the same location. Each graph entity may contain its own graph properties.
-reportgraph10.jpg\\
+{{:ReportGraph10.jpg}}
+For example, this image shows two graphs RANKLE_ANGLE and LANKLE_ANGLE located on Page 2, Column 1, Row 1.
-for example, this image shows two graphs rankle_angle and lankle_angle located on page 2, column 1, row 1.
+The resulting graph contains data from the 2 signals. RANGLE_ANGLE in Red and LANKLE_ANGLE in Black, each with its own mean and standard deviation.
-the resulting graph contains data from the 2 signals. rangle_angle in red and lankle_angle in black, each with its own mean and standard deviation.
+{{:ReportGraph11.jpg}}
-reportgraph11.jpg
-}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}