Inspect3D Documentation ToolBar: Difference between revisions

From Software Product Documentation
Jump to navigation Jump to search
(Reorganized to reflect the toolbar organization in the application.)
m (→‎Export: Removed the external scripts note, since this feature was removed in a previous release.)
 
(23 intermediate revisions by 2 users not shown)
Line 7: Line 7:
The tool bar originally appears at the top left hand side of the page. Its sections can be repositioned or made to float outside the window by selecting the set of vertical dots on the left side of the section and dragging it into your desired new position. Right-clicking on the toolbar causes a dropdown menu to appear that allows you to show or hide any of the tool bar sections.  
The tool bar originally appears at the top left hand side of the page. Its sections can be repositioned or made to float outside the window by selecting the set of vertical dots on the left side of the section and dragging it into your desired new position. Right-clicking on the toolbar causes a dropdown menu to appear that allows you to show or hide any of the tool bar sections.  


[[Image:I3DToolBar7.png]]
[[Image:I3DToolBar7.png|700px]]


==Workspace==
==Workspace==
Line 13: Line 13:
[[Image:I3DRestoreDefault.png|30px]] <b>Clear Workspace</b>: clear all the graphs, queries and library paths
[[Image:I3DRestoreDefault.png|30px]] <b>Clear Workspace</b>: clear all the graphs, queries and library paths


[[Image:I3DLoadWorkSpace.png|30px]] <b>Load Workspace</b>: open a workspace that you had previously created and saved (includes group definitions and plots)
[[Image:I3DLoadWorkSpace.png|30px]] <b>Load Workspace</b>: open an application workspace that you had previously created and saved to an .i3d file. This workspace includes query definitions and plots.
* The file being loaded must be in the .i3d format and must have been saved in Inspect3D, a text file saved using any other program (such as Visual3D) cannot be loaded.  


[[Image:I3DSaveWorkspaceAs.png|30px]] <b>Save Workspace As</b>: saves the application workspace
[[Image:I3DSaveWorkspaceAs.png|30px]] <b>Save Workspace As</b>: saves the application workspace
* Workspaces may be opened again to continue working where you left off


[[Image:I3DSaveWorkspace.png|30px]] <b>Save Workspace</b>: save the current application workspace
[[Image:I3DSaveWorkspace.png|30px]] <b>Save Workspace</b>: save the current application workspace
Line 25: Line 23:
[[Image:I3DLoadLibrary.png|30px]] <b>Load Library</b>: opens the [[Inspect3D_Documentation_Load_Library_Dialogue|Library Dialog]]
[[Image:I3DLoadLibrary.png|30px]] <b>Load Library</b>: opens the [[Inspect3D_Documentation_Load_Library_Dialogue|Library Dialog]]


[[Image:I3DGroups.png|30px]] The Group Definitions button is a dropdown with multiple options:
[[Image:I3DGroups.png|30px]] <b>Query Definitions</b>: opens a dropdown menu with the following options:
* [[Image:I3DGroups.png|30px]] <b>Group Definitions</b>: Opens the [[Inspect3D_Advanced_Query_Section|Group Definition Dialog]]
::* [[Image:I3DGroups.png|30px]] <b>Query Definitions</b>: Opens the [[Inspect3D_Advanced_Query_Section|Query Definition Dialog]] where users can define which signals to query from the CMO Library and group different signals together based on different conditions
** Defines which signals to query from the CMO Library and group different signals together based on different conditions
::* [[Image:I3DGroups.png|30px]] <b>Auto-Populate Queries</b>: Opens the [[Inspect3D:_AutoPopulate_Groups|Auto-Populate Queries Dialog]] which can be used to automatically group and import signals based on tags or conditions.
* [[Image:I3DOpenGroupDef.png|30px]] <b>Load Group Def & Compute Groups</b>: loads a Q3D file containing group definitions and query the open library
::* [[Image:I3DOpenGroupDef.png|30px]] <b>Load Query Definitions</b>: loads a [[Q3D Query File|.q3d file]] containing query definitions and queries the open library
* [[Image:I3DSaveGroupDef.png|30px]] <b>Save Group Definitions</b>: saves a Q3D file containing all open group definitions
::* [[Image:I3DOpenGroupDef.png|30px]] <b>Load Query Def & Compute Groups</b>: loads a [[Q3D Query File|.q3d file]] containing query definitions, queries the open library and computes all queries
* [[Image:I3DClearGroupDef.png|30px]] <b>Clear Group Definitions</b>: clears current group definitions
::* [[Image:I3DSaveGroupDef.png|30px]] <b>Save Query Definitions</b>: saves a .q3d file containing all current query definitions
* [[Image:I3DReloadLibrary.png|30px]] <b>Reload Library</b>: re-query the CMO Library. This should be done if you have modified the CMO Library in Visual3D, but note that your current inclusions/exclusions will be overwritten.
::* [[Image:I3DClearGroupDef.png|30px]] <b>Clear Query Definitions</b>: clears current query definitions from the application workspace
::* [[Image:I3DReloadLibrary.png|30px]] <b>Reload Library</b>: re-queries the CMO Library. This should be done if you have modified the CMO Library in Visual3D, but note that your current inclusions/exclusions will be overwritten.


[[Image:I3DLayoutOptions.png|30px]] The layout button allows you to modify the layout of Inspect3D
[[Image:I3DLayoutOptions.png|30px]] <b>Layout Options</b>: opens a dropdown menu with the following options:
* [[Image:I3DRestoreLayout.png|30px]] <b>Restore Layout</b>: returns the layout of the sections of the screen to the position they were in when the program was started for its current session.
::* [[Image:I3DRestoreLayout.png|30px]] <b>Revert Layout</b>: returns the layout of the sections of the screen to the position they were in when the program was started for its current session.
* [[Image:I3DSaveLayout.png|30px]] <b>Save Layout</b>: allows you to save the layout of the screen sections so that they can be reused during another session.
::* [[Image:I3DSaveLayout.png|30px]] <b>Save Layout</b>: allows you to save the layout of the screen sections so that they can be reused during another session.
* [[Image:I3DLoadLayout.png|30px]] <b>Load Layout</b>: allows you to open a layout of the screen sections that you had saved during a previous session.
::* [[Image:I3DLoadLayout.png|30px]] <b>Load Layout</b>: allows you to open a layout of the screen sections that you had saved during a previous session.
* [[Image:I3DRestoreDefault2.png|30px]] <b>Restore Default</b>: returns the screen sections to their original positions (as seen on the main documentation page).
::* [[Image:I3DRestoreDefault2.png|30px]] <b>Redock Subwindows</b>: returns the screen sections to their original positions (as seen on the main documentation page).


==Export==
==Export==


[[Image:I3DExportPCAResults.png|30px]] The Export Results button allows you to export data to a text file.
[[Image:I3DExportPCAResults.png|30px]] <b>Export Results</b>: Opens the [[Export Results]] dialog where users can export data and results to various text file formats.


[[Image:I3DReloadLibrary.png|30px]] The Reload Library reloads the library with any changes to the CMO files made outside of Inspect3D. Note any inclusion/exclusions done within Inspect3D would be lost.
[[Image:I3DReloadLibrary.png|30px]] <b>Recompute Groups</b>: Reloads the list of queries. Users are given the option to update CMZ files with excluded data before re-querying.


[[Image:I3DUpdateCMOsWithBadEvents.png]] The Update CMZs button opens the [[Inspect3D_Pipeline|Update CMZs dialog]] which allows the you to make changes to the original CMZ files by:
[[Image:I3DUpdateCMOsWithBadEvents.png|30px]] <b>Update CMZs</b>: opens the [[Inspect3D_Pipeline|Update CMZs dialog]] where users can make changes to the original CMZ files by:
* Creating BAD events or tags to indicate traces that were excluded in Inspect3D
* Creating BAD events or tags to indicate traces that were excluded in Inspect3D
* Update force assignments based on excluded traces
* Update force assignments based on excluded traces
* Creating events or tags to indicate traces that are included in Inspect3D
* Creating events or tags to indicate traces that are included in Inspect3D
* Run external pipeline scripts on the active data
 
* Remove BAD events or tags that were created in the CMZ file by Inspect3D
* Remove BAD events or tags that were created in the CMZ file by Inspect3D


==Graph Options==
==Graph Options==


[[Image:I3DShowAnimation.png]] The Show Animation button opens an animation window that plays the 3D data for all the data the is selected in the graph.
[[Image:I3DShowAnimation.png|30px]] <b>Show Animation</b>: opens an animation window that plays the 3D data for all the selected data in the graph.


[[Image:I3DShowVideoButton.png]] The Show Video button opens the [[Inspect3D:_Show_Video|video dialogue]].
[[Image:I3DShowVideoButton.png|30px]] <b>Show Video</b>: opens the [[Inspect3D:_Show_Video|video dialog]].


[[Image:I3DShowGraphs2.png|30px]] Pick one graph to display or all graphs:
[[Image:I3DShowGraphs2.png|30px]] <b>Display list of graphs</b>: select one graph to display or all graphs:
* Display Graph(s) Graph n,n or Row or Column
::* [[Image:I3DShowGraphs2.png|30px]] <b>Display Graph(s)</b> Displays a single graph (at row n, column n), a row of graphs or a columns of graphs according to the view option specified in the [[Inspect3D_Documentation_Options_Dialogue#Plotting_options|Show Options]] dialog's <b>Plot View Type</b> item (Single, Row, or Column).
** In [[Inspect3D_Documentation_Options_Dialogue#Plotting_options|Options Dialogue -> Plot View Type]] you can specify the view options:
::* [[Image:I3DShowAllGraphs2.png|30px]] <b>Show All</b>: returns all of the graphs to the screen
*** Single: Display single graph (Row, Column)
*** Row: Display all graphs in that row
*** Column: Display all graphs in that column
* [[Image:I3DShowAllGraphs2.png|30px]] <b>Show All</b>: returns all of the graphs to the screen


[[Image:I3DRescaleGraphs.png|30px]] The Rescale Graphs scales the graph so that the graph is fitted to the data that is being graphed.
[[Image:I3DRescaleGraphs.png|30px]] <b>Rescale Graphs</b>: scales the graph so that the graph is fitted to the data that is being graphed.


[[Image:I3DDeselectData.png|30px]] The Highlight All Data option re-highlights all data.
[[Image:I3DDeselectData.png|30px]] <b>Highlight All Data</b> re-highlights all plotted data.


[[Image:I3DExcludeOptions.png|30px]] Modify Excluded data:
[[Image:I3DExcludeOptions.png|30px]] <b>Modify Excluded data</b>:
* [[Image:I3DExcludeOptions.png|30px]] <b>Exclude Highlighted Trace(s)</b>: Exclude all highlighted traces from further analysis
::* [[Image:I3DExcludeOptions.png|30px]] <b>Exclude Highlighted Trace(s)</b>: Exclude all highlighted traces from further analysis
* [[Image:I3DExcludeSubjects.png|30px]] <b>Exclude Highlighted Subject(s)</b>: Exclude workspace(s) containing highlighted data from further analysis
::* [[Image:I3DExcludeSubjects.png|30px]] <b>Exclude Highlighted Workspace(s)</b>: Exclude workspace(s) containing highlighted data from further analysis
* [[Image:I3DExcludeInclude.png|30px]] <b>Re-Include All Data</b>: Re-Include any excluded data
::* [[Image:I3DExcludeInclude.png|30px]] <b>Re-Include All Data</b>: Re-Include any excluded data


==PCA==
==PCA==


[[Image:I3D_PCAOptions2.png|30px]] The following options allow the user to control the PCA section of Inspect3D.
[[Image:I3D_PCAOptions2.png|30px]] <b>PCA Options</b> opens a dropdown menu with the following items:
* [[Image:I3D_PCAShowGraphs.png|30px]] <b>Show PCA Graphs</b>: shows/hides the PCA graphs from the main section of the program window
::* [[Image:I3D_PCAShowGraphs.png|30px]] <b>Show PCA Graphs</b>: shows/hides the PCA graphs from the main section of the program window
* <b>Number of PCs</b>: the number of primary components that should be calculated
::* <b>Number of PCs</b>: specify the number of primary components that should be calculated
* <b>Use Workspace Mean</b>: use all traces or the the subject means for the PCA calculation
::* <b>Use Workspace Mean</b>: specify whether PCA calculations should use all traces or only the workspace means
* [[Image:I3D_RunPCA.png|30px]] <b>Run QA Using PCA</b>: Opens the [[Inspect3D:Run_QA_Using_PCA|Run QA Using PCA dialog]]
::* [[Image:I3D_RunPCA.png|30px]] <b>Run QA Using PCA</b>: Opens the [[Inspect3D:Run_QA_Using_PCA|Run QA Using PCA dialog]]
* [[Image:I3D_RunPCA.png|30px]] <b>Run PCA</b>: instigates the calculation of the primary components
::* [[Image:I3D_RunPCA.png|30px]] <b>Run PCA</b>: executes principal component analysis with the parameter values from this dropdown menu


==Help==
==Help==


[[Image:I3DQuestions.png|30px]] The Documentation button produces quick access to select Inspect3D wiki pages:
[[Image:I3DQuestions.png|30px]] <b>Documentation</b>: provides quick access to select Inspect3D wiki pages:
* [[Image:I3DOverview.png|30px]] [https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Overview Overview]
* [[Image:I3DOverview.png|30px]] [[Inspect3D_Overview|Overview]]
* [[Image:I3DDocumentation.png|30px]] [https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Documentation Documentation]
* [[Image:I3DDocumentation.png|30px]] [[Inspect3D_Documentation|Documentation]]
* [[Image:I3DTutorials.png|30px]] [https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Tutorials Tutorials]:
* [[Image:I3DTutorials.png|30px]] [[Inspect3D_Tutorials|Tutorials]]:
** [https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Tutorial_1 Tutorial 1 - Quality Assurance]
** [[Inspect3D_Tutorial:_Load_and_View_Data|Tutorial 1: Load signals into Inspect3D and view them]]
** [https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Tutorial_2 Tutorial 2 - Exporting Text Data]
** [[Inspect3D_Tutorial:_Clean_your_Data|Tutorial 2: Clean your data]]
** [https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Tutorial_3 Tutorial 3 - Principal Component Analysis]
** [[Inspect3D_Tutorial:_Perform_Principal_Component_Analysis|Tutorial 3: Perform principal component analysis]]
* [[Image:I3DTroubleshooting.png|30px]] [https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Troubleshooting Troubleshooting]
** [[Inspect3D_Tutorial:_Export_Results|Tutorial 4: Export Results]]
 
* [[Image:I3DTroubleshooting.png|30px]] [[Inspect3D_Troubleshooting|Troubleshooting]]
[[Image:I3DAboutDialogue.png|right]]
[[Image:I3DAboutDialogue.png|right]]
* [[Image:I3DAboutButton.png|30px]] <b>About</b>:
* [[Image:I3DAboutButton.png|30px]] <b>About</b>:
Line 104: Line 99:
** License Number
** License Number
** The Activation and Deactivation Button
** The Activation and Deactivation Button


[[Category:Inspect3D]]
[[Category:Inspect3D]]

Latest revision as of 16:38, 8 November 2023

Language:  English  • français • italiano • português • español 

The tool bar originally appears at the top left hand side of the page. Its sections can be repositioned or made to float outside the window by selecting the set of vertical dots on the left side of the section and dragging it into your desired new position. Right-clicking on the toolbar causes a dropdown menu to appear that allows you to show or hide any of the tool bar sections.

Workspace

Clear Workspace: clear all the graphs, queries and library paths

Load Workspace: open an application workspace that you had previously created and saved to an .i3d file. This workspace includes query definitions and plots.

Save Workspace As: saves the application workspace

Save Workspace: save the current application workspace

Show Options: opens the Options Dialog

Load Library: opens the Library Dialog

Query Definitions: opens a dropdown menu with the following options:

  • Query Definitions: Opens the Query Definition Dialog where users can define which signals to query from the CMO Library and group different signals together based on different conditions
  • Auto-Populate Queries: Opens the Auto-Populate Queries Dialog which can be used to automatically group and import signals based on tags or conditions.
  • Load Query Definitions: loads a .q3d file containing query definitions and queries the open library
  • Load Query Def & Compute Groups: loads a .q3d file containing query definitions, queries the open library and computes all queries
  • Save Query Definitions: saves a .q3d file containing all current query definitions
  • Clear Query Definitions: clears current query definitions from the application workspace
  • Reload Library: re-queries the CMO Library. This should be done if you have modified the CMO Library in Visual3D, but note that your current inclusions/exclusions will be overwritten.

Layout Options: opens a dropdown menu with the following options:

  • Revert Layout: returns the layout of the sections of the screen to the position they were in when the program was started for its current session.
  • Save Layout: allows you to save the layout of the screen sections so that they can be reused during another session.
  • Load Layout: allows you to open a layout of the screen sections that you had saved during a previous session.
  • Redock Subwindows: returns the screen sections to their original positions (as seen on the main documentation page).

Export

Export Results: Opens the Export Results dialog where users can export data and results to various text file formats.

Recompute Groups: Reloads the list of queries. Users are given the option to update CMZ files with excluded data before re-querying.

Update CMZs: opens the Update CMZs dialog where users can make changes to the original CMZ files by:

  • Creating BAD events or tags to indicate traces that were excluded in Inspect3D
  • Update force assignments based on excluded traces
  • Creating events or tags to indicate traces that are included in Inspect3D
  • Remove BAD events or tags that were created in the CMZ file by Inspect3D

Graph Options

Show Animation: opens an animation window that plays the 3D data for all the selected data in the graph.

Show Video: opens the video dialog.

Display list of graphs: select one graph to display or all graphs:

  • Display Graph(s) Displays a single graph (at row n, column n), a row of graphs or a columns of graphs according to the view option specified in the Show Options dialog's Plot View Type item (Single, Row, or Column).
  • Show All: returns all of the graphs to the screen

Rescale Graphs: scales the graph so that the graph is fitted to the data that is being graphed.

Highlight All Data re-highlights all plotted data.

Modify Excluded data:

  • Exclude Highlighted Trace(s): Exclude all highlighted traces from further analysis
  • Exclude Highlighted Workspace(s): Exclude workspace(s) containing highlighted data from further analysis
  • Re-Include All Data: Re-Include any excluded data

PCA

PCA Options opens a dropdown menu with the following items:

  • Show PCA Graphs: shows/hides the PCA graphs from the main section of the program window
  • Number of PCs: specify the number of primary components that should be calculated
  • Use Workspace Mean: specify whether PCA calculations should use all traces or only the workspace means
  • Run QA Using PCA: Opens the Run QA Using PCA dialog
  • Run PCA: executes principal component analysis with the parameter values from this dropdown menu

Help

Documentation: provides quick access to select Inspect3D wiki pages:

  • About:
    • Version Number
    • Release Date
    • Copyright Information
    • Contact Information (support@c-motion.com)
    • CMLib Version Number
    • License Number
    • The Activation and Deactivation Button
Retrieved from ""