Sift - Query Builder Dialog: Difference between revisions

From Software Product Documentation
Jump to navigation Jump to search
(Re-ordered page to start with Manual Query Building. Added note about choosing 0 as the "Number of Points" to avoid time normalization.)
 
Line 5: Line 5:
|}
|}
The Query Builder 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 Query Builder 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.
[[file:sift_query_builder_whole.png|500px]]
[[file:sift_query_builder_whole.png|500px]]
<br>
<br>
Line 24: Line 25:
</ul>
</ul>


=Auto Populate Queries=
=Manual Query Definition=
The Auto Populate Queries button opens up a dialog that will allow you to customize the signals the auto generated query will pull from.
Manual query definition allows users to exactly specify which signals and metrics they want to pull out of the loaded library.
 
[[file:sift_manual_queries.png]]
<br>
<ul>
 
<li><strong>Query Name</strong>: The title displayed for the defined query</li>
 
<li><strong>Condition Name</strong>: The title of the condition to be added to the query</li>


[[file:sift_query_builder_auto_builder.png]]
</li>


==Signals==
[[file:sift_query_builder_manual_signal.png]]
<br>
<ul>
<ul>


<li>[[file:sift_browser.png|15px]]<strong>Auto-populate Settings File</strong>: This can be used to load in auto-population settings that have been previously saved.</li>
<li><strong>Type</strong>: The type of signal used for the query definition.</li>
 
<li><strong>Folder</strong>: The folder the signal is found in.</li>


<li>[[file:sift_save.png|15px]]<strong>Save</strong>: Will save the current auto-population settings for later use.<li>
<li><strong>Signal Name</strong>: The name of the signal used for the definition.</li>


<li>[[file:sift_reset.png|15px]]<strong>Reset</strong>: Will reset the Auto-Populate Queries dialog to its default state.</li>
<li><strong>Component</strong>: The dimensional component of the signal (if applicable)</strong></li>


<li>[[file:sift_apply.png|15px]]<strong>Create</strong>: Will auto generate queries based on the parameters provided.</li>
<li><strong>Negate Signal</strong>: If checked the defined signal will be negated</li>


</ul>
</ul>


==Signals==
==Events==
The signals tab is used to specify what signals to use when creating a query.
[[file:sift_query_builder_events.png]]
 
[[file:sift_query_builder_signals.png]]
<br>
<br>
<ul>
<ul>


<li><strong>Signal Type</strong>: Refers to the type of signal being queried e.g. LINK_MODEL_BASED, DERIVED, METRIC etc.</li>
<li><strong>All Events Boxs</strong>: A list of all events defined in the library</li>
 
<li><strong>Event Sequence</strong>: All events selected for the queries sequence of events</li>
 
<li><strong>Excluded Events</strong>: All events to be excluded for the query</li>
 
<li><strong>></strong>: Move the selected event into the Event Sequence or Excluded Events widgets</li>
 
<li><strong><</strong>: Move the selected event out of the Event Sequence or Excluded Events widgets</li>
 
<li><strong>Up</strong>: Move the selected event one space up in the Event Sequence or Excluded Events widgets</li>
 
<li><strong>Down</strong>: Move the selected event one space down in the Event Sequence of Excluded Events widgets</li>


<li><strong>Signal Folder</strong>: The folder the queried signals can be found in e.g ORIGINAL, PROCESSED etc.</li>
<li><strong>Number of Points</strong>: The number of points to which traces will be time normalized. If 0 is chosen then the queried traces will NOT be time normalized.</li>


<li><strong>Signal Names</strong>: All the signals found of the given type in the specified folder.</li>
<li><strong>Spline Type</strong>: Choose between a Cubic or Linear spline.</li>


</ul>
</ul>


==Combine Sides==
==Refinement==
Provides options for combining signals together based on, side, tags etc.
[[file:sift_query_builder_manual_refinement.png]]
<br>
<ul>


[[file:sift_query_builder_combine_sides.png]]
<li><strong>Refine using tag</strong>: If checked query will be refined using the selected tags</li>
<br>


==Refinements==
<li><strong>Use AND Logic</strong>: If checked only signals with ALL selected tags will be used, if not checked signals with ANY of the selected tags will be used.</li>
The refinements tab allows you to refine the queries generated based on tags or even specific signal values.


[[file:sift_query_builder_refinements.png]]
<li><strong>Refine using signal</strong>: If checked refine the query using the created signals.</li>
<br>


<ul>
<li>[[file:sift_action_add.png|15px]]<strong>Add</strong>: Opens the [[Sift - Query Builder Dialog#Signal Refinement Dialog|signal refinement dialog]].</li>


<li><strong>Tags</strong>: The Tag multi-selector selects which tags to be included in the query.</li>
<li><strong>Tags(multi select)</strong>: A list of all tags defined in the library.</li>


<li><strong>Signals</strong>: This will display and allow you to edit any generated signal conditions.</li>
<li><strong>Refinements</strong>: A list of all generated refinements.</li>


<li><strong>Add Signal</strong>: Opens the signal refinement dialog.</li>
<li><strong>Negate selected signals</strong>: If checked selected signals will be negated, it will refine the query to signals WITHOUT the selected tag</li>


</ul>
</ul>
Line 106: Line 129:
</ul>
</ul>


=Queries and Conditions Widgets=
=Auto Populate Queries=
All generated queries and their associated conditions are displayed in the Queries and Conditions widget.
The Auto Populate Queries button opens up a dialog that will allow you to customize the signals the auto generated query will pull from.


[[file:sift_query_builder_quey_condition_box.png|400px]]
[[file:sift_query_builder_auto_builder.png]]
<br>


<ul>
<ul>


<li>[[file:sift_action_add.png|15px]]<strong>Add Query / Condition</strong>: Adds a new query or condition.</li>
<li>[[file:sift_browser.png|15px]]<strong>Auto-populate Settings File</strong>: This can be used to load in auto-population settings that have been previously saved.</li>


<li>[[file:sift_modify.png|15px]]<strong>Modify Query / Condition</strong>: Modify the currently selected query or condition.</li>
<li>[[file:sift_save.png|15px]]<strong>Save</strong>: Will save the current auto-population settings for later use.<li>


<li><strong>Context Menu (Queries)</strong>: Right click on a query to open the context menu.
<li>[[file:sift_reset.png|15px]]<strong>Reset</strong>: Will reset the Auto-Populate Queries dialog to its default state.</li>
<ul>


<li>[[file:sift_modify.png|15px]]<strong>Edit</strong> Modify the selected query</li>
<li>[[file:sift_apply.png|15px]]<strong>Create</strong>: Will auto generate queries based on the parameters provided.</li>


<li>[[file:sift_action_remove.png|15px]]<strong>Remove</strong> Delete the selected queries.</li>
</ul>


<li><strong>Duplicate</strong>: Create a copy of the selected query.</li>
==Signals==
The signals tab is used to specify what signals to use when creating a query.


<li><strong>Reflect</strong>: Create an inverted copy of the selected condition e.g. if selecting right ankle angle x, the copy will be left ankle angle x.</li>
[[file:sift_query_builder_signals.png]]
 
<br>
</ul>
</li>
 
<li><strong>Context Menu (Conditions)</strong>: Right click on a condition to open the context menu.
<ul>
<ul>


<li><strong>Calculate</strong>: Calculate the currently selected queries.</li>
<li><strong>Signal Type</strong>: Refers to the type of signal being queried e.g. LINK_MODEL_BASED, DERIVED, METRIC etc.</li>


<li>[[file:sift_modify.png|15px]]<strong>Edit</strong> Modify the selected query</li>
<li><strong>Signal Folder</strong>: The folder the queried signals can be found in e.g ORIGINAL, PROCESSED etc.</li>


<li>[[file:sift_action_remove.png|15px]]<strong>Remove</strong> Delete the selected queries.</li>
<li><strong>Signal Names</strong>: All the signals found of the given type in the specified folder.</li>
 
<li><strong>Duplicate</strong>: Create a copy of the selected query.</li>


</ul>
</ul>
</li>


</ul>
==Combine Sides==
Provides options for combining signals together based on, side, tags etc.


=Manual Query Definition=
[[file:sift_query_builder_combine_sides.png]]
In addition to being automatically generated queries can be defined manually.
 
[[file:sift_manual_queries.png]]
<br>
<br>
<ul>


<li><strong>Query Name</strong>: The title displayed for the defined query</li>
==Refinements==
The refinements tab allows you to refine the queries generated based on tags or even specific signal values.


<li><strong>Condition Name</strong>: The title of the condition to be added to the query</li>
[[file:sift_query_builder_refinements.png]]
 
<br>
</li>


==Signals==
[[file:sift_query_builder_manual_signal.png]]
<br>
<ul>
<ul>


<li><strong>Type</strong>: The type of signal used for the query definition.</li>
<li><strong>Tags</strong>: The Tag multi-selector selects which tags to be included in the query.</li>


<li><strong>Folder</strong>: The folder the signal is found in.</li>
<li><strong>Signals</strong>: This will display and allow you to edit any generated signal conditions.</li>


<li><strong>Signal Name</strong>: The name of the signal used for the definition.</li>
<li><strong>Add Signal</strong>: Opens the signal refinement dialog.</li>


<li><strong>Component</strong>: The dimensional component of the signal (if applicable)</strong></li>
</ul>


<li><strong>Negate Signal</strong>: If checked the defined signal will be negated</li>
=Queries and Conditions Widgets=
All generated queries and their associated conditions are displayed in the Queries and Conditions widget.


</ul>
[[file:sift_query_builder_quey_condition_box.png|400px]]
<br>


==Events==
[[file:sift_query_builder_events.png]]
<br>
<ul>
<ul>


<li><strong>All Events Boxs</strong>: A list of all events defined in the library</li>
<li>[[file:sift_action_add.png|15px]]<strong>Add Query / Condition</strong>: Adds a new query or condition.</li>


<li><strong>Event Sequence</strong>: All events selected for the queries sequence of events</li>
<li>[[file:sift_modify.png|15px]]<strong>Modify Query / Condition</strong>: Modify the currently selected query or condition.</li>


<li><strong>Excluded Events</strong>: All events to be excluded for the query</li>
<li><strong>Context Menu (Queries)</strong>: Right click on a query to open the context menu.
<ul>


<li><strong>></strong>: Move the selected event into the Event Sequence or Excluded Events widgets</li>
<li>[[file:sift_modify.png|15px]]<strong>Edit</strong> Modify the selected query</li>


<li><strong><</strong>: Move the selected event out of the Event Sequence or Excluded Events widgets</li>
<li>[[file:sift_action_remove.png|15px]]<strong>Remove</strong> Delete the selected queries.</li>


<li><strong>Up</strong>: Move the selected event one space up in the Event Sequence or Excluded Events widgets</li>
<li><strong>Duplicate</strong>: Create a copy of the selected query.</li>


<li><strong>Down</strong>: Move the selected event one space down in the Event Sequence of Excluded Events widgets</li>
<li><strong>Reflect</strong>: Create an inverted copy of the selected condition e.g. if selecting right ankle angle x, the copy will be left ankle angle x.</li>
 
<li><strong>Number of Points</strong>: The number of points of normalization</li>
 
<li><strong>Spline Type</strong>: Choose between a Cubic or Linear spline.</li>


</ul>
</ul>
</li>


==Refinement==
<li><strong>Context Menu (Conditions)</strong>: Right click on a condition to open the context menu.
[[file:sift_query_builder_manual_refinement.png]]
<br>
<ul>
<ul>


<li><strong>Refine using tag</strong>: If checked query will be refined using the selected tags</li>
<li><strong>Calculate</strong>: Calculate the currently selected queries.</li>


<li><strong>Use AND Logic</strong>: If checked only signals with ALL selected tags will be used, if not checked signals with ANY of the selected tags will be used.</li>
<li>[[file:sift_modify.png|15px]]<strong>Edit</strong> Modify the selected query</li>


<li><strong>Refine using signal</strong>: If checked refine the query using the created signals.</li>
<li>[[file:sift_action_remove.png|15px]]<strong>Remove</strong> Delete the selected queries.</li>


<li>[[file:sift_action_add.png|15px]]<strong>Add</strong>: Opens the [[Sift - Query Builder Dialog#Signal Refinement Dialog|signal refinement dialog]].</li>
<li><strong>Duplicate</strong>: Create a copy of the selected query.</li>


<li><strong>Tags(multi select)</strong>: A list of all tags defined in the library.</li>
</ul>
 
</li>
<li><strong>Refinements</strong>: A list of all generated refinements.</li>
 
<li><strong>Negate selected signals</strong>: If checked selected signals will be negated, it will refine the query to signals WITHOUT the selected tag</li>


</ul>
</ul>


[[Category:Sift]]
[[Category:Sift]]

Latest revision as of 15:46, 15 May 2024

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

The Query Builder 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: Opens the Auto Populate Query Dialog.
  • Remove All Queries: Delete all generated queries.
  • Load Query Definitions: Load a previously saved list of definitions.
  • Save Query Definitions: Save the current list of definitions for later use.
  • Calculate Selected Queries: Calculate only the queries that are currently selected in the Queries Box.
  • Calculate All Queries: Calculate all generated queries.

Manual Query Definition

Manual query definition allows users to exactly specify which signals and metrics they want to pull out of the loaded library.


  • Query Name: The title displayed for the defined query
  • Condition Name: The title of the condition to be added to the query

    • Signals


    • Type: The type of signal used for the query definition.
    • Folder: The folder the signal is found in.
    • Signal Name: The name of the signal used for the definition.
    • Component: The dimensional component of the signal (if applicable)
    • Negate Signal: If checked the defined signal will be negated

    Events


    • All Events Boxs: A list of all events defined in the library
    • Event Sequence: All events selected for the queries sequence of events
    • Excluded Events: All events to be excluded for the query
    • >: Move the selected event into the Event Sequence or Excluded Events widgets
    • <: Move the selected event out of the Event Sequence or Excluded Events widgets
    • Up: Move the selected event one space up in the Event Sequence or Excluded Events widgets
    • Down: Move the selected event one space down in the Event Sequence of Excluded Events widgets
    • Number of Points: The number of points to which traces will be time normalized. If 0 is chosen then the queried traces will NOT be time normalized.
    • Spline Type: Choose between a Cubic or Linear spline.

    Refinement


    • Refine using tag: If checked query will be refined using the selected tags
    • Use AND Logic: If checked only signals with ALL selected tags will be used, if not checked signals with ANY of the selected tags will be used.
    • Refine using signal: If checked refine the query using the created signals.
    • Add: Opens the signal refinement dialog.
    • Tags(multi select): A list of all tags defined in the library.
    • Refinements: A list of all generated refinements.
    • Negate selected signals: If checked selected signals will be negated, it will refine the query to signals WITHOUT the selected tag

    Signal Refinement Dialog

    • Refinement Name: The title displayed for the created refinement.
    • Type: The Type of signal used for the refinement.
    • Folder: The location of the signal used for the refinement.
    • Name: The name of the signal used for the refinement.
    • Component: The specific dimensional component of the signal used for the refinement (if applicable).
    • Value Must Be: The expression used to refine options e.g. Less Than, Greater Than, Between.
    • Value: The value the signal will be compared to.
    • Cancel: Close the Refinement Builder without applying any changes.
    • Save: Close the Refinement Builder and save the generated refinement to the signals list.

    Auto Populate Queries

    The Auto Populate Queries button opens up a dialog that will allow you to customize the signals the auto generated query will pull from.

    • Auto-populate Settings File: This can be used to load in auto-population settings that have been previously saved.
    • Save: Will save the current auto-population settings for later use.
    • Reset: Will reset the Auto-Populate Queries dialog to its default state.
    • Create: Will auto generate queries based on the parameters provided.

    Signals

    The signals tab is used to specify what signals to use when creating a query.


    • Signal Type: Refers to the type of signal being queried e.g. LINK_MODEL_BASED, DERIVED, METRIC etc.
    • Signal Folder: The folder the queried signals can be found in e.g ORIGINAL, PROCESSED etc.
    • Signal Names: All the signals found of the given type in the specified folder.

    Combine Sides

    Provides options for combining signals together based on, side, tags etc.


    Refinements

    The refinements tab allows you to refine the queries generated based on tags or even specific signal values.


    • Tags: The Tag multi-selector selects which tags to be included in the query.
    • Signals: This will display and allow you to edit any generated signal conditions.
    • Add Signal: Opens the signal refinement dialog.

    Queries and Conditions Widgets

    All generated queries and their associated conditions are displayed in the Queries and Conditions widget.


    • Add Query / Condition: Adds a new query or condition.
    • Modify Query / Condition: Modify the currently selected query or condition.
    • Context Menu (Queries): Right click on a query to open the context menu.
      • Edit Modify the selected query
      • Remove Delete the selected queries.
      • Duplicate: Create a copy of the selected query.
      • Reflect: Create an inverted copy of the selected condition e.g. if selecting right ankle angle x, the copy will be left ankle angle x.
    • Context Menu (Conditions): Right click on a condition to open the context menu.
      • Calculate: Calculate the currently selected queries.
      • Edit Modify the selected query
      • Remove Delete the selected queries.
      • Duplicate: Create a copy of the selected query.
Retrieved from ""