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 18:07] – sgrangersift:command_line [2025/09/23 18:33] (current) – [-RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics] wikisysop
Line 42: Line 42:
 ==== -LoadLib / -l ==== ==== -LoadLib / -l ====
 ---- ----
-Search the provided directory and all sub directories for .cmz files and load them+Search the provided directory and all sub directories for .cmz files and load them into the library
 === Parameters === === Parameters ===
 __**directory (DEFAULT) (REQUIRED) **__ \\  __**directory (DEFAULT) (REQUIRED) **__ \\ 
 A path to the root directory to be searched recursively for .cmzs A path to the root directory to be searched recursively for .cmzs
-  * **Data Type:** Directory+  * **Data Type:** String (Directory)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**libQuery **__ \\  __**libQuery **__ \\ 
-A query to refine the files loaded into the library.+The query used to refine the files loaded into the library
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** NULL   * **Default Value:** NULL
 __**libSubjTags **__ \\  __**libSubjTags **__ \\ 
-A list of subject tags.+A list of subject tags that must be included within the .cmzs
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** NULL   * **Default Value:** NULL
- +<code> -LoadLib "C:\Library Location\Data" libQuery "RUN AND NOT(OLD)" libSubjTags "RUN"</code>
  
 ---- ----
Line 66: Line 65:
 __**file (DEFAULT) (REQUIRED) **__ \\  __**file (DEFAULT) (REQUIRED) **__ \\ 
 Path to the .q3d containing query definitions Path to the .q3d containing query definitions
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **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 ==== ==== -RunPCA / -pca ====
 ---- ----
-Run Principal Compnent Analysis+Run Principal Compnent Analysis on selected groups / workspaces
 === Parameters === === Parameters ===
 __**name (DEFAULT) (REQUIRED) **__ \\  __**name (DEFAULT) (REQUIRED) **__ \\ 
-The name of the new PCA being computed+The name of the PCA
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** N/A   * **Default Value:** N/A
 __**numPCs **__ \\  __**numPCs **__ \\ 
-The number of dimensions to reduce to+The number of principal components calculated
   * **Data Type:** Integer   * **Data Type:** Integer
   * **Default Value:** 4   * **Default Value:** 4
 __**workspaceMean **__ \\  __**workspaceMean **__ \\ 
-If passed PCA will be run on the mean value of each workspace, and not individual traces +If passed run PCA on workspace mean instead of individual traces 
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** 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
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**grouping **__ \\  __**grouping **__ \\ 
-How should data be grouped before running: Combined Groups: All data points will be compared Groups: Data will be compared within groups Workspace: Data will be compared within workspaces+How should data be grouped before looking for outliers
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** combined group   * **Default Value:** combined group
Line 127: Line 156:
 __**scaleToVariability **__ \\  __**scaleToVariability **__ \\ 
 Scale all calculated values to the variavility explained by the PC Scale all calculated values to the variavility explained by the PC
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
- +<code> -RunLOF grouping "combined group" numPasses "2" numNeighbors "7" autoExclude</code>
  
 ---- ----
 ==== -RunKMeans / -kmeans ==== ==== -RunKMeans / -kmeans ====
 ---- ----
-Run K-Means cluster+Run K-Means clustering on currently actve PCA
 === Parameters === === Parameters ===
 __**clusters **__ \\  __**clusters **__ \\ 
-How many clusters to sort the data into+How many clusters generated
   * **Data Type:** Integer   * **Data Type:** Integer
   * **Default Value:** 2   * **Default Value:** 2
Line 146: Line 174:
   * **Default Value:** 0   * **Default Value:** 0
 __**grouping **__ \\  __**grouping **__ \\ 
-How should data be grouped before running: Combined Groups: All data points will be compared Groups: Data will be compared within groups Workspace: Data will be compared within workspaces+How should data be grouped before being clustered
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** combined group   * **Default Value:** combined group
Line 163: Line 191:
   * **Default Value:** 95   * **Default Value:** 95
 __**scaleToVariability **__ \\  __**scaleToVariability **__ \\ 
-Scale all calculated values to the variavility explained by the PC +Scale all calculated values to the variability explained by the PC 
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** 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
   * **Data Type:** Decimal   * **Data Type:** Decimal
   * **Default Value:** 0.1   * **Default Value:** 0.1
Line 181: Line 208:
 __**autoExclude **__ \\  __**autoExclude **__ \\ 
 If passed any outliers found will be exclude automatically If passed any outliers found will be exclude automatically
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**numPCs **__ \\  __**numPCs **__ \\ 
Line 191: Line 218:
   * **Data Type:** Decimal   * **Data Type:** Decimal
   * **Default Value:** 95   * **Default Value:** 95
- +<code> -RunSPE alphaValue "0.005" PCsVariance "80.0"</code>
  
 ---- ----
 ==== -RunMah / -mah ==== ==== -RunMah / -mah ====
 ---- ----
-Run Mahalanobis Distance test+Run Mahalanobis Distance test 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
   * **Data Type:** Decimal   * **Data Type:** Decimal
   * **Default Value:** 0.1   * **Default Value:** 0.1
Line 206: Line 232:
 __**autoExclude **__ \\  __**autoExclude **__ \\ 
 If passed any outliers found will be excluded automatically If passed any outliers found will be excluded automatically
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**grouping **__ \\  __**grouping **__ \\ 
-How should data be grouped before running: Combined Groups: All data points will be compared Groups: Data will be compared within groups Workspace: Data will be compared within workspaces+How should data be grouped before running
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** combined group   * **Default Value:** combined group
Line 227: Line 253:
 __**scaleToVariance **__ \\  __**scaleToVariance **__ \\ 
 scale calculated values to variability explained scale calculated values to variability explained
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
- +<code> -RunMah grouping "group" alphaValue "0.5" autoExclude</code>
  
 ---- ----
 ==== -RunV3D / -s / -plpath ==== ==== -RunV3D / -s / -plpath ====
 ---- ----
-Run pipelines via the V3D engine+Run pipelines via the Visual3D engine
 === Parameters === === Parameters ===
 __**exportLog **__ \\  __**exportLog **__ \\ 
-If passed the processing log will be exported to the file provided +If passed a processing log will be exported to the file path provided 
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** NULL   * **Default Value:** NULL
 __**onLib **__ \\  __**onLib **__ \\ 
-If passed the the loaded library will be updated using the provided script(s) +If passed the scripts will be run on the loaded library 
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**script (DEFAULT) (REQUIRED) **__ \\  __**script (DEFAULT) (REQUIRED) **__ \\ 
-A path to the script file to be run, multiple scripts can be passed by repeating the parameter+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   * **Data Type:** List
   * **Default Value:** N/A   * **Default Value:** N/A
- +<code> -RunV3D script "C:\Scripts\v3d_script.v3s" exportLog "C:\Scripts\v3d_script_export.txt"</code>
  
 ---- ----
Line 258: Line 282:
 === Parameters === === Parameters ===
 __**command (DEFAULT) (REQUIRED) **__ \\  __**command (DEFAULT) (REQUIRED) **__ \\ 
-The pipeline command to be executed+The pipeline command executed
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** N/A   * **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 variable to the passed path+Set a global variable within the V3D Engine to the passed path
 === Parameters === === Parameters ===
 __**path (DEFAULT) (REQUIRED) **__ \\  __**path (DEFAULT) (REQUIRED) **__ \\ 
 The path to set The path to set
-  * **Data Type:** Directory+  * **Data Type:** String (Directory)
   * **Default Value:** N/A   * **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 ==== ==== -RegisterCurves / -rc ====
 ---- ----
-Register curves+Register time series data to allign certain landmarks / events
 === Parameters === === Parameters ===
 __**eventSequence **__ \\  __**eventSequence **__ \\ 
 Register by events Register by events
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**localMax **__ \\  __**localMax **__ \\ 
-Use local maximum +Register by local maximum 
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**localMaxLower **__ \\  __**localMaxLower **__ \\ 
Line 298: Line 331:
   * **Default Value:** -1   * **Default Value:** -1
 __**localMin **__ \\  __**localMin **__ \\ 
-use local minimum +Register by local minimum 
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**localMinLower **__ \\  __**localMinLower **__ \\ 
Line 311: Line 344:
 __**max **__ \\  __**max **__ \\ 
 Register by maximum Register by maximum
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**min **__ \\  __**min **__ \\ 
 Register by minimum Register by minimum
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**name (DEFAULT) (REQUIRED) **__ \\  __**name (DEFAULT) (REQUIRED) **__ \\ 
-The name for the group after curve registration+The name for the new group created
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** N/A   * **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
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** group   * **Default Value:** group
   * **Options:** workspace, group   * **Options:** workspace, group
 __**name (DEFAULT) (REQUIRED) **__ \\  __**name (DEFAULT) (REQUIRED) **__ \\ 
-The name of the GLM being created+The name of the GLM
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** N/A   * **Default Value:** N/A
 __**test **__ \\  __**test **__ \\ 
-The intended test type for the model : One sample t-test, Two sample t-test, Paired t-test+The intended test type for the model
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** two_sample   * **Default Value:** two_sample
   * **Options:** one_sample, two_sample, paired, one_way_anova   * **Options:** one_sample, two_sample, paired, one_way_anova
 __**workspaceMeans **__ \\  __**workspaceMeans **__ \\ 
-If using workspace means, instead of the individual traces +If passed use workspace means, instead of the individual traces 
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
- +<code> -CreateGLM name "GLM_ONE" test "one_sample" grouping "group" workspaceMeans</code>
  
 ---- ----
Line 373: Line 404:
 __**twoTailed **__ \\  __**twoTailed **__ \\ 
 If two-tailed inference (as opposed to one-tailed) If two-tailed inference (as opposed to one-tailed)
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
- +<code> -RunSPM1TTest name "SPM_1_Test" glm "GLM_ONE" alpha "0.7" group "AnkleAngleX"</code>
  
 ---- ----
Line 405: Line 435:
 __**twoTailed **__ \\  __**twoTailed **__ \\ 
 If two-tailed inference (as opposed to one-tailed) If two-tailed inference (as opposed to one-tailed)
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
- +<code> -RunSPM2TTest name "spm_two_sample" glm "GLM_TWO" group1 "KneeAngleX" group2 "HipAngleX"</code>
  
 ---- ----
Line 437: Line 466:
 __**twoTailed **__ \\  __**twoTailed **__ \\ 
 If two-tailed inference (as opposed to one-tailed) If two-tailed inference (as opposed to one-tailed)
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
- +<code> -RunSPMPairedTTest name "spm_pair" glm "GLM_ONE" group1 "AnkleAngleX" group2 "KneeAngleX"</code>
  
 ---- ----
 ==== -RunSPMOneWayAnova ==== ==== -RunSPMOneWayAnova ====
 ---- ----
-Run Statistical Parameteric Mapping Paired T-Test+Run Statistical Parameteric Mapping one way Anova test
 === Parameters === === Parameters ===
 __**alpha (REQUIRED) **__ \\  __**alpha (REQUIRED) **__ \\ 
Line 461: Line 489:
 __**twoTailed **__ \\  __**twoTailed **__ \\ 
 If two-tailed inference (as opposed to one-tailed) If two-tailed inference (as opposed to one-tailed)
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
- +<code> -RunSPMOneWayAnova name "anova_spm" glm "GLM_2" twoTailed</code>
  
 ---- ----
Line 480: Line 507:
   * **Default Value:** 1   * **Default Value:** 1
   * **Options:** 1, 2, 3   * **Options:** 1, 2, 3
- +<code> -RunDTW name "SAMPLE_DTW" standardDeviations "3"</code>
  
 ---- ----
Line 490: Line 516:
 __**allSequencesNorm **__ \\  __**allSequencesNorm **__ \\ 
 CommandExport all sequences normalized CommandExport all sequences normalized
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**allSequencesTime **__ \\  __**allSequencesTime **__ \\ 
 CommandExport all time based sequences CommandExport all time based sequences
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**eventsNorm **__ \\  __**eventsNorm **__ \\ 
 CommandExport all events normalized CommandExport all events normalized
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**eventsOrig **__ \\  __**eventsOrig **__ \\ 
 CommandExport all time based events CommandExport all time based events
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**exportFormat **__ \\  __**exportFormat **__ \\ 
Line 511: Line 537:
 __**file (REQUIRED) **__ \\  __**file (REQUIRED) **__ \\ 
 Desired path for the text export to be saved Desired path for the text export to be saved
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**groupMean **__ \\  __**groupMean **__ \\ 
 CommandExport the mean value of each group CommandExport the mean value of each group
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**groupStdDev **__ \\  __**groupStdDev **__ \\ 
 CommandExport the standard deviation of each group CommandExport the standard deviation of each group
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**normalizedTo **__ \\  __**normalizedTo **__ \\ 
Line 531: Line 557:
 __**workspaceMean **__ \\  __**workspaceMean **__ \\ 
 CommandExport the mean of each workspace CommandExport the mean of each workspace
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**workspaceStdDev **__ \\  __**workspaceStdDev **__ \\ 
 CommandExport the standard deviation of each workspace CommandExport the standard deviation of each workspace
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
- +<code> -ExporData file "C:\Data\Export Folder\data_export.txt" precision "2" exportFormat "transposed" groupMean groupStdDev workspaceMean workspaceStdDev</code>
  
 ---- ----
Line 547: Line 572:
 __**addMetrics **__ \\  __**addMetrics **__ \\ 
 Export metrics Export metrics
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**exportFormat **__ \\  __**exportFormat **__ \\ 
Line 556: Line 581:
 __**file (REQUIRED) **__ \\  __**file (REQUIRED) **__ \\ 
 Desired path for the text export to be saved Desired path for the text export to be saved
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**max **__ \\  __**max **__ \\ 
 Export the maximum value Export the maximum value
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**maxEventPoint **__ \\  __**maxEventPoint **__ \\ 
 Export the maximum event point Export the maximum event point
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**maxStdDev **__ \\  __**maxStdDev **__ \\ 
 Export the maximum standard deviation Export the maximum standard deviation
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**mean **__ \\  __**mean **__ \\ 
 Export the mean value Export the mean value
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**meanStdDev **__ \\  __**meanStdDev **__ \\ 
 Export the mean standard deviation Export the mean standard deviation
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**min **__ \\  __**min **__ \\ 
 Export the minimum value Export the minimum value
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**minEventPoint **__ \\  __**minEventPoint **__ \\ 
 Export the minimum event point Export the minimum event point
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**minStdDev **__ \\  __**minStdDev **__ \\ 
 Export the minimum standard deviation Export the minimum standard deviation
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**normalizeMetrics **__ \\  __**normalizeMetrics **__ \\ 
 Normalize exported metrics Normalize exported metrics
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**precision **__ \\  __**precision **__ \\ 
Line 603: Line 628:
   * **Default Value:** groups   * **Default Value:** groups
   * **Options:** groups, workspaces, instances   * **Options:** groups, workspaces, instances
- +<code> -ExportSummaryStatistics file "C:\Exports\summary_stats.txt" results "workspaces" mean min max</code>
  
 ---- ----
Line 618: Line 642:
 __**file (REQUIRED) **__ \\  __**file (REQUIRED) **__ \\ 
 Desired path for the text export to be saved Desired path for the text export to be saved
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**landmarkAll **__ \\  __**landmarkAll **__ \\ 
 Export all landmarks Export all landmarks
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**landmarkMeans **__ \\  __**landmarkMeans **__ \\ 
 Export the landmark mean value Export the landmark mean value
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**precision **__ \\  __**precision **__ \\ 
Line 634: Line 658:
 __**registeredCurves **__ \\  __**registeredCurves **__ \\ 
 Export registered curves Export registered curves
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**warpingFunctions **__ \\  __**warpingFunctions **__ \\ 
 Export all warping functions Export all warping functions
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
- +<code> -ExportRegisteredCurves file "C:\Export Folder\registered_curves.txt" registeredCurves warpingFunctions landmarkMeans</code>
  
 ---- ----
Line 650: Line 673:
 __**costFunctions **__ \\  __**costFunctions **__ \\ 
 Export cost functions Export cost functions
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**exportFormat **__ \\  __**exportFormat **__ \\ 
Line 659: Line 682:
 __**file (REQUIRED) **__ \\  __**file (REQUIRED) **__ \\ 
 Desired path for the text export to be saved Desired path for the text export to be saved
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**foundAnomalies **__ \\  __**foundAnomalies **__ \\ 
 Export all outliers found with dynamic time warping Export all outliers found with dynamic time warping
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**precision **__ \\  __**precision **__ \\ 
Line 669: Line 692:
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** 4   * **Default Value:** 4
- +<code> -ExportDTW file "C:\DTW DATA\export.txt" costFunctions foundAnomalies</code>
  
 ---- ----
Line 679: Line 701:
 __**bMatrix **__ \\  __**bMatrix **__ \\ 
 Export the B Matrix used Export the B Matrix used
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**exportFormat **__ \\  __**exportFormat **__ \\ 
Line 688: Line 710:
 __**file (REQUIRED) **__ \\  __**file (REQUIRED) **__ \\ 
 Desired path for the text export to be saved Desired path for the text export to be saved
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**precision **__ \\  __**precision **__ \\ 
Line 696: Line 718:
 __**residualMatrix **__ \\  __**residualMatrix **__ \\ 
 Export the residual matrix Export the residual matrix
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**spm **__ \\  __**spm **__ \\ 
 Export the statistical parameteric map Export the statistical parameteric map
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
- +<code> -ExportSPM file "C:\Export Folder\SPM.txt" bMatrix residualMatrix spm</code>
  
 ---- ----
Line 712: Line 733:
 __**eigenVectors **__ \\  __**eigenVectors **__ \\ 
 Export the eigen vectors Export the eigen vectors
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**exportFormat **__ \\  __**exportFormat **__ \\ 
Line 721: Line 742:
 __**file (REQUIRED) **__ \\  __**file (REQUIRED) **__ \\ 
 Desired path for the text export to be saved Desired path for the text export to be saved
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**groupScores **__ \\  __**groupScores **__ \\ 
 Export group scores Export group scores
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**groupStdDev **__ \\  __**groupStdDev **__ \\ 
 Export group standard deviation Export group standard deviation
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**kMeans **__ \\  __**kMeans **__ \\ 
 Export K-Means results Export K-Means results
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**lof **__ \\  __**lof **__ \\ 
 Export local outlier factor results Export local outlier factor results
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**lofThreshold **__ \\  __**lofThreshold **__ \\ 
 Export threshould to determine an LOF outlier Export threshould to determine an LOF outlier
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**mahDis **__ \\  __**mahDis **__ \\ 
 Export the mahalanobis distance results Export the mahalanobis distance results
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**mahDisThreshold **__ \\  __**mahDisThreshold **__ \\ 
 Export the threshold used to determine a mahalanobis distance outlier Export the threshold used to determine a mahalanobis distance outlier
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**mean595 **__ \\  __**mean595 **__ \\ 
 Export the mean plus or minus 5 and 95% Export the mean plus or minus 5 and 95%
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**meanSD **__ \\  __**meanSD **__ \\ 
 Export the mean plus or minus one standard deviation Export the mean plus or minus one standard deviation
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**precision **__ \\  __**precision **__ \\ 
Line 765: Line 786:
 __**spe **__ \\  __**spe **__ \\ 
 Export squared prediction error results Export squared prediction error results
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**speThreshold **__ \\  __**speThreshold **__ \\ 
 Export the threshold to determine an SPE outlier Export the threshold to determine an SPE outlier
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**varianceExplained **__ \\  __**varianceExplained **__ \\ 
 Export the variance explained Export the variance explained
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**workspaceScores **__ \\  __**workspaceScores **__ \\ 
 Export workspace scores Export workspace scores
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
- +<code> -ExportPCA file "C:\Processing Folder\PCA\export.txt" groupScores workspaceScores lof spe</code>
  
 ---- ----
 ==== -ExportPlotSignalTime / -ExportPlotST / -EPST ==== ==== -ExportPlotSignalTime / -ExportPlotST / -EPST ====
 ---- ----
 +Export a signal time plot using the currently selected groups / workspaces
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 794: Line 814:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**groupDispersion **__ \\  __**groupDispersion **__ \\ 
 If passed group dispersion will be plotted If passed group dispersion will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**groupDispersionType **__ \\  __**groupDispersionType **__ \\ 
Line 807: Line 827:
 __**groupMean **__ \\  __**groupMean **__ \\ 
 If passed group mean will be plotted If passed group mean will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**height **__ \\  __**height **__ \\ 
Line 820: Line 840:
 __**rawTraces **__ \\  __**rawTraces **__ \\ 
 If passed indivdual traces will be plotted If passed indivdual traces will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**title **__ \\  __**title **__ \\ 
Line 832: Line 852:
 __**workspaceDispersion **__ \\  __**workspaceDispersion **__ \\ 
 If passed workspace dispersion will be plotted If passed workspace dispersion will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**workspaceDispersionType **__ \\  __**workspaceDispersionType **__ \\ 
Line 841: Line 861:
 __**workspaceMean **__ \\  __**workspaceMean **__ \\ 
 If passed workspace mean will be plotted If passed workspace mean will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**xLabel **__ \\  __**xLabel **__ \\ 
Line 848: Line 868:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 856: Line 876:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
- +<code> -ExportPlotSignalTime filePath "C:\Plots\signal_time.png" groupMean WorkspaceMean groupDispersion workspaceDispersion</code>
  
 ---- ----
 ==== -ExportPlotMetric / -ExportPlotM / -EPM ==== ==== -ExportPlotMetric / -ExportPlotM / -EPM ====
 ---- ----
 +Export a metric plot using the currently selected groups / workspaces
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 874: Line 893:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**groupDispersion **__ \\  __**groupDispersion **__ \\ 
 If passed group dispersion will be plotted If passed group dispersion will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**groupDispersionType **__ \\  __**groupDispersionType **__ \\ 
Line 887: Line 906:
 __**groupMean **__ \\  __**groupMean **__ \\ 
 If passed group mean will be plotted If passed group mean will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**height **__ \\  __**height **__ \\ 
Line 910: Line 929:
 __**rawTraces **__ \\  __**rawTraces **__ \\ 
 If passed indivdual traces will be plotted If passed indivdual traces will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**title **__ \\  __**title **__ \\ 
Line 922: Line 941:
 __**workspaceDispersion **__ \\  __**workspaceDispersion **__ \\ 
 If passed workspace dispersion will be plotted If passed workspace dispersion will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**workspaceDispersionType **__ \\  __**workspaceDispersionType **__ \\ 
Line 931: Line 950:
 __**workspaceMean **__ \\  __**workspaceMean **__ \\ 
 If passed workspace mean will be plotted If passed workspace mean will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**xLabel **__ \\  __**xLabel **__ \\ 
Line 938: Line 957:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 946: Line 965:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
- +<code> -ExportPlotMetric file "C:\Plot Exports\metric_plot.png" groupMean meanPlotStyle "Stacked Bar Chart"</code>
  
 ---- ----
 ==== -ExportPlotPairSignal / -ExportPlotPS / -EPPS ==== ==== -ExportPlotPairSignal / -ExportPlotPS / -EPPS ====
 ---- ----
 +Export a Signal Signal plot using the currently selected groups / workspaces
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 964: Line 982:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**groupDispersion **__ \\  __**groupDispersion **__ \\ 
 If passed group dispersion will be plotted If passed group dispersion will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**groupDispersionType **__ \\  __**groupDispersionType **__ \\ 
Line 977: Line 995:
 __**groupMean **__ \\  __**groupMean **__ \\ 
 If passed group mean will be plotted If passed group mean will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**height **__ \\  __**height **__ \\ 
Line 994: Line 1012:
 __**rawTraces **__ \\  __**rawTraces **__ \\ 
 If passed indivdual traces will be plotted If passed indivdual traces will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**title **__ \\  __**title **__ \\ 
Line 1006: Line 1024:
 __**workspaceDispersion **__ \\  __**workspaceDispersion **__ \\ 
 If passed workspace dispersion will be plotted If passed workspace dispersion will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**workspaceDispersionType **__ \\  __**workspaceDispersionType **__ \\ 
Line 1015: Line 1033:
 __**workspaceMean **__ \\  __**workspaceMean **__ \\ 
 If passed workspace mean will be plotted If passed workspace mean will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**xLabel **__ \\  __**xLabel **__ \\ 
Line 1022: Line 1040:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 1030: Line 1048:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
- +<code> -ExportPlotPairSignal filePath "C:\Plot Folder\signalSignal.pdf" workspaceMean workspaceDispersion</code>
  
 ---- ----
 ==== -ExportPlotPairMetric / -ExportPlotPM / -EPPM ==== ==== -ExportPlotPairMetric / -ExportPlotPM / -EPPM ====
 ---- ----
 +Export a Metric Metric plot using the currently selected groups / workspaces
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1048: Line 1065:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**groupDispersion **__ \\  __**groupDispersion **__ \\ 
 If passed group dispersion will be plotted If passed group dispersion will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**groupDispersionType **__ \\  __**groupDispersionType **__ \\ 
Line 1061: Line 1078:
 __**groupMean **__ \\  __**groupMean **__ \\ 
 If passed group mean will be plotted If passed group mean will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**height **__ \\  __**height **__ \\ 
Line 1086: Line 1103:
 __**rawTraces **__ \\  __**rawTraces **__ \\ 
 If passed indivdual traces will be plotted If passed indivdual traces will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**title **__ \\  __**title **__ \\ 
Line 1098: Line 1115:
 __**workspaceDispersion **__ \\  __**workspaceDispersion **__ \\ 
 If passed workspace dispersion will be plotted If passed workspace dispersion will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**workspaceDispersionType **__ \\  __**workspaceDispersionType **__ \\ 
Line 1107: Line 1124:
 __**workspaceMean **__ \\  __**workspaceMean **__ \\ 
 If passed workspace mean will be plotted If passed workspace mean will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**xLabel **__ \\  __**xLabel **__ \\ 
Line 1114: Line 1131:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 1122: Line 1139:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **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 ==== ==== -ExportPlotSPM / -EPSPM ====
 ---- ----
 +Export the current SPM plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1140: Line 1156:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**height **__ \\  __**height **__ \\ 
Line 1164: Line 1180:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 1172: Line 1188:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
- +<code> ExportPlotSPM filePath "C:\Plots\SPM\spm_plot"</code>
  
 ---- ----
 ==== -ExportPlotResiduals / -ExportPlotR / -EPR ==== ==== -ExportPlotResiduals / -ExportPlotR / -EPR ====
 ---- ----
 +Export the current GLMs residuals plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1190: Line 1205:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**height **__ \\  __**height **__ \\ 
Line 1214: Line 1229:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 1222: Line 1237:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
- +<code> -ExportPlotResiduals filePath "C:\Plots\SPM\glm_residuals.png"</code>
  
 ---- ----
Line 1240: Line 1254:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**height **__ \\  __**height **__ \\ 
Line 1264: Line 1278:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 1272: Line 1286:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
- +<code> -ExportPlotB filePath "C:\ProcessingPlots\bPlot.png dataStyle "Workspace" legend "Bottom Right"</code>
  
 ---- ----
 ==== -ExportPlotVarianceExplained / -ExportPlotVE / -EPVE ==== ==== -ExportPlotVarianceExplained / -ExportPlotVE / -EPVE ====
 ---- ----
 +Export the current PCAs variance explained plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1290: Line 1303:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**height **__ \\  __**height **__ \\ 
Line 1314: Line 1327:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 1322: Line 1335:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
- +<code> -ExportPlotVarianceExplained filePath "C:\Plots\PCA\variacen_explained.png"</code>
  
 ---- ----
 ==== -ExportPlotLoadingVector / -ExportPlotLV / -EPLV ==== ==== -ExportPlotLoadingVector / -ExportPlotLV / -EPLV ====
 ---- ----
 +Export the current PCAs loading vectors plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1340: Line 1352:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**flipPC **__ \\  __**flipPC **__ \\ 
 If passed, invert PC If passed, invert PC
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**height **__ \\  __**height **__ \\ 
Line 1372: Line 1384:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 1380: Line 1392:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
- +<code> -ExportPlotLoadingVector file "C:\Processing\PCA\loading_vector_plot.png" xRange "20,70"</code>
  
 ---- ----
 ==== -ExportPlotWorkspaceScores / -ExportPlotWS / -EPWS ==== ==== -ExportPlotWorkspaceScores / -ExportPlotWS / -EPWS ====
 ---- ----
 +Export the current PCAs workspace scores plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1398: Line 1409:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**height **__ \\  __**height **__ \\ 
Line 1411: Line 1422:
 __**normalizeScores **__ \\  __**normalizeScores **__ \\ 
 If passed workspace scores will be normalized If passed workspace scores will be normalized
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**title **__ \\  __**title **__ \\ 
Line 1430: Line 1441:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 1442: Line 1453:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
- +<code> -ExportPlotWorkspaceScores filePath "C:\Plots\PCA\workspace_scores.png" xAxisPC "2" yAxisPC "3"</code>
  
 ---- ----
 ==== -ExportPlotGroupScores / -ExportPlotGS / -EPGS ==== ==== -ExportPlotGroupScores / -ExportPlotGS / -EPGS ====
 ---- ----
 +Export the current PCAs groups scores plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1460: Line 1470:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**height **__ \\  __**height **__ \\ 
Line 1484: Line 1494:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 1492: Line 1502:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
- +<code> -ExportPlotGroupScores filePath "C:\Processing\PCA\group_scores_plot.png" title "Group Scores Ankle Angle X"</code>
  
 ---- ----
 ==== -ExportPlotReconstruction / -ExportPlotR / -EPR ==== ==== -ExportPlotReconstruction / -ExportPlotR / -EPR ====
 ---- ----
 +Export the current PCAs reconstruction plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1510: Line 1519:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**group **__ \\  __**group **__ \\ 
Line 1518: Line 1527:
 __**groupMean **__ \\  __**groupMean **__ \\ 
 If passed group mean will be plotted If passed group mean will be plotted
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**height **__ \\  __**height **__ \\ 
Line 1550: Line 1559:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 1558: Line 1567:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
- +<code> -ExportPlotReconstruction filePath "C:\Plots\PCA\reconstruction.jpg" group "Ankle Angle X" workspace "P001.cmz"</code>
  
 ---- ----
 ==== -ExportPlotExtreme / -ExportPlotE / -EPE ==== ==== -ExportPlotExtreme / -ExportPlotE / -EPE ====
 ---- ----
 +Export the current PCAs extreme plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1576: Line 1584:
 __**filePath (DEFAULT) (REQUIRED) **__ \\  __**filePath (DEFAULT) (REQUIRED) **__ \\ 
 The file path the plot will be saved to. The file path the plot will be saved to.
-  * **Data Type:** File+  * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
 __**height **__ \\  __**height **__ \\ 
Line 1609: Line 1617:
   * **Default Value:** ###   * **Default Value:** ###
 __**XRange **__ \\  __**XRange **__ \\ 
-The display range of the X Axis: "X,Y"+The display range of the X Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
Line 1617: Line 1625:
   * **Default Value:** ###   * **Default Value:** ###
 __**YRange **__ \\  __**YRange **__ \\ 
-The display range of the Y Axis: "X,Y"+The display range of the Y Axis: "Max,Min"
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** ###   * **Default Value:** ###
- +<code> -ExportPlotExtreme filePath "C:\Processing\PCA\extreme_plot.png" height "600" width "1200" pcNumber "2"</code>
  
 ---- ----
Line 1636: Line 1643:
   * **Data Type:** List   * **Data Type:** List
   * **Default Value:** NULL   * **Default Value:** NULL
- +<code> -SelectSignals group "KneeAngleX"</code>
  
 ---- ----
Line 1652: Line 1658:
   * **Data Type:** List   * **Data Type:** List
   * **Default Value:** NULL   * **Default Value:** NULL
- +<code> -SelectMetrics group "AnkleAngleX" group "AnkleAngleY" workspace "P002"</code>
- +
- +
----- +
-==== -SaveProject / -sv ==== +
----- +
-Save the current project +
-=== Parameters === +
-__**file (DEFAULT) (REQUIRED) **__ \\  +
-The path and name of the file +
-  * **Data Type:** File +
-  * **Default Value:** N/A +
- +
- +
- +
----- +
-==== -LoadProject / -ld ==== +
----- +
-Load a previously saved project +
-=== Parameters === +
-__**file (DEFAULT) (REQUIRED) **__ \\  +
-The path and name of project to be loaded +
-  * **Data Type:** File +
-  * **Default Value:** N/A +
-__**LoadLib **__ \\  +
-If passed the library associated with the file will be loaded +
-  * **Data Type:** True / False +
-  * **Default Value:** false +
- +
- +
- +
----- +
-==== -ClearProject / -clr ==== +
----- +
-Clear and create a new project workspace +
-=== Parameters === +
- +
  
 ---- ----
 ==== -CreateWatcher / -cw ==== ==== -CreateWatcher / -cw ====
 ---- ----
-Creates a directory watcher+Creates a new directory watcher
 === Parameters === === Parameters ===
 __**delay **__ \\  __**delay **__ \\ 
Line 1710: Line 1679:
 __**overwrite **__ \\  __**overwrite **__ \\ 
 If passed and existing watchers with the same name will be overwritten If passed and existing watchers with the same name will be overwritten
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**recursive **__ \\  __**recursive **__ \\ 
 If passed all subdirectories will be watched as well If passed all subdirectories will be watched as well
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
 __**script (REQUIRED) **__ \\  __**script (REQUIRED) **__ \\ 
Line 1721: Line 1690:
   * **Default Value:** N/A   * **Default Value:** N/A
 __**triggerOnDelete **__ \\  __**triggerOnDelete **__ \\ 
-If passed watcher will be triggered when a file is deleted +If passed watcher will be triggered when a file is deleted as well as added or edited 
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** 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 ==== ==== -ActivateWatcher / -aw ====
 ---- ----
-Activate the passed watcher(s), if no watcher is passed activate all watchers+Activate the passed watcher(s) if not already activated
 === Parameters === === Parameters ===
 __**name (DEFAULT) **__ \\  __**name (DEFAULT) **__ \\ 
-The name of the watcher to be activated+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   * **Data Type:** List
   * **Default Value:** NULL   * **Default Value:** NULL
- +<code> -ActivateWatcher name "WATCHER_ONE" name "WATCHER_TWO"</code>
  
 ---- ----
Line 1748: Line 1716:
   * **Data Type:** List   * **Data Type:** List
   * **Default Value:** NULL   * **Default Value:** NULL
- +<code> -DeactivateWatcher name "WATCHER_ONE"</code>
  
 ---- ----
Line 1760: Line 1727:
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** N/A   * **Default Value:** N/A
- +<code> -DeleteWatcher "WATCHER_ONE"</code>
  
 ---- ----
Line 1767: Line 1733:
 ---- ----
 List all watchers List all watchers
-=== Parameters === +<code> -ListWatchers</code>
- +
  
 ---- ----
Line 1778: Line 1742:
 __**disable **__ \\  __**disable **__ \\ 
 If passed Sift will will no longer launch minimized to the system tray. If passed Sift will will no longer launch minimized to the system tray.
-  * **Data Type:** True / False+  * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
- +<code> -LaunchMinimized disable</code>
  
 ---- ----
Line 1787: Line 1750:
 ---- ----
 Immediatly launch a background instance of Sift in the system tray. Immediatly launch a background instance of Sift in the system tray.
-=== Parameters === +<code> -LaunchBackgroundInstance</code>
- +
  
 ---- ----
-==== -Exit / -x ====+==== -RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics ====
 ---- ----
-Exit Sift+Compute Summary Metrics
 === Parameters === === 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>
  
 ---- ----
-==== -SetEnginePluginsFolder / -SEPF ====+==== -Exit / -x ====
 ---- ----
-Set the location the engine will look for plugins e.g Meta-Commands +Exit Sift 
-=== Parameters === +<code> -Exit</code>
-__**folderPath (DEFAULT) (REQUIRED) **__ \\  +
-The path to the engine plugins folder +
-  * **Data Type:** Directory +
-  * **Default Value:** N/A +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
sift/command_line.1757614027.txt.gz · Last modified: 2025/09/11 18:07 by sgranger