User Tools

Site Tools


sift:command_line

This is an old revision of the document!


Sift Command Line

It is possible to run sift from the command line, this offers several advantages:

  • With no need to update a GUI or plots the application will run much faster
  • With experience it makes it possible to quickly execute commands
  • Creating a bat file or python script it is possible to completely automate processing

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

  • Commands are prefixed with a dash these are considered a reserved character, but Sift will ignore any dashes that are within double quotes so file-name.txt will cause an error, where “file-name.txt” will not.
  • Commands and parameters are case insensitive
  • 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
  • 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
  • To exit pass the command -Exit, or press Ctrl + C to quickly exit at any time (Sift will exit once the current command finishes executing)
  • Most commands have one or more aliases that will be accepted

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:

  • Whether or not this parameter is required for the command to run
  • The default value of the parameter if its not passed
  • The expected data type of the parameter

Command Reference


-LoadLib / -l


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

Parameters

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

  • Data Type: String (Directory)
  • Default Value: N/A

**libQuery **
A query to refine the files loaded into the library.

  • Data Type: String
  • Default Value: NULL

**libSubjTags **
A list of subject tags.

  • Data Type: String
  • Default Value: NULL
 -LoadLib "C:\Library Location\Data" libQuery "RUN AND NOT(OLD)" libSubjTags "RUN"

-LoadQuery / -q


Load and calculate a predifined query

Parameters

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

  • Data Type: String (File Path)
  • Default Value: N/A
 -LoadQuery file "C:\Data\query.q3d"

-RunPCA / -pca


Run Principal Compnent Analysis

Parameters

**name (DEFAULT) (REQUIRED) **
The name of the new PCA being computed

  • Data Type: String
  • Default Value: N/A

**numPCs **
The number of dimensions to reduce to

  • Data Type: Integer
  • Default Value: 4

**workspaceMean **
If passed PCA will be run on the mean value of each workspace, and not individual traces

  • Data Type: Boolean (True / False)
  • Default Value: false
 -RunPCA name "Sample_PCA" numPCs "4" workspaceMean

-RunLOF / -lof


Run Local Outlier Factor

Parameters

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

  • Data Type: Boolean (True / False)
  • Default Value: false

**grouping **
How should data be grouped before running: Combined Groups: All data points will be compared Groups: Data will be compared within groups Workspace: Data will be compared within workspaces

  • Data Type: String
  • Default Value: combined group
  • Options: combined group, group, workspace

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

  • Data Type: Decimal
  • Default Value: 3

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

  • Data Type: Integer
  • Default Value: 14

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

  • Data Type: Integer
  • Default Value: 1

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

  • Data Type: Integer
  • Default Value: 2

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

  • Data Type: Decimal
  • Default Value: 95

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

  • Data Type: Boolean (True / False)
  • Default Value: false
 -RunLOF grouping "combined group" numPasses "2" numNeighbors "7" autoExclude

-RunKMeans / -kmeans


Run K-Means cluster

Parameters

**clusters **
How many clusters to sort the data into

  • Data Type: Integer
  • Default Value: 2

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

  • Data Type: Integer
  • Default Value: 0

**grouping **
How should data be grouped before running: Combined Groups: All data points will be compared Groups: Data will be compared within groups Workspace: Data will be compared within workspaces

  • Data Type: String
  • Default Value: combined group
  • Options: combined group, group, workspace

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

  • Data Type: Integer
  • Default Value: 1

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

  • Data Type: Integer
  • Default Value: 2

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

  • Data Type: Decimal
  • Default Value: 95

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

  • Data Type: Boolean (True / False)
  • Default Value: false
 -RunKMeans clusters "4" scaleToVariability

-RunSPE / -spe


Run Squared Prediction Error

Parameters

**alphaValue **
The alpha threshold used to determine outliers: 0.1, 0.05, 0.025, 0.01, 0.005

  • Data Type: Decimal
  • Default Value: 0.1
  • Options: 0.1, 0.05, 0.025, 0.01, 0.005

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Integer
  • Default Value: 2

**PCsVariance **
scale calculated values to variability explained

  • Data Type: Decimal
  • Default Value: 95
 -RunSPE alphaValue "0.005" PCsVariance "80.0"

-RunMah / -mah


Run Mahalanobis Distance test

Parameters

**alphaValue **
The alpha threshold used to determine outliers: 0.1, 0.05, 0.025, 0.01, 0.005

  • Data Type: Decimal
  • Default Value: 0.1
  • Options: 0.1, 0.05, 0.025, 0.01, 0.005

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

  • Data Type: Boolean (True / False)
  • Default Value: false

**grouping **
How should data be grouped before running: Combined Groups: All data points will be compared Groups: Data will be compared within groups Workspace: Data will be compared within workspaces

  • Data Type: String
  • Default Value: combined group
  • Options: combined group, group, workspace

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

  • Data Type: Integer
  • Default Value: 1

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

  • Data Type: Integer
  • Default Value: 2

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

  • Data Type: Decimal
  • Default Value: 95

**scaleToVariance **
scale calculated values to variability explained

  • Data Type: Boolean (True / False)
  • Default Value: false
 -RunMah grouping "group" alphaValue "0.5" autoExclude

-RunV3D / -s / -plpath


Run pipelines via the V3D engine

Parameters

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

  • Data Type: String (File Path)
  • Default Value: NULL

**onLib **
If passed the the loaded library will be updated using the provided script(s)

  • Data Type: Boolean (True / False)
  • Default Value: false

**script (DEFAULT) (REQUIRED) **
A path to the script file to be run, multiple scripts can be passed by repeating the parameter

  • Data Type: List
  • Default Value: N/A
 -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 to be executed

  • Data Type: String
  • Default Value: N/A
 -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 to the passed path

Parameters

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

  • Data Type: String (Directory)
  • Default Value: N/A
 -DirPath path "C:\Work Directory\Data"

-RegisterCurves / -rc


Register curves

Parameters

**eventSequence **
Register by events

  • Data Type: Boolean (True / False)
  • Default Value: false

**localMax **
Use local maximum

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Integer
  • Default Value: -1

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

  • Data Type: Integer
  • Default Value: -1

**localMin **
use local minimum

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Integer
  • Default Value: -1

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

  • Data Type: Integer
  • Default Value: -1

**max **
Register by maximum

  • Data Type: Boolean (True / False)
  • Default Value: false

**min **
Register by minimum

  • Data Type: Boolean (True / False)
  • Default Value: false

**name (DEFAULT) (REQUIRED) **
The name for the group after curve registration

  • Data Type: String
  • Default Value: N/A
 -RegisterCurves name "Knee Angle X Reg" max min

-CreateGLM / -glm


Create a General Linear Model

Parameters

**grouping **
The grouping used for the model

  • Data Type: String
  • Default Value: group
  • Options: workspace, group

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: two_sample
  • Options: one_sample, two_sample, paired, one_way_anova

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

  • Data Type: Boolean (True / False)
  • Default Value: false
 -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

  • Data Type: Decimal
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false
 -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

  • Data Type: Decimal
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false
 -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

  • Data Type: Decimal
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false
 -RunSPMPairedTTest name "spm_pair" glm "GLM_ONE" group1 "AnkleAngleX" group2 "KneeAngleX"

-RunSPMOneWayAnova


Run Statistical Parameteric Mapping Paired T-Test

Parameters

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

  • Data Type: Decimal
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false
 -RunSPMOneWayAnova name "anova_spm" glm "GLM_2" twoTailed

-RunDTW / -dtw


Run Dynamic Time Warping

Parameters

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: Integer
  • Default Value: 1
  • Options: 1, 2, 3
 -RunDTW name "SAMPLE_DTW" standardDeviations "3"

-ExportData / -ex


Export queried data

Parameters

**allSequencesNorm **
CommandExport all sequences normalized

  • Data Type: Boolean (True / False)
  • Default Value: false

**allSequencesTime **
CommandExport all time based sequences

  • Data Type: Boolean (True / False)
  • Default Value: false

**eventsNorm **
CommandExport all events normalized

  • Data Type: Boolean (True / False)
  • Default Value: false

**eventsOrig **
CommandExport all time based events

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: standard
  • Options: standard, transposed, spss, p2d

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Boolean (True / False)
  • Default Value: false

**normalizedTo **
Normalize values to…

  • Data Type: String
  • Default Value: 101

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

  • Data Type: String
  • Default Value: 4

**workspaceMean **
CommandExport the mean of each workspace

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Boolean (True / False)
  • Default Value: false
 -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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: standard
  • Options: standard, transposed, spss, p2d

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

  • Data Type: String (File Path)
  • Default Value: N/A

**max **
Export the maximum value

  • Data Type: Boolean (True / False)
  • Default Value: false

**maxEventPoint **
Export the maximum event point

  • Data Type: Boolean (True / False)
  • Default Value: false

**maxStdDev **
Export the maximum standard deviation

  • Data Type: Boolean (True / False)
  • Default Value: false

**mean **
Export the mean value

  • Data Type: Boolean (True / False)
  • Default Value: false

**meanStdDev **
Export the mean standard deviation

  • Data Type: Boolean (True / False)
  • Default Value: false

**min **
Export the minimum value

  • Data Type: Boolean (True / False)
  • Default Value: false

**minEventPoint **
Export the minimum event point

  • Data Type: Boolean (True / False)
  • Default Value: false

**minStdDev **
Export the minimum standard deviation

  • Data Type: Boolean (True / False)
  • Default Value: false

**normalizeMetrics **
Normalize exported metrics

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: 4

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

  • Data Type: String
  • Default Value: groups
  • Options: groups, workspaces, instances
 -ExportSummaryStatistics file "C:\Exports\summary_stats.txt" results "workspaces" mean min max

-ExportRegisteredCurves


Export results of curve registration

Parameters

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

  • Data Type: String
  • Default Value: standard
  • Options: standard, transposed, spss, p2d

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

  • Data Type: String (File Path)
  • Default Value: N/A

**landmarkAll **
Export all landmarks

  • Data Type: Boolean (True / False)
  • Default Value: false

**landmarkMeans **
Export the landmark mean value

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: 4

**registeredCurves **
Export registered curves

  • Data Type: Boolean (True / False)
  • Default Value: false

**warpingFunctions **
Export all warping functions

  • Data Type: Boolean (True / False)
  • Default Value: false
 -ExportRegisteredCurves file "C:\Export Folder\registered_curves.txt" registeredCurves warpingFunctions landmarkMeans

-ExportDTW


Export Dynamic Time Warping results

Parameters

**costFunctions **
Export cost functions

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: standard
  • Options: standard, transposed, spss, p2d

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: 4
 -ExportDTW file "C:\DTW DATA\export.txt" costFunctions foundAnomalies

-ExportSPM


Export Statistical Parameteric Mapping results

Parameters

**bMatrix **
Export the B Matrix used

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: standard
  • Options: standard, transposed, spss, p2d

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: 4

**residualMatrix **
Export the residual matrix

  • Data Type: Boolean (True / False)
  • Default Value: false

**spm **
Export the statistical parameteric map

  • Data Type: Boolean (True / False)
  • Default Value: false
 -ExportSPM file "C:\Export Folder\SPM.txt" bMatrix residualMatrix spm

-ExportPCA


Export Principal Component Analysis results

Parameters

**eigenVectors **
Export the eigen vectors

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: standard
  • Options: standard, transposed, spss, p2d

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

  • Data Type: String (File Path)
  • Default Value: N/A

**groupScores **
Export group scores

  • Data Type: Boolean (True / False)
  • Default Value: false

**groupStdDev **
Export group standard deviation

  • Data Type: Boolean (True / False)
  • Default Value: false

**kMeans **
Export K-Means results

  • Data Type: Boolean (True / False)
  • Default Value: false

**lof **
Export local outlier factor results

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Boolean (True / False)
  • Default Value: false

**mahDis **
Export the mahalanobis distance results

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: 4

**spe **
Export squared prediction error results

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Boolean (True / False)
  • Default Value: false

**varianceExplained **
Export the variance explained

  • Data Type: Boolean (True / False)
  • Default Value: false

**workspaceScores **
Export workspace scores

  • Data Type: Boolean (True / False)
  • Default Value: false
 -ExportPCA file "C:\Processing Folder\PCA\export.txt" groupScores workspaceScores lof spe

-ExportPlotSignalTime / -ExportPlotST / -EPST


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: One Standard Deviation
  • Options: One Standard Deviation, Two Standard Deviations, Interquartile Range

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

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

  • Data Type: Boolean (True / False)
  • Default Value: false

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: One Standard Deviation
  • Options: One Standard Deviation, Two Standard Deviations, Interquartile Range

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 -ExportPlotSignalTime filePath "C:\Plots\signal_time.png" groupMean WorkspaceMean groupDispersion workspaceDispersion

-ExportPlotMetric / -ExportPlotM / -EPM


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: One Standard Deviation
  • Options: One Standard Deviation, Two Standard Deviations, Interquartile Range

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

**meanPlotStyle **
How should means be displayed

  • Data Type: String
  • Default Value: Bar Chart
  • Options: Bar Chart, Stacked Bar Chart, Box Plot

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

  • Data Type: String
  • Default Value: No Group
  • Options: No Group, Group, Workspace

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

  • Data Type: Boolean (True / False)
  • Default Value: false

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: One Standard Deviation
  • Options: One Standard Deviation, Two Standard Deviations, Interquartile Range

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 -ExportPlotMetric file "C:\Plot Exports\metric_plot.png" groupMean meanPlotStyle "Stacked Bar Chart"

-ExportPlotPairSignal / -ExportPlotPS / -EPPS


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: One Standard Deviation
  • Options: One Standard Deviation, Two Standard Deviations, Interquartile Range

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

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

  • Data Type: List
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: One Standard Deviation
  • Options: One Standard Deviation, Two Standard Deviations, Interquartile Range

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 -ExportPlotPairSignal filePath "C:\Plot Folder\signalSignal.pdf" workspaceMean workspaceDispersion

-ExportPlotPairMetric / -ExportPlotPM / -EPPM


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: One Standard Deviation
  • Options: One Standard Deviation, Two Standard Deviations, Interquartile Range

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: Decimal
  • Default Value: 0

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

  • Data Type: Decimal
  • Default Value: 0

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

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

  • Data Type: List
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: One Standard Deviation
  • Options: One Standard Deviation, Two Standard Deviations, Interquartile Range

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 -ExportPlotPairMetric filePath "C:\Plot Folder\pair_metric_plot.jpg" pair "Stride_Length_Start|Stride_Length_End" jitterX "0.2" jitterY "0.2"

-ExportPlotSPM / -EPSPM


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 ExportPlotSPM filePath "C:\Plots\SPM\spm_plot"

-ExportPlotResiduals / -ExportPlotR / -EPR


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 -ExportPlotResiduals filePath "C:\Plots\SPM\glm_residuals.png"

-ExportPlotB / -EPB


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 -ExportPlotB filePath "C:\ProcessingPlots\bPlot.png dataStyle "Workspace" legend "Bottom Right"

-ExportPlotVarianceExplained / -ExportPlotVE / -EPVE


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 -ExportPlotVarianceExplained filePath "C:\Plots\PCA\variacen_explained.png"

-ExportPlotLoadingVector / -ExportPlotLV / -EPLV


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

**flipPC **
If passed, invert PC

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

**pcNumber **
The principal component to plot.

  • Data Type: Integer
  • Default Value: 1

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 -ExportPlotLoadingVector file "C:\Processing\PCA\loading_vector_plot.png" xRange "20,70"

-ExportPlotWorkspaceScores / -ExportPlotWS / -EPWS


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

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

  • Data Type: Boolean (True / False)
  • Default Value: false

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: Integer
  • Default Value: 1

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 2

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 -ExportPlotWorkspaceScores filePath "C:\Plots\PCA\workspace_scores.png" xAxisPC "2" yAxisPC "3"

-ExportPlotGroupScores / -ExportPlotGS / -EPGS


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 -ExportPlotGroupScores filePath "C:\Processing\PCA\group_scores_plot.png" title "Group Scores Ankle Angle X"

-ExportPlotReconstruction / -ExportPlotR / -EPR


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: List
  • Default Value: NULL

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

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

  • Data Type: List
  • Default Value: NULL

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: List
  • Default Value: NULL

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 -ExportPlotReconstruction filePath "C:\Plots\PCA\reconstruction.jpg" group "Ankle Angle X" workspace "P001.cmz"

-ExportPlotExtreme / -ExportPlotE / -EPE


Parameters

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

  • Data Type: String
  • Default Value: Workspace
  • Options: Workspace, Group, Sub Group, Cluster

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

  • Data Type: String (File Path)
  • Default Value: N/A

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: NULL
  • Options: , Top Left, Top Right, Bottom Left, Bottom Right

**pcNumber **

  • Data Type: Integer
  • Default Value: 1

**plotType **

  • Data Type: String
  • Default Value: StdDevRecon
  • Options: StdDevRecon, 595Recon, 595Raw

**title **
The title of the plot.

  • Data Type: String
  • Default Value: ###

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

  • Data Type: Integer
  • Default Value: 1000

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###

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

  • Data Type: String
  • Default Value: ###
 -ExportPlotExtreme filePath "C:\Processing\PCA\extreme_plot.png" height "600" width "1200" pcNumber "2"

-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)

  • Data Type: List
  • Default Value: NULL

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

  • Data Type: List
  • Default Value: NULL
 -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)

  • Data Type: List
  • Default Value: NULL

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

  • Data Type: List
  • Default Value: NULL
 -SelectMetrics group "AnkleAngleX" group "AnkleAngleY" workspace "P002"

-SaveProject / -sv


Save the current project

Parameters

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

  • Data Type: String (File Path)
  • Default Value: N/A
 -SaveProject file "C:\Project Files\test_project.i3d"

-LoadProject / -ld


Load a previously saved project

Parameters

**file (DEFAULT) (REQUIRED) **
The path and name of project to be loaded

  • Data Type: String (File Path)
  • Default Value: N/A

**loadLib **
If passed the library associated with the file will be loaded

  • Data Type: Boolean (True / False)
  • Default Value: false
 -LoadProject "C:\Saved Projects\test_project.i3d" loadLib

-ClearProject / -clr


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

 -ClearProject

-CreateWatcher / -cw


Creates a directory watcher

Parameters

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

  • Data Type: Integer
  • Default Value: 3000

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

  • Data Type: List
  • Default Value: N/A

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

  • Data Type: String
  • Default Value: N/A

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: Boolean (True / False)
  • Default Value: false

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

  • Data Type: List
  • Default Value: N/A

**triggerOnDelete **
If passed watcher will be triggered when a file is deleted

  • Data Type: Boolean (True / False)
  • Default Value: false
 -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.

  • Data Type: List
  • Default Value: NULL
 -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

  • Data Type: List
  • Default Value: NULL
 -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

  • Data Type: String
  • Default Value: N/A
 -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.

  • Data Type: Boolean (True / False)
  • Default Value: false
 -LaunchMinimized disable

-LaunchBackgroundInstance / -LaunchTray


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

 -LaunchBackgroundInstance

-Exit / -x


Exit Sift

 -Exit

-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

  • Data Type: String (Directory)
  • Default Value: N/A
 -SetEnginePluginsFolder folderPath "C:\Engine Resources"
sift/command_line.1757700303.txt.gz · Last modified: by sgranger