Wiki Documentation Site

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:29] – sgrangersift:command_line [2026/08/21 16:02] (current) – wikisysop
Line 1: Line 1:
-===== Sift Command Line ===== +====== Sift Command Line ====== 
-It is possible to run sift from the command line, this offers several advantages: +Running Sift from the command line offers several advantages: 
-  * With no need to update a GUI or plots the application will run much faster +  * With no need to update a GUI or plots, the application will run much faster 
-  * With experience it makes it possible to quickly execute commands +  * With experience, it makes it possible to quickly execute commands 
-  * Creating a bat file or python script it is possible to completely automate processing+  * Creating a bat file or python script makes it possible to completely automate processing
  
  
Line 38: Line 38:
  
  
 +----
 ===== Command Reference ===== ===== Command Reference =====
 ---- ----
Line 57: Line 58:
   * **Default Value:** NULL   * **Default Value:** NULL
 <code> -LoadLib "C:\Library Location\Data" libQuery "RUN AND NOT(OLD)" libSubjTags "RUN"</code> <code> -LoadLib "C:\Library Location\Data" libQuery "RUN AND NOT(OLD)" libSubjTags "RUN"</code>
 +
 +----
 +==== -LoadLib / -l ====
 +----
 +Search the provided directory and all sub directories for .cmz files and load them into the library
 +=== Parameters ===
 +__**directory (DEFAULT) (REQUIRED) **__ \\ 
 +A path to the root directory to be searched recursively for .cmzs
 +  * **Data Type:** String (Directory)
 +  * **Default Value:** N/A
 +__**libQuery **__ \\ 
 +The query used to refine the files loaded into the library
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**libSubjTags **__ \\ 
 +A list of subject tags that must be included within the .cmzs
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +<code> -LoadLib "C:\Library Location\Data" libQuery "RUN AND NOT(OLD)" libSubjTags "RUN"</code>
 +
 +----
 +==== -LoadND / -lnd ====
 +----
 +Takes in the filepath for a Sift Normal Database .Sift file and loads it into the current project.
 +=== Parameters ===
 +__**File (DEFAULT) (REQUIRED) **__ \\ 
 +A filepath with the Normal Database .sift file to be loaded into the workspace
 +  * **Data Type:** String (File Path)
 +  * **Default Value:** N/A
 +<code> -LoadND "C:\Library Location\Data\ND.sift"</code>
  
 ---- ----
Line 68: Line 99:
   * **Default Value:** N/A   * **Default Value:** N/A
 <code> -LoadQuery file "C:\Data\query.q3d"</code> <code> -LoadQuery file "C:\Data\query.q3d"</code>
 +
 +----
 +==== -LoadProject / -ld ====
 +----
 +Load a previously saved project
 +=== Parameters ===
 +__**file (DEFAULT) (REQUIRED) **__ \\ 
 +The path and name of the project
 +  * **Data Type:** String (File Path)
 +  * **Default Value:** N/A
 +__**loadLib **__ \\ 
 +If passed Sift will attempt to load the library associated with the project
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +<code> -LoadProject "C:\Saved Projects\test_project.i3d" loadLib</code>
 +
 +----
 +==== -LoadNDQuery / -ndq ====
 +----
 +Load and calculate a predifined Normal Database query
 +=== Parameters ===
 +__**file (DEFAULT) (REQUIRED) **__ \\ 
 +Path to the .q3d containing query definitions
 +  * **Data Type:** String (File Path)
 +  * **Default Value:** N/A
 +<code> -LoadNDQuery file "C:\Data\NDquery.q3d"</code>
  
 ---- ----
Line 81: Line 138:
  
 ---- ----
-==== -LoadProject / -ld ====+==== -ClearProject / -clr ====
 ---- ----
-Load a previously saved project+Clear and create a new project workspace (All unsaved progress will be lost) 
 +<code> -ClearProject</code> 
 + 
 +---- 
 +==== -SelectSignals / -sig ==== 
 +---- 
 +Select queried signals (if no parameters are passed all signals are selected)
 === Parameters === === Parameters ===
-__**file (DEFAULT) (REQUIRED) **__ \\  +__**group **__ \\  
-The path and name of project to be loaded+The name of a group to be selected (pass multiple times to select more than one) 
 +  * **Data Type:** List 
 +  * **Default Value:** NULL 
 +__**workspace **__ \\  
 +The name of a workspace to be selcted (pass multiple time to select more than one) 
 +  * **Data Type:** List 
 +  * **Default Value:** NULL 
 +<code> -SelectSignals group "KneeAngleX"</code> 
 + 
 +---- 
 +==== -SelectMetrics / -met ==== 
 +---- 
 +Select queried metrics (if no parameters are passed all metrics are selected) 
 +=== Parameters === 
 +__**group **__ \\  
 +The name of the group to be selected (pass multiple times to select more than one) 
 +  * **Data Type:** List 
 +  * **Default Value:** NULL 
 +__**workspace **__ \\  
 +The name of the workspace to be selected (pass multiple times to select more than one) 
 +  * **Data Type:** List 
 +  * **Default Value:** NULL 
 +<code> -SelectMetrics group "AnkleAngleX" group "AnkleAngleY" workspace "P002"</code> 
 + 
 +---- 
 +==== -RunTheiaBatch / -RunTheia / -RTB ==== 
 +---- 
 +Make a call to Theia3D.exe and pass an instruction file 
 +=== Parameters === 
 +__**settingsFile (DEFAULT) (REQUIRED) **__ \\  
 +The instruction set for Theia3D
   * **Data Type:** String (File Path)   * **Data Type:** String (File Path)
   * **Default Value:** N/A   * **Default Value:** N/A
-__**loadLib **__ \\  +__**theiaLocation **__ \\  
-If passed the library associated with the file will be loaded+The location of Theia3D.exe, if not passed a default value will be used, either the last successful location used or the default install location 
 +  * **Data Type:** String (File Path) 
 +  * **Default Value:** NULL 
 +<code> -RunTheiaBatch theiaLocation "C:\Program Files\Theia\Theia3D\Theia3D.exe" settingsFile "C:\Data\Theia\The3DSettingsFile.txt"</code> 
 + 
 +---- 
 +==== -BuildNormalDatabase / -BuildND ==== 
 +---- 
 +Build a normal database using currently queried data 
 +=== Parameters === 
 +__**excludedData **__ \\  
 +Pass to use excluded data when creating normal database
   * **Data Type:** Boolean (True / False)   * **Data Type:** Boolean (True / False)
   * **Default Value:** false   * **Default Value:** false
-<code> -LoadProject "C:\Saved Projects\test_project.i3d" loadLib</code>+__**filePath (DEFAULT) (REQUIRED) **__ \\  
 +Location to save the ND 
 +  * **Data Type:** String (File Path) 
 +  * **Default Value:** N/A 
 +__**group **__ \\  
 +Group to build normal database with, pass multiple time to select more than one, do not pass to select all 
 +  * **Data Type:** List 
 +  * **Default Value:** NULL 
 +__**librarySummary **__ \\  
 +Pass to include a library summary in the normal database, if no other summaries are passed this is the default 
 +  * **Data Type:** Boolean (True / False) 
 +  * **Default Value:** false 
 +__**summaryStats **__ \\  
 +What statistics to build the normal database with, pass multiple times to select more than one, do not pass to select all 
 +  * **Data Type:** List 
 +  * **Default Value:** NULL 
 +  * **Options:** Mean, Median, Mode, Trimean, Geometric Mean, Trimmed Mean, Standard Deviation, Variance, Range, 1st Quartile, 3rd Quartile, Interquartile Range, 5th Percentile, 95th Percentile, Mean Absolute Deviation, Median Absolute Deviation 
 +__**trialSummary **__ \\  
 +Pass to include a trial summary in the normal database, if no other summaries are passed librarySummbary is the default 
 +  * **Data Type:** Boolean (True / False) 
 +  * **Default Value:** false 
 +__**workspaceSummary **__ \\  
 +Pass to include a workspace summary in the normal database, if no other summaries are passed librarySummary is the default 
 +  * **Data Type:** Boolean (True / False) 
 +  * **Default Value:** false 
 +<code> -BuildNormalDatabase "C:\Library\ND.sift" group "AnkleAngleX" summaryStats "Mean" summaryStats "Mode" librarySummary</code>
  
 ---- ----
-==== -ClearProject / -clr ====+==== -MakeHybridModel ====
 ---- ----
-Clear and create a new project workspace (All unsaved progress will be lost) +Adds the MakeHybridModel module to the build CMZ function. 
-<code> -ClearProject</code>+=== Parameters === 
 +__**currentFileDirectory (DEFAULT) (REQUIRED) **__ \\  
 +Path to library directory 
 +  * **Data Type:** String (Directory) 
 +  * **Default Value:** N/A 
 +__**modelTemplateFile (REQUIRED) **__ \\  
 +Path to MDH settings file 
 +  * **Data Type:** String (File Path) 
 +  * **Default Value:** N/A 
 +<code> -MakeHybridModel modelTemplateFile "C:\Data Folder\ModelFile.mdh" currentFileDirectory "C:\Data Folder\DataFiles\" </code> 
 + 
 +---- 
 +==== -MergeData / -Merge ==== 
 +---- 
 +Adds the MergeData module to the build CMZ function. 
 +=== Parameters === 
 +__**mergeScriptFile (DEFAULT) (REQUIRED) **__ \\  
 +Path to V3S script file 
 +  * **Data Type:** String (File Path) 
 +  * **Default Value:** N/A 
 +<code> -MergeData mergeScriptFile "C:\Data Folder\Merge Script.v3s" </code> 
 + 
 +---- 
 +==== -AddMetaData / -Merge ==== 
 +---- 
 +Adds the AddMetaData module to the build CMZ function. 
 +=== Parameters === 
 +__**metaFile (REQUIRED) **__ \\  
 +Path to CSV metadata file 
 +  * **Data Type:** String (File Path) 
 +  * **Default Value:** N/A 
 +__**settingsFile (DEFAULT) **__ \\  
 +Path to XML settings file for metaData selections 
 +  * **Data Type:** String (File Path) 
 +  * **Default Value:** NULL 
 +<code> -AddMetaData metaFile "C:\Data Folder\MetaData.csv" settings File "C:\Data Folder\Meta Settings File.xml" </code> 
 + 
 +---- 
 +==== -TagByFile ==== 
 +---- 
 +Adds the TagByFile module to the build CMZ function. 
 +=== Parameters === 
 +__**MaskAndTag (DEFAULT) (REQUIRED) **__ \\  
 +String containing the file mask followed by the tag to assign the file. These should be separated with a colon ':'  
 +  * **Data Type:** List 
 +  * **Default Value:** N/A 
 +<code>  - TagByFile MaskAndTag "*run.c3d:run" </code> 
 + 
 +---- 
 +==== -AddV3DScript ==== 
 +---- 
 +Adds the V3D Script module to the build CMZ function. 
 +=== Parameters === 
 +__**scriptFile (DEFAULT) (REQUIRED) **__ \\  
 +Path to script file 
 +  * **Data Type:** List 
 +  * **Default Value:** N/A 
 +<code> -AddV3DScript scriptFile "C:\Data Folder\pipeline.v3s" </code> 
 + 
 +---- 
 +==== -BuildCMZ ==== 
 +---- 
 +Main function for building CMZ workspaces. Calls sub functions 
 +        ~ directory 
 +        ~ settingsFile 
 +        ~ preview 
 +=== Parameters === 
 +__**directory (DEFAULT) (REQUIRED) **__ \\  
 +A path to the root directory to be searched recursively for .c3ds 
 +  * **Data Type:** String (Directory) 
 +  * **Default Value:** N/A 
 +__**settingsFile**__ \\  
 +A .xml file containing buildCMZ dialog settings saved from the GUI 
 +  * **Data Type:** String (File Path) 
 +  * **Default Value:** N/A 
 +__**preview**__ \\  
 +If passed Sift will provide a preview of the build it will run and ask the user if they wish to continue. 
 +  * **Data Type:** Boolean (True / False) 
 +  * **Default Value:** false 
 +<code> -BuildCMZ directory ".../../" settingsFile "/.../buildSettings.xml" preview</code>
  
 ---- ----
Line 256: Line 464:
   * **Default Value:** false   * **Default Value:** false
 <code> -RunMah grouping "group" alphaValue "0.5" autoExclude</code> <code> -RunMah grouping "group" alphaValue "0.5" autoExclude</code>
 +
 +----
 +==== -RunGDI ====
 +----
 +Calculate Gait Deviation Index (GDI)
 +=== Parameters ===
 +__**computeComponents **__ \\ 
 +If passed compute all component queries
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**computeQueries **__ \\ 
 +If passed compute generated queries after running
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**leftEvent **__ \\ 
 +The left gait event used
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**normalDatabase (REQUIRED) **__ \\ 
 +The normal database used to run GDI
 +  * **Data Type:** String (File Path)
 +  * **Default Value:** N/A
 +__**normalizedPoints **__ \\ 
 +The number of points to normalize to
 +  * **Data Type:** Integer
 +  * **Default Value:** 0
 +__**rightEvent **__ \\ 
 +The right gait event used
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**settingsFile (DEFAULT) (REQUIRED) **__ \\ 
 +The settings XML file containing the calculate instructions, to overwrite the settings within the file pass the associated parameter
 +  * **Data Type:** String (File Path)
 +  * **Default Value:** N/A
 +__**signalFolder **__ \\ 
 +What folder to search for signals
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +<code> </code>
  
 ---- ----
Line 498: Line 745:
 Run Dynamic Time Warping Run Dynamic Time Warping
 === Parameters === === Parameters ===
-__**name (REQUIRED) **__ \\  +__**DTWType **__ \\  
-The name of the DTW test being run+The type of DTW test to run.
   * **Data Type:** String   * **Data Type:** String
 +  * **Default Value:** FindOutliers
 +  * **Options:** FindOutliers, FindTrace
 +__**exclude **__ \\ 
 +Do you want to exclude the found traces?
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**framesOfTrace **__ \\ 
 +The frames of the trace you want to compare the dataset to. Example input frames: [1,100]
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**groupOfTrace **__ \\ 
 +The group of the trace you want to compare the dataset to.
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**groups (REQUIRED) **__ \\ 
 +Groups to run DTW on
 +  * **Data Type:** List
   * **Default Value:** N/A   * **Default Value:** N/A
 __**standardDeviations **__ \\  __**standardDeviations **__ \\ 
Line 507: Line 771:
   * **Default Value:** 1   * **Default Value:** 1
   * **Options:** 1, 2, 3   * **Options:** 1, 2, 3
 +__**testName (REQUIRED) **__ \\ 
 +The name of the DTW test being run.
 +  * **Data Type:** String
 +  * **Default Value:** N/A
 +__**trialOfTrace **__ \\ 
 +The trial of the trace you want to compare the dataset to.
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**workspaceOfTrace **__ \\ 
 +The workspace of the trace you want to compare the dataset to.
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**workspaces **__ \\ 
 +Workspaces to run DTW on, if left blank all workspaces will be used.
 +  * **Data Type:** List
 +  * **Default Value:** NULL
 <code> -RunDTW name "SAMPLE_DTW" standardDeviations "3"</code> <code> -RunDTW name "SAMPLE_DTW" standardDeviations "3"</code>
 +
 +----
 +==== -DeleteGLM / -DGLM ====
 +----
 +Delete an existing GLM and all of its associated SPMs
 +=== Parameters ===
 +__**name (DEFAULT) (REQUIRED) **__ \\ 
 +The name of the GLM to delete
 +  * **Data Type:** String
 +  * **Default Value:** N/A
 +<code> -DeleteGLM "GLM_ONE"</code>
 +
 +----
 +==== -DeleteSPM / -DSPM ====
 +----
 +Delete an existing SPM from the passed GLM
 +=== Parameters ===
 +__**glm (REQUIRED) **__ \\ 
 +The name of the GLM that contains the SPM to delete
 +  * **Data Type:** String
 +  * **Default Value:** N/A
 +__**spm (REQUIRED) **__ \\ 
 +The name of the SPM to delete
 +  * **Data Type:** String
 +  * **Default Value:** N/A
 +<code> -DeleteSPM glm "GLM_ONE" spm "SPM_ONE"</code>
 +
 +----
 +==== -SelectGLM / -SGLM ====
 +----
 +Select an existing GLM
 +=== Parameters ===
 +__**name (DEFAULT) (REQUIRED) **__ \\ 
 +The name to the GLM to select
 +  * **Data Type:** String
 +  * **Default Value:** N/A
 +<code> -SelectGLM name "GLM_ONE"</code>
 +
 +----
 +==== -SelectSPM / -SSPM ====
 +----
 +Select and existing SPM from the active GLM
 +=== Parameters ===
 +__**glm (REQUIRED) **__ \\ 
 +The name of the GLM containing the SPM to select
 +  * **Data Type:** String
 +  * **Default Value:** N/A
 +__**spm (REQUIRED) **__ \\ 
 +The name of the SPM to select
 +  * **Data Type:** String
 +  * **Default Value:** N/A
 +<code> -SelectSPM glm "GLM_ONE" spm "SPM_ONE"</code>
 +
 +----
 +==== -RunGPS / -GPS ====
 +----
 +Calulates GPS metrics for the loaded data.
 +=== Parameters ===
 +__**computeComponentQueries **__ \\ 
 +If passed calculate individual component queries generated by results
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**computeQueries **__ \\ 
 +If passed calculate all queries generated by results
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**leftEvent **__ \\ 
 +The left cycle event to use for gait
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**normalDatabase (REQUIRED) **__ \\ 
 +Path to normal database file
 +  * **Data Type:** String (File Path)
 +  * **Default Value:** N/A
 +__**normalizedPoints **__ \\ 
 +How many points to normalize to
 +  * **Data Type:** Integer
 +  * **Default Value:** 0
 +__**p2dFolder **__ \\ 
 +The normal database folder (only used for .vnd files)
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**rightEvent **__ \\ 
 +The right cycle event to use for gait
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**settingsFile (DEFAULT) (REQUIRED) **__ \\ 
 +Path to XML settings file, to overwrite any settings within the file pass the associated parameter
 +  * **Data Type:** String (File Path)
 +  * **Default Value:** N/A
 +__**signalFolder **__ \\ 
 +The folder the singal can be found in
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**signalType **__ \\ 
 +The signal type the signal can be found in
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +<code> -RunGPS "C:\Data Folder\GPS Settings File.xml" leftEvent "RTO"</code>
 +
 +----
 +==== -RunGGA / -GGA ====
 +----
 +Execute the GGA process on all loaded .cmz files in the library using the configured parameters and settings.
 +=== Parameters ===
 +__**computeQuery **__ \\ 
 +Compute query after calculation
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**leftCycleEvent **__ \\ 
 +The left cycle event to be evaluated
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**leftSelects **__ \\ 
 +Select the left side signals for GGA processing
 +  * **Data Type:** List
 +  * **Default Value:** NULL
 +__**pelvis **__ \\ 
 +Select pelvis signal to use for GGA computation
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**settingsFile **__ \\ 
 +A path to a LGGA settings file
 +  * **Data Type:** String (File Path)
 +  * **Default Value:** NULL
 +__**signalFolder **__ \\ 
 +The folder of signals you would like to process for LGGA
 +  * **Data Type:** String
 +  * **Default Value:** ORIGINAL
 +  * **Options:** ORIGINAL, PROCESSED
 +__**signalMagnitude **__ \\ 
 +Use signal magnitude for LGGA
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**trunk **__ \\ 
 +Select trunk signal to use for GGA computation
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +<code> -runGGA leftCycleEvent "LHS" leftSelects "LAnklePower" rightCycleEvent "RHS" computeQuery</code>
  
 ---- ----
Line 531: Line 950:
   * **Default Value:** false   * **Default Value:** false
 __**exportFormat **__ \\  __**exportFormat **__ \\ 
-What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D+What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d+  * **Options:** standard, transposed, spss, p2d, csv, json, xml
 __**file (REQUIRED) **__ \\  __**file (REQUIRED) **__ \\ 
 Desired path for the text export to be saved Desired path for the text export to be saved
Line 575: Line 994:
   * **Default Value:** false   * **Default Value:** false
 __**exportFormat **__ \\  __**exportFormat **__ \\ 
-What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D+What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d+  * **Options:** standard, transposed, spss, p2d, csv, json, xml
 __**file (REQUIRED) **__ \\  __**file (REQUIRED) **__ \\ 
 Desired path for the text export to be saved Desired path for the text export to be saved
Line 629: Line 1048:
   * **Options:** groups, workspaces, instances   * **Options:** groups, workspaces, instances
 <code> -ExportSummaryStatistics file "C:\Exports\summary_stats.txt" results "workspaces" mean min max</code> <code> -ExportSummaryStatistics file "C:\Exports\summary_stats.txt" results "workspaces" mean min max</code>
 +
 +----
 +==== -ExportStatsTestResults ====
 +----
 +Export results from statistical tests
 +=== Parameters ===
 +__**exportFormat **__ \\ 
 +What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV
 +  * **Data Type:** String
 +  * **Default Value:** standard
 +  * **Options:** standard, transposed, spss, p2d, csv, json, xml
 +__**file (REQUIRED) **__ \\ 
 +Desired path for the text export to be saved
 +  * **Data Type:** String (File Path)
 +  * **Default Value:** N/A
 +__**groupResults **__ \\ 
 +Export group results: Mean, Standard Deviation, Standard Error, N
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**precision **__ \\ 
 +How many decimal places should values be displayed to
 +  * **Data Type:** String
 +  * **Default Value:** 4
 +__**testInfo **__ \\ 
 +Export test information: Statistical Test, Significance Level, Population Mean, Group1 : Name of group used
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**testResults **__ \\ 
 +Export test results:Degrees of Freedom, T Stat, Null Hypothesis
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +<code> -ExportStatsTestResults file "C:\Exports\stats_results.txt" testInfo groupResults testResults</code>
  
 ---- ----
Line 636: Line 1087:
 === Parameters === === Parameters ===
 __**exportFormat **__ \\  __**exportFormat **__ \\ 
-What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D+What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d+  * **Options:** standard, transposed, spss, p2d, csv, json, xml
 __**file (REQUIRED) **__ \\  __**file (REQUIRED) **__ \\ 
 Desired path for the text export to be saved Desired path for the text export to be saved
Line 676: Line 1127:
   * **Default Value:** false   * **Default Value:** false
 __**exportFormat **__ \\  __**exportFormat **__ \\ 
-What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D+What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d+  * **Options:** standard, transposed, spss, p2d, csv, json, xml
 __**file (REQUIRED) **__ \\  __**file (REQUIRED) **__ \\ 
 Desired path for the text export to be saved Desired path for the text export to be saved
Line 704: Line 1155:
   * **Default Value:** false   * **Default Value:** false
 __**exportFormat **__ \\  __**exportFormat **__ \\ 
-What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D+What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d+  * **Options:** standard, transposed, spss, p2d, csv, json, xml
 __**file (REQUIRED) **__ \\  __**file (REQUIRED) **__ \\ 
 Desired path for the text export to be saved Desired path for the text export to be saved
Line 736: Line 1187:
   * **Default Value:** false   * **Default Value:** false
 __**exportFormat **__ \\  __**exportFormat **__ \\ 
-What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D+What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d+  * **Options:** standard, transposed, spss, p2d, csv, json, xml
 __**file (REQUIRED) **__ \\  __**file (REQUIRED) **__ \\ 
 Desired path for the text export to be saved Desired path for the text export to be saved
Line 801: Line 1252:
   * **Default Value:** false   * **Default Value:** false
 <code> -ExportPCA file "C:\Processing Folder\PCA\export.txt" groupScores workspaceScores lof spe</code> <code> -ExportPCA file "C:\Processing Folder\PCA\export.txt" groupScores workspaceScores lof spe</code>
 +
 +----
 +==== -ExportND ====
 +----
 +Export Principal Component Analysis results
 +=== Parameters ===
 +__**exportFormat **__ \\ 
 +What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D, CSV
 +  * **Data Type:** String
 +  * **Default Value:** standard
 +  * **Options:** standard, transposed, spss, p2d, csv, json, xml
 +__**file (REQUIRED) **__ \\ 
 +Desired path for the text export to be saved
 +  * **Data Type:** String (File Path)
 +  * **Default Value:** N/A
 +__**ndSignals **__ \\ 
 +Export Normal Database Signals
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**precision **__ \\ 
 +How many decimal places should values be displayed to
 +  * **Data Type:** String
 +  * **Default Value:** 4
 +<code> -ExportND file "C:\Processing Folder\ND\export.txt" ndSignals</code>
  
 ---- ----
Line 1629: Line 2104:
   * **Default Value:** ###   * **Default Value:** ###
 <code> -ExportPlotExtreme filePath "C:\Processing\PCA\extreme_plot.png" height "600" width "1200" pcNumber "2"</code> <code> -ExportPlotExtreme filePath "C:\Processing\PCA\extreme_plot.png" height "600" width "1200" pcNumber "2"</code>
- 
----- 
-==== -SelectSignals / -sig ==== 
----- 
-Select queried signals (if no parameters are passed all signals are selected) 
-=== Parameters === 
-__**group **__ \\  
-The name of a group to be selected (pass multiple times to select more than one) 
-  * **Data Type:** List 
-  * **Default Value:** NULL 
-__**workspace **__ \\  
-The name of a workspace to be selcted (pass multiple time to select more than one) 
-  * **Data Type:** List 
-  * **Default Value:** NULL 
-<code> -SelectSignals group "KneeAngleX"</code> 
- 
----- 
-==== -SelectMetrics / -met ==== 
----- 
-Select queried metrics (if no parameters are passed all metrics are selected) 
-=== Parameters === 
-__**group **__ \\  
-The name of the group to be selected (pass multiple times to select more than one) 
-  * **Data Type:** List 
-  * **Default Value:** NULL 
-__**workspace **__ \\  
-The name of the workspace to be selected (pass multiple times to select more than one) 
-  * **Data Type:** List 
-  * **Default Value:** NULL 
-<code> -SelectMetrics group "AnkleAngleX" group "AnkleAngleY" workspace "P002"</code> 
  
 ---- ----
Line 1751: Line 2196:
 Immediatly launch a background instance of Sift in the system tray. Immediatly launch a background instance of Sift in the system tray.
 <code> -LaunchBackgroundInstance</code> <code> -LaunchBackgroundInstance</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>
 +
 +----
 +==== -RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics ====
 +----
 +Compute Summary Metrics
 +=== Parameters ===
 +__**EventIndex **__ \\ 
 +Index Event to compute Metrics at.
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**GlobalMax **__ \\ 
 +Compute Global Max.
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**GlobalMin **__ \\ 
 +Compute Global Min.
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**Group (REQUIRED) **__ \\ 
 +The group you will calculate metrics for.
 +  * **Data Type:** String
 +  * **Default Value:** N/A
 +__**LocalMax **__ \\ 
 +Compute Local Max.
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**LocalMaxEnd **__ \\ 
 +Local Max End Range.
 +  * **Data Type:** Integer
 +  * **Default Value:** 0
 +__**LocalMaxStart **__ \\ 
 +Local Max Start Range.
 +  * **Data Type:** Integer
 +  * **Default Value:** 0
 +__**LocalMin **__ \\ 
 +Compute Local Min.
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**LocalMinEnd **__ \\ 
 +Local Min End Range.
 +  * **Data Type:** Integer
 +  * **Default Value:** 0
 +__**LocalMinStart **__ \\ 
 +Local Min Start Range.
 +  * **Data Type:** Integer
 +  * **Default Value:** 0
 +__**MaxBetweenEvents **__ \\ 
 +Compute Maximum Between Events.
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**MaxEventEndIndex **__ \\ 
 +Index of End Event for Maximum Between Events.
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**MaxEventStartIndex **__ \\ 
 +Index of Start Event for Maximum Between Events.
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**Mean **__ \\ 
 +Compute Mean.
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**MetricAtEvent **__ \\ 
 +Compute Metric at Event.
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**MinBetweenEvents **__ \\ 
 +Compute Minimum Between Events.
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**MinEventEndIndex **__ \\ 
 +Index of End Event for Minimum Between Events.
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**MinEventStartIndex **__ \\ 
 +Index of Start Event for Minimum Between Events.
 +  * **Data Type:** String
 +  * **Default Value:** NULL
 +__**StandardDeviation **__ \\ 
 +Compute Standard Deviation.
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**StandardError **__ \\ 
 +Compute Standard Error.
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**UseExcludedData **__ \\ 
 +Use Excluded Data to compute metrics.
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**Workspaces **__ \\ 
 +Workspaces you will calculate metrics for. If left blank all workspaces will be used.
 +  * **Data Type:** List
 +  * **Default Value:** NULL
 +<code> </code>
 +
 +----
 +==== -RunSummaryStatistics / -ComputeSummaryStatistics / -SummaryStatistics / -RunSumStats ====
 +----
 +Compute Summary Statistics on selected groups / workspaces
 +=== Parameters ===
 +__**group (REQUIRED) **__ \\ 
 +The group you will calculate summary statistics for.
 +  * **Data Type:** List
 +  * **Default Value:** N/A
 +__**popMean **__ \\ 
 +Mean of the population you are comparing against for your summary statistical test.
 +  * **Data Type:** Decimal
 +  * **Default Value:** -9999
 +__**sigLevel **__ \\ 
 +The is the signifigance level used for the chosen statistical test.
 +  * **Data Type:** Decimal
 +  * **Default Value:** 0.05
 +  * **Options:** 0.1, 0.05, 0.025, 0.01, 0.005, 0.001, 0.2, 0.02, 0.002
 +__**statTest (REQUIRED) **__ \\ 
 +The is the type of statistcal test that will be performed.
 +  * **Data Type:** String
 +  * **Default Value:** N/A
 +  * **Options:** One Sample T-Test, Two Sample T-Test, Paired T-Test
 +__**testName (REQUIRED) **__ \\ 
 +The result name for your summary statistical test.
 +  * **Data Type:** String
 +  * **Default Value:** N/A
 +__**useExcludedData **__ \\ 
 +Use Excluded Data to compute summary statistics.
 +  * **Data Type:** Boolean (True / False)
 +  * **Default Value:** false
 +__**workspace **__ \\ 
 +Workspaces you will calculate summary statistics for. If left blank all workspaces will be used. Workspaces need to be written as group:workspace
 +  * **Data Type:** List
 +  * **Default Value:** NULL
 +<code>  - Summary Statistics Test Name "Example_SummaryStatistics" Statistical Test "One Sample T-Test" Signifigance Level "0.05"</code>
  
 ---- ----
sift/command_line.1757705364.txt.gz · Last modified: by sgranger