Inspect3D Advanced Query Section: Difference between revisions

From Software Product Documentation
Jump to navigation Jump to search
(Updated all references to Group/Sub-Group to Query/Condition.)
 
(9 intermediate revisions by 3 users not shown)
Line 6: Line 6:




=Introduction=
The Query Builder dialog is used to define the queries that will extract signals from the loaded CMZ library. The dialog also allows you to group specific signals together based on a number of possible features, e.g. right/left or intact/affected.


The group definition dialog is used to define which signals you want to query from the CMZ library and allows you to group data together (ex. right and left side, intact/affected).
[[Image:querybuilder.png|700 px]]


[[Image:FullAdvancedQueriesDialogue3.png]]
==Auto-Populate Queries==


=Sections=
Inspect3D has the convenient ability to automatically define queries based on common signals and groupings. This feature saves the user from the tedious task of manually defining common queries. More information about Auto-Populating Groups can be found [[Inspect3D:_AutoPopulate_Groups|here]].


==Group Definition File==
==Query Definition File==


[[Image:I3DAdvancedQueriesDialogueLoadSave.png]]
[[Image:I3DAdvancedQueriesDialogueLoadSave.png]]


You can save group definitions (.q3d) so they can be loaded again (for use on the same or a different CMZ library). You can save one group definition at a time to a file, or all files.
Inspect3D also allows users to save time by saving queries definitions to a [[Q3D Query File|.q3d file]] so that they can be easily re-used during future analysis. This capability is at its most useful when using the Load Group Def & Compute Groups option in the Group Definitions drop-down menu.


==Groups and Sub Groups==
==Queries and Conditions==


{| style= width="100%"
{| style= width="100%"
| style="width: 50%" align="left" style="vertical-align:top"|  
| style="width: 50%" align="left" style="vertical-align:top"|  
You can define Groups and Sub-Groups.  
You can define Groups and Sub-Groups for the signals in the CMZ library.
* A <b>Group</b> would be "AnkleMoment_X"
* An example <b>Group</b> is "AnkleMoment_X"
* A <b>Sub-Group</b> would be "LAnkleMoment_X" and "RAnkleMoment_X"
* Example <b>Sub-Groups</b> for "AnkleMoment_X" are "LAnkleMoment_X" and "RAnkleMoment_X"
* A group can have as many Sub-Groups as necessary (1-N)
* A group can have as many Sub-Groups as necessary (1-N)


Note: Groups and Sub-Groups can use spaces and special characters - if you plan to update the CMZ files with exclusions, be cautious using special characters. Sub-Group names can be repeated in different groups (but not within the same group).
Names for Queries and Conditions can include spaces and special characters. Note, however, that some special characters can cause difficulty for updating CMZ libraries with exclusions. Condition names can be repeated between different queries but not within a single query.
| style= "width: 50%" align="right" style="vertical-align:top"|  
| style= "width: 50%" align="right" style="vertical-align:top"|  
[[Image:I3DAdvancedQueriesDialogueQueryName2.png|right]]
[[Image:I3DAdvancedQueriesDialogueQueryName2.png|right]]
|}
|}


==Sub-Group Definition==
==Condition Definition==


The Sub-Group Definition lets you define the signals you want to query. These signals are defined using the following information:
The Condition Definition lets you define the signals you want to query. Query results are defined according to the signals you want from the CMZ library, the events or event sequences to which you want to time normalize the signals, and any further refinements that you want to apply, e.g., threshold values.


===Signals===
===Signals===
{| style= width="100%"
{| style= width="100%"
| style="width: 50%" align="left" style="vertical-align:top"|  
| style="width: 50%" align="left" style="vertical-align:top"|  
[[File:I3D_GroupDef_Signals.png|350px]]
[[File:I3D_GroupDef_Signals.png|350px]]
| style= "width: 50%" align="left" style="vertical-align:top"|  
| style= "width: 50%" align="left" style="vertical-align:top"|  
Name of the signal as it is referenced in the [[Data_Tree_Summary|Visual3D Data Tree]]:
This tab allows the user to select a signal according to how it is specified in the [[Data_Tree_Summary|Visual3D Data Tree]]. This specification includes four components with an additional option to negate the results.
* Type
* Type
* Folder
* Folder
Line 53: Line 52:


===Events===
===Events===
{| style= width="100%"
{| style= width="100%"
| style="width: 50%" align="left" style="vertical-align:top"|  
| style="width: 50%" align="left" style="vertical-align:top"|  
[[File:I3D_GroupDef_Events.png|350px]]
[[File:I3D_GroupDef_Events.png|350px]]
| style= "width: 50%" align="left" style="vertical-align:top"|  
| style= "width: 50%" align="left" style="vertical-align:top"|  
Events you want to use to normalize the data to:
This tab allows user to specify the events to which the data will be normalized, which event sequences should be excluded, and how the data should be normalized.
* <b>Event Sequence:</b> Events to normalize data to
* <b>Event Sequence:</b> Events to normalize data to
** Typically Kinematic Signals are normalized from R/LHS to R/LHS  
** Typically Kinematic Signals are normalized from R/LHS to R/LHS  
Line 69: Line 67:


===Refinement===
===Refinement===
{| style= width="100%"
{| style= width="100%"
| style="width: 50%" align="left" style="vertical-align:top"|  
| style="width: 50%" align="left" style="vertical-align:top"|  
[[File:I3D_GroupDef_Refinement.png|350px]]
[[File:I3D_GroupDef_Refinement.png|350px]]
| style= "width: 50%" align="left" style="vertical-align:top"|  
| style= "width: 50%" align="left" style="vertical-align:top"|  
<b>Refinement:</b>
This tab permits signal selection to be refined according to additional conditions that must be met. There are two broad types of refinements:
* <b>Refine using tag:</b> Any tags that exist in the workspace can be selected
* <b>Refine using tag:</b> Any tags that exist in the workspace can be selected
* <b>Use AND Logic:</b> If two tags are selected:
** <b>Use AND Logic:</b> Determines how to treat refinements based on more than one tag. If checked, then the query will only include trials that contain ALL of the selected tags. If unchecked then the query will include trials that contain ANY of the selected tags.
** Checking AND will only include trials that contain both tags
** Unchecking AND will include any trials that contain either tag
* <b>Refine using signal:</b> Allows you to add further requirements to query a signal
|}
|}
<br>
<br>
Line 85: Line 79:
{| style= width="100%"
{| style= width="100%"
| style="width: 50%" align="left" style="vertical-align:top"|  
| style="width: 50%" align="left" style="vertical-align:top"|  
Refinement allows you to say if this trial contains "Signal X", check if that signal meets the specified criteria.
* <b>Refine using signal:</b> These refinements allow users to specify additional criteria that must be met before a signal in brought into the group you define. These criteria are defined using the following information:
* <b>Refinement Name:</b> Each refinement in a sub-group requires a unique name
** <b>Refinement Name:</b> Each refinement in a sub-group requires a unique name
* <b>Signal Definition:</b> Specify the signal you want to work with as it is referenced in the [[Data_Tree_Summary|Visual3D Data Tree]]
** <b>Signal Definition:</b> Specify the signal you want to work with as it is referenced in the [[Data_Tree_Summary|Visual3D Data Tree]], i.e., Type, Folder, Name, and Component.
** <b>Type:</b>
** <b>Value Must Be:</b> There are 6 types of criteria that can be specified for a refinement.
** <b>Folder:</b>
*** <b>Less Than</b>: The signal must be less than the specified threshold to be included
** <b>Name:</b>
*** <b>Greater Than</b>: The signal must be greater than the specified threshold to be included
** <b>Component:</b>
*** <b>Equal To</b>: The signal must be equal to the specified threshold to be included
* <b>Value Must Be:</b> Options are:
*** <b>Not Equal To</b>: The signal must not be equal to the specified threshold to be included
** <b>Less Than</b>: Specify a threshold the signal must be less than
*** <b>Between</b>: The signal must be between the two specified values to be included
** <b>Greater Than</b>: Specify a threshold the signal must be greater than
*** <b>Manual</b>: The signal must satisfy the specified [[Expressions|Visual3D Expression]]
** <b>Equal To</b>: Specify a threshold the signal must be equal to
** <b>Not Equal To</b>: Specify a threshold the signal must not be equal to
** <b>Between</b>: Specify two values the signal must be between
** <b>Manual</b>: Specify a [[Expressions|Visual3D Expression]] the signal must satisfy
| style= "width: 50%" align="left" style="vertical-align:top"|  
| style= "width: 50%" align="left" style="vertical-align:top"|  
[[File:I3D_GroupDef_RefinementDialog.png|250px]]
[[File:I3D_GroupDef_RefinementDialog.png|250px]]

Latest revision as of 17:12, 19 October 2023

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


The Query Builder dialog is used to define the queries that will extract signals from the loaded CMZ library. The dialog also allows you to group specific signals together based on a number of possible features, e.g. right/left or intact/affected.

Auto-Populate Queries

Inspect3D has the convenient ability to automatically define queries based on common signals and groupings. This feature saves the user from the tedious task of manually defining common queries. More information about Auto-Populating Groups can be found here.

Query Definition File

Inspect3D also allows users to save time by saving queries definitions to a .q3d file so that they can be easily re-used during future analysis. This capability is at its most useful when using the Load Group Def & Compute Groups option in the Group Definitions drop-down menu.

Queries and Conditions

You can define Groups and Sub-Groups for the signals in the CMZ library.

  • An example Group is "AnkleMoment_X"
  • Example Sub-Groups for "AnkleMoment_X" are "LAnkleMoment_X" and "RAnkleMoment_X"
  • A group can have as many Sub-Groups as necessary (1-N)

Names for Queries and Conditions can include spaces and special characters. Note, however, that some special characters can cause difficulty for updating CMZ libraries with exclusions. Condition names can be repeated between different queries but not within a single query.

Condition Definition

The Condition Definition lets you define the signals you want to query. Query results are defined according to the signals you want from the CMZ library, the events or event sequences to which you want to time normalize the signals, and any further refinements that you want to apply, e.g., threshold values.

Signals

This tab allows the user to select a signal according to how it is specified in the Visual3D Data Tree. This specification includes four components with an additional option to negate the results.

  • Type
  • Folder
  • Name
  • Component
  • Negate Results

Events

This tab allows user to specify the events to which the data will be normalized, which event sequences should be excluded, and how the data should be normalized.

  • Event Sequence: Events to normalize data to
    • Typically Kinematic Signals are normalized from R/LHS to R/LHS
    • Typically Kinetic Signals are normalized from R/LON to R/LHS
  • Exclude Events:
    • Event sequences that data should not be included
  • Number of Points: Typically a gait cycle is normalized to 101 data points
  • Spline Type: Cubic or Linear - you should use a cubic spline to normalize the data

Refinement

This tab permits signal selection to be refined according to additional conditions that must be met. There are two broad types of refinements:

  • Refine using tag: Any tags that exist in the workspace can be selected
    • Use AND Logic: Determines how to treat refinements based on more than one tag. If checked, then the query will only include trials that contain ALL of the selected tags. If unchecked then the query will include trials that contain ANY of the selected tags.



  • Refine using signal: These refinements allow users to specify additional criteria that must be met before a signal in brought into the group you define. These criteria are defined using the following information:
    • Refinement Name: Each refinement in a sub-group requires a unique name
    • Signal Definition: Specify the signal you want to work with as it is referenced in the Visual3D Data Tree, i.e., Type, Folder, Name, and Component.
    • Value Must Be: There are 6 types of criteria that can be specified for a refinement.
      • Less Than: The signal must be less than the specified threshold to be included
      • Greater Than: The signal must be greater than the specified threshold to be included
      • Equal To: The signal must be equal to the specified threshold to be included
      • Not Equal To: The signal must not be equal to the specified threshold to be included
      • Between: The signal must be between the two specified values to be included
      • Manual: The signal must satisfy the specified Visual3D Expression

Retrieved from ""