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/10/31 20:15] – 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 =====
 +----
 +==== -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>
 +
 ---- ----
 ==== -LoadLib / -l ==== ==== -LoadLib / -l ====
Line 152: Line 172:
   * **Default Value:** NULL   * **Default Value:** NULL
 <code> -SelectMetrics group "AnkleAngleX" group "AnkleAngleY" workspace "P002"</code> <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)
 +  * **Default Value:** N/A
 +__**theiaLocation **__ \\ 
 +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>
  
 ---- ----
Line 188: Line 223:
   * **Default Value:** false   * **Default Value:** false
 <code> -BuildNormalDatabase "C:\Library\ND.sift" group "AnkleAngleX" summaryStats "Mean" summaryStats "Mode" librarySummary</code> <code> -BuildNormalDatabase "C:\Library\ND.sift" group "AnkleAngleX" summaryStats "Mean" summaryStats "Mode" librarySummary</code>
 +
 +----
 +==== -MakeHybridModel ====
 +----
 +Adds the MakeHybridModel module to the build CMZ function.
 +=== 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 668: Line 788:
   * **Default Value:** NULL   * **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>
  
 ---- ----
Line 781: Line 953:
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d, csv+  * **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 825: Line 997:
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d, csv+  * **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 886: Line 1058:
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d, csv+  * **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 918: Line 1090:
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d, csv+  * **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 958: Line 1130:
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d, csv+  * **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 986: Line 1158:
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d, csv+  * **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 1018: Line 1190:
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d, csv+  * **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 1090: Line 1262:
   * **Data Type:** String   * **Data Type:** String
   * **Default Value:** standard   * **Default Value:** standard
-  * **Options:** standard, transposed, spss, p2d, csv+  * **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 2173: Line 2345:
 Exit Sift Exit Sift
 <code> -Exit</code> <code> -Exit</code>
- 
sift/command_line.1761941731.txt.gz · Last modified: by sgranger