sift:command_line
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| sift:command_line [2024/10/09 19:03] – sgranger | sift:command_line [2025/04/04 19:57] (current) – sgranger | ||
|---|---|---|---|
| Line 11: | Line 11: | ||
| * any parameters containing a space or a dash (e.g. a folder path) must be wrapped in double quotes ("" | * any parameters containing a space or a dash (e.g. a folder path) must be wrapped in double quotes ("" | ||
| * Command parameters are named not positional, so the order they are passed does not matter | * Command parameters are named not positional, so the order they are passed does not matter | ||
| - | * Some commands have a default parameter, in these cases the parameter name can be omitted, for example with -loadLib the directory parameter name is optional. so either of the following will work: -loadLib directory " | + | * Some commands have a default parameter, in these cases the parameter name can be omitted, for example with -loadLib the directory parameter name is optional. so either of the following will work: -loadLib directory " |
| * Commands can be entered all at once in the same command that launches sift, or one at a time | * Commands can be entered all at once in the same command that launches sift, or one at a time | ||
| * Enter the command **-Help** to get a list of all available commands | * Enter the command **-Help** to get a list of all available commands | ||
| Line 26: | Line 26: | ||
| Load in a library of CMZs | Load in a library of CMZs | ||
| === Parameters === | === Parameters === | ||
| - | == Directory (Required) == | + | == Directory (Required/Default) == |
| Path to the directory containing the CMZs to be loaded, all sub-directories will be searched as well. | Path to the directory containing the CMZs to be loaded, all sub-directories will be searched as well. | ||
| === Example === | === Example === | ||
| Line 36: | Line 36: | ||
| Load a saved query from a .q3d file | Load a saved query from a .q3d file | ||
| === Parameters === | === Parameters === | ||
| - | == File (Required) == | + | == File (Required/Default) == |
| The path to the .q3d file containing the query | The path to the .q3d file containing the query | ||
| === Example === | === Example === | ||
| Line 42: | Line 42: | ||
| ---- | ---- | ||
| - | ==== RunLOF ==== | + | ==== -RunLOF |
| ---- | ---- | ||
| Run Local Outlier Factor | Run Local Outlier Factor | ||
| Line 72: | Line 72: | ||
| If passed scale all calculated values to the variability explained by the PC | If passed scale all calculated values to the variability explained by the PC | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== RunKMeans ==== | + | ==== -RunKMeans |
| ---- | ---- | ||
| Run K-Means clustering | Run K-Means clustering | ||
| Line 102: | Line 102: | ||
| If passed scale all calculated values to the variability explained by the PC | If passed scale all calculated values to the variability explained by the PC | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== RunSPE ==== | + | ==== -RunSPE |
| ---- | ---- | ||
| Run squared prediction error | Run squared prediction error | ||
| Line 121: | Line 121: | ||
| < | < | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== RunMah ==== | + | ==== -RunMah |
| ---- | ---- | ||
| Run a Mahalanobis distance test | Run a Mahalanobis distance test | ||
| Line 151: | Line 151: | ||
| If passed scale calculated values to variability explained | If passed scale calculated values to variability explained | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== RegisterCurves ==== | + | ==== -RegisterCurves |
| ---- | ---- | ||
| === Parameters === | === Parameters === | ||
| Line 178: | Line 178: | ||
| The name for registered curve group created | The name for registered curve group created | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== CreateGLM ==== | + | ==== -CreateGLM |
| ---- | ---- | ||
| Create a General Linear Model | Create a General Linear Model | ||
| Line 188: | Line 188: | ||
| The grouping used for the model: Workspace / Group \\ | The grouping used for the model: Workspace / Group \\ | ||
| < | < | ||
| - | == Name (Required) == | + | == Name (Required/Default) == |
| The name of the GLM being created | The name of the GLM being created | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== RunSPM ==== | + | ==== -RunSPM |
| ---- | ---- | ||
| Run Statistical Parametric Mapping | Run Statistical Parametric Mapping | ||
| Line 207: | Line 207: | ||
| The name of the SPM being created | The name of the SPM being created | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== RunDTW ==== | + | ==== -RunDTW |
| ---- | ---- | ||
| Run Dynamic Time Warping | Run Dynamic Time Warping | ||
| Line 223: | Line 223: | ||
| ---- | ---- | ||
| - | ==== RunV3D ==== | + | ==== -RunV3D |
| ---- | ---- | ||
| Execute one or more Visual3D pipeline scripts via the V3D Engine, currently this only works if a library has be loaded and a query run | Execute one or more Visual3D pipeline scripts via the V3D Engine, currently this only works if a library has be loaded and a query run | ||
| Line 230: | Line 230: | ||
| A path to a .v3s script file, this parameter can be used more than once to load multiple scripts, the scripts will be executed in the order the are passed | A path to a .v3s script file, this parameter can be used more than once to load multiple scripts, the scripts will be executed in the order the are passed | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== RunPCA ==== | + | ==== -RunPCA |
| ---- | ---- | ||
| Run Principal Component Analysis on all queries | Run Principal Component Analysis on all queries | ||
| === Parameters === | === Parameters === | ||
| - | == Name (Required) == | + | == Name (Required/Default) == |
| The name for the PCA to be created | The name for the PCA to be created | ||
| == numPCs == | == numPCs == | ||
| Line 245: | Line 245: | ||
| If passed PCA will be run on the mean of each workspace and not the individual traces | If passed PCA will be run on the mean of each workspace and not the individual traces | ||
| === Example === | === Example === | ||
| - | < | + | < |
| + | |||
| + | ---- | ||
| + | ==== -ExportPlotSignalTime / -ExportPlotST / -EPST ==== | ||
| + | ---- | ||
| + | Export the selected traces on a signal time plot | ||
| + | === Parameters === | ||
| + | == FilePath (Required/ | ||
| + | The file path the plot will be saved to, pass the desired image extension. Accepted image formats are .png, .pdf, .bmp, and .jpg | ||
| + | == Height == | ||
| + | The height in pixels of the generated plot \\ | ||
| + | < | ||
| + | == Width == | ||
| + | The width in pixels of the generated plot \\ | ||
| + | < | ||
| + | == Title == | ||
| + | The title displayed at the top of the plot | ||
| + | == XLabel == | ||
| + | The label displayed along the X Axis of the plot | ||
| + | == YLabel == | ||
| + | The label displayed along the Y Axis of the plot | ||
| + | == Legend == | ||
| + | Where the legend will be displayed, options are: Top Right, Top Left, Bottom Right, Bottom Left. If this is not passed no legend will be displayed. | ||
| + | == DataStyle == | ||
| + | Which data style type to use when generating the plot, options are: Workspace, Group, Sub Group, Cluster \\ | ||
| + | < | ||
| + | == GroupDispersion == | ||
| + | If passed the group dispersion will be plotted | ||
| + | == GroupDispersionType == | ||
| + | The method of dispersion to plot, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range \\ | ||
| + | < | ||
| + | == GroupMean == | ||
| + | If passed group mean will be plotted | ||
| + | == WorkspaceDispersion == | ||
| + | If passed the workspace dispersion will be plotted | ||
| + | == WorkspaceDispersionType == | ||
| + | The method of dispersion to plot, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range \\ | ||
| + | < | ||
| + | == WorkspaceMean == | ||
| + | If passed workspace mean will be plotted | ||
| + | == XRange == | ||
| + | The range of values displayed on the X Axis of the plot, format: " | ||
| + | == YRange == | ||
| + | The range of values displayed on the Y Axis of the plot, format: " | ||
| + | == RawTraces == | ||
| + | If passed individual traces will be plotted, if no other items are plotted, raw traces will be plotted by default | ||
| + | === Example === | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | |||
| + | ==== -ExportPlotMetric / -ExportPlotM / -EPM ==== | ||
| + | Export the select metrics on a metric plot | ||
| + | === Parameters === | ||
| + | == FilePath (Required/ | ||
| + | The file path the plot will be saved to, pass the desired image extension. Accepted image formats are .png, .pdf, .bmp, and .jpg | ||
| + | == Height == | ||
| + | The height in pixels of the generated plot \\ | ||
| + | < | ||
| + | == Width == | ||
| + | The width in pixels of the generated plot \\ | ||
| + | < | ||
| + | == Title == | ||
| + | The title displayed at the top of the plot | ||
| + | == XLabel == | ||
| + | The label displayed along the X Axis of the plot | ||
| + | == YLabel == | ||
| + | The label displayed along the Y Axis of the plot | ||
| + | == Legend == | ||
| + | Where the legend will be displayed, options are: Top Right, Top Left, Bottom Right, Bottom Left. If this is not passed no legend will be displayed. | ||
| + | == DataStyle == | ||
| + | What data style used when plotting, options are: Workspace, Group, Sub Group, Cluster \\ | ||
| + | < | ||
| + | == RawTraces == | ||
| + | If passed individual traces will be displayed | ||
| + | == GroupMean == | ||
| + | If passed group mean will be plotted | ||
| + | == GroupDispersion == | ||
| + | If passed group dispersion will be plotted | ||
| + | == GroupDispersionType == | ||
| + | The method of dispersion used, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range \\ | ||
| + | < | ||
| + | == WorkspaceMean == | ||
| + | If passed workspace mean will be plotted | ||
| + | == WorkspaceDispersion == | ||
| + | If passed workspace dispersion will be plotted | ||
| + | == WorkspaceDispersionType == | ||
| + | The method of dispersion used, options are: One Standard Deviation, Two Standard Deviations, Interquartile Range \\ | ||
| + | < | ||
| + | == MeanPlotStyle == | ||
| + | Method used for plotting means, options are Bar Chart, Stacked Bar Chart, Box Plot | ||
| + | < | ||
| + | == MetricGrouping == | ||
| + | How should workspace means be grouped, options are No Group, Group, Workspace | ||
| + | < | ||
| + | === Example === | ||
| + | <code> | ||
| ---- | ---- | ||
| - | ==== ExportData ==== | + | ==== -ExportData |
| Export queried data results in an ascii text file | Export queried data results in an ascii text file | ||
| === Parameter === | === Parameter === | ||
| Line 271: | Line 367: | ||
| If passed all time based sequences will be exported | If passed all time based sequences will be exported | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== ExportPCA ==== | + | ==== -ExportPCA ==== |
| ---- | ---- | ||
| Export PCA results to a .txt file | Export PCA results to a .txt file | ||
| Line 303: | Line 399: | ||
| If passed the mean +/- 5 and 95% will be exported | If passed the mean +/- 5 and 95% will be exported | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== ExportSummaryStatistics ==== | + | ==== -ExportSummaryStatistics ==== |
| ---- | ---- | ||
| Export summary statistics to a .txt file | Export summary statistics to a .txt file | ||
| Line 341: | Line 437: | ||
| Export results for: Groups, Workspaces, Instances | Export results for: Groups, Workspaces, Instances | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== ExportRegisteredCurves ==== | + | ==== -ExportRegisteredCurves ==== |
| Export any results of curve registration | Export any results of curve registration | ||
| === Parameters === | === Parameters === | ||
| Line 366: | Line 462: | ||
| If passed warping functions will be exported | If passed warping functions will be exported | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== ExportDTW ==== | + | ==== -ExportDTW ==== |
| ---- | ---- | ||
| Export Dynamic Time Warping results | Export Dynamic Time Warping results | ||
| Line 388: | Line 484: | ||
| If passed all anomalies will be exported | If passed all anomalies will be exported | ||
| === Example === | === Example === | ||
| - | < | + | < |
| ---- | ---- | ||
| - | ==== ExportSPM ==== | + | ==== -ExportSPM ==== |
| ---- | ---- | ||
| Export Statistical Parametric Mapping Results | Export Statistical Parametric Mapping Results | ||
| Line 412: | Line 508: | ||
| If passed the Statistical Parametric Map will be exported | If passed the Statistical Parametric Map will be exported | ||
| === Example === | === Example === | ||
| - | < | + | < |
| + | |||
| + | ---- | ||
| + | ==== -SelectSignals / -sig ==== | ||
| + | ---- | ||
| + | Select all or a selection of Signal groups and workspaces | ||
| + | === Parameters === | ||
| + | == Group == | ||
| + | The name of a group to be selected, this parameter can be passed multiple times to select more than one group, if this parameter is not passed, all groups will be selected | ||
| + | == Workspace == | ||
| + | The name of a workspace to be selected, this parameter can be passed multiple times to select more than one workspace, if this parameter is not passed, all workspaces will be selected | ||
| + | === Example === | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -SelectMetrics / -met ==== | ||
| + | ---- | ||
| + | Select all or a selection of Metric groups and workspaces | ||
| + | === Parameters === | ||
| + | == Group == | ||
| + | The name of a group to be selected, this parameter can be passed multiple times to select more than one group, if this parameter is not passed, all groups will be selected | ||
| + | == Workspace == | ||
| + | The name of a workspace to be selected, this parameter can be passed multiple times to select more than one workspace, if this parameter is not passed, all groups will be selected | ||
| + | === Example === | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -SaveProject / -sv ==== | ||
| + | ---- | ||
| + | Save the currently open project to an .i3d file | ||
| + | === Parameters === | ||
| + | == file (Required/ | ||
| + | The name and path of the .i3d file being saved | ||
| + | === Example === | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -LoadProject / -ld ==== | ||
| + | ---- | ||
| + | Load the passed project file | ||
| + | === Parameters === | ||
| + | == file == | ||
| + | The name and path of the .i3d file being loaded | ||
| + | === Example === | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -ClearProject / -clr ==== | ||
| + | ---- | ||
| + | Clear all data from the current project, no parameters | ||
| + | === Example === | ||
| + | < | ||
sift/command_line.1728500636.txt.gz · Last modified: 2024/10/09 19:03 by sgranger