Inspect3D Documentation ToolBar: Difference between revisions

From Software Product Documentation
Jump to navigation Jump to search
m (→‎Export: Removed the external scripts note, since this feature was removed in a previous release.)
 
(48 intermediate revisions by 3 users not shown)
Line 5: Line 5:
|}
|}


=Introduction=
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. However, its sections can be moved by selecting the set of vertical dots on the left side of the section and dragging it into a new position. If you right click on the tool bar a dropdown menu will appear that will allow you to hide any of the tool bar sections.  
[[Image:I3DToolBar7.png|700px]]


[[Image:I3DToolBar7.png]]
==Workspace==


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


==Clear Workspace==
[[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.


[[Image:I3DRestoreDefault.png]] The Clear Workspace button will clear all the graphs, queries and library paths.
[[Image:I3DSaveWorkspaceAs.png|30px]] <b>Save Workspace As</b>: saves the application workspace


==Load Workspace==
[[Image:I3DSaveWorkspace.png|30px]] <b>Save Workspace</b>: save the current application workspace


[[Image:I3DLoadWorkSpace.png]] The Load Workspace button allows you to open a workspace that you had previously created and saved. This includes any Library Queries, Data Queries, and Plots that have been created.
[[Image:I3DShowOptions.png|30px]] <b>Show Options</b>: opens the [[Inspect3D_Documentation_Options_Dialogue|Options Dialog]]
* 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.
* The 'Save Workspace' button updates the loaded workspace
* Use the 'Save Workspace As' if you don't want to update the original workspace


==Save Workspace As==
[[Image:I3DLoadLibrary.png|30px]] <b>Load Library</b>: opens the [[Inspect3D_Documentation_Load_Library_Dialogue|Library Dialog]]


[[Image:I3DSaveWorkspaceAs.png]] The Save Workspace As button allows you to save your workspace, which includes any Library Queries, Data Queries, and Plots that have been created. They may be opened again in the future and allow you to continue working on you project from where you had left off. The Save Workspace As button is used the first time a new workspace is saved the a browser window will open allowing you to specify the workspace name and where to save it.  
[[Image:I3DGroups.png|30px]] <b>Query Definitions</b>: opens a dropdown menu with the following options:
::* [[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
::* [[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 Query Definitions</b>: loads a [[Q3D Query File|.q3d file]] containing query definitions and queries the open library
::* [[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:I3DSaveGroupDef.png|30px]] <b>Save Query Definitions</b>: saves a .q3d file containing all current query definitions
::* [[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.


==Save Workspace==
[[Image:I3DLayoutOptions.png|30px]] <b>Layout Options</b>: opens a dropdown menu with the following options:
::* [[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: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>Redock Subwindows</b>: returns the screen sections to their original positions (as seen on the main documentation page).


[[Image:I3DSaveWorkspace.png]] Once the active workplace has been saved using the Save Workspace As button, clicking the Save Workspace button will simply update the saved file and maintain the previously designated file name and location.
==Export==


==Show Options==
[[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:I3DShowOptions.png]] The Show Options button opens the options dialogue. For more information on the options available see the [[Inspect3D_Documentation_Options_Dialogue|Options page]].
[[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.


==Load Library==
[[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
* Update force assignments based on excluded traces
* Creating events or tags to indicate traces that are included in Inspect3D


[[Image:I3DLoadLibrary.png]] The Load Library button opens the Library dialogue. For more information on loading libraries see the [[Inspect3D_Documentation_Load_Library_Dialogue|Load Library page]].
* Remove BAD events or tags that were created in the CMZ file by Inspect3D


==Group Definitions==
==Graph Options==


[[Image:I3DGroups.png|30px]] The Group Definitions button is a dropdown with multiple options:
[[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:I3DQueriesDropdown.png]]
[[Image:I3DShowVideoButton.png|30px]] <b>Show Video</b>: opens the [[Inspect3D:_Show_Video|video dialog]].


===Group Definitions===
[[Image:I3DShowGraphs2.png|30px]] <b>Display list of graphs</b>: select one graph to display or all graphs:
::* [[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).
::* [[Image:I3DShowAllGraphs2.png|30px]] <b>Show All</b>: returns all of the graphs to the screen


Opens the [[Inspect3D_Advanced_Query_Section|Advanced Query Dialogue]] to define what signals to query from the CMO Library and group different signals together based on different conditions.
[[Image:I3DRescaleGraphs.png|30px]] <b>Rescale Graphs</b>: scales the graph so that the graph is fitted to the data that is being graphed.


===Load Group Def & Compute Groups===
[[Image:I3DDeselectData.png|30px]] <b>Highlight All Data</b> re-highlights all plotted data.


Load a Q3D file containing group definitions and query the open library.
[[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: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


===Save Group Definitions===
==PCA==


Save a Q3D file containing all open group definitions.
[[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
::* <b>Number of PCs</b>: specify the number of primary components that should be calculated
::* <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 PCA</b>: executes principal component analysis with the parameter values from this dropdown menu


===Clear Group Definitions===
==Help==


Clear current group definitions.
[[Image:I3DQuestions.png|30px]] <b>Documentation</b>: provides quick access to select Inspect3D wiki pages:
 
* [[Image:I3DOverview.png|30px]] [[Inspect3D_Overview|Overview]]
===Reload Library===
* [[Image:I3DDocumentation.png|30px]] [[Inspect3D_Documentation|Documentation]]
 
* [[Image:I3DTutorials.png|30px]] [[Inspect3D_Tutorials|Tutorials]]:
Re-query the CMO Library (this should be done if you modified the CMO Library in Visual3D). Note that any current inclusions/exclusions done in Inspect3D would be overwritten.
** [[Inspect3D_Tutorial:_Load_and_View_Data|Tutorial 1: Load signals into Inspect3D and view them]]
 
** [[Inspect3D_Tutorial:_Clean_your_Data|Tutorial 2: Clean your data]]
==Layout Options==
** [[Inspect3D_Tutorial:_Perform_Principal_Component_Analysis|Tutorial 3: Perform principal component analysis]]
 
** [[Inspect3D_Tutorial:_Export_Results|Tutorial 4: Export Results]]
[[Image:I3DLayoutOptions.png|30px]] The layout button allows you to modify the layout of Inspect3D  
* [[Image:I3DTroubleshooting.png|30px]] [[Inspect3D_Troubleshooting|Troubleshooting]]
 
===Restore Layout===
 
[[Image:I3DRestoreLayout.png|30px]] The Restore Layout button 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===
 
[[Image:I3DSaveLayout.png|30px]] The Save Layout button allows you to save the layout of the screen sections so that they can be reused during another session.
 
===Load Layout===
 
[[Image:I3DLoadLayout.png|30px]] The Load Layout button allows you to open a layout of the screen sections that you had saved during a previous session.
 
===Restore Default===
 
[[Image:I3DRestoreDefault2.png|30px]] The Restore Default button will return the screen sections to their original positions (as seen on the main documentation page).
 
==Export Results==
 
[[Image:I3DExportPCAResults.png|30px]] The Export Results button allows you to export data to a text file.
 
==Reload Library==
 
[[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.
 
==Update CMOs With Bad Events==
 
[[Image:I3DUpdateCMOsWithBadEvents.png]] The Update CMOs With Bad Events button opens the Update CMOs dialogue box which allows the you to make changes to the original CMOs based on how you have manipulated the traces in Inspect3D.
 
[[Image:UpdateCMOsDialogue2.png|right]]
 
===Exclude Traces===
 
'''Add Event to Exclude Signals''' - If the Add Event to Exclude Signals checkbox is selected the event name in text box below are added to all the excluded signals.
 
'''Text Box''' - The default Bad Event name is BAD. However, it can be appended to include more information. For example, BAD_Legs, if the bad events should only affect the legs and upper arm movements should not be excluded.
 
'''Add Tag to Excluded Signals''' - If the Add Tag to Exclude Signals checkbox is selected the tag name in the text box below is added to all the excluded signals.
 
'''Text Box''' - The default Bad Tag name is BAD. However, it can be appended to include more information. For example, BAD_Legs, if the bad events should only affect the legs and upper arm movements should not be excluded.
 
'''Use condition name for side (right/left)''' - If the Use condition name for side checkbox is selected then right or left will be added to the BAD event to indicate which side it is associated with.
 
'''Remove Force Assignment For Excluded Signals''' - If the Remove Force Assignment For Excluded Signals checkbox is selected then all of the force assignments that are associated with an excluded signal will be deleted.
 
'''Remove C3D file for excluded signals''' - If the Remove C3D file for excluded signals checkbox is selected then the c3d file for excluded events is removed from the .cmo file.
 
===Selected Traces===
 
'''Add Tag to Traces''' - If the Add Tag to Traces checkbox is selected and a name is typed into the Tag Name text box then the c3d files of all the selected traces will be tagged with the Tag Name.
 
'''Add Event to Traces''' - If the Add Event to Traces checkbox is selected and a name is typed into the Event Name text box then an event is added to all the traces that are selected.
 
===Controls===
 
'''Cancel''' - Clicking on the Cancel button will close the Update CMOs dialogue without making any changes to the original CMOs.
 
'''Update CMOs''' - Clicking on the Update CMOs button will make changes to the CMO files. These changes cannot be undone from within Inspect3D.
 
==Show Animation==
 
[[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.
 
==Show Video==
 
[[Image:I3DShowVideoButton.png]] The Show Video button opens the video dialogue. The Selected Traces section of the dialogue box can be expanded and collapsed by selecting and deselecting the Selected Traces check box.
 
<table>
<tr>
<td>
 
[[Image:I3DVideoDialogue.png|left]]
 
</td>
<td>
 
'''Query''' - The Query drop down menu has a list of all the queries computed in the current workspace.
 
'''Subject''' - The Subject drop down menu has a list of all the .cmo files that are loaded into the workspace.
 
'''Motion File''' - The Motion File drop down menu has a list of all the .c3d files that are contained in the selected subject or .cmo file.
 
'''Frames''' - The Frames drop down menu has a list of all the frame ranges that are outlined by the events in the queries.
 
'''Associate C3D with Video''' -
 
'''Associate Frames with Video''' -
 
'''Trim the video to the selected trace times''' - The Trim the video to the selected trace times check box allows the user to sync the length of the video to the length of the trace that is selected in the Selected Traces section.
 
'''Browse''' - The Browse button opens a standard file search window that allows the user to select the .avi video file that should be loaded.
 
'''Video''' - The video file that you have loaded using the Browse button. '''Note:''' If the Video section is not present when you first open the Video Dialogue, increase the size of the dialogue box. The video function will not work on virtual machines such as Parallels.
 
'''Controller''' - The Controller allows the user to navigate the video file.
 
</td>
</tr>
</table>
 
==Show Graphs==
 
[[Image:I3DShowGraphs2.png|30px]] Pick one graph to display or all graphs:
 
===Graph n,n or Row or Column===
 
Display Graph: Row, Column
 
To change the number of graphs displayed, go to [[Inspect3D_Documentation_Options_Dialogue#Plotting_options|Options Dialogue Plot View Type]].
 
===Show all===
 
[[Image:I3DShowAllGraphs2.png|30px]] The Show All button returns all of the graphs to the screen.
 
==Rescale Graphs==
 
[[Image:I3DRescaleGraphs.png|30px]] The Rescale Graphs scales the graph so that the graph is fitted to the data that is being graphed.
 
==Highlight All Data==
 
[[Image:I3DDeselectData.png|30px]] The Highlight All Data option re-highlights all data.
 
==Exclusion Options==
 
[[Image:I3DExcludeOptions.png|30px]] Modify Excluded data:
 
===Exclude Highlighted Trace(s)===
 
[[Image:I3DExcludeOptions.png|30px]] Exclude all highlighted traces from further analysis.
 
===Exclude Highlighted Subject(s)===
 
[[Image:I3DExcludeSubjects.png|30px]] Exclude workspace(s) containing highlighted data from further analysis.
 
===Re-Include All Data===
 
[[Image:I3DExcludeInclude.png|30px]] Re-Include any excluded data
 
==PCA Options==
 
[[Image:I3D_PCAOptions2.png|left]] The following options allow the user to control the PCA section of Inspect3D.
 
===Show PCA Graphs===
 
The Show PCA Graphs button allows the user to add and remove the PCA graphs from the main section of the program window.
 
===Number PC's===
 
The Number of PC's button allows the user to enter the number of primary components that should be calculated.
 
===Use Subject Mean===
 
The Use Subject Mean checkbox allows the user to use the subject means for the PCA calculation.
 
===Run QA Using PCA===
 
===Run PCA===
 
The Run PCA button instigates the calculation of the primary components.
 
==Documentation==
 
[[Image:I3DDocumentation.png]] The Documentation button produces a drop down menu that allows you to access various Inspect3D wiki pages.
 
[[Image:I3DDocumentationDropDown.png|right]] The dropdown menu includes the following links:
-[https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Overview Overview]
 
-[https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Documentation Documentation]
 
-[https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Tutorials Tutorials]. The tutorial button expands into a drop down menu that includes links to specific tutorials, including:<br>
:-[https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Tutorial_1 Tutorial 1 - Quality Assurance]
:-[https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Tutorial_2 Tutorial 2 - Export Tool]
:-[https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Tutorial_3 Tutorial 3 - Principal Component Analysis]
 
-[https://www.c-motion.com/v3dwiki/index.php/Inspect3D_Troubleshooting Troubleshooting]
[[Image:I3DAboutDialogue.png|right]]
[[Image:I3DAboutDialogue.png|right]]
* [[Image:I3DAboutButton.png|30px]] <b>About</b>:
** Version Number
** Release Date
** Copyright Information
** Contact Information (support@c-motion.com)
** CMLib Version Number
** License Number
** The Activation and Deactivation Button


-About
:The About dialogue contains several important pieces of information regarding the Inspect3D program. These include:
:-Version Number
:-Release Date
:-Copyright Information
:-Contact Information (support@c-motion.com)
:-CMLib Version Number
:-License Number
:-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 ""