HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » sift » Sift Command Line
sift:command_line

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:command_line [2024/10/09 19:10] – sgrangersift:command_line [2025/04/04 19:57] (current) – sgranger
Line 11: Line 11:
   * any parameters containing a space or a dash (e.g. a folder path) must be wrapped in double quotes ("")   * any parameters containing a space or a dash (e.g. a folder path) must be wrapped in double quotes ("")
   * Command parameters are named not positional, so the order they are passed does not matter   * Command parameters are named not positional, so the order they are passed does not matter
-  * Some commands have a default parameter, in these cases the parameter name can be omitted, for example with -loadLib the directory parameter name is optional. so either of the following will work: -loadLib directory "folder path" or -loadLib "folder path"+  * Some commands have a default parameter, in these cases the parameter name can be omitted, for example with -loadLib the directory parameter name is optional. so either of the following will work: -loadLib directory "folder path" or -loadLib "folder path". These parameters are marked as default in the list below
   * Commands can be entered all at once in the same command that launches sift, or one at a time   * Commands can be entered all at once in the same command that launches sift, or one at a time
   * Enter the command **-Help** to get a list of all available commands   * Enter the command **-Help** to get a list of all available commands
Line 26: Line 26:
 Load in a library of CMZs Load in a library of CMZs
 === Parameters === === Parameters ===
-== Directory (Required) ==+== Directory (Required/Default) ==
 Path to the directory containing the CMZs to be loaded, all sub-directories will be searched as well. Path to the directory containing the CMZs to be loaded, all sub-directories will be searched as well.
 === Example === === Example ===
Line 36: Line 36:
 Load a saved query from a .q3d file Load a saved query from a .q3d file
 === Parameters === === Parameters ===
-== File (Required) ==+== File (Required/Default) ==
 The path to the .q3d file containing the query The path to the .q3d file containing the query
 === Example === === Example ===
Line 188: Line 188:
 The grouping used for the model: Workspace / Group \\ The grouping used for the model: Workspace / Group \\
 <sub>//Default:// Group</sub> <sub>//Default:// Group</sub>
-== Name (Required) ==+== Name (Required/Default) ==
 The name of the GLM being created The name of the GLM being created
 === Example === === Example ===
Line 237: Line 237:
 Run Principal Component Analysis on all queries Run Principal Component Analysis on all queries
 === Parameters === === Parameters ===
-== Name (Required) ==+== Name (Required/Default) ==
 The name for the PCA to be created The name for the PCA to be created
 == numPCs == == numPCs ==
Line 246: Line 246:
 === Example === === Example ===
 <code>-RunPCA name "New PCA" numPCs "3" workspaceMean</code> <code>-RunPCA name "New PCA" numPCs "3" workspaceMean</code>
 +
 +----
 +==== -ExportPlotSignalTime / -ExportPlotST / -EPST ====
 +----
 +Export the selected traces on a signal time plot
 +=== Parameters ===
 +== FilePath (Required/Default) ==
 +The file path the plot will be saved to, pass the desired image extension. Accepted image formats are .png, .pdf, .bmp, and .jpg
 +== Height ==
 +The height in pixels of the generated plot \\
 +<sub>//Default:// 1000</sub>
 +== Width ==
 +The width in pixels of the generated plot \\
 +<sub>//Default:// 1000</sub>
 +== Title ==
 +The title displayed at the top of the plot
 +== XLabel ==
 +The label displayed along the X Axis of the plot
 +== YLabel ==
 +The label displayed along the Y Axis of the plot
 +== Legend ==
 +Where the legend will be displayed, options are: Top Right, Top Left, Bottom Right, Bottom Left. If this is not passed no legend will be displayed.
 +== DataStyle ==
 +Which data style type to use when generating the plot, options are: Workspace, Group, Sub Group, Cluster \\
 +<sub>//Default:// Workspace</sub>
 +== GroupDispersion ==
 +If passed the group dispersion will be plotted
 +== GroupDispersionType ==
 +The method of dispersion to plot, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range \\
 +<sub>//Default:// One Standard Deviation</sub>
 +== GroupMean ==
 +If passed group mean will be plotted
 +== WorkspaceDispersion ==
 +If passed the workspace dispersion will be plotted
 +== WorkspaceDispersionType ==
 +The method of dispersion to plot, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range \\
 +<sub>//Default:// One Standard Deviation</sub>
 +== WorkspaceMean ==
 +If passed workspace mean will be plotted
 +== XRange ==
 +The range of values displayed on the X Axis of the plot, format: "min,max"
 +== YRange ==
 +The range of values displayed on the Y Axis of the plot, format: "min,max"
 +== RawTraces ==
 +If passed individual traces will be plotted, if no other items are plotted, raw traces will be plotted by default
 +=== Example ===
 +<code>-ExportPlotSignalTime filePath "C:\Export Folder\signal_time_plot.png" rawTraces workspaceMean workspaceDispersion workspaceDispersionType "Interquartile Range" legend "Bottom Left"</code>
 +
 +----
 +
 +==== -ExportPlotMetric / -ExportPlotM / -EPM ====
 +Export the select metrics on a metric plot
 +=== Parameters ===
 +== FilePath (Required/Default) ==
 +The file path the plot will be saved to, pass the desired image extension. Accepted image formats are .png, .pdf, .bmp, and .jpg
 +== Height ==
 +The height in pixels of the generated plot \\
 +<sub>//Default:// 1000</sub>
 +== Width ==
 +The width in pixels of the generated plot \\
 +<sub>//Default:// 1000</sub>
 +== Title ==
 +The title displayed at the top of the plot
 +== XLabel ==
 +The label displayed along the X Axis of the plot
 +== YLabel ==
 +The label displayed along the Y Axis of the plot
 +== Legend ==
 +Where the legend will be displayed, options are: Top Right, Top Left, Bottom Right, Bottom Left. If this is not passed no legend will be displayed.
 +== DataStyle ==
 +What data style used when plotting, options are: Workspace, Group, Sub Group, Cluster \\
 +<sub>
 +== RawTraces ==
 +If passed individual traces will be displayed
 +== GroupMean ==
 +If passed group mean will be plotted
 +== GroupDispersion ==
 +If passed group dispersion will be plotted
 +== GroupDispersionType == 
 +The method of dispersion used, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range \\
 +<sub>//Default:// One Standard Deviation</sub>
 +== WorkspaceMean ==
 +If passed workspace mean will be plotted
 +== WorkspaceDispersion ==
 +If passed workspace dispersion will be plotted 
 +== WorkspaceDispersionType ==
 +The method of dispersion used, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range \\
 +<sub>//Default:// One Standard Deviation</sub>
 +== MeanPlotStyle ==
 +Method used for plotting means, options are Bar Chart, Stacked Bar Chart, Box Plot
 +<sub>//Default:// Bar Chart</sub>
 +== MetricGrouping ==
 +How should workspace means be grouped, options are No Group, Group, Workspace
 +<sub>//Default:// No Group</sub>
 +=== Example ===
 +<code>
  
 ---- ----
Line 413: Line 509:
 === Example === === Example ===
 <code>-ExportSPM file "C:\library folder\exports\Statistical Parametric Map Export.txt" precision "5" exportFormat "transposed" bMatrix residualMatrix spm</code> <code>-ExportSPM file "C:\library folder\exports\Statistical Parametric Map Export.txt" precision "5" exportFormat "transposed" bMatrix residualMatrix spm</code>
 +
 +----
 +==== -SelectSignals / -sig ====
 +----
 +Select all or a selection of Signal groups and workspaces
 +=== Parameters ===
 +== Group ==
 +The name of a group to be selected, this parameter can be passed multiple times to select more than one group, if this parameter is not passed, all groups will be selected
 +== Workspace ==
 +The name of a workspace to be selected, this parameter can be passed multiple times to select more than one workspace, if this parameter is not passed, all workspaces will be selected
 +=== Example ===
 +<code>-SelectSignals group "AnkleAngleX" group "AnkleAngleY" workspace "Sub004"</code>
 +
 +---- 
 +==== -SelectMetrics / -met ====
 +----
 +Select all or a selection of Metric groups and workspaces
 +=== Parameters ===
 +== Group ==
 +The name of a group to be selected, this parameter can be passed multiple times to select more than one group, if this parameter is not passed, all groups will be selected
 +== Workspace ==
 +The name of a workspace to be selected, this parameter can be passed multiple times to select more than one workspace, if this parameter is not passed, all groups will be selected
 +=== Example ===
 +<code>-SelectMetrics group "MaxKneeAngleX" group "MinKneeAngleX" workspace "Sub001"</code>
 +
 +----
 +==== -SaveProject / -sv ====
 +----
 +Save the currently open project to an .i3d file
 +=== Parameters ===
 +== file (Required/Default) ==
 +The name and path of the .i3d file being saved
 +=== Example ===
 +<code>-SaveProject file "C:/folder/file.i3d"</code>
 +
 +----
 +==== -LoadProject / -ld ====
 +----
 +Load the passed project file
 +=== Parameters ===
 +== file ==
 +The name and path of the .i3d file being loaded
 +=== Example ===
 +<code>-LoadProject file "C:/folder/file.i3d"</code>
 +
 +----
 +==== -ClearProject / -clr ====
 +----
 +Clear all data from the current project, no parameters
 +=== Example ===
 +<code>-ClearProject</code>
  
sift/command_line.1728501028.txt.gz · Last modified: 2024/10/09 19:10 by sgranger