HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » sift » Sift Command Line
sift:command_line

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
sift:command_line [2025/09/11 14:38] – sgrangersift:command_line [2025/09/23 18:33] (current) – [-RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics] wikisysop
Line 38: Line 38:
  
  
-===== Library / File Management =====+===== Command Reference =====
 ---- ----
 ==== -LoadLib / -l ==== ==== -LoadLib / -l ====
 ---- ----
-Load in a library of CMZs+Search the provided directory and all sub directories for .cmz files and load them into the library
 === Parameters === === Parameters ===
-== Directory (Required/Default) == +__**directory (DEFAULT) (REQUIRED) **__ \\  
-Path to the directory containing the CMZs to be loaded, all sub-directories will be searched as well. +A path to the root directory to be searched recursively for .cmzs 
-=== Example === +  * **Data Type:** String (Directory) 
-<code>-LoadLib directory "C:\library folder"</code>+  * **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 ====+==== -LoadQuery / -q ====
 ---- ----
-Load a saved query from a .q3d file+Load and calculate a predifined query
 === Parameters === === Parameters ===
-== File (Required/Default) == +__**file (DEFAULT) (REQUIRED) **__ \\  
-The path to the .q3d file containing the query +Path to the .q3d containing query definitions 
-=== Example === +  * **Data Type:** String (File Path) 
-<code>-LoadQuery file "C:\library folder\query.q3d"</code> +  * **Default Value:** N/A 
- +<code> -LoadQuery file "C:\Data\query.q3d"</code>
----- +
-==== -SelectSignals / -sig ==== +
----- +
-Select all or a selection of Signal groups and workspaces +
-=== Parameters === +
-== Group == +
-The name of a group to be selected, this parameter can be passed multiple times to select more than one group, if this parameter is not passed, all groups will be selected +
-== Workspace == +
-The name of a workspace to be selected, this parameter can be passed multiple times to select more than one workspace, if this parameter is not passed, all workspaces will be selected +
-=== Example === +
-<code>-SelectSignals group "AnkleAngleX" group "AnkleAngleY" workspace "Sub004"</code> +
- +
-----  +
-==== -SelectMetrics / -met ==== +
----- +
-Select all or a selection of Metric groups and workspaces +
-=== Parameters === +
-== Group == +
-The name of a group to be selected, this parameter can be passed multiple times to select more than one group, if this parameter is not passed, all groups will be selected +
-== Workspace == +
-The name of a workspace to be selected, this parameter can be passed multiple times to select more than one workspace, if this parameter is not passed, all groups will be selected +
-=== Example === +
-<code>-SelectMetrics group "MaxKneeAngleX" group "MinKneeAngleX" workspace "Sub001"</code>+
  
 ---- ----
 ==== -SaveProject / -sv ==== ==== -SaveProject / -sv ====
 ---- ----
-Save the currently open project to an .i3d file+Save the current project
 === Parameters === === Parameters ===
-== file (Required/Default) == +__**file (DEFAULT) (REQUIRED) **__ \\  
-The name and path of the .i3d file being saved +The path and name of the file 
-=== Example === +  * **Data Type:** String (File Path) 
-<code>-SaveProject file "C:/folder/file.i3d"</code>+  * **Default Value:** N/A 
 +<code> -SaveProject file "C:\Project Files\test_project.i3d"</code>
  
 ---- ----
 ==== -LoadProject / -ld ==== ==== -LoadProject / -ld ====
 ---- ----
-Load the passed project file+Load a previously saved project
 === Parameters === === Parameters ===
-== file == +__**file (DEFAULT) (REQUIRED) **__ \\  
-The name and path of the .i3d file being loaded +The path and name of project to be loaded 
-=== Example === +  * **Data Type:** String (File Path) 
-<code>-LoadProject file "C:/folder/file.i3d"</code>+  * **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 ==== ==== -ClearProject / -clr ====
 ---- ----
-Clear all data from the current project, no parameters +Clear and create a new project workspace (All unsaved progress will be lost) 
-=== Example === +<code> -ClearProject</code>
-<code>-ClearProject</code>+
  
- 
- 
-===== PCA ===== 
 ---- ----
 ==== -RunPCA / -pca ==== ==== -RunPCA / -pca ====
 ---- ----
-Run Principal Component Analysis on all queries+Run Principal Compnent Analysis on selected groups / workspaces
 === Parameters === === Parameters ===
-== Name (Required/Default) == +__**name (DEFAULT) (REQUIRED) **__ \\  
-The name for the PCA to be created +The name of the PCA 
-== numPCs == +  * **Data Type:** String 
-How many principal components should be created \\ +  * **Default Value:** N/A 
-<sub>//Default:// 4</sub> +__**numPCs **__ \\  
-== WorkspaceMean == +The number of principal components calculated 
-If passed PCA will be run on the mean of each workspace and not the individual traces +  * **Data Type:** Integer 
-=== Example === +  * **Default Value:** 4 
-<code>-RunPCA name "New PCA" numPCs "3" workspaceMean</code>+__**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 ==== ==== -RunLOF / -lof ====
 ---- ----
-Run Local Outlier Factor+Run Local Outlier Factor on currently active PCA
 === Parameters === === Parameters ===
-== AutoExclude ==+__**autoExclude **__ \\ 
 If passed any outliers found will be excluded automatically If passed any outliers found will be excluded automatically
-== Grouping == +  * **Data Type:** Boolean (True / False) 
-How should data be grouped before running? \\ +  * **Default Value:** false 
-  * Combined Groups: All data points will be compared +__**grouping **__ \\  
-  * Groups: Data will be compared within groups +How should data be grouped before looking for outliers 
-  * Workspace: Data will be compared within workspaces +  * **Data Type:** String 
-<sub>//Default:// Combined Groups</sub> +  * **Default Value:** combined group 
-== ManualThreshold == +  * **Options:** combined group, group, workspace 
-The threshold to consider when searching for outliers \\ +__**manualThreshold **__ \\  
-<sub>//Default:// 2.00</sub> +The threshold to consider when searching for outliers 
-== NumNeighbors == +  * **Data Type:** Decimal 
-How many neighbors should each point be compared to? \\ +  * **Default Value:** 3 
-<sub>//Default:// 10</sub> +__**numNeighbors **__ \\  
-== numPasses == +How many neighbors should each point be compared to 
-How many iterations of the test should be run \\ +  * **Data Type:** Integer 
-<sub>//Default:// 1</sub> +  * **Default Value:** 14 
-== NumPCs == +__**numPasses **__ \\  
-How many principal components should the test be run on \\ +How many iterations of the test should be run 
-<sub>//Default:// 2</sub> +  * **Data Type:** Integer 
-== PCsVariance == +  * **Default Value:** 1 
-Determine the number of PCs by variance explained (replaces NumPCs if used) \\ +__**numPCs **__ \\  
-<sub>//Default:// 95.0</sub> +How many principal components should the test be run on 
-== ScaleToVariability == +  * **Data Type:** Integer 
-If passed scale all calculated values to the variability explained by the PC +  * **Default Value:** 2 
-=== Example === +__**PCsVariance **__ \\  
-<code>-RunLOF autoExclude manualThreshold "3" numNeighbors "20" numPasses "2" numPCs "2" scaleToVariability</code>+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 ==== ==== -RunKMeans / -kmeans ====
 ---- ----
-Run K-Means clustering+Run K-Means clustering on currently actve PCA
 === Parameters === === Parameters ===
-== Clusters == +__**clusters **__ \\  
-How many clusters to sort the data into \\ +How many clusters generated 
-<sub>//Default:// 2</sub> +  * **Data Type:** Integer 
-== CustomSeed == +  * **Default Value:** 2 
-If provided use as a seed for the random first centroid (produces repeatable results) +__**customSeed **__ \\  
-== Grouping == +Provide a seed for the random first centroid (produces repeatable results) 
-How should data be grouped before running: +  * **Data Type:** Integer 
-  * Combined Groups: All data points will be compared  +  * **Default Value:** 0 
-  * Groups: Data will be compared within groups +__**grouping **__ \\  
-  * Workspaces: Data will be compared within workspaces +How should data be grouped before being clustered 
-<sub>//Default:// Combined Groups</sub> +  * **Data Type:** String 
-==  Iterations == +  * **Default Value:** combined group 
-How many iterations of the test should be run \\ +  * **Options:** combined group, group, workspace 
-<sub>//Default:// 5</sub> +__**iterations **__ \\  
-== NumPCs == +How many iterations of the test should be run 
-The number of principal components to run the test on \\ +  * **Data Type:** Integer 
-<sub>//Default://2</sub> +  * **Default Value:** 1 
-== PCsVariance == +__**numPCs **__ \\  
-Determine the number of principal components by variance explained (replaces NumPCs if used) \\ +The number of principal components to run the test on 
-<sub>//Default:// 95.0</sub> +  * **Data Type:** Integer 
-== ScaleToVariability == +  * **Default Value:** 2 
-If passed scale all calculated values to the variability explained by the PC +__**PCsVariance **__ \\  
-=== Example === +Determine the number of PCs by variance explained 
-<code>-RunKMeans clusters "3" customSeed "0" grouping "combined groups" iterations "1" numPCs "2" scaleToVariability</code>+  * **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 ==== ==== -RunSPE / -spe ====
 ---- ----
-Run squared prediction error +Run Squared Prediction Error on the currently active PCA 
-===Parameters=== +=== Parameters === 
-== AlphaValue == +__**alphaValue **__ \\  
-The alpha threshold used to determine outliers: 0.1, 0.05, 0.025, 0.01, 0.005 \\ +The alpha threshold used to determine outliers 
-<sub>//Default:// 0.05</sub> +  * **Data Type:** Decimal 
-== AutoExclude == +  * **Default Value:** 0.1 
-If passed any outliers will be excluded automatically +  * **Options:** 0.1, 0.05, 0.025, 0.01, 0.005 
-== numPCs ==  +__**autoExclude **__ \\  
-The number of Principal Components to run the test on // +If passed any outliers found will be exclude automatically 
-<sub>//Default:// 2</sub> +  * **Data Type:** Boolean (True / False) 
-== PCsVariance == +  * **Default Value:** false 
-scale calculated values to variability explained // +__**numPCs **__ \\  
-<sub>//Default:// 95.0</sub> +The number of principal components to run the test on 
-=== Example === +  * **Data Type:** Integer 
-<code>-RunSPE alphaValue "0.005" autoExclude numPCs "2"</code>+  * **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 ==== ==== -RunMah / -mah ====
 ---- ----
-Run a Mahalanobis distance test+Run Mahalanobis Distance test on the currently active PCA
 === Parameters === === Parameters ===
-== AlphaValue == +__**alphaValue **__ \\  
-The threshold used to determine outliers: 0.1, 0.05, 0.025, 0.01, 0.005 \\ +The alpha threshold used to determine outliers 
-<sub>//Default:// 0.05</sub> +  * **Data Type:** Decimal 
-== AutoExclude ==+  * **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 If passed any outliers found will be excluded automatically
-== Grouping == +  * **Data Type:** Boolean (True / False) 
-How should data be grouped before running: +  * **Default Value:** false 
-  * Combined Groups: All data points will be compared +__**grouping **__ \\  
-  * Groups: Data will be compared within groups +How should data be grouped before running 
-  * Workspace: Data will be compared within workspaces +  * **Data Type:** String 
-<sub>//Default:// Combined Groups</sub> +  * **Default Value:** combined group 
-== NumPasses == +  * **Options:** combined group, group, workspace 
-How many iterations of the test should be run \\ +__**numPasses **__ \\  
-<sub>//Default:// 1</sub> +How many iterations of the test should be run 
-== NumPCs == +  * **Data Type:** Integer 
-The number of principal components to run the test on \\ +  * **Default Value:** 1 
-<sub>//Default:// 2</sub> +__**numPCs **__ \\  
-== PCsVariance == +The number of principal components to run the test on 
-Determining the number of PCs by variance explained \\ +  * **Data Type:** Integer 
-<sub>//Default:// 95.0</sub> +  * **Default Value:** 2 
-== ScaleToVariance == +__**PCsVariance **__ \\  
-If passed scale calculated values to variability explained +Determing the number of PCs by variance explained instead of number 
-=== Example === +  * **Data Type:** Decimal 
-<code>-LoadMah alphaValue "0.1" autoExclude grouping "groups" numPasses "3" numPCs "2" scaleToVariance</code>+  * **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>
  
- +----
- +
-===== Visual3D Engine ===== +
----- +
 ==== -RunV3D / -s / -plpath ==== ==== -RunV3D / -s / -plpath ====
 ---- ----
-Execute one or more Visual3D pipeline scripts via the V3D Engine, currently this only works if a library has be loaded and a query run+Run pipelines via the Visual3D engine
 === Parameters === === Parameters ===
-== Script (Required) == +__**exportLog **__ \\  
-A path to a .v3s script file, this parameter can be used more than once to load multiple scripts, the scripts will be executed in the order the are passed +If passed a processing log will be exported to the file path provided 
-=== Example === +  * **Data Type:** String (File Path) 
-<code>-RunV3d script "C:\library folder\Script One.v3s" script "C:\library folder\Script Two.v3s"</code>+  * **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 ==== ==== -RunV3DCommand / -c ====
 ---- ----
-Run a single V3D pipeline command (Can be use multiple times to execute multiple commands)+Run a single V3D pipeline command (Can be used multiple times to execute multiple commands
 === Parameters === === Parameters ===
-== command (Required/Default) == +__**command (DEFAULT) (REQUIRED) **__ \\  
-The pipeline command to be executed +The pipeline command executed 
-=== Example === +  * **Data Type:** String 
-<code>-RunV3DCommand command "Set_Default_Folders C:\Folder Path\;"</code>+  * **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 +==== -DirPath ==== 
-Set a global parameter within the Visual3D Engine to be used later+---- 
 +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 === === Parameters ===
-== path (Required/Default) == +__**folderPath (DEFAULT) (REQUIRED) **__ \\  
-The path you want to set the global variable to +The path to the engine plugins folder 
-=== Example === +  * **Data Type:** String (Directory) 
-<code>-DirPath path "C:\Program Files\Directory Path\"</code>+  * **Default Value:** N/A 
 +<code> -SetEnginePluginsFolder folderPath "C:\Engine Resources"</code>
  
-===== SPM ===== 
 ---- ----
 ==== -RegisterCurves / -rc ==== ==== -RegisterCurves / -rc ====
 ---- ----
 +Register time series data to allign certain landmarks / events
 === Parameters === === Parameters ===
-== EventSequence == +__**eventSequence **__ \\  
-Register via events +Register by events 
-== LocalMax == +  * **Data Type:** Boolean (True / False) 
-Use local maximum as a registration point +  * **Default Value:** false 
-== LocalMaxLower ==+__**localMax **__ \\  
 +Register by local maximum 
 +  * **Data Type:** Boolean (True / False) 
 +  * **Default Value:** false 
 +__**localMaxLower **__ \\ 
 The lower bounds of the local max The lower bounds of the local max
-== LocalMaxUpper ==+  * **Data Type:** Integer 
 +  * **Default Value:** -1 
 +__**localMaxUpper **__ \\ 
 The upper bounds of the local max The upper bounds of the local max
-== LocalMin == +  * **Data Type:** Integer 
-Use the local minimum as a registration point +  * **Default Value:** -1 
-== LocalMinLower == +__**localMin **__ \\  
-The lower bounds of the local min +Register by local minimum 
-== LocalMinUpper == +  * **Data Type:** Boolean (True / False) 
-The upper bounds of the local min +  * **Default Value:** false 
-== Max ==+__**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 Register by maximum
-== Min ==+  * **Data Type:** Boolean (True / False) 
 +  * **Default Value:** false 
 +__**min **__ \\ 
 Register by minimum Register by minimum
-== Name == +  * **Data Type:** Boolean (True / False) 
-The name for registered curve group created +  * **Default Value:** false 
-=== Example === +__**name (DEFAULT) (REQUIRED) **__ \\  
-<code>-RegisterCurves max name "AnkleAngleX_Reg"</code>+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 ==== ==== -CreateGLM / -glm ====
 ---- ----
-Create a General Linear Model+Create a General Linear Model using the selected groups / workspaces
 === Parameters === === Parameters ===
-== Grouping == +__**grouping **__ \\  
-The grouping used for the model: Workspace / Group \\ +The grouping used for the model 
-<sub>//Default:// Group</sub> +  * **Data Type:** String 
-== Name (Required/Default) == +  * **Default Value:** group 
-The name of the GLM being created +  * **Options:** workspace, group 
-=== Example === +__**name (DEFAULT) (REQUIRED) **__ \\  
-<code>-CreateGLM name "New GLM" grouping "group"</code>+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>
  
 ---- ----
-==== -RunSPM / -spm ====+==== -RunSPM1ttest ====
 ---- ----
-Run Statistical Parametric Mapping +Run Statistical Parameteric Mapping One-Sample T-Test
 === Parameters === === Parameters ===
-== GLM (Required) == +__**alpha (REQUIRED) **__ \\  
-The name of the GLM used when creating the SPM +The alpha value to threshold with 
-== Group1 (Required) == +  * **Data Type:** Decimal 
-The first grouping to compare +  * **Default Value:** N/A 
-== Group2 (Required) == +__**glm (REQUIRED) **__ \\  
-The second grouping to compare +The name of the GLM to use when creating the SPM 
-== Name (Required) ==+  * **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 The name of the SPM being created
-=== Example === +  * **Data Type:** String 
-<code>-RunSPM name "New SPM" glm "New GLM" group1 "AnkleAngleX1_Reg" group2 "AnkleAngleX2_Reg"</code>+  * **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>
  
 ---- ----
Line 334: Line 498:
 Run Dynamic Time Warping Run Dynamic Time Warping
 === Parameters === === Parameters ===
-== Name (Required) ==+__**name (REQUIRED) **__ \\ 
 The name of the DTW test being run The name of the DTW test being run
-== StandardDeviations == +  * **Data Type:** String 
-How many standard deviations to test for: 1-3 \\ +  * **Default Value:** N/A 
-<sub>//Default:// 1</sub> +__**standardDeviations **__ \\  
-=== Example === +How many standard deviation to test for: 1-3 
-<code>--RunDTW name "New DTW" standardDeviations "2"</code>+  * **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>
  
-===== Exports ====== 
 ---- ----
 ==== -ExportPlotSignalTime / -ExportPlotST / -EPST ==== ==== -ExportPlotSignalTime / -ExportPlotST / -EPST ====
 ---- ----
-Export the selected traces on a signal time plot+Export a signal time plot using the currently selected groups / workspaces
 === Parameters === === Parameters ===
-== FilePath (Required/Default) == +__**dataStyle **__ \\  
-The file path the plot will be saved to, pass the desired image extension. Accepted image formats are .png, .pdf, .bmp, and .jpg +The data style to use when generating plot. 
-== Height == +  * **Data Type:** String 
-The height in pixels of the generated plot \\ +  * **Default Value:** Workspace 
-<sub>//Default:// 1000</sub> +  * **Options:** Workspace, Group, Sub Group, Cluster 
-== Width == +__**filePath (DEFAULT) (REQUIRED) **__ \\  
-The width in pixels of the generated plot \\ +The file path the plot will be saved to. 
-<sub>//Default:// 1000</sub> +  * **Data Type:** String (File Path) 
-== Title == +  * **Default Value:** N/A 
-The title displayed at the top of the plot +__**groupDispersion **__ \\  
-== XLabel == +If passed group dispersion will be plotted 
-The label displayed along the X Axis of the plot +  * **Data Type:** Boolean (True / False) 
-== YLabel == +  * **Default Value:** false 
-The label displayed along the Y Axis of the plot +__**groupDispersionType **__ \\  
-== Legend == +The type of dispersion to be displayed for groups 
-Where the legend will be displayed, options are: Top Right, Top Left, Bottom Right, Bottom Left. If this is not passed no legend will be displayed. +  * **Data Type:** String 
-== DataStyle == +  * **Default Value:** One Standard Deviation 
-Which data style type to use when generating the plot, options are: Workspace, Group, Sub Group, Cluster \\ +  * **Options:** One Standard Deviation, Two Standard Deviations, Interquartile Range 
-<sub>//Default:// Workspace</sub> +__**groupMean **__ \\ 
-== GroupDispersion == +
-If passed the group dispersion will be plotted +
-== GroupDispersionType == +
-The method of dispersion to plot, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range \\ +
-<sub>//Default:// One Standard Deviation</sub> +
-== GroupMean ==+
 If passed group mean will be plotted If passed group mean will be plotted
-== WorkspaceDispersion == +  * **Data Type:** Boolean (True / False) 
-If passed the workspace dispersion will be plotted +  * **Default Value:** false 
-== WorkspaceDispersionType == +__**height **__ \\  
-The method of dispersion to plot, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range \\ +The height of the image exported. 
-<sub>//Default:// One Standard Deviation</sub> +  * **Data Type:** Integer 
-== WorkspaceMean ==+  * **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 If passed workspace mean will be plotted
-== XRange == +  * **Data Type:** Boolean (True / False) 
-The range of values displayed on the X Axis of the plot, format: "min,max" +  * **Default Value:** false 
-== YRange == +__**xLabel **__ \\  
-The range of values displayed on the Y Axis of the plot, format: "min,max" +Label for the X-Axis. 
-== RawTraces == +  * **Data Type:** String 
-If passed individual traces will be plotted, if no other items are plotted, raw traces will be plotted by default +  * **Default Value:** ### 
-=== Example === +__**XRange **__ \\  
-<code>-ExportPlotSignalTime filePath "C:\Export Folder\signal_time_plot.png" rawTraces workspaceMean workspaceDispersion workspaceDispersionType "Interquartile Range" legend "Bottom Left"</code>+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 ==== ==== -ExportPlotMetric / -ExportPlotM / -EPM ====
 ---- ----
-Export the select metrics on a metric plot+Export a metric plot using the currently selected groups / workspaces
 === Parameters === === Parameters ===
-== FilePath (Required/Default) == +__**dataStyle **__ \\  
-The file path the plot will be saved to, pass the desired image extension. Accepted image formats are .png, .pdf, .bmp, and .jpg +The data style to use when generating plot. 
-== Height == +  * **Data Type:** String 
-The height in pixels of the generated plot \\ +  * **Default Value:** Workspace 
-<sub>//Default:// 1000</sub> +  * **Options:** Workspace, Group, Sub Group, Cluster 
-== Width == +__**filePath (DEFAULT) (REQUIRED) **__ \\  
-The width in pixels of the generated plot \\ +The file path the plot will be saved to. 
-<sub>//Default:// 1000</sub> +  * **Data Type:** String (File Path) 
-== Title == +  * **Default Value:** N/A 
-The title displayed at the top of the plot +__**groupDispersion **__ \\  
-== XLabel == +If passed group dispersion will be plotted 
-The label displayed along the X Axis of the plot +  * **Data Type:** Boolean (True / False) 
-== YLabel == +  * **Default Value:** false 
-The label displayed along the Y Axis of the plot +__**groupDispersionType **__ \\  
-== Legend == +The type of dispersion to be displayed for groups 
-Where the legend will be displayed, options are: Top Right, Top Left, Bottom Right, Bottom Left. If this is not passed no legend will be displayed. +  * **Data Type:** String 
-=== Example === +  * **Default Value:** One Standard Deviation 
-<code>-ExportPlotMetric filePath "C:\Export Folder\metric_plot.png" rawTraces workspaceMean workspaceDispersion workspaceDispersionType "Interquartile Range" legend "Bottom Left"</code>+  * **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>
  
 ---- ----
-==== -ExportPlotSPM /  -EPSPM ====+==== -ExportPlotPairSignal / -ExportPlotPS / -EPPS ====
 ---- ----
-Export the active SPM+Export a Signal Signal plot using the currently selected groups / workspaces
 === Parameters === === Parameters ===
-== FilePath (Required/Default) == +__**dataStyle **__ \\  
-The file path the plot will be saved to, pass the desired image extension. Accepted image formats are .png, .pdf, .bmp, and .jpg +The data style to use when generating plot. 
-== Height == +  * **Data Type:** String 
-The height in pixels of the generated plot \\ +  * **Default Value:** Workspace 
-<sub>//Default:// 1000</sub> +  * **Options:** Workspace, Group, Sub Group, Cluster 
-== Width == +__**filePath (DEFAULT) (REQUIRED) **__ \\  
-The width in pixels of the generated plot \\ +The file path the plot will be saved to. 
-<sub>//Default:// 1000</sub> +  * **Data Type:** String (File Path) 
-== Title == +  * **Default Value:** N/A 
-The title displayed at the top of the plot +__**groupDispersion **__ \\  
-== XLabel == +If passed group dispersion will be plotted 
-The label displayed along the X Axis of the plot +  * **Data Type:** Boolean (True / False) 
-== YLabel == +  * **Default Value:** false 
-The label displayed along the Y Axis of the plot +__**groupDispersionType **__ \\  
-== Legend == +The type of dispersion to be displayed for groups 
-Where the legend will be displayed, options are: Top Right, Top Left, Bottom Right, Bottom Left. If this is not passed no legend will be displayed. +  * **Data Type:** String 
-== DataStyle == +  * **Default Value:** One Standard Deviation 
-What data style used when plotting, options are: Workspace, Group, Sub Group, Cluster \\ +  * **Options:** One Standard Deviation, Two Standard Deviations, Interquartile Range 
-=== Example === +__**groupMean **__ \\  
-<code>-ExportPlotSPM filePath "C:\Export Folder\spm_plot.png" legend "Bottom Left"</code>+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>
  
 ---- ----
-==== -ExportData / -ex ====+==== -ExportPlotPairMetric / -ExportPlotPM / -EPPM ====
 ---- ----
-Export queried data results in an ascii text file  +Export a Metric Metric plot using the currently selected groups / workspaces 
-=== Parameter === +=== Parameters === 
-== File (Required) == +__**dataStyle **__ \\  
-The path and name of the .txt file to export  +The data style to use when generating plot. 
-== Precision ==  +  * **Data Type:** String 
-How many decimal places to display in exported values \\ +  * **Default Value:** Workspace 
-<sub>//Default:// 4</sub> +  * **Options:** Workspace, Group, Sub Group, Cluster 
-== ExportFormat == +__**filePath (DEFAULT) (REQUIRED) **__ \\  
-The format of the exported ASCII file: Standard, SPSS, Transposed, P2D \\ +The file path the plot will be saved to. 
-<sub>//Default:// Standard</sub> +  * **Data Type:** String (File Path) 
-== NormalizedTo == +  * **Default Value:** N/A 
-Number of points to normalize the export data to \\ +__**groupDispersion **__ \\  
-<sub>//Default:// 101</sub> +If passed group dispersion will be plotted 
-== GroupMean == +  * **Data Type:** Boolean (True / False) 
-If passed the group mean will be exported +  * **Default Value:** false 
-== GroupStdDev == +__**groupDispersionType **__ \\  
-If passed the workspace standard deviation will be exported +The type of dispersion to be displayed for groups 
-== AllSequencesNorm == +  * **Data Type:** String 
-If passed all normalized sequences will be exported +  * **Default Value:** One Standard Deviation 
-== AllSequencesTime == +  * **Options:** One Standard Deviation, Two Standard Deviations, Interquartile Range 
-If passed all time based sequences will be exported +__**groupMean **__ \\  
-=== Example === +If passed group mean will be plotted 
-<code>-ExportData file "C:\library folder\exports\Data Export.txt"  precision "2" exportFormat "standard" normalizedTo "100" groupMean groupStdDev workspaceMean workspaceStdDev allSequenceNorm allSequencesTime</code>+  * **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>
  
 ---- ----
-==== -ExportPCA ====+==== -ExportPlotSPM / -EPSPM ====
 ---- ----
-Export PCA results to a .txt file +Export the current SPM plot 
-=== Parameter === +=== Parameters === 
-== File (Required) == +__**dataStyle **__ \\  
-The path and name of the .txt file to export  +The data style to use when generating plot. 
-== Precision ==  +  * **Data Type:** String 
-How many decimal places to display in exported values \\ +  * **Default Value:** Workspace 
-<sub>//Default:// 4</sub> +  * **Options:** Workspace, Group, Sub Group, Cluster 
-== ExportFormat == +__**filePath (DEFAULT) (REQUIRED) **__ \\  
-The format of the exported ASCII file: Standard, SPSS, Transposed, P2D \\ +The file path the plot will be saved to. 
-<sub>//Default:// Standard</sub> +  * **Data Type:** String (File Path) 
-== ExportFormat == +  * **Default Value:** N/A 
-The format of the exported ASCII file: Standard, Transposed, SPSS, P2D +__**height **__ \\  
-== WorkspaceScores == +The height of the image exported. 
-If passed the workspace scores will be exported +  * **Data Type:** Integer 
-== GroupScores == +  * **Default Value:** 1000 
-If passed the group scores will be exported +__**legend **__ \\  
-== GroupStdDev == +Which corner should the legend be displayed in, if not passed no legend will be displayed 
-If passed the group standard deviation will be exported +  * **Data Type:** String 
-== VarianceExplained == +  * **Default Value:** NULL 
-If passed the variance explained by each PC will be exported +  * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right 
-== EigenVectors == +__**title **__ \\  
-If passed all eigen vectors will be exported +The title of the plot. 
-== MeanSD == +  * **Data Type:** String 
-If passed the mean +/- one standard deviation will be exported +  * **Default Value:** ### 
-== Mean595 == +__**width **__ \\  
-If passed the mean +/- 5 and 95% will be exported +The width of the image exported. 
-=== Example === +  * **Data Type:** Integer 
-<code>-ExportPCA fileName "C:\library folder\exports\PCA Export.txt" precision "4" exportFormat "transposed" workspaceScores groupScores groupStdDev varianceExplained eigenVectors meanSD mean595</code>+  * **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>
  
 ---- ----
-==== -ExportSummaryStatistics ====+==== -ExportPlotResiduals / -ExportPlotR / -EPR ====
 ---- ----
-Export summary statistics to a .txt file+Export the current GLMs residuals plot
 === Parameters === === Parameters ===
-== File (Required) == +__**dataStyle **__ \\  
-The path and name of the .txt file to export  +The data style to use when generating plot. 
-== Precision ==  +  * **Data Type:** String 
-How many decimal places to display in exported values \\ +  * **Default Value:** Workspace 
-<sub>//Default:// 4</sub> +  * **Options:** Workspace, Group, Sub Group, Cluster 
-== ExportFormat == +__**filePath (DEFAULT) (REQUIRED) **__ \\  
-The format of the exported ASCII file: Standard, SPSS, Transposed, P2D \\ +The file path the plot will be saved to. 
-<sub>//Default:// Standard</sub> +  * **Data Type:** String (File Path) 
-== ExportFormat == +  * **Default Value:** N/A 
-The format of the exported ASCII file: Standard, Transposed, SPSS, P2D +__**height **__ \\  
-== Max == +The height of the image exported. 
-If passed the maximum value will be exported +  * **Data Type:** Integer 
-== MaxEventPoint == +  * **Default Value:** 1000 
-If passed the maximum event point will be exported +__**legend **__ \\  
-== MaxStdDev == +Which corner should the legend be displayed in, if not passed no legend will be displayed 
-If passed the maximum standard deviation will be exported +  * **Data Type:** String 
-== Mean == +  * **Default Value:** NULL 
-If passed the mean value will be exported +  * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right 
-== MeanStdDev == +__**title **__ \\  
-If passed the mean standard deviation will be exported +The title of the plot. 
-== Min == +  * **Data Type:** String 
-If passed the the minimum value will be exported  +  * **Default Value:** ### 
-== MinEventPoint == +__**width **__ \\  
-If passed the minimum event point will be exported +The width of the image exported. 
-== MinStdDev == +  * **Data Type:** Integer 
-If passed the minimum standard deviation will be exported  +  * **Default Value:** 1000 
-== NormalizeMetrics == +__**xLabel **__ \\  
-Normalize exported metrics +Label for the X-Axis. 
-== Results == +  * **Data Type:** String 
-Export results for: Groups, Workspaces, Instances +  * **Default Value:** ### 
-=== Example === +__**XRange **__ \\  
-<code>-ExportSummaryStatistics file "C:\library folder\exports\Summary Statistics Export.txt" precision "2" exportFormat "SPSS" max maxEventPoint maxStdDev mean meanStdDev min minEventPoint minStdDev normalizeMetrics results "groups"</code>+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>
  
 ---- ----
-==== -ExportRegisteredCurves ====+==== -ExportPlotB / -EPB ====
 ---- ----
-Export any results of curve registration+
 === Parameters === === Parameters ===
-== File (Required) == +__**dataStyle **__ \\  
-The path and name of the .txt file to export  +The data style to use when generating plot. 
-== Precision ==  +  * **Data Type:** String 
-How many decimal places to display in exported values \\ +  * **Default Value:** Workspace 
-<sub>//Default:// 4</sub> +  * **Options:** Workspace, Group, Sub Group, Cluster 
-== ExportFormat == +__**filePath (DEFAULT) (REQUIRED) **__ \\  
-The format of the exported ASCII file: Standard, SPSS, Transposed, P2D \\ +The file path the plot will be saved to. 
-<sub>//Default:// Standard</sub> +  * **Data Type:** String (File Path) 
-== ExportFormat == +  * **Default Value:** N/A 
-The format of the exported ASCII file: Standard, Transposed, SPSS, P2D +__**height **__ \\  
-== LandmarkAll == +The height of the image exported. 
-If passed all landmarks will be exported +  * **Data Type:** Integer 
-== LandmarkMeans == +  * **Default Value:** 1000 
-If passed the mean of all landmarks will be exported +__**legend **__ \\  
-== RegisteredCurves == +Which corner should the legend be displayed in, if not passed no legend will be displayed 
-If passed registered curves will be exported +  * **Data Type:** String 
-== WarpingFunctions == +  * **Default Value:** NULL 
-If passed warping functions will be exported +  * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right 
-=== Example === +__**title **__ \\  
-<code>-ExportRegisteredCurves file "C:\library folder\exports\Registered Curves Export.txt" precision "3" exportFormat "transposed" landmarkAll landmarkMeans registeredCurves warpingFunctions</code>+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>
  
 ---- ----
-==== -ExportDTW ====+==== -ExportPlotVarianceExplained / -ExportPlotVE / -EPVE ====
 ---- ----
-Export Dynamic Time Warping results+Export the current PCAs variance explained plot
 === Parameters === === Parameters ===
-== File (Required) == +__**dataStyle **__ \\  
-The path and name of the .txt file to export  +The data style to use when generating plot. 
-== Precision ==  +  * **Data Type:** String 
-How many decimal places to display in exported values \\ +  * **Default Value:** Workspace 
-<sub>//Default:// 4</sub> +  * **Options:** Workspace, Group, Sub Group, Cluster 
-== ExportFormat == +__**filePath (DEFAULT) (REQUIRED) **__ \\  
-The format of the exported ASCII file: Standard, SPSS, Transposed, P2D \\ +The file path the plot will be saved to. 
-<sub>//Default:// Standard</sub> +  * **Data Type:** String (File Path) 
-== ExportFormat == +  * **Default Value:** N/A 
-The format of the exported ASCII file: Standard, Transposed, SPSS, P2D +__**height **__ \\  
-== CostFunctions == +The height of the image exported. 
-If passed cost functions will be exported +  * **Data Type:** Integer 
-== FoundAnomalies == +  * **Default Value:** 1000 
-If passed all anomalies will be exported +__**legend **__ \\  
-=== Example === +Which corner should the legend be displayed in, if not passed no legend will be displayed 
-<code>-ExportDTW file "C:\library folder\exports\Dynamic Time Warping Export.txt" precision "3" exportFormat "transposed"  foundAnomalies costFunctions</code>+  * **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>
  
 ---- ----
-==== -ExportSPM ====+==== -ExportPlotLoadingVector / -ExportPlotLV / -EPLV ====
 ---- ----
-Export Statistical Parametric Mapping Results+Export the current PCAs loading vectors plot
 === Parameters === === Parameters ===
-== File (Required) == +__**dataStyle **__ \\  
-The path and name of the .txt file to export  +The data style to use when generating plot. 
-== Precision ==  +  * **Data Type:** String 
-How many decimal places to display in exported values \\ +  * **Default Value:** Workspace 
-<sub>//Default:// 4</sub> +  * **Options:** Workspace, Group, Sub Group, Cluster 
-== ExportFormat == +__**filePath (DEFAULT) (REQUIRED) **__ \\  
-The format of the exported ASCII file: Standard, SPSS, Transposed, P2D \\ +The file path the plot will be saved to. 
-<sub>//Default:// Standard</sub> +  * **Data Type:** String (File Path) 
-== ExportFormat == +  * **Default Value:** N/A 
-The format of the exported ASCII file: Standard, Transposed, SPSS, P2D +__**flipPC **__ \\  
-== BMatrix == +If passed, invert PC 
-If passed the B Matrix used will be exported +  * **Data Type:** Boolean (True / False) 
-== ResidualMatrix == +  * **Default Value:** false 
-If passed the Residual Matrix will be exported +__**height **__ \\  
-== SPM == +The height of the image exported. 
-If passed the Statistical Parametric Map will be exported +  * **Data Type:** Integer 
-=== Example === +  * **Default Value:** 1000 
-<code>-ExportSPM file "C:\library folder\exports\Statistical Parametric Map Export.txt" precision "5" exportFormat "transposed" bMatrix residualMatrix spm</code>+__**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>
sift/command_line.1757601496.txt.gz · Last modified: 2025/09/11 14:38 by sgranger