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/12 17:53] – 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) **__ \\ 
Line 49: Line 49:
   * **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
Line 68: Line 68:
   * **Default Value:** N/A   * **Default Value:** N/A
 <code> -LoadQuery file "C:\Data\query.q3d"</code> <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:** Boolean (True / False)   * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
Line 91: Line 123:
 ==== -RunLOF / -lof ==== ==== -RunLOF / -lof ====
 ---- ----
-Run Local Outlier Factor+Run Local Outlier Factor on currently active PCA
 === Parameters === === Parameters ===
 __**autoExclude **__ \\  __**autoExclude **__ \\ 
Line 98: Line 130:
   * **Default Value:** false   * **Default Value:** false
 __**grouping **__ \\  __**grouping **__ \\ 
-How should data be grouped before running: +How should data be grouped before looking for outliers
-Combined Groups: All data points will be compared +
-Groups: Data will be compared within groups +
-Workspace: Data will be compared within workspaces+
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** combined group   * **Default Value:** combined group
Line 134: Line 163:
 ==== -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 145: 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 162: 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:** Boolean (True / False)   * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
Line 170: Line 199:
 ==== -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 194: Line 223:
 ==== -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 235:
   * **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 231: Line 260:
 ==== -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:** String (File Path)   * **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:** Boolean (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
Line 253: 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
Line 259: Line 288:
  
 ---- ----
-==== -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) **__ \\ 
Line 268: Line 297:
   * **Default Value:** N/A   * **Default Value:** N/A
 <code> -DirPath path "C:\Work Directory\Data"</code> <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 **__ \\ 
Line 279: Line 319:
   * **Default Value:** false   * **Default Value:** false
 __**localMax **__ \\  __**localMax **__ \\ 
-Use local maximum+Register by local maximum
   * **Data Type:** Boolean (True / False)   * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
Line 291: Line 331:
   * **Default Value:** -1   * **Default Value:** -1
 __**localMin **__ \\  __**localMin **__ \\ 
-use local minimum+Register by local minimum
   * **Data Type:** Boolean (True / False)   * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
Line 311: Line 351:
   * **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
Line 319: Line 359:
 ==== -CreateGLM / -glm ==== ==== -CreateGLM / -glm ====
 ---- ----
-Create a General Linear Model+Create a General Linear Model using the selected groups / workspaces
 === Parameters === === Parameters ===
 __**grouping **__ \\  __**grouping **__ \\ 
Line 327: Line 367:
   * **Options:** workspace, group   * **Options:** workspace, group
 __**name (DEFAULT) (REQUIRED) **__ \\  __**name (DEFAULT) (REQUIRED) **__ \\ 
-The name of the GLM created+The name of the GLM
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** N/A   * **Default Value:** N/A
Line 433: Line 473:
 ==== -RunSPMOneWayAnova ==== ==== -RunSPMOneWayAnova ====
 ---- ----
-Run Statistical Parameteric Mapping Paired T-Test+Run Statistical Parameteric Mapping one way Anova test
 === Parameters === === Parameters ===
 __**alpha (REQUIRED) **__ \\  __**alpha (REQUIRED) **__ \\ 
Line 765: Line 805:
 ==== -ExportPlotSignalTime / -ExportPlotST / -EPST ==== ==== -ExportPlotSignalTime / -ExportPlotST / -EPST ====
 ---- ----
 +Export a signal time plot using the currently selected groups / workspaces
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 844: Line 884:
 ==== -ExportPlotMetric / -ExportPlotM / -EPM ==== ==== -ExportPlotMetric / -ExportPlotM / -EPM ====
 ---- ----
 +Export a metric plot using the currently selected groups / workspaces
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 933: Line 973:
 ==== -ExportPlotPairSignal / -ExportPlotPS / -EPPS ==== ==== -ExportPlotPairSignal / -ExportPlotPS / -EPPS ====
 ---- ----
 +Export a Signal Signal plot using the currently selected groups / workspaces
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1016: Line 1056:
 ==== -ExportPlotPairMetric / -ExportPlotPM / -EPPM ==== ==== -ExportPlotPairMetric / -ExportPlotPM / -EPPM ====
 ---- ----
 +Export a Metric Metric plot using the currently selected groups / workspaces
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1107: Line 1147:
 ==== -ExportPlotSPM / -EPSPM ==== ==== -ExportPlotSPM / -EPSPM ====
 ---- ----
 +Export the current SPM plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1156: Line 1196:
 ==== -ExportPlotResiduals / -ExportPlotR / -EPR ==== ==== -ExportPlotResiduals / -ExportPlotR / -EPR ====
 ---- ----
 +Export the current GLMs residuals plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1254: Line 1294:
 ==== -ExportPlotVarianceExplained / -ExportPlotVE / -EPVE ==== ==== -ExportPlotVarianceExplained / -ExportPlotVE / -EPVE ====
 ---- ----
 +Export the current PCAs variance explained plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1303: Line 1343:
 ==== -ExportPlotLoadingVector / -ExportPlotLV / -EPLV ==== ==== -ExportPlotLoadingVector / -ExportPlotLV / -EPLV ====
 ---- ----
 +Export the current PCAs loading vectors plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1360: Line 1400:
 ==== -ExportPlotWorkspaceScores / -ExportPlotWS / -EPWS ==== ==== -ExportPlotWorkspaceScores / -ExportPlotWS / -EPWS ====
 ---- ----
 +Export the current PCAs workspace scores plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1421: Line 1461:
 ==== -ExportPlotGroupScores / -ExportPlotGS / -EPGS ==== ==== -ExportPlotGroupScores / -ExportPlotGS / -EPGS ====
 ---- ----
 +Export the current PCAs groups scores plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1470: Line 1510:
 ==== -ExportPlotReconstruction / -ExportPlotR / -EPR ==== ==== -ExportPlotReconstruction / -ExportPlotR / -EPR ====
 ---- ----
 +Export the current PCAs reconstruction plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1535: Line 1575:
 ==== -ExportPlotExtreme / -ExportPlotE / -EPE ==== ==== -ExportPlotExtreme / -ExportPlotE / -EPE ====
 ---- ----
 +Export the current PCAs extreme plot
 === Parameters === === Parameters ===
 __**dataStyle **__ \\  __**dataStyle **__ \\ 
Line 1619: Line 1659:
   * **Default Value:** NULL   * **Default Value:** NULL
 <code> -SelectMetrics group "AnkleAngleX" group "AnkleAngleY" workspace "P002"</code> <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:** 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> 
- 
-<code> -ClearProject</code> 
  
 ---- ----
 ==== -CreateWatcher / -cw ==== ==== -CreateWatcher / -cw ====
 ---- ----
-Creates a directory watcher+Creates a new directory watcher
 === Parameters === === Parameters ===
 __**delay **__ \\  __**delay **__ \\ 
Line 1678: 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:** Boolean (True / False)   * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
Line 1717: Line 1729:
 <code> -DeleteWatcher "WATCHER_ONE"</code> <code> -DeleteWatcher "WATCHER_ONE"</code>
  
 +----
 +==== -ListWatchers / -lw ====
 +----
 +List all watchers
 <code> -ListWatchers</code> <code> -ListWatchers</code>
  
Line 1730: Line 1746:
 <code> -LaunchMinimized disable</code> <code> -LaunchMinimized disable</code>
  
 +----
 +==== -LaunchBackgroundInstance / -LaunchTray ====
 +----
 +Immediatly launch a background instance of Sift in the system tray.
 <code> -LaunchBackgroundInstance</code> <code> -LaunchBackgroundInstance</code>
- 
-<code> -Exit</code> 
  
 ---- ----
-==== -SetEnginePluginsFolder / -SEPF ====+==== -RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics ====
 ---- ----
-Set the location the engine will look for plugins e.g Meta-Commands+Compute Summary Metrics
 === Parameters === === Parameters ===
-__**folderPath (DEFAULT) (REQUIRED) **__ \\  +__**EventIndex **__ \\  
-The path to the engine plugins folder +Index Event to compute Metrics at. 
-  * **Data Type:** String (Directory)+  * **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   * **Default Value:** N/A
-<code> -SetEnginePluginsFolder folderPath "C:\Engine Resources"</code>+__**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.1757699629.txt.gz · Last modified: 2025/09/12 17:53 by sgranger