HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » sift » documentation » Getting Started
sift:documentation:getting_started

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
sift:documentation:getting_started [2024/08/01 14:33] – wikisysopsift:documentation:getting_started [2024/08/02 14:01] (current) – [Walk-through] wikisysop
Line 8: Line 8:
 Learn how to load an existing CMZ Library, normalize all signals in the Link Model Based folder, average left and right sides together, then calculate, plot and export the mean data, all done in under five minutes. Learn how to load an existing CMZ Library, normalize all signals in the Link Model Based folder, average left and right sides together, then calculate, plot and export the mean data, all done in under five minutes.
  
-  * After opening Sift, while on the Load page select Load Library +  - After opening Sift, while on the Load page select Load Library \\ {{:sift_load_library.png?800}}  
- +  - Select browse and navigate to and select the folder containing the data you wish to import, then press load \\ {{:sift_browse.png?800}} 
-{{:sift_load_library.png}}  +  - After your library has been loaded, ensure that all the expected CMZ's are present (Pressing the + next to the CMZ will expand it to display the individual C3Ds associated) \\ {{:sift_verify_cmz.png?800}} 
- +  - On the left of the screen select the Explore tab \\ {{:sift_to_explore.png?800}}   
-  * Select browse and navigate to and select the folder containing the data you wish to import, then press load +  - From the explore page select Query Builder \\ {{:sift_explore_to_query.png?800}}  
- +  - Press Auto-Populate Queries \\ {{:sift_to_populate.png?800}}  
-{{:sift_browse.png}} +  - Leave the default values and press create \\ {{:sift_create_query.png?500}} 
-   +  - Press Calculate All Queries \\ {{:sift_calculate_queries.png?800}} 
- * After your library has been loaded, ensure that all the expected CMZ's are present (Pressing the + next to the CMZ will expand it to display the individual C3Ds associated) +  - Wait for the calculations to finish, note the progress bar on the bottom of the main screen \\ {{:sift_query_progress.png?800}}  
- +  - When all Queries have been calculated select AnkleAngle_X in the groups display box, this will populate the workspace display box, select all workspaces by clicking the top most workspace and dragging down to the last with the left mouse |button still held down. Then press Refresh Plot \\ {{:sift_select_workspace.png?800}}   
-{{:sift_verify_cmz.png}} +  - If the plot displayed is all one color, we need to set the displayed data style to workspace, press Data Styles \\ {{:sift_to_data_styles.png?800}}  
- +  - In the Display Styles From... section ensure Workspace is selected the exit the dialog \\ {{:sift_set_workspace_style.png?800}}   
-  * On the left of the screen select the Explore tab +  - Looking at the plot we notice that one trace seems to be out of place \\ {{:sift_bad_trace.png?800}}   
- +  - Left click on the trace to isolate it \\ {{:sift_isolate.png?800}}   
-{{:sift_to_explore.png}}   +  - Then right click and select Exclude -> Exclude Trace (raw data) \\ {{:sift_exclude_trace.png?800}}   
- +  - The trace is now excluded from the plot \\ {{:sift_clean_plot.png?800}}   
-  * From the explore page select Query Builder +  - We want the workspace mean and dispersion displayed and not the individual traces, so uncheck Plot All Traces, and check Plot Workspace Mean and Plot Workspace Dispersion then press Refresh Plot \\ {{:sift_plot_mean.png?800}}   
- +  - We also want to display the Y and Z dimensions of the ankle angle, so we need some more plots. On the toolbar press |show general options \\ {{:sift_open_general_options.png?800}}  
-{{:sift_explore_to_query.png}}  +  - Set graph rows to 3 and exit the dialog \\ {{:sift_graph_rows_three.png?500}} 
- +  - Select the second plot, selecting AnkleAngle_Y and all workspaces then hit Refresh Plot \\ {{:sift_second_plot.png?800}} 
-  * Press Auto-Populate Queries +  - Select and exclude the problematic trace \\ {{:sift_exclude_trace_two.png?800}}   
- +  - Uncheck Plot All Traces and check Plot Workspace Mean and Plot Workspace Dispersion \\ {{:sift_plot_mean_two.png?800}}   
-{{:sift_to_populate.png}}  +  - Select the final plot, selecting AnkleAngle_Z and all workspaces then hit Refresh Plot \\ {{:sift_plot_final.png?800}}   
- +  - Select and exclude the problematic trace \\ {{:sift_exclude_trace_three.png?800}}   
-  * Leave the default values and press create +  - Uncheck Plot All Traces and check Plot Workspace Mean and Plot Workspace Dispersion \\ {{:sift_plot_mean_three.png?800}}   
- +  - We now have the graphs plotted and we're ready to export the data: on the toolbar press Export Results \\ {{:sift_export_open.png?800}}   
-{{:sift_create_query.png}} +  - In the Export Results dialog check Workspace Mean and Workspace Std. Dev. then press generate preview to verify the data \\ {{:sift_export_preview.png?400}}   
- +  - Select Browse and navigate to the desired export folder, provide a name for the export file and then press export \\ {{:sift_export_file.png?400}}   
-  * Press Calculate All Queries +  - Navigate to the selected export folder to ensure the file was exported correctly and inspect the data \\ {{:sift_exported.png?800}} 
- +
-{{:sift_calculate_queries.png}} +
- +
-  * Wait for the calculations to finish, note the progress bar on the bottom of the main screen +
- +
-{{:sift_query_progress.png}}  +
- +
-  * When all Queries have been calculated select AnkleAngle_X in the groups display box, this will populate the workspace display box, select all workspaces by clicking the top most workspace and dragging down to the last with the left mouse |button still held down. Then press Refresh Plot +
- +
-{{:sift_select_workspace.png}}   +
- +
-  * If the plot displayed is all one color, we need to set the displayed data style to workspace, press Data Styles +
- +
-{{:sift_to_data_styles.png}}  +
- +
-  * In the Display Styles From... section ensure Workspace is selected the exit the dialog +
- +
-{{:sift_set_workspace_style.png}}   +
- +
-  * Looking at the plot we notice that one trace seems to be out of place +
- +
-{{:sift_bad_trace.png}}   +
- +
-  * Left click on the trace to isolate it +
- +
-{{:sift_isolate.png}}   +
- +
-  * Then right click and select Exclude -> Exclude Trace (raw data) +
- +
-{{:sift_exclude_trace.png}}   +
- +
-  * The trace is now excluded from the plot +
- +
-{{:sift_clean_plot.png}}   +
- +
-  * We want the workspace mean and dispersion displayed and not the individual traces, so uncheck Plot All Traces, and check Plot Workspace Mean and Plot Workspace Dispersion then press Refresh Plot +
- +
-{{:sift_plot_mean.png}}   +
- +
-  * We also want to display the Y and Z dimensions of the ankle angle, so we need some more plots. On the toolbar press |show general options +
-                                                                                                +
-{{:sift_open_general_options.png}}  +
-<HTML></li></HTML> +
-<HTML><li></HTML>Set graph rows to 3 and exit the dialog +
-                                                                                        +
-{{:sift_graph_rows_three.png}}   +
-<HTML></li></HTML> +
-<HTML><li></HTML>Select the second plot, selecting AnkleAngle_Y and all workspaces then hit Refresh Plot +
-|                                                                              +
-|{{:sift_second_plot.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>Select and exclude the problematic trace +
-                                                                                         +
-{{:sift_exclude_trace_two.png}}   +
- +
-  - Uncheck Plot All Traces and check Plot Workspace Mean and Plot Workspace Dispersion +
-                                                                                   +
-{{:sift_plot_mean_two.png}}   +
- +
-  - Select the final plot, selecting AnkleAngle_Z and all workspaces then hit Refresh Plot. +
-                                                                             +
-{{:sift_plot_final.png}}   +
- +
-  - Select and exclude the problematic trace. +
-                                                                                              +
-{{:sift_exclude_trace_three.png}}   +
-  - Uncheck Plot All Traces and check Plot Workspace Mean and Plot Workspace Dispersion +
-                                                                                       +
-{{:sift_plot_mean_three.png}}   +
- +
-  - We now have the graphs plotted and we're ready to export the data: on the toolbar press Export Results +
-                                                                            +
-{{:sift_export_open.png}}   +
- +
-  - In the Export Results dialog check Workspace Mean and Workspace Std. Dev. then press generate preview to verify the data +
-                                                                                   +
-{{:sift_export_preview.png}}   +
- +
-  - Select Browse and navigate to the desired export folder, provide a name for the export file and then press export +
-                                                                              +
-{{:sift_export_file.png}}   +
- +
-  - Navigate to the selected export folder to ensure the file was exported correctly and inspect the data +
-                                                                       +
-{{:sift_exported.png}} +
  
 ==== Custom Queries ==== ==== Custom Queries ====
  
-Once your library is loaded, you can define queries to indicate which signals you want to analyze and how you want them grouped (ex. average all right/left sagittal ankle angles for treadmill trials). Data can be grouped based on tags, events, signals or expressions.\\+Once your library is loaded, you can define queries to indicate which signals you want to analyze and how you want them grouped (ex. average all right/left sagittal ankle angles for treadmill trials). Data can be grouped based on tags, events, signals or expressions.
 Some examples of common groupings are: Some examples of common groupings are:
  
Line 132: Line 47:
   * Affected/Unaffected   * Affected/Unaffected
     * Grouping signals based on a baseball player's pitching side versus their non-pitching side     * Grouping signals based on a baseball player's pitching side versus their non-pitching side
- 
-\\ 
- 
  
 This tutorial will teach you how to make a custom query (Ankle Angle X): This tutorial will teach you how to make a custom query (Ankle Angle X):
  
-\\ +  - Open the query builder, and press the + next to queries to create a new query \\ {{:sift_new_custom_query.png?800}} 
- +  - Name the query Ankle_Angle_X and press save \\ {{:sift_name_query.png?800}} 
- +  - Name the first condition L_Ankle_Angle_X and set the type to LINK_MODEL_BASED \\ {{:sift_name_condition.png?800}} 
-<HTML><ol></HTML> +  - In the Events tab add two left heel strike events to the event sequence by selecting LHS and pressing the right arrow, then press save. \\ {{:sift_query_events.png?800}} 
-<HTML><li></HTML>Open the query builder, and press the + next to queries to create a new query +  - In the Refinement tab check Refine using tag, and then select a tag, in our case we are selecting RUN. Then press save. \\ {{:sift_query_refinement.png?800}} 
-|                                                                                       | +  - Now right click on the condition we just made (L_Ankle_Angle_X) and select reflect, this will create the same condition for the Right Ankle, then press Calculate All Queries \\ {{:sift_query_reflect.png?800}} 
-|{{:sift_new_custom_query.png}}  | +  - From there you are free to plot your newly calculated query. \\ {{:sift_query_plotted.png?800}}
-<HTML></li></HTML> +
-<HTML><li></HTML>Name the query Ankle_Angle_X and press save +
-|                                                                           | +
-|{{:sift_name_query.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>Name the first condition L_Ankle_Angle_X and set the type to LINK_MODEL_BASED +
-|                                                                                   | +
-|{{:sift_name_condition.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>In the Events tab add two left heel strike events to the event sequence by selecting LHS and pressing the right arrow, then press save. +
-|                                                                               | +
-|{{:sift_query_events.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>In the Refinement tab check Refine using tag, and then select a tag, in our case we are selecting RUN. Then press save. +
-|                                                                                       | +
-|{{:sift_query_refinement.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>Now right click on the condition we just made (L_Ankle_Angle_X) and select reflect, this will create the same condition for the Right Ankle, then press Calculate All Queries +
-|                                                                                 | +
-|{{:sift_query_reflect.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>From there you are free to plot your newly calculated query. +
-|                                                                                  | +
-|{{:sift_query_plotted.png}}  | +
-<HTML></li></HTML><HTML></ol></HTML>+
  
 ==== Working with Other Plot Types ==== ==== Working with Other Plot Types ====
Line 180: Line 67:
 Signal time plots display a continuous data point over time, features include: Signal time plots display a continuous data point over time, features include:
  
-<HTML><ul></HTML> +  - Plotting all traces \\ {{:sift_signal_time_eg.png?800}} 
-<HTML><li></HTML>Plotting all traces +  - Plotting group mean and dispersion \\ {{:sift_signal_time_group_mean.png?800}} 
-|                                                                                    | +  - Plotting workspace mean and dispersion \\ {{:sift_signal_time_workspace_mean.png?800}}
-|{{:sift_signal_time_eg.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>Plotting group mean and dispersion +
-|                                                                                                    | +
-|{{:sift_signal_time_group_mean.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>Plotting workspace mean and dispersion +
-|                                                                                                            | +
-|{{:sift_signal_time_workspace_mean.png}}  | +
-<HTML></li></HTML><HTML></ul></HTML> +
- +
-\\ +
  
 === Metric === === Metric ===
Line 201: Line 75:
 Metric plots display a metric value as a bar chart, features include: Metric plots display a metric value as a bar chart, features include:
  
-<HTML><ul></HTML> +  - Plotting all traces \\ {{:sift_metric_all.png?800}} 
-<HTML><li></HTML>Plotting all traces +  - plotting group mean and dispersion \\ {{:sift_metric_group_mean.png?800}} 
-|                                                                            | +  - plotting workspace mean and dispersion \\ {{:sift_metric_workspace_mean.png?800}} 
-|{{:sift_metric_all.png}}  | +  - Also allowing for choice in the way workspace means are displayed and grouped \\ {{:sift_metric_bar_type.png?800}}
-<HTML></li></HTML> +
-<HTML><li></HTML>plotting group mean and dispersion +
-|                                                                                          | +
-|{{:sift_metric_group_mean.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>plotting workspace mean and dispersion +
-|                                                                                                  | +
-|{{:sift_metric_workspace_mean.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>Also allowing for choice in the way workspace means are displayed and grouped +
-|                                                                                      | +
-|{{:sift_metric_bar_type.png}}  | +
-<HTML></li></HTML><HTML></ul></HTML> +
- +
-\\ +
  
 === Signal Signal === === Signal Signal ===
Line 226: Line 84:
 Signal Signal plots compare to signals with each other using a line graph: Signal Signal plots compare to signals with each other using a line graph:
  
-<HTML><ol></HTML> +  - To create a Signal Signal plot you must first create a pair of signal groups, select two signal groups (you can Ctrl click to select multiple groups) then press New Pair \\ {{:sift_signal_signal_pair.png?800}} 
-<HTML><li></HTML>To create a Signal Signal plot you must first create a pair of signal groups, select two signal groups (you can Ctrl click to select multiple groups) then press New Pair +  - Select which group you want on the X-Axis and which you want on the Y \\ {{:sift_signal_signal_xy.png?800}} 
-|                                                                                            | +  - When the graph is plotted you can also choose which groups styles you want displayed \\ {{:sift_signal_signal_style.png?800}}
-|{{:sift_signal_signal_pair.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>Select which group you want on the X-Axis and which you want on the Y +
-|                                                                                        | +
-|{{:sift_signal_signal_xy.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>When the graph is plotted you can also choose which groups styles you want displayed +
-|                                                                                              | +
-|{{:sift_signal_signal_style.png}}  | +
-<HTML></li></HTML><HTML></ol></HTML> +
- +
-\\ +
  
 === Metric Metric === === Metric Metric ===
Line 247: Line 92:
 Metric Metric plots compare two metric values with each other using a scatter plot. Metric Metric plots compare two metric values with each other using a scatter plot.
  
-<HTML><ol></HTML> +  - To create a Metric Metric plot you must first create a pair of two metric groups, select two metric groups (You can Ctrl click to select multiple groups) with both groups selected press New Pair \\ {{:sift_metric_metric_pair.png?800}} 
-<HTML><li></HTML>To create a Metric Metric plot you must first create a pair of two metric groups, select two metric groups (You can Ctrl click to select multiple groups) with both groups selected press New Pair +  - Select which group you want on the X_Axis and which you want on the Y \\ {{:sift_metric_metric_xy.png?800}} 
-|                                                                                            | +  - It is possible that some metric values may overlap, if this is the case you can set the Jitter X or Jitter Y values to displace the scatter plots and make all points visible. \\ {{:sift_metric_metric_jitter.png?800}}
-|{{:sift_metric_metric_pair.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>Select which group you want on the X_Axis and which you want on the Y +
-|                                                                                        | +
-|{{:sift_metric_metric_xy.png}}  | +
-<HTML></li></HTML> +
-<HTML><li></HTML>It is possible that some metric values may overlap, if this is the case you can set the Jitter X or Jitter Y values to displace the scatter plots and make all points visible. +
-|                                                                                                | +
-|{{:sift_metric_metric_jitter.png}}  | +
-<HTML></li></HTML><HTML></ol></HTML> +
- +
-\\ +
- +
- +
  
sift/documentation/getting_started.1722522834.txt.gz · Last modified: 2024/08/01 14:33 by wikisysop