It is possible to run sift from the command line, this offers several advantages:
To start sift in command line mode, open a command line console, navigate to sifts install directory and run sift with any argument that starts with a single dash (-) if you do not want to run any commands as Sift is launched you can instead pass -NoGUI
All commands and their parameters are listed below
Load in a library of CMZs
Path to the directory containing the CMZs to be loaded, all sub-directories will be searched as well.
-LoadLib directory "C:\library folder"
Load a saved query from a .q3d file
The path to the .q3d file containing the query
-LoadQuery file "C:\library folder\query.q3d"
Run Local Outlier Factor
If passed any outliers found will be excluded automatically
How should data be grouped before running?
Default: Combined Groups
The threshold to consider when searching for outliers
Default: 2.00
How many neighbors should each point be compared to?
Default: 10
How many iterations of the test should be run
Default: 1
How many principal components should the test be run on
Default: 2
Determine the number of PCs by variance explained (replaces NumPCs if used)
Default: 95.0
If passed scale all calculated values to the variability explained by the PC
-RunLOF autoExclude manualThreshold "3" numNeighbors "20" numPasses "2" numPCs "2" scaleToVariability
Run K-Means clustering
How many clusters to sort the data into
Default: 2
If provided use as a seed for the random first centroid (produces repeatable results)
How should data be grouped before running:
Default: Combined Groups
How many iterations of the test should be run
Default: 5
The number of principal components to run the test on
Default:2
Determine the number of principal components by variance explained (replaces NumPCs if used)
Default: 95.0
If passed scale all calculated values to the variability explained by the PC
-RunKMeans clusters "3" customerSeed "0" grouping "combined groups" iterations "1" numPCs "2" scaleToVariability
Run squared prediction error
The alpha threshold used to determine outliers: 0.1, 0.05, 0.025, 0.01, 0.005
Default: 0.05
If passed any outliers will be excluded automatically
The number of Principal Components to run the test on Default: 2 == PCsVariance == scale calculated values to variability explained Default: 95.0
-RunSPE alphaValue "0.005" autoExclude numPCs "2"
Run a Mahalanobis distance test
The threshold used to determine outliers: 0.1, 0.05, 0.025, 0.01, 0.005
Default: 0.05
If passed any outliers found will be excluded automatically
How should data be grouped before running:
Default: Combined Groups
How many iterations of the test should be run
Default: 1
The number of principal components to run the test on
Default: 2
Determining the number of PCs by variance explained
Default: 95.0
If passed scale calculated values to variability explained
-LoadMah alphaValue "0.1" autoExclude grouping "groups" numPasses "3" numPCs "2" scaleToVariance
Register via events
Use local maximum as a registration point
The lower bounds of the local max
The upper bounds of the local max
Use the local minimum as a registration point
The lower bounds of the local min
The upper bounds of the local min
Register by maximum
Register by minimum
The name for registered curve group created
-RegisterCurves max name "AnkleAngleX_Reg"
Create a General Linear Model
The grouping used for the model: Workspace / Group
Default: Group
The name of the GLM being created
-CreateGLM name "New GLM" grouping "group"
Run Statistical Parametric Mapping
The name of the GLM used when creating the SPM
The first grouping to compare
The second grouping to compare
The name of the SPM being created
-RunSPM name "New SPM" glm "New GLM" group1 "AnkleAngleX1_Reg" group2 "AnkleAngleX2_Reg"
Run Dynamic Time Warping
The name of the DTW test being run
How many standard deviations to test for: 1-3
Default: 1
--RunDTW name "New DTW" standardDeviations "2"
Execute one or more Visual3D pipeline scripts via the V3D Engine, currently this only works if a library has be loaded and a query run
A path to a .v3s script file, this parameter can be used more than once to load multiple scripts, the scripts will be executed in the order the are passed
-RunV3d script "C:\library folder\Script One.v3s" script "C:\library folder\Script Two.v3s"
Run Principal Component Analysis on all queries
The name for the PCA to be created
How many principal components should be created
Default: 4
If passed PCA will be run on the mean of each workspace and not the individual traces
-RunPCA name "New PCA" numPCs "3" workspaceMean
Export the selected traces on a signal time plot
The file path the plot will be saved to, pass the desired image extension. Accepted image formats are .png, .pdf, .bmp, and .jpg
The height in pixels of the generated plot
Default: 1000
The width in pixels of the generated plot
Default: 1000
The title displayed at the top of the plot
The label displayed along the X Axis of the plot
The label displayed along the Y Axis of the plot
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.
Which data style type to use when generating the plot, options are: Workspace, Group, Sub Group, Cluster
Default: Workspace
If passed the group dispersion will be plotted
The method of dispersion to plot, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range
Default: One Standard Deviation
If passed group mean will be plotted
If passed the workspace dispersion will be plotted
The method of dispersion to plot, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range
Default: One Standard Deviation
If passed workspace mean will be plotted
The range of values displayed on the X Axis of the plot, format: “min,max”
The range of values displayed on the Y Axis of the plot, format: “min,max”
If passed individual traces will be plotted, if no other items are plotted, raw traces will be plotted by default
-ExportPlotSignalTime filePath "C:\Export Folder\signal_time_plot.png" rawTraces workspaceMean workspaceDispersion workspaceDispersionType "Interquartile Range" legend "Bottom Left"
Export the select metrics on a metric plot
The file path the plot will be saved to, pass the desired image extension. Accepted image formats are .png, .pdf, .bmp, and .jpg
The height in pixels of the generated plot
Default: 1000
The width in pixels of the generated plot
Default: 1000
The title displayed at the top of the plot
The label displayed along the X Axis of the plot
The label displayed along the Y Axis of the plot
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.
What data style used when plotting, options are: Workspace, Group, Sub Group, Cluster
== 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
If passed workspace mean will be plotted
If passed workspace dispersion will be plotted
The method of dispersion used, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range
Default: One Standard Deviation
Method used for plotting means, options are Bar Chart, Stacked Bar Chart, Box Plot Default: Bar Chart
How should workspace means be grouped, options are No Group, Group, Workspace Default: No Group
---- ==== -ExportData / -ex ==== Export queried data results in an ascii text file === Parameter === == File (Required) == The path and name of the .txt file to export == Precision == How many decimal places to display in exported values \\ <sub>//Default:// 4</sub> == ExportFormat == The format of the exported ASCII file: Standard, SPSS, Transposed, P2D \\ <sub>//Default:// Standard</sub> == NormalizedTo == Number of points to normalize the export data to \\ <sub>//Default:// 101</sub> == GroupMean == If passed the group mean will be exported == GroupStdDev == If passed the workspace standard deviation will be exported == AllSequencesNorm == If passed all normalized sequences will be exported == AllSequencesTime == If passed all time based sequences will be exported === Example === <code>-ExportData file "C:\library folder\exports\Data Export.txt" precision "2" exportFormat "standard" normalizedTo "100" groupMean groupStdDev workspaceMean workspaceStdDev allSequenceNorm allSequencesTime
Export PCA results to a .txt file
The path and name of the .txt file to export
How many decimal places to display in exported values
Default: 4
The format of the exported ASCII file: Standard, SPSS, Transposed, P2D
Default: Standard
The format of the exported ASCII file: Standard, Transposed, SPSS, P2D
If passed the workspace scores will be exported
If passed the group scores will be exported
If passed the group standard deviation will be exported
If passed the variance explained by each PC will be exported
If passed all eigen vectors will be exported
If passed the mean +/- one standard deviation will be exported
If passed the mean +/- 5 and 95% will be exported
-ExportPCA fileName "C:\library folder\exports\PCA Export.txt" precision "4" exportFormat "transposed" workspaceScores groupScores groupStdDev varianceExplained eigenVectors meanSD mean595
Export summary statistics to a .txt file
The path and name of the .txt file to export
How many decimal places to display in exported values
Default: 4
The format of the exported ASCII file: Standard, SPSS, Transposed, P2D
Default: Standard
The format of the exported ASCII file: Standard, Transposed, SPSS, P2D
If passed the maximum value will be exported
If passed the maximum event point will be exported
If passed the maximum standard deviation will be exported
If passed the mean value will be exported
If passed the mean standard deviation will be exported
If passed the the minimum value will be exported
If passed the minimum event point will be exported
If passed the minimum standard deviation will be exported
Normalize exported metrics
Export results for: Groups, Workspaces, Instances
-ExportSummaryStatistics file "C:\library folder\exports\Summary Statistics Export.txt" precision "2" exportFormat "SPSS" max maxEventPoint maxStdDev mean meanStdDev min minEventPoint minStdDev normalizeMetrics results "groups"
Export any results of curve registration
The path and name of the .txt file to export
How many decimal places to display in exported values
Default: 4
The format of the exported ASCII file: Standard, SPSS, Transposed, P2D
Default: Standard
The format of the exported ASCII file: Standard, Transposed, SPSS, P2D
If passed all landmarks will be exported
If passed the mean of all landmarks will be exported
If passed registered curves will be exported
If passed warping functions will be exported
-ExportRegisteredCurves file "C:\library folder\exports\Registered Curves Export.txt" precision "3" exportFormat "transposed" landmarkAll landmarkMeans registeredCurves warpingFunctions
Export Dynamic Time Warping results
The path and name of the .txt file to export
How many decimal places to display in exported values
Default: 4
The format of the exported ASCII file: Standard, SPSS, Transposed, P2D
Default: Standard
The format of the exported ASCII file: Standard, Transposed, SPSS, P2D
If passed cost functions will be exported
If passed all anomalies will be exported
-ExportDTW file "C:\library folder\exports\Dynamic Time Warping Export.txt" precision "3" exportFormat "transposed" foundAnomalies costFunctions
Export Statistical Parametric Mapping Results
The path and name of the .txt file to export
How many decimal places to display in exported values
Default: 4
The format of the exported ASCII file: Standard, SPSS, Transposed, P2D
Default: Standard
The format of the exported ASCII file: Standard, Transposed, SPSS, P2D
If passed the B Matrix used will be exported
If passed the Residual Matrix will be exported
If passed the Statistical Parametric Map will be exported
-ExportSPM file "C:\library folder\exports\Statistical Parametric Map Export.txt" precision "5" exportFormat "transposed" bMatrix residualMatrix spm
Select all or a selection of Signal groups and workspaces
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
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
-SelectSignals group "AnkleAngleX" group "AnkleAngleY" workspace "Sub004"
Select all or a selection of Metric groups and workspaces
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
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
-SelectMetrics group "MaxKneeAngleX" group "MinKneeAngleX" workspace "Sub001"
Save the currently open project to an .i3d file
The name and path of the .i3d file being saved
-SaveProject file "C:/folder/file.i3d"
Load the passed project file
The name and path of the .i3d file being loaded
-LoadProject file "C:/folder/file.i3d"
Clear all data from the current project, no parameters
-ClearProject