HAS-Motion Software Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== 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: \\
{{:help_command.png}} \\
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: \\
{{:help_parameter.png}} \\
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 into the library
=== 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 **__ \\ 
The query used to refine the files loaded into the library
  * **Data Type:** String
  * **Default Value:** NULL
__**libSubjTags **__ \\ 
A list of subject tags that must be included within the .cmzs
  * **Data Type:** String
  * **Default Value:** NULL
<code> -LoadLib "C:\Library Location\Data" libQuery "RUN AND NOT(OLD)" libSubjTags "RUN"</code>

----
==== -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
<code> -LoadQuery file "C:\Data\query.q3d"</code>

----
==== -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
<code> -SaveProject file "C:\Project Files\test_project.i3d"</code>

----
==== -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
<code> -LoadProject "C:\Saved Projects\test_project.i3d" loadLib</code>

----
==== -ClearProject / -clr ====
----
Clear and create a new project workspace (All unsaved progress will be lost)
<code> -ClearProject</code>

----
==== -RunPCA / -pca ====
----
Run Principal Compnent Analysis on selected groups / workspaces
=== Parameters ===
__**name (DEFAULT) (REQUIRED) **__ \\ 
The name of the PCA
  * **Data Type:** String
  * **Default Value:** N/A
__**numPCs **__ \\ 
The number of principal components calculated
  * **Data Type:** Integer
  * **Default Value:** 4
__**workspaceMean **__ \\ 
If passed run PCA on workspace mean instead of individual traces
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
<code> -RunPCA name "Sample_PCA" numPCs "4" workspaceMean</code>

----
==== -RunLOF / -lof ====
----
Run Local Outlier Factor on currently active PCA
=== 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 looking for outliers
  * **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
<code> -RunLOF grouping "combined group" numPasses "2" numNeighbors "7" autoExclude</code>

----
==== -RunKMeans / -kmeans ====
----
Run K-Means clustering on currently actve PCA
=== Parameters ===
__**clusters **__ \\ 
How many clusters generated
  * **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 being clustered
  * **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 variability explained by the PC
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
<code> -RunKMeans clusters "4" scaleToVariability</code>

----
==== -RunSPE / -spe ====
----
Run Squared Prediction Error on the currently active PCA
=== Parameters ===
__**alphaValue **__ \\ 
The alpha threshold used to determine outliers
  * **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
<code> -RunSPE alphaValue "0.005" PCsVariance "80.0"</code>

----
==== -RunMah / -mah ====
----
Run Mahalanobis Distance test on the currently active PCA
=== Parameters ===
__**alphaValue **__ \\ 
The alpha threshold used to determine outliers
  * **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
  * **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
<code> -RunMah grouping "group" alphaValue "0.5" autoExclude</code>

----
==== -RunV3D / -s / -plpath ====
----
Run pipelines via the Visual3D engine
=== Parameters ===
__**exportLog **__ \\ 
If passed a processing log will be exported to the file path provided
  * **Data Type:** String (File Path)
  * **Default Value:** NULL
__**onLib **__ \\ 
If passed the scripts will be run on the loaded library
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**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)
  * **Data Type:** List
  * **Default Value:** N/A
<code> -RunV3D script "C:\Scripts\v3d_script.v3s" exportLog "C:\Scripts\v3d_script_export.txt"</code>

----
==== -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
  * **Data Type:** String
  * **Default Value:** N/A
<code> -RunV3DCommand command "Set_Default_Folders / DEFAULT_DATA = C:\Users\Shane Granger\Desktop\Intro_Project\SPL - Open - Data - main\basketball\freethrowdata; "</code>

----
==== -DirPath ====
----
Set a global variable within the V3D Engine to the passed path
=== Parameters ===
__**path (DEFAULT) (REQUIRED) **__ \\ 
The path to set
  * **Data Type:** String (Directory)
  * **Default Value:** N/A
<code> -DirPath path "C:\Work Directory\Data"</code>

----
==== -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
<code> -SetEnginePluginsFolder folderPath "C:\Engine Resources"</code>

----
==== -RegisterCurves / -rc ====
----
Register time series data to allign certain landmarks / events
=== Parameters ===
__**eventSequence **__ \\ 
Register by events
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**localMax **__ \\ 
Register by 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 **__ \\ 
Register by 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 new group created
  * **Data Type:** String
  * **Default Value:** N/A
<code> -RegisterCurves name "Knee Angle X Reg" max min</code>

----
==== -CreateGLM / -glm ====
----
Create a General Linear Model using the selected groups / workspaces
=== 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
  * **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
<code> -CreateGLM name "GLM_ONE" test "one_sample" grouping "group" workspaceMeans</code>

----
==== -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
<code> -RunSPM1TTest name "SPM_1_Test" glm "GLM_ONE" alpha "0.7" group "AnkleAngleX"</code>

----
==== -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
<code> -RunSPM2TTest name "spm_two_sample" glm "GLM_TWO" group1 "KneeAngleX" group2 "HipAngleX"</code>

----
==== -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
<code> -RunSPMPairedTTest name "spm_pair" glm "GLM_ONE" group1 "AnkleAngleX" group2 "KneeAngleX"</code>

----
==== -RunSPMOneWayAnova ====
----
Run Statistical Parameteric Mapping one way Anova 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
<code> -RunSPMOneWayAnova name "anova_spm" glm "GLM_2" twoTailed</code>

----
==== -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
<code> -RunDTW name "SAMPLE_DTW" standardDeviations "3"</code>

----
==== -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
<code> -ExporData file "C:\Data\Export Folder\data_export.txt" precision "2" exportFormat "transposed" groupMean groupStdDev workspaceMean workspaceStdDev</code>

----
==== -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
<code> -ExportSummaryStatistics file "C:\Exports\summary_stats.txt" results "workspaces" mean min max</code>

----
==== -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
<code> -ExportRegisteredCurves file "C:\Export Folder\registered_curves.txt" registeredCurves warpingFunctions landmarkMeans</code>

----
==== -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
<code> -ExportDTW file "C:\DTW DATA\export.txt" costFunctions foundAnomalies</code>

----
==== -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
<code> -ExportSPM file "C:\Export Folder\SPM.txt" bMatrix residualMatrix spm</code>

----
==== -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
<code> -ExportPCA file "C:\Processing Folder\PCA\export.txt" groupScores workspaceScores lof spe</code>

----
==== -ExportPlotSignalTime / -ExportPlotST / -EPST ====
----
Export a signal time plot using the currently selected groups / workspaces
=== 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:** ###
<code> -ExportPlotSignalTime filePath "C:\Plots\signal_time.png" groupMean WorkspaceMean groupDispersion workspaceDispersion</code>

----
==== -ExportPlotMetric / -ExportPlotM / -EPM ====
----
Export a metric plot using the currently selected groups / workspaces
=== 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:** ###
<code> -ExportPlotMetric file "C:\Plot Exports\metric_plot.png" groupMean meanPlotStyle "Stacked Bar Chart"</code>

----
==== -ExportPlotPairSignal / -ExportPlotPS / -EPPS ====
----
Export a Signal Signal plot using the currently selected groups / workspaces
=== 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:** ###
<code> -ExportPlotPairSignal filePath "C:\Plot Folder\signalSignal.pdf" workspaceMean workspaceDispersion</code>

----
==== -ExportPlotPairMetric / -ExportPlotPM / -EPPM ====
----
Export a Metric Metric plot using the currently selected groups / workspaces
=== 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:** ###
<code> -ExportPlotPairMetric filePath "C:\Plot Folder\pair_metric_plot.jpg" pair "Stride_Length_Start|Stride_Length_End" jitterX "0.2" jitterY "0.2"</code>

----
==== -ExportPlotSPM / -EPSPM ====
----
Export the current SPM plot
=== 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:** ###
<code> ExportPlotSPM filePath "C:\Plots\SPM\spm_plot"</code>

----
==== -ExportPlotResiduals / -ExportPlotR / -EPR ====
----
Export the current GLMs residuals plot
=== 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:** ###
<code> -ExportPlotResiduals filePath "C:\Plots\SPM\glm_residuals.png"</code>

----
==== -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:** ###
<code> -ExportPlotB filePath "C:\ProcessingPlots\bPlot.png dataStyle "Workspace" legend "Bottom Right"</code>

----
==== -ExportPlotVarianceExplained / -ExportPlotVE / -EPVE ====
----
Export the current PCAs variance explained plot
=== 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:** ###
<code> -ExportPlotVarianceExplained filePath "C:\Plots\PCA\variacen_explained.png"</code>

----
==== -ExportPlotLoadingVector / -ExportPlotLV / -EPLV ====
----
Export the current PCAs loading vectors plot
=== 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:** ###
<code> -ExportPlotLoadingVector file "C:\Processing\PCA\loading_vector_plot.png" xRange "20,70"</code>

----
==== -ExportPlotWorkspaceScores / -ExportPlotWS / -EPWS ====
----
Export the current PCAs workspace scores plot
=== 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:** ###
<code> -ExportPlotWorkspaceScores filePath "C:\Plots\PCA\workspace_scores.png" xAxisPC "2" yAxisPC "3"</code>

----
==== -ExportPlotGroupScores / -ExportPlotGS / -EPGS ====
----
Export the current PCAs groups scores plot
=== 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:** ###
<code> -ExportPlotGroupScores filePath "C:\Processing\PCA\group_scores_plot.png" title "Group Scores Ankle Angle X"</code>

----
==== -ExportPlotReconstruction / -ExportPlotR / -EPR ====
----
Export the current PCAs reconstruction plot
=== 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:** ###
<code> -ExportPlotReconstruction filePath "C:\Plots\PCA\reconstruction.jpg" group "Ankle Angle X" workspace "P001.cmz"</code>

----
==== -ExportPlotExtreme / -ExportPlotE / -EPE ====
----
Export the current PCAs extreme plot
=== 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:** ###
<code> -ExportPlotExtreme filePath "C:\Processing\PCA\extreme_plot.png" height "600" width "1200" pcNumber "2"</code>

----
==== -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
<code> -SelectSignals group "KneeAngleX"</code>

----
==== -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
<code> -SelectMetrics group "AnkleAngleX" group "AnkleAngleY" workspace "P002"</code>

----
==== -CreateWatcher / -cw ====
----
Creates a new 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 as well as added or edited
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
<code> -CreateWatcher name "WATCHER_ONE" directory "C:\Local Data Folder" script "C:\Local Data Folder\Processing Script.v3s" delay "8000" recursive</code>

----
==== -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
<code> -ActivateWatcher name "WATCHER_ONE" name "WATCHER_TWO"</code>

----
==== -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
<code> -DeactivateWatcher name "WATCHER_ONE"</code>

----
==== -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
<code> -DeleteWatcher "WATCHER_ONE"</code>

----
==== -ListWatchers / -lw ====
----
List all watchers
<code> -ListWatchers</code>

----
==== -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
<code> -LaunchMinimized disable</code>

----
==== -LaunchBackgroundInstance / -LaunchTray ====
----
Immediatly launch a background instance of Sift in the system tray.
<code> -LaunchBackgroundInstance</code>

----
==== -RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics ====
----
Compute Summary Metrics
=== Parameters ===
__**EventIndex **__ \\ 
Index Event to compute Metrics at.
  * **Data Type:** String
  * **Default Value:** NULL
__**GlobalMax **__ \\ 
Compute Global Max.
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**GlobalMin **__ \\ 
Compute Global Min.
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**Group (REQUIRED) **__ \\ 
The group you will calculate metrics for.
  * **Data Type:** String
  * **Default Value:** N/A
__**LocalMax **__ \\ 
Compute Local Max.
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**LocalMaxEnd **__ \\ 
Local Max End Range.
  * **Data Type:** Integer
  * **Default Value:** 0
__**LocalMaxStart **__ \\ 
Local Max Start Range.
  * **Data Type:** Integer
  * **Default Value:** 0
__**LocalMin **__ \\ 
Compute Local Min.
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**LocalMinEnd **__ \\ 
Local Min End Range.
  * **Data Type:** Integer
  * **Default Value:** 0
__**LocalMinStart **__ \\ 
Local Min Start Range.
  * **Data Type:** Integer
  * **Default Value:** 0
__**MaxBetweenEvents **__ \\ 
Compute Maximum Between Events.
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**MaxEventEndIndex **__ \\ 
Index of End Event for Maximum Between Events.
  * **Data Type:** String
  * **Default Value:** NULL
__**MaxEventStartIndex **__ \\ 
Index of Start Event for Maximum Between Events.
  * **Data Type:** String
  * **Default Value:** NULL
__**Mean **__ \\ 
Compute Mean.
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**MetricAtEvent **__ \\ 
Compute Metric at Event.
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**MinBetweenEvents **__ \\ 
Compute Minimum Between Events.
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**MinEventEndIndex **__ \\ 
Index of End Event for Minimum Between Events.
  * **Data Type:** String
  * **Default Value:** NULL
__**MinEventStartIndex **__ \\ 
Index of Start Event for Minimum Between Events.
  * **Data Type:** String
  * **Default Value:** NULL
__**StandardDeviation **__ \\ 
Compute Standard Deviation.
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**StandardError **__ \\ 
Compute Standard Error.
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**UseExcludedData **__ \\ 
Use Excluded Data to compute metrics.
  * **Data Type:** Boolean (True / False)
  * **Default Value:** false
__**Workspaces **__ \\ 
Workspaces you will calculate metrics for. If left blank all workspaces will be used.
  * **Data Type:** List
  * **Default Value:** NULL
<code> 
-RunSummaryMetrics Group "AnkleAngleX" Mean StandardDeviation StandardError GlobalMax GlobalMin</code>

----
==== -Exit / -x ====
----
Exit Sift
<code> -Exit</code>