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 19:25] – sgrangersift:command_line [2025/09/23 18:33] (current) – [-RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics] wikisysop
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>
  
 ---- ----
Line 265: 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>
  
 ---- ----
Line 1616: 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> 
- 
----- 
-==== -ClearProject / -clr ==== 
----- 
-Clear and create a new project workspace (All unsaved progress will be lost) 
-<code> -ClearProject</code> 
  
 ---- ----
Line 1742: Line 1753:
  
 ---- ----
-==== -Exit / -x ====+==== -RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics ====
 ---- ----
-Exit Sift +Compute Summary Metrics 
-<code> -Exit</code>+=== 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:** String (Directory) +
-  * **Default Value:** N/A +
-<code> -SetEnginePluginsFolder folderPath "C:\Engine Resources"</code>+
sift/command_line.1757705131.txt.gz · Last modified: 2025/09/12 19:25 by sgranger