Table of Contents

Sift Command Line

Running Sift from the command line offers several advantages:

Running Sift From Command Line

To start sift in command line mode, open a command line console, navigate to Sift's 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

Command Line Overview

Help Command

If at any point you need help remembering a command or its parameters you can use the help function. Enter the command -Help to receive a list of all available commands within the command line:

This will display the commands default name and any aliases separated by |'s, below each will be a brief description of the command as well as a list of all it's parameters

From here, if you want some more information about a specific command and its parameters you can enter the command of interest and pass it the help parameter, this will give a more detailed description of the command and its parameters:

This will display the command name and any accepted aliases, and below that a list of all parameters complete with a description and some more details about the parameter:

Command Reference

-LoadLib / -l

Search the provided directory and all sub directories for .cmz files and load them into the library

Parameters

**directory (DEFAULT) (REQUIRED) **
A path to the root directory to be searched recursively for .cmzs

**libQuery **
The query used to refine the files loaded into the library

**libSubjTags **
A list of subject tags that must be included within the .cmzs 

 -LoadLib "C:\Library Location\Data" libQuery "RUN AND NOT(OLD)" libSubjTags "RUN"

-LoadLib / -l

Search the provided directory and all sub directories for .cmz files and load them into the library

Parameters

**directory (DEFAULT) (REQUIRED) **
A path to the root directory to be searched recursively for .cmzs

**libQuery **
The query used to refine the files loaded into the library

**libSubjTags **
A list of subject tags that must be included within the .cmzs 

 -LoadLib "C:\Library Location\Data" libQuery "RUN AND NOT(OLD)" libSubjTags "RUN"

-LoadND / -lnd

Takes in the filepath for a Sift Normal Database .Sift file and loads it into the current project.

Parameters

**File (DEFAULT) (REQUIRED) **
A filepath with the Normal Database .sift file to be loaded into the workspace 

 -LoadND "C:\Library Location\Data\ND.sift"

-LoadQuery / -q

Load and calculate a predifined query

Parameters

**file (DEFAULT) (REQUIRED) **
Path to the .q3d containing query definitions 

 -LoadQuery file "C:\Data\query.q3d"

-LoadProject / -ld

Load a previously saved project

Parameters

**file (DEFAULT) (REQUIRED) **
The path and name of the project

**loadLib **
If passed Sift will attempt to load the library associated with the project 

 -LoadProject "C:\Saved Projects\test_project.i3d" loadLib

-LoadNDQuery / -ndq

Load and calculate a predifined Normal Database query

Parameters

**file (DEFAULT) (REQUIRED) **
Path to the .q3d containing query definitions 

 -LoadNDQuery file "C:\Data\NDquery.q3d"

-SaveProject / -sv

Save the current project

Parameters

**file (DEFAULT) (REQUIRED) **
The path and name of the file 

 -SaveProject file "C:\Project Files\test_project.i3d"

-ClearProject / -clr

Clear and create a new project workspace (All unsaved progress will be lost) 

 -ClearProject

-SelectSignals / -sig

Select queried signals (if no parameters are passed all signals are selected)

Parameters

**group **
The name of a group to be selected (pass multiple times to select more than one)

**workspace **
The name of a workspace to be selcted (pass multiple time to select more than one) 

 -SelectSignals group "KneeAngleX"

-SelectMetrics / -met

Select queried metrics (if no parameters are passed all metrics are selected)

Parameters

**group **
The name of the group to be selected (pass multiple times to select more than one)

**workspace **
The name of the workspace to be selected (pass multiple times to select more than one) 

 -SelectMetrics group "AnkleAngleX" group "AnkleAngleY" workspace "P002"

-RunTheiaBatch / -RunTheia / -RTB

Make a call to Theia3D.exe and pass an instruction file

Parameters

**settingsFile (DEFAULT) (REQUIRED) **
The instruction set for Theia3D

**theiaLocation **
The location of Theia3D.exe, if not passed a default value will be used, either the last successful location used or the default install location 

 -RunTheiaBatch theiaLocation "C:\Program Files\Theia\Theia3D\Theia3D.exe" settingsFile "C:\Data\Theia\The3DSettingsFile.txt"

-BuildNormalDatabase / -BuildND

Build a normal database using currently queried data

Parameters

**excludedData **
Pass to use excluded data when creating normal database

**filePath (DEFAULT) (REQUIRED) **
Location to save the ND

**group **
Group to build normal database with, pass multiple time to select more than one, do not pass to select all

**librarySummary **
Pass to include a library summary in the normal database, if no other summaries are passed this is the default

**summaryStats **
What statistics to build the normal database with, pass multiple times to select more than one, do not pass to select all

**trialSummary **
Pass to include a trial summary in the normal database, if no other summaries are passed librarySummbary is the default

**workspaceSummary **
Pass to include a workspace summary in the normal database, if no other summaries are passed librarySummary is the default 

 -BuildNormalDatabase "C:\Library\ND.sift" group "AnkleAngleX" summaryStats "Mean" summaryStats "Mode" librarySummary

-MakeHybridModel

Adds the MakeHybridModel module to the build CMZ function.

Parameters

**currentFileDirectory (DEFAULT) (REQUIRED) **
Path to library directory

**modelTemplateFile (REQUIRED) **
Path to MDH settings file 

 -MakeHybridModel modelTemplateFile "C:\Data Folder\ModelFile.mdh" currentFileDirectory "C:\Data Folder\DataFiles\"

-MergeData / -Merge

Adds the MergeData module to the build CMZ function.

Parameters

**mergeScriptFile (DEFAULT) (REQUIRED) **
Path to V3S script file 

 -MergeData mergeScriptFile "C:\Data Folder\Merge Script.v3s"

-AddMetaData / -Merge

Adds the AddMetaData module to the build CMZ function.

Parameters

**metaFile (REQUIRED) **
Path to CSV metadata file

**settingsFile (DEFAULT) **
Path to XML settings file for metaData selections 

 -AddMetaData metaFile "C:\Data Folder\MetaData.csv" settings File "C:\Data Folder\Meta Settings File.xml"

-TagByFile

Adds the TagByFile module to the build CMZ function.

Parameters

**MaskAndTag (DEFAULT) (REQUIRED) **
String containing the file mask followed by the tag to assign the file. These should be separated with a colon ':' 

  - TagByFile MaskAndTag "*run.c3d:run"

-AddV3DScript

Adds the V3D Script module to the build CMZ function.

Parameters

**scriptFile (DEFAULT) (REQUIRED) **
Path to script file 

 -AddV3DScript scriptFile "C:\Data Folder\pipeline.v3s"

-BuildCMZ

Main function for building CMZ workspaces. Calls sub functions 

      ~ directory
      ~ settingsFile
      ~ preview

Parameters

**directory (DEFAULT) (REQUIRED) **
A path to the root directory to be searched recursively for .c3ds

settingsFile
A .xml file containing buildCMZ dialog settings saved from the GUI

preview
If passed Sift will provide a preview of the build it will run and ask the user if they wish to continue. 

 -BuildCMZ directory ".../../" settingsFile "/.../buildSettings.xml" preview

-RunPCA / -pca

Run Principal Compnent Analysis on selected groups / workspaces

Parameters

**name (DEFAULT) (REQUIRED) **
The name of the PCA

**numPCs **
The number of principal components calculated

**workspaceMean **
If passed run PCA on workspace mean instead of individual traces 

 -RunPCA name "Sample_PCA" numPCs "4" workspaceMean

-RunLOF / -lof

Run Local Outlier Factor on currently active PCA

Parameters

**autoExclude **
If passed any outliers found will be excluded automatically

**grouping **
How should data be grouped before looking for outliers

**manualThreshold **
The threshold to consider when searching for outliers

**numNeighbors **
How many neighbors should each point be compared to

**numPasses **
How many iterations of the test should be run

**numPCs **
How many principal components should the test be run on

**PCsVariance **
Determine the numbe of PCs by variance explained

**scaleToVariability **
Scale all calculated values to the variavility explained by the PC 

 -RunLOF grouping "combined group" numPasses "2" numNeighbors "7" autoExclude

-RunKMeans / -kmeans

Run K-Means clustering on currently actve PCA

Parameters

**clusters **
How many clusters generated

**customSeed **
Provide a seed for the random first centroid (produces repeatable results)

**grouping **
How should data be grouped before being clustered

**iterations **
How many iterations of the test should be run

**numPCs **
The number of principal components to run the test on

**PCsVariance **
Determine the number of PCs by variance explained

**scaleToVariability **
Scale all calculated values to the variability explained by the PC 

 -RunKMeans clusters "4" scaleToVariability

-RunSPE / -spe

Run Squared Prediction Error on the currently active PCA

Parameters

**alphaValue **
The alpha threshold used to determine outliers

**autoExclude **
If passed any outliers found will be exclude automatically

**numPCs **
The number of principal components to run the test on

**PCsVariance **
scale calculated values to variability explained 

 -RunSPE alphaValue "0.005" PCsVariance "80.0"

-RunMah / -mah

Run Mahalanobis Distance test on the currently active PCA

Parameters

**alphaValue **
The alpha threshold used to determine outliers

**autoExclude **
If passed any outliers found will be excluded automatically

**grouping **
How should data be grouped before running

**numPasses **
How many iterations of the test should be run

**numPCs **
The number of principal components to run the test on

**PCsVariance **
Determing the number of PCs by variance explained instead of number

**scaleToVariance **
scale calculated values to variability explained 

 -RunMah grouping "group" alphaValue "0.5" autoExclude

-RunGDI

Calculate Gait Deviation Index (GDI)

Parameters

**computeComponents **
If passed compute all component queries

**computeQueries **
If passed compute generated queries after running

**leftEvent **
The left gait event used

**normalDatabase (REQUIRED) **
The normal database used to run GDI

**normalizedPoints **
The number of points to normalize to

**rightEvent **
The right gait event used

**settingsFile (DEFAULT) (REQUIRED) **
The settings XML file containing the calculate instructions, to overwrite the settings within the file pass the associated parameter

**signalFolder **
What folder to search for signals

-RunV3D / -s / -plpath

Run pipelines via the Visual3D engine

Parameters

**exportLog **
If passed a processing log will be exported to the file path provided

**onLib **
If passed the scripts will be run on the loaded library

**script (DEFAULT) (REQUIRED) **
A path to the script file, multiple scripts can be passed by repeating the parameter (Scripts are executed in the order passed) 

 -RunV3D script "C:\Scripts\v3d_script.v3s" exportLog "C:\Scripts\v3d_script_export.txt"

-RunV3DCommand / -c

Run a single V3D pipeline command (Can be used multiple times to execute multiple commands

Parameters

**command (DEFAULT) (REQUIRED) **
The pipeline command executed 

 -RunV3DCommand command "Set_Default_Folders / DEFAULT_DATA = C:\Users\Shane Granger\Desktop\Intro_Project\SPL - Open - Data - main\basketball\freethrowdata; "

-DirPath

Set a global variable within the V3D Engine to the passed path

Parameters

**path (DEFAULT) (REQUIRED) **
The path to set 

 -DirPath path "C:\Work Directory\Data"

-SetEnginePluginsFolder / -SEPF

Set the location the engine will look for plugins e.g Meta-Commands

Parameters

**folderPath (DEFAULT) (REQUIRED) **
The path to the engine plugins folder 

 -SetEnginePluginsFolder folderPath "C:\Engine Resources"

-RegisterCurves / -rc

Register time series data to allign certain landmarks / events

Parameters

**eventSequence **
Register by events

**localMax **
Register by local maximum

**localMaxLower **
The lower bounds of the local max

**localMaxUpper **
The upper bounds of the local max

**localMin **
Register by local minimum

**localMinLower **
The lower bounds of the local minimum

**localMinUpper **
The upper bounds of the local minimum

**max **
Register by maximum

**min **
Register by minimum

**name (DEFAULT) (REQUIRED) **
The name for the new group created 

 -RegisterCurves name "Knee Angle X Reg" max min

-CreateGLM / -glm

Create a General Linear Model using the selected groups / workspaces

Parameters

**grouping **
The grouping used for the model

**name (DEFAULT) (REQUIRED) **
The name of the GLM

**test **
The intended test type for the model

**workspaceMeans **
If passed use workspace means, instead of the individual traces 

 -CreateGLM name "GLM_ONE" test "one_sample" grouping "group" workspaceMeans

-RunSPM1ttest

Run Statistical Parameteric Mapping One-Sample T-Test

Parameters

**alpha (REQUIRED) **
The alpha value to threshold with

**glm (REQUIRED) **
The name of the GLM to use when creating the SPM

**group (REQUIRED) **
The name of the group to test

**name (REQUIRED) **
The name of the SPM being created

**twoTailed **
If two-tailed inference (as opposed to one-tailed) 

 -RunSPM1TTest name "SPM_1_Test" glm "GLM_ONE" alpha "0.7" group "AnkleAngleX"

-RunSPM2ttest / -spm

Run Statistical Parameteric Mapping Two-Sample T-Test

Parameters

**alpha (REQUIRED) **
The alpha value to threshold with

**glm (REQUIRED) **
The name of the GLM to use when creating the SPM

**group1 (REQUIRED) **
The name of the first group to test

**group2 (REQUIRED) **
The name of the second group to test

**name (REQUIRED) **
The name of the SPM being created

**twoTailed **
If two-tailed inference (as opposed to one-tailed) 

 -RunSPM2TTest name "spm_two_sample" glm "GLM_TWO" group1 "KneeAngleX" group2 "HipAngleX"

-RunSPMpairedttest

Run Statistical Parameteric Mapping Paired T-Test

Parameters

**alpha (REQUIRED) **
The alpha value to threshold with

**glm (REQUIRED) **
The name of the GLM to use when creating the SPM

**group1 (REQUIRED) **
The name of the first group to test

**group2 (REQUIRED) **
The name of the second group to test

**name (REQUIRED) **
The name of the SPM being created

**twoTailed **
If two-tailed inference (as opposed to one-tailed) 

 -RunSPMPairedTTest name "spm_pair" glm "GLM_ONE" group1 "AnkleAngleX" group2 "KneeAngleX"

-RunSPMOneWayAnova

Run Statistical Parameteric Mapping one way Anova test

Parameters

**alpha (REQUIRED) **
The alpha value to threshold with

**glm (REQUIRED) **
The name of the GLM to use when creating the SPM

**name (REQUIRED) **
The name of the SPM being created

**twoTailed **
If two-tailed inference (as opposed to one-tailed) 

 -RunSPMOneWayAnova name "anova_spm" glm "GLM_2" twoTailed

-RunDTW / -dtw

Run Dynamic Time Warping

Parameters

**DTWType **
The type of DTW test to run.

**exclude **
Do you want to exclude the found traces?

**framesOfTrace **
The frames of the trace you want to compare the dataset to. Example input frames: [1,100]

**groupOfTrace **
The group of the trace you want to compare the dataset to.

**groups (REQUIRED) **
Groups to run DTW on

**standardDeviations **
How many standard deviation to test for: 1-3

**testName (REQUIRED) **
The name of the DTW test being run.

**trialOfTrace **
The trial of the trace you want to compare the dataset to.

**workspaceOfTrace **
The workspace of the trace you want to compare the dataset to.

**workspaces **
Workspaces to run DTW on, if left blank all workspaces will be used. 

 -RunDTW name "SAMPLE_DTW" standardDeviations "3"

-DeleteGLM / -DGLM

Delete an existing GLM and all of its associated SPMs

Parameters

**name (DEFAULT) (REQUIRED) **
The name of the GLM to delete 

 -DeleteGLM "GLM_ONE"

-DeleteSPM / -DSPM

Delete an existing SPM from the passed GLM

Parameters

**glm (REQUIRED) **
The name of the GLM that contains the SPM to delete

**spm (REQUIRED) **
The name of the SPM to delete 

 -DeleteSPM glm "GLM_ONE" spm "SPM_ONE"

-SelectGLM / -SGLM

Select an existing GLM

Parameters

**name (DEFAULT) (REQUIRED) **
The name to the GLM to select 

 -SelectGLM name "GLM_ONE"

-SelectSPM / -SSPM

Select and existing SPM from the active GLM

Parameters

**glm (REQUIRED) **
The name of the GLM containing the SPM to select

**spm (REQUIRED) **
The name of the SPM to select 

 -SelectSPM glm "GLM_ONE" spm "SPM_ONE"

-RunGPS / -GPS

Calulates GPS metrics for the loaded data.

Parameters

**computeComponentQueries **
If passed calculate individual component queries generated by results

**computeQueries **
If passed calculate all queries generated by results

**leftEvent **
The left cycle event to use for gait

**normalDatabase (REQUIRED) **
Path to normal database file

**normalizedPoints **
How many points to normalize to

**p2dFolder **
The normal database folder (only used for .vnd files)

**rightEvent **
The right cycle event to use for gait

**settingsFile (DEFAULT) (REQUIRED) **
Path to XML settings file, to overwrite any settings within the file pass the associated parameter

**signalFolder **
The folder the singal can be found in

**signalType **
The signal type the signal can be found in 

 -RunGPS "C:\Data Folder\GPS Settings File.xml" leftEvent "RTO"

-RunGGA / -GGA

Execute the GGA process on all loaded .cmz files in the library using the configured parameters and settings.

Parameters

**computeQuery **
Compute query after calculation

**leftCycleEvent **
The left cycle event to be evaluated

**leftSelects **
Select the left side signals for GGA processing

**pelvis **
Select pelvis signal to use for GGA computation

**settingsFile **
A path to a LGGA settings file

**signalFolder **
The folder of signals you would like to process for LGGA

**signalMagnitude **
Use signal magnitude for LGGA

**trunk **
Select trunk signal to use for GGA computation 

 -runGGA leftCycleEvent "LHS" leftSelects "LAnklePower" rightCycleEvent "RHS" computeQuery

-ExportData / -ex

Export queried data

Parameters

**allSequencesNorm **
CommandExport all sequences normalized

**allSequencesTime **
CommandExport all time based sequences

**eventsNorm **
CommandExport all events normalized

**eventsOrig **
CommandExport all time based events

**exportFormat **
What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV

**file (REQUIRED) **
Desired path for the text export to be saved

**groupMean **
CommandExport the mean value of each group

**groupStdDev **
CommandExport the standard deviation of each group

**normalizedTo **
Normalize values to…

**precision **
How many decimal places should values be displayed to

**workspaceMean **
CommandExport the mean of each workspace

**workspaceStdDev **
CommandExport the standard deviation of each workspace 

 -ExporData file "C:\Data\Export Folder\data_export.txt" precision "2" exportFormat "transposed" groupMean groupStdDev workspaceMean workspaceStdDev

-ExportSummaryStatistics

Export summary statistics

Parameters

**addMetrics **
Export metrics

**exportFormat **
What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV

**file (REQUIRED) **
Desired path for the text export to be saved

**max **
Export the maximum value

**maxEventPoint **
Export the maximum event point

**maxStdDev **
Export the maximum standard deviation

**mean **
Export the mean value

**meanStdDev **
Export the mean standard deviation

**min **
Export the minimum value

**minEventPoint **
Export the minimum event point

**minStdDev **
Export the minimum standard deviation

**normalizeMetrics **
Normalize exported metrics

**precision **
How many decimal places should values be displayed to

**results **
Export results for: Groups, Workspaces, Instances 

 -ExportSummaryStatistics file "C:\Exports\summary_stats.txt" results "workspaces" mean min max

-ExportStatsTestResults

Export results from statistical tests

Parameters

**exportFormat **
What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV

**file (REQUIRED) **
Desired path for the text export to be saved

**groupResults **
Export group results: Mean, Standard Deviation, Standard Error, N

**precision **
How many decimal places should values be displayed to

**testInfo **
Export test information: Statistical Test, Significance Level, Population Mean, Group1 : Name of group used

**testResults **
Export test results:Degrees of Freedom, T Stat, Null Hypothesis 

 -ExportStatsTestResults file "C:\Exports\stats_results.txt" testInfo groupResults testResults

-ExportRegisteredCurves

Export results of curve registration

Parameters

**exportFormat **
What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV

**file (REQUIRED) **
Desired path for the text export to be saved

**landmarkAll **
Export all landmarks

**landmarkMeans **
Export the landmark mean value

**precision **
How many decimal places should values be displayed to

**registeredCurves **
Export registered curves

**warpingFunctions **
Export all warping functions 

 -ExportRegisteredCurves file "C:\Export Folder\registered_curves.txt" registeredCurves warpingFunctions landmarkMeans

-ExportDTW

Export Dynamic Time Warping results

Parameters

**costFunctions **
Export cost functions

**exportFormat **
What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV

**file (REQUIRED) **
Desired path for the text export to be saved

**foundAnomalies **
Export all outliers found with dynamic time warping

**precision **
How many decimal places should values be displayed to 

 -ExportDTW file "C:\DTW DATA\export.txt" costFunctions foundAnomalies

-ExportSPM

Export Statistical Parameteric Mapping results

Parameters

**bMatrix **
Export the B Matrix used

**exportFormat **
What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV

**file (REQUIRED) **
Desired path for the text export to be saved

**precision **
How many decimal places should values be displayed to

**residualMatrix **
Export the residual matrix

**spm **
Export the statistical parameteric map 

 -ExportSPM file "C:\Export Folder\SPM.txt" bMatrix residualMatrix spm

-ExportPCA

Export Principal Component Analysis results

Parameters

**eigenVectors **
Export the eigen vectors

**exportFormat **
What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV

**file (REQUIRED) **
Desired path for the text export to be saved

**groupScores **
Export group scores

**groupStdDev **
Export group standard deviation

**kMeans **
Export K-Means results

**lof **
Export local outlier factor results

**lofThreshold **
Export threshould to determine an LOF outlier

**mahDis **
Export the mahalanobis distance results

**mahDisThreshold **
Export the threshold used to determine a mahalanobis distance outlier

**mean595 **
Export the mean plus or minus 5 and 95%

**meanSD **
Export the mean plus or minus one standard deviation

**precision **
How many decimal places should values be displayed to

**spe **
Export squared prediction error results

**speThreshold **
Export the threshold to determine an SPE outlier

**varianceExplained **
Export the variance explained

**workspaceScores **
Export workspace scores 

 -ExportPCA file "C:\Processing Folder\PCA\export.txt" groupScores workspaceScores lof spe

-ExportND

Export Principal Component Analysis results

Parameters

**exportFormat **
What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV

**file (REQUIRED) **
Desired path for the text export to be saved

**ndSignals **
Export Normal Database Signals

**precision **
How many decimal places should values be displayed to 

 -ExportND file "C:\Processing Folder\ND\export.txt" ndSignals

-ExportPlotSignalTime / -ExportPlotST / -EPST

Export a signal time plot using the currently selected groups / workspaces

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**groupDispersion **
If passed group dispersion will be plotted

**groupDispersionType **
The type of dispersion to be displayed for groups

**groupMean **
If passed group mean will be plotted

**height **
The height of the image exported.

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**rawTraces **
If passed indivdual traces will be plotted

**title **
The title of the plot.

**width **
The width of the image exported.

**workspaceDispersion **
If passed workspace dispersion will be plotted

**workspaceDispersionType **
The type of dispersion to be displayed for workspaces

**workspaceMean **
If passed workspace mean will be plotted

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 -ExportPlotSignalTime filePath "C:\Plots\signal_time.png" groupMean WorkspaceMean groupDispersion workspaceDispersion

-ExportPlotMetric / -ExportPlotM / -EPM

Export a metric plot using the currently selected groups / workspaces

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**groupDispersion **
If passed group dispersion will be plotted

**groupDispersionType **
The type of dispersion to be displayed for groups

**groupMean **
If passed group mean will be plotted

**height **
The height of the image exported.

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**meanPlotStyle **
How should means be displayed

**metricGrouping **
How should workspace means be grouped?

**rawTraces **
If passed indivdual traces will be plotted

**title **
The title of the plot.

**width **
The width of the image exported.

**workspaceDispersion **
If passed workspace dispersion will be plotted

**workspaceDispersionType **
The type of dispersion to be displayed for workspaces

**workspaceMean **
If passed workspace mean will be plotted

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 -ExportPlotMetric file "C:\Plot Exports\metric_plot.png" groupMean meanPlotStyle "Stacked Bar Chart"

-ExportPlotPairSignal / -ExportPlotPS / -EPPS

Export a Signal Signal plot using the currently selected groups / workspaces

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**groupDispersion **
If passed group dispersion will be plotted

**groupDispersionType **
The type of dispersion to be displayed for groups

**groupMean **
If passed group mean will be plotted

**height **
The height of the image exported.

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**pair (REQUIRED) **
Add a pair of two groups, seperare group names with '|' eg. “GROUP_1|GROUP_2”

**rawTraces **
If passed indivdual traces will be plotted

**title **
The title of the plot.

**width **
The width of the image exported.

**workspaceDispersion **
If passed workspace dispersion will be plotted

**workspaceDispersionType **
The type of dispersion to be displayed for workspaces

**workspaceMean **
If passed workspace mean will be plotted

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 -ExportPlotPairSignal filePath "C:\Plot Folder\signalSignal.pdf" workspaceMean workspaceDispersion

-ExportPlotPairMetric / -ExportPlotPM / -EPPM

Export a Metric Metric plot using the currently selected groups / workspaces

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**groupDispersion **
If passed group dispersion will be plotted

**groupDispersionType **
The type of dispersion to be displayed for groups

**groupMean **
If passed group mean will be plotted

**height **
The height of the image exported.

**jitterX **
The random offset of each point on the X Axis

**jitterY **
The random offset of each pointer on the Y Axis

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**pair (REQUIRED) **
Add a pair of two groups, seperare group names with '|' eg. “GROUP_1|GROUP_2”

**rawTraces **
If passed indivdual traces will be plotted

**title **
The title of the plot.

**width **
The width of the image exported.

**workspaceDispersion **
If passed workspace dispersion will be plotted

**workspaceDispersionType **
The type of dispersion to be displayed for workspaces

**workspaceMean **
If passed workspace mean will be plotted

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 -ExportPlotPairMetric filePath "C:\Plot Folder\pair_metric_plot.jpg" pair "Stride_Length_Start|Stride_Length_End" jitterX "0.2" jitterY "0.2"

-ExportPlotSPM / -EPSPM

Export the current SPM plot

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**height **
The height of the image exported.

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**title **
The title of the plot.

**width **
The width of the image exported.

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 ExportPlotSPM filePath "C:\Plots\SPM\spm_plot"

-ExportPlotResiduals / -ExportPlotR / -EPR

Export the current GLMs residuals plot

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**height **
The height of the image exported.

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**title **
The title of the plot.

**width **
The width of the image exported.

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 -ExportPlotResiduals filePath "C:\Plots\SPM\glm_residuals.png"

-ExportPlotB / -EPB

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**height **
The height of the image exported.

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**title **
The title of the plot.

**width **
The width of the image exported.

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 -ExportPlotB filePath "C:\ProcessingPlots\bPlot.png dataStyle "Workspace" legend "Bottom Right"

-ExportPlotVarianceExplained / -ExportPlotVE / -EPVE

Export the current PCAs variance explained plot

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**height **
The height of the image exported.

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**title **
The title of the plot.

**width **
The width of the image exported.

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 -ExportPlotVarianceExplained filePath "C:\Plots\PCA\variacen_explained.png"

-ExportPlotLoadingVector / -ExportPlotLV / -EPLV

Export the current PCAs loading vectors plot

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**flipPC **
If passed, invert PC

**height **
The height of the image exported.

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**pcNumber **
The principal component to plot.

**title **
The title of the plot.

**width **
The width of the image exported.

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 -ExportPlotLoadingVector file "C:\Processing\PCA\loading_vector_plot.png" xRange "20,70"

-ExportPlotWorkspaceScores / -ExportPlotWS / -EPWS

Export the current PCAs workspace scores plot

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**height **
The height of the image exported.

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**normalizeScores **
If passed workspace scores will be normalized

**title **
The title of the plot.

**width **
The width of the image exported.

**XAxisPC **
Principal Component represented on the X Axis

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**YAxisPC **
Prinicipal Component represented on the Y Axis

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 -ExportPlotWorkspaceScores filePath "C:\Plots\PCA\workspace_scores.png" xAxisPC "2" yAxisPC "3"

-ExportPlotGroupScores / -ExportPlotGS / -EPGS

Export the current PCAs groups scores plot

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**height **
The height of the image exported.

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**title **
The title of the plot.

**width **
The width of the image exported.

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 -ExportPlotGroupScores filePath "C:\Processing\PCA\group_scores_plot.png" title "Group Scores Ankle Angle X"

-ExportPlotReconstruction / -ExportPlotR / -EPR

Export the current PCAs reconstruction plot

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**group **
What group to reconstruct, pass multiple times to select multiple groups, do not pass to select all

**groupMean **
If passed group mean will be plotted

**height **
The height of the image exported.

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**pc **
What PCs to reconstruct, pass multiple times to select multiple PCs, do not pass to select all

**title **
The title of the plot.

**width **
The width of the image exported.

**workspace **
What workspace to reconstruct, pass multiple times to select multiple workspaces, do not pass to select all

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 -ExportPlotReconstruction filePath "C:\Plots\PCA\reconstruction.jpg" group "Ankle Angle X" workspace "P001.cmz"

-ExportPlotExtreme / -ExportPlotE / -EPE

Export the current PCAs extreme plot

Parameters

**dataStyle **
The data style to use when generating plot.

**filePath (DEFAULT) (REQUIRED) **
The file path the plot will be saved to.

**height **
The height of the image exported.

**legend **
Which corner should the legend be displayed in, if not passed no legend will be displayed

**pcNumber **

**plotType **

**title **
The title of the plot.

**width **
The width of the image exported.

**xLabel **
Label for the X-Axis.

**XRange **
The display range of the X Axis: “Max,Min”

**yLabel **
Label for the Y-Axis.

**YRange **
The display range of the Y Axis: “Max,Min” 

 -ExportPlotExtreme filePath "C:\Processing\PCA\extreme_plot.png" height "600" width "1200" pcNumber "2"

-CreateWatcher / -cw

Creates a new directory watcher

Parameters

**delay **
The number of ms to wait before executing scripts after watcher is triggered

**directory (REQUIRED) **
The directories to be watched, pass multiple times to add more directories

**name (REQUIRED) **
The name of the watcher being created

**overwrite **
If passed and existing watchers with the same name will be overwritten

**recursive **
If passed all subdirectories will be watched as well

**script (REQUIRED) **
A list of paths to the scripts to execute when the watcher is triggered

**triggerOnDelete **
If passed watcher will be triggered when a file is deleted as well as added or edited 

 -CreateWatcher name "WATCHER_ONE" directory "C:\Local Data Folder" script "C:\Local Data Folder\Processing Script.v3s" delay "8000" recursive

-ActivateWatcher / -aw

Activate the passed watcher(s) if not already activated

Parameters

**name (DEFAULT) **
The name of the watcher to be activated, pass multiple times to activate multiple watchers. if not passed all watcher will be activated. 

 -ActivateWatcher name "WATCHER_ONE" name "WATCHER_TWO"

-DeactivateWatcher / -daw

Deactivate the passed watcher(s), if no watcher is passed deactivate all watchers

Parameters

**name (DEFAULT) **
The name of the watcher to be deactivated 

 -DeactivateWatcher name "WATCHER_ONE"

-DeleteWatcher / -dw

Deletes the passed watcher if it exists

Parameters

**name (DEFAULT) (REQUIRED) **
The name of the watcher to be deleted 

 -DeleteWatcher "WATCHER_ONE"

-ListWatchers / -lw

List all watchers 

 -ListWatchers

-LaunchMinimized

Set Sift to lauch minimized to the system tray by default.

Parameters

**disable **
If passed Sift will will no longer launch minimized to the system tray. 

 -LaunchMinimized disable

-LaunchBackgroundInstance / -LaunchTray

Immediatly launch a background instance of Sift in the system tray. 

 -LaunchBackgroundInstance

-SetEnginePluginsFolder / -SEPF

Set the location the engine will look for plugins e.g Meta-Commands

Parameters

**folderPath (DEFAULT) (REQUIRED) **
The path to the engine plugins folder 

 -SetEnginePluginsFolder folderPath "C:\Engine Resources"

-RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics

Compute Summary Metrics

Parameters

**EventIndex **
Index Event to compute Metrics at.

**GlobalMax **
Compute Global Max.

**GlobalMin **
Compute Global Min.

**Group (REQUIRED) **
The group you will calculate metrics for.

**LocalMax **
Compute Local Max.

**LocalMaxEnd **
Local Max End Range.

**LocalMaxStart **
Local Max Start Range.

**LocalMin **
Compute Local Min.

**LocalMinEnd **
Local Min End Range.

**LocalMinStart **
Local Min Start Range.

**MaxBetweenEvents **
Compute Maximum Between Events.

**MaxEventEndIndex **
Index of End Event for Maximum Between Events.

**MaxEventStartIndex **
Index of Start Event for Maximum Between Events.

**Mean **
Compute Mean.

**MetricAtEvent **
Compute Metric at Event.

**MinBetweenEvents **
Compute Minimum Between Events.

**MinEventEndIndex **
Index of End Event for Minimum Between Events.

**MinEventStartIndex **
Index of Start Event for Minimum Between Events.

**StandardDeviation **
Compute Standard Deviation.

**StandardError **
Compute Standard Error.

**UseExcludedData **
Use Excluded Data to compute metrics.

**Workspaces **
Workspaces you will calculate metrics for. If left blank all workspaces will be used.

-RunSummaryStatistics / -ComputeSummaryStatistics / -SummaryStatistics / -RunSumStats

Compute Summary Statistics on selected groups / workspaces

Parameters

**group (REQUIRED) **
The group you will calculate summary statistics for.

**popMean **
Mean of the population you are comparing against for your summary statistical test.

**sigLevel **
The is the signifigance level used for the chosen statistical test.

**statTest (REQUIRED) **
The is the type of statistcal test that will be performed.

**testName (REQUIRED) **
The result name for your summary statistical test.

**useExcludedData **
Use Excluded Data to compute summary statistics.

**workspace **
Workspaces you will calculate summary statistics for. If left blank all workspaces will be used. Workspaces need to be written as group:workspace 

  - Summary Statistics Test Name "Example_SummaryStatistics" Statistical Test "One Sample T-Test" Signifigance Level "0.05"

-Exit / -x

Exit Sift 

 -Exit