HAS-Motion Software Documentation

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

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

• 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

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

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

A path to the root directory to be searched recursively for .cmzs

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

A query to refine the files loaded into the library.

• Data Type: String
• Default Value: NULL

A list of subject tags.

• Data Type: String
• Default Value: NULL

Load and calculate a predifined query

Path to the .q3d containing query definitions

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

Run Principal Compnent Analysis

The name of the new PCA being computed

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

The number of dimensions to reduce to

• Data Type: Integer
• Default Value: 4

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

• Data Type: True / False
• Default Value: false

Run Local Outlier Factor

If passed any outliers found will be excluded automatically

• Data Type: True / False
• Default Value: false

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

The threshold to consider when searching for outliers

• Data Type: Decimal
• Default Value: 3

How many neighbors should each point be compared to

• Data Type: Integer
• Default Value: 14

How many iterations of the test should be run

• Data Type: Integer
• Default Value: 1

How many principal components should the test be run on

• Data Type: Integer
• Default Value: 2

Determine the numbe of PCs by variance explained

• Data Type: Decimal
• Default Value: 95

Scale all calculated values to the variavility explained by the PC

• Data Type: True / False
• Default Value: false

Run K-Means cluster

How many clusters to sort the data into

• Data Type: Integer
• Default Value: 2

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

• Data Type: Integer
• Default Value: 0

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

How many iterations of the test should be run

• Data Type: Integer
• Default Value: 1

The number of principal components to run the test on

• Data Type: Integer
• Default Value: 2

Determine the number of PCs by variance explained

• Data Type: Decimal
• Default Value: 95

Scale all calculated values to the variavility explained by the PC

• Data Type: True / False
• Default Value: false

Run Squared Prediction Error

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

If passed any outliers found will be exclude automatically

• Data Type: True / False
• Default Value: false

The number of principal components to run the test on

• Data Type: Integer
• Default Value: 2

scale calculated values to variability explained

• Data Type: Decimal
• Default Value: 95

Run Mahalanobis Distance test

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

If passed any outliers found will be excluded automatically

• Data Type: True / False
• Default Value: false

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

How many iterations of the test should be run

• Data Type: Integer
• Default Value: 1

The number of principal components to run the test on

• Data Type: Integer
• Default Value: 2

Determing the number of PCs by variance explained instead of number

• Data Type: Decimal
• Default Value: 95

scale calculated values to variability explained

• Data Type: True / False
• Default Value: false

Run pipelines via the V3D engine

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

• Data Type: File
• Default Value: NULL

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

• Data Type: True / False
• Default Value: false

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

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

The pipeline command to be executed

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

Set a global variable to the passed path

The path to set

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

Register curves

Register by events

• Data Type: True / False
• Default Value: false

Use local maximum

• Data Type: True / False
• Default Value: false

The lower bounds of the local max

• Data Type: Integer
• Default Value: -1

The upper bounds of the local max

• Data Type: Integer
• Default Value: -1

use local minimum

• Data Type: True / False
• Default Value: false

The lower bounds of the local minimum

• Data Type: Integer
• Default Value: -1

The upper bounds of the local minimum

• Data Type: Integer
• Default Value: -1

Register by maximum

• Data Type: True / False
• Default Value: false

Register by minimum

• Data Type: True / False
• Default Value: false

The name for the group after curve registration

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

Create a General Linear Model

The grouping used for the model : Workspace / Group

• Data Type: String
• Default Value: group

* Options:workspace, group

The name of the GLM being created

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

The intended test type for the model : One sample t-test, Two sample t-test, Paired t-test

• Data Type: String
• Default Value: two_sample

* Options:one_sample, two_sample, paired, one_way_anova

If using workspace means, instead of the individual traces

• Data Type: True / False
• Default Value: false

Run Statistical Parameteric Mapping One-Sample T-Test

The alpha value to threshold with

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

The name of the GLM to use when creating the SPM

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

The name of the group to test

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

The name of the SPM being created

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

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

• Data Type: True / False
• Default Value: false

Run Statistical Parameteric Mapping Two-Sample T-Test

The alpha value to threshold with

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

The name of the GLM to use when creating the SPM

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

The name of the first group to test

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

The name of the second group to test

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

The name of the SPM being created

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

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

• Data Type: True / False
• Default Value: false

Run Statistical Parameteric Mapping Paired T-Test

The alpha value to threshold with

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

The name of the GLM to use when creating the SPM

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

The name of the first group to test

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

The name of the second group to test

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

The name of the SPM being created

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

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

• Data Type: True / False
• Default Value: false

Run Statistical Parameteric Mapping Paired T-Test

The alpha value to threshold with

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

The name of the GLM to use when creating the SPM

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

The name of the SPM being created

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

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

• Data Type: True / False
• Default Value: false

Run Dynamic Time Warping

The name of the DTW test being run

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

How many standard deviation to test for: 1-3

• Data Type: Integer
• Default Value: 1

* Options:1, 2, 3

Export queried data

CommandExport all sequences normalized

• Data Type: True / False
• Default Value: false

CommandExport all time based sequences

• Data Type: True / False
• Default Value: false

CommandExport all events normalized

• Data Type: True / False
• Default Value: false

CommandExport all time based events

• Data Type: True / False
• Default Value: false

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

• Data Type: String
• Default Value: standard

* Options:standard, transposed, spss, p2d

Desired path for the text export to be saved

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

CommandExport the mean value of each group

• Data Type: True / False
• Default Value: false

CommandExport the standard deviation of each group

• Data Type: True / False
• Default Value: false

Normalize values to…

• Data Type: String
• Default Value: 101

How many decimal places should values be displayed to

• Data Type: String
• Default Value: 4

CommandExport the mean of each workspace

• Data Type: True / False
• Default Value: false

CommandExport the standard deviation of each workspace

• Data Type: True / False
• Default Value: false

Export summary statistics

Export metrics

• Data Type: True / False
• Default Value: false

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

• Data Type: String
• Default Value: standard

* Options:standard, transposed, spss, p2d

Desired path for the text export to be saved

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

Export the maximum value

• Data Type: True / False
• Default Value: false

Export the maximum event point

• Data Type: True / False
• Default Value: false

Export the maximum standard deviation

• Data Type: True / False
• Default Value: false

Export the mean value

• Data Type: True / False
• Default Value: false

Export the mean standard deviation

• Data Type: True / False
• Default Value: false

Export the minimum value

• Data Type: True / False
• Default Value: false

Export the minimum event point

• Data Type: True / False
• Default Value: false

Export the minimum standard deviation

• Data Type: True / False
• Default Value: false

Normalize exported metrics

• Data Type: True / False
• Default Value: false

How many decimal places should values be displayed to

• Data Type: String
• Default Value: 4

Export results for: Groups, Workspaces, Instances

• Data Type: String
• Default Value: groups

* Options:groups, workspaces, instances

Export results of curve registration

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

• Data Type: String
• Default Value: standard

* Options:standard, transposed, spss, p2d

Desired path for the text export to be saved

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

Export all landmarks

• Data Type: True / False
• Default Value: false

Export the landmark mean value

• Data Type: True / False
• Default Value: false

How many decimal places should values be displayed to

• Data Type: String
• Default Value: 4

Export registered curves

• Data Type: True / False
• Default Value: false

Export all warping functions

• Data Type: True / False
• Default Value: false

Export Dynamic Time Warping results

Export cost functions

• Data Type: True / False
• Default Value: false

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

• Data Type: String
• Default Value: standard

* Options:standard, transposed, spss, p2d

Desired path for the text export to be saved

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

Export all outliers found with dynamic time warping

• Data Type: True / False
• Default Value: false

How many decimal places should values be displayed to

• Data Type: String
• Default Value: 4

Export Statistical Parameteric Mapping results

Export the B Matrix used

• Data Type: True / False
• Default Value: false

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

• Data Type: String
• Default Value: standard

* Options:standard, transposed, spss, p2d

Desired path for the text export to be saved

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

How many decimal places should values be displayed to

• Data Type: String
• Default Value: 4

Export the residual matrix

• Data Type: True / False
• Default Value: false

Export the statistical parameteric map

• Data Type: True / False
• Default Value: false

Export Principal Component Analysis results

Export the eigen vectors

• Data Type: True / False
• Default Value: false

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

• Data Type: String
• Default Value: standard

* Options:standard, transposed, spss, p2d

Desired path for the text export to be saved

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

Export group scores

• Data Type: True / False
• Default Value: false

Export group standard deviation

• Data Type: True / False
• Default Value: false

Export K-Means results

• Data Type: True / False
• Default Value: false

Export local outlier factor results

• Data Type: True / False
• Default Value: false

Export threshould to determine an LOF outlier

• Data Type: True / False
• Default Value: false

Export the mahalanobis distance results

• Data Type: True / False
• Default Value: false

Export the threshold used to determine a mahalanobis distance outlier

• Data Type: True / False
• Default Value: false

Export the mean plus or minus 5 and 95%

• Data Type: True / False
• Default Value: false

Export the mean plus or minus one standard deviation

• Data Type: True / False
• Default Value: false

How many decimal places should values be displayed to

• Data Type: String
• Default Value: 4

Export squared prediction error results

• Data Type: True / False
• Default Value: false

Export the threshold to determine an SPE outlier

• Data Type: True / False
• Default Value: false

Export the variance explained

• Data Type: True / False
• Default Value: false

Export workspace scores

• Data Type: True / False
• Default Value: false

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

If passed group dispersion will be plotted

• Data Type: True / False
• Default Value: false

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

If passed group mean will be plotted

• Data Type: True / False
• Default Value: false

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

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

If passed indivdual traces will be plotted

• Data Type: True / False
• Default Value: false

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

If passed workspace dispersion will be plotted

• Data Type: True / False
• Default Value: false

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

If passed workspace mean will be plotted

• Data Type: True / False
• Default Value: false

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

If passed group dispersion will be plotted

• Data Type: True / False
• Default Value: false

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

If passed group mean will be plotted

• Data Type: True / False
• Default Value: false

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

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

How should means be displayed

• Data Type: String
• Default Value: Bar Chart

* Options:Bar Chart, Stacked Bar Chart, Box Plot

How should workspace means be grouped?

• Data Type: String
• Default Value: No Group

* Options:No Group, Group, Workspace

If passed indivdual traces will be plotted

• Data Type: True / False
• Default Value: false

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

If passed workspace dispersion will be plotted

• Data Type: True / False
• Default Value: false

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

If passed workspace mean will be plotted

• Data Type: True / False
• Default Value: false

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

If passed group dispersion will be plotted

• Data Type: True / False
• Default Value: false

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

If passed group mean will be plotted

• Data Type: True / False
• Default Value: false

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

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

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

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

If passed indivdual traces will be plotted

• Data Type: True / False
• Default Value: false

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

If passed workspace dispersion will be plotted

• Data Type: True / False
• Default Value: false

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

If passed workspace mean will be plotted

• Data Type: True / False
• Default Value: false

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

If passed group dispersion will be plotted

• Data Type: True / False
• Default Value: false

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

If passed group mean will be plotted

• Data Type: True / False
• Default Value: false

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

The random offset of each point on the X Axis

• Data Type: Decimal
• Default Value: 0

The random offset of each pointer on the Y Axis

• Data Type: Decimal
• Default Value: 0

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

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

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

If passed indivdual traces will be plotted

• Data Type: True / False
• Default Value: false

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

If passed workspace dispersion will be plotted

• Data Type: True / False
• Default Value: false

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

If passed workspace mean will be plotted

• Data Type: True / False
• Default Value: false

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

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

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

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

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

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

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

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

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

If passed, invert PC

• Data Type: True / False
• Default Value: false

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

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

The principal component to plot.

• Data Type: Integer
• Default Value: 1

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

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

If passed workspace scores will be normalized

• Data Type: True / False
• Default Value: false

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

Principal Component represented on the X Axis

• Data Type: Integer
• Default Value: 1

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Prinicipal Component represented on the Y Axis

• Data Type: Integer
• Default Value: 2

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

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

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

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

• Data Type: List
• Default Value: NULL

If passed group mean will be plotted

• Data Type: True / False
• Default Value: false

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

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

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

• Data Type: List
• Default Value: NULL

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

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

• Data Type: List
• Default Value: NULL

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

The data style to use when generating plot.

• Data Type: String
• Default Value: Workspace

* Options:Workspace, Group, Sub Group, Cluster

The file path the plot will be saved to.

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

The height of the image exported.

• Data Type: Integer
• Default Value: 1000

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

• Data Type: Integer
• Default Value: 1

• Data Type: String
• Default Value: StdDevRecon

* Options:StdDevRecon, 595Recon, 595Raw

The title of the plot.

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

The width of the image exported.

• Data Type: Integer
• Default Value: 1000

Label for the X-Axis.

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

The display range of the X Axis: “X,Y”

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

Label for the Y-Axis.

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

The display range of the Y Axis: “X,Y”

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

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

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

• Data Type: List
• Default Value: NULL

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

• Data Type: List
• Default Value: NULL

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

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

• Data Type: List
• Default Value: NULL

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

• Data Type: List
• Default Value: NULL

Save the current project

The path and name of the file

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

Load a previously saved project

The path and name of project to be loaded

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

If passed the library associated with the file will be loaded

• Data Type: True / False
• Default Value: false

Clear and create a new project workspace

Creates a directory watcher

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

• Data Type: Integer
• Default Value: 3000

The directories to be watched, pass multiple times to add more directories

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

The name of the watcher being created

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

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

• Data Type: True / False
• Default Value: false

If passed all subdirectories will be watched as well

• Data Type: True / False
• Default Value: false

A list of paths to the scripts to execute when the watcher is triggered

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

If passed watcher will be triggered when a file is deleted

• Data Type: True / False
• Default Value: false

Activate the passed watcher(s), if no watcher is passed activate all watchers

The name of the watcher to be activated

• Data Type: List
• Default Value: NULL

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

The name of the watcher to be deactivated

• Data Type: List
• Default Value: NULL

Deletes the passed watcher if it exists

The name of the watcher to be deleted

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

List all watchers

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

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

• Data Type: True / False
• Default Value: false

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

Exit Sift

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

The path to the engine plugins folder

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