HAS-Motion Software Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Load and View Data ======

This tutorial begins by assuming that you have a [[Visual3D:Documentation:Definitions:File_Formats:CMZ_Format_|CMZ]] file for each subject/session from [[Visual3D:Visual3D_Overview|Visual3D]]. If necessary you can use our [[Other:Inspect3D:Tutorials:Build_CMZs|build CMZ feature]] or work through the Visual3D tutorial for [[Visual3D:Tutorials:Pipeline:Generic_Pipeline_to_Create_CMZ|building a CMZ file]].

==== Data ====

This tutorial can be completed with any CMZ file. One possibility is a data set from a Visual3D Workshop at a recent ASB meeting: [[https://www.has-motion.com/download/examples/V3D_Workshop.zip|V3D Workshop @ ASB]].
\\
\\
\\
{{ :Inspect3D_Loaded_Library.png?350}}
==== Load your library ====

To start, you need to tell Inspect3D where to look for your data. After opening Inspect3D:
  - {{:I3DLoadLibrary.png?20}} Click the Load Library button on the [[Other:Inspect3D:Documentation:Dialogs:ToolBar|toolbar]] to open the Library dialog:
    - Click **Browse** to open a dialog that allows you to select a file path
    - Select the top level folder/root directory which contains the CMZ files NOTE: the CMZ files' associated CMX files must also be present for Inspect3D to be able to load the library.
    - Click **Select Folder**
  - Click **Load**
  - Once the library is loaded, you will be able to do some initial exploration here in the Load Library dialog:
    - Verify which CMZ files have been loaded in the 3D Viewer dropdown box as well as which C3D files are associated with each CMZ;
    - Verify which file tags are present in the library;
    - If you have loaded [[Visual3D:Documentation:Definitions:Multisubject|multisubject data]], verify which [[Visual3D:Documentation:Definitions:Multisubject#Important_Terms|subject prefixes]] and [[Visual3D:Documentation:Definitions:Multisubject#Important_Terms|subject tags]] are present in the library; and
    - Animate the data contained in any loaded C3D file.
  - Close the Library dialog

\\
\\

==== Define queries and group signals ====

Once you have loaded the library, the Group definition dialog will be activated. You now have the ability to automatically or manually define queries that will group the signals in your library. To do this:
{{ :inspect3d_auto-populated_Queries.png?550}}
  - Click on {{:I3DGroups.png?20}} **Query Definitions** on the [[Other:Inspect3D:Documentation:Dialogs:ToolBar|toolbar]]
  - Click on {{:I3DGroups.png?20}} **Query Definitions** to define group definitions for the first time and open the [[Other:Inspect3D:Documentation:Dialogs:Advanced_Query_Section|Query Builder Dialog]]
  - Alternatively, if you have previously saved query definitions, you can click on {{:I3DOpenGroupDef.png?20}} **Load Query Def & Compute Groups** to load a [[Other:Inspect3D:Documentation:Files:Q3D_Query_File|.q3d]] file containing query definitions and then automatically calculate the groups for the loaded library.
  - Either manually create group definitions by
    - Clicking the {{:ActionAdd48x48.png?20}} green addition button to name a new group and add it
    - While your new group is selected, click the {{:ActionAdd48x48.png?20}} green addition button to name and define a new sub-group
    - Repeat these steps until you have created all of your groups
  - OR Click **Auto-Populate Groups**
    - Accept the default settings and click **Create**
  - Once you have created your query definitions:
    - **Calculate All Queries** to apply the queries you have defined to the loaded library.
    - Close the Query Builder dialog. Note that if Inspect3D has not finished computing all of the groups then it will ask you if you want it to continue. Click **Compute Groups**.

=== Manually Create Group Definitions (Video) === 
                                                                                                                                                    
{{https://has-motion.com/download/inspect_3d/Inspect3DManuallyDefineGroups.mp4}}

==== Visualize your data ====

Now that the signals in the library have been grouped, it is now possible to visually examine them and begin exploring your data:

  - Select a particular group in the **Groups** widget of the Queried Data subwindow to determine which signals you would like to view
  - Selecting different workspaces in the Queried Data subwindow's **Workspaces** widget determines which are displayed. Checking the **Select All Workspaces** box conveniently displays all of the workspaces associated with your selected group(s)
  - Check the appropriate boxes to plot all sequences, workspace means/standard deviations, and group means/standard deviations.
  - Click **Refresh Plot**

{{:SignalsAndTraces.png}}

The [[Other:Inspect3D:Documentation:Dialogs:Load_Library_Dialogue|Options dialog]] allows you to modify the [[Other:Inspect3D:Documentation:Pages:Queried_Data#Plotting_Options|plot options]] to determine what is displayed. For example, you can choose the number and layout of plots to display, change how lines are coloured and styled, and modify axis labels among many other things.

If you have multiple plots, then a gray bounding box will appear around the active plot, identifying which plot is currently being modified.


==== Interact with your data ====

You can highlight a trace by left-clicking on it. This causes the trace to become more visually prominent than non-highlighted traces and produces a tooltip that includes:

  - The trace's group name
  - The trace's workspace name
  - The name of the specific [[Visual3D:Documentation:C3D_Signal_Types:C3D_Format|C3D]] file for that trace
  - The trace's frame range from that C3D file
  - The trace's sub-group name
  - The x- and y- values of the trace where you left-clicked it

A trace can be excluded from the plot by:

  - left-clicking on the trace to highlight it; then
  - right-clicking and selecting **Exclude** > **Exclude Trace (raw data)** from the context menu.

You can confirm that the trace has been excluded in the **Workspaces** widget: excluded traces will be marked with a red X and workspaces containing excluded traces will have their checkmark icon replaced by an X.

=== Manually View Group Definitions (Video) ===

{{https://has-motion.com/download/inspect_3d/Inspect3DPlottingData.mp4}}

==== Save the application workspace ====

Click {{:I3DSaveWorkspaceAs.png?20}} **Save Workspace As** to save the work you've done so far. This saves the application workspace as an [[Other:Inspect3D:Documentation:Files:I3D_Workspace_File|.i3d file]], which is an XML file.

NOTE: If you have excluded data then your CMZ files are out of sync with your Inspect3D workspace at this point. This means that if you re-queried the loaded library, you would need to exclude the traces again. To avoid this, click the {{:I3DUpdateCMOsWithBadEvents.png?20}} **Update CMZ files** icon on the [[Other:Inspect3D:Documentation:Dialogs:ToolBar|toolbar]] to update your CMZ files at any point.

==== Navigate Tutorials ====

Previous: None

**Inspect3D Getting Started Tutorials**

Next: [[Other:Inspect3D:Tutorials:Clean_your_Data|Tutorial 2: Clean your Data]]