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:27] – sgrangersift:command_line [2025/04/04 19:57] (current) – sgranger
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 437: Line 533:
 === Example === === Example ===
 <code>-SelectMetrics group "MaxKneeAngleX" group "MinKneeAngleX" workspace "Sub001"</code> <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.1728502031.txt.gz · Last modified: 2024/10/09 19:27 by sgranger