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 [2025/09/11 16:05] – sgranger | sift:command_line [2025/09/23 18:33] (current) – [-RunSummaryMetrics / -ComputeSummaryMetrics / -SummaryMetrics] wikisysop | ||
|---|---|---|---|
| Line 38: | Line 38: | ||
| - | ===== Library / File Management | + | ===== Command Reference |
| ---- | ---- | ||
| ==== -LoadLib / -l ==== | ==== -LoadLib / -l ==== | ||
| ---- | ---- | ||
| - | Load in a library | + | Search the provided directory and all sub directories for .cmz files and load them into the library |
| === Parameters === | === Parameters === | ||
| - | == Directory | + | __**directory |
| - | Path to the directory | + | A path to the root directory to be searched recursively for .cmzs |
| - | === Example === | + | * **Data Type:** String (Directory) |
| - | < | + | * **Default Value:** N/A |
| + | __**libQuery **__ \\ | ||
| + | The query used to refine the files loaded | ||
| + | * **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 | ||
| + | < | ||
| ---- | ---- | ||
| - | ==== -LoadQuery | + | ==== -LoadQuery / -q ==== |
| ---- | ---- | ||
| - | Load a saved query from a .q3d file | + | Load and calculate |
| === Parameters === | === Parameters === | ||
| - | == File (Required/ | + | __**file |
| - | The path to the .q3d file containing | + | Path to the .q3d containing query definitions |
| - | === Example === | + | * **Data Type:** String (File Path) |
| - | < | + | * **Default Value:** N/A |
| - | + | < | |
| - | ---- | + | |
| - | ==== -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 ==== | ==== -SaveProject / -sv ==== | ||
| ---- | ---- | ||
| - | Save the currently open project | + | Save the current |
| === Parameters === | === Parameters === | ||
| - | == file (Required/ | + | __**file (DEFAULT) (REQUIRED) **__ \\ |
| - | The name and path of the .i3d file being saved | + | The path and name of the file |
| - | === Example === | + | * **Data Type:** String (File Path) |
| - | < | + | * **Default Value:** N/A |
| + | < | ||
| ---- | ---- | ||
| ==== -LoadProject / -ld ==== | ==== -LoadProject / -ld ==== | ||
| ---- | ---- | ||
| - | Load the passed | + | Load a previously saved project |
| === Parameters === | === Parameters === | ||
| - | == file == | + | __**file (DEFAULT) (REQUIRED) **__ \\ |
| - | The name and path of the .i3d file being loaded | + | The path and name of project to be loaded |
| - | === Example === | + | * **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 | ||
| + | < | ||
| ---- | ---- | ||
| ==== -ClearProject / -clr ==== | ==== -ClearProject / -clr ==== | ||
| ---- | ---- | ||
| - | Clear all data from the current | + | Clear and create a new project |
| - | === Example === | + | < |
| - | < | + | |
| - | + | ||
| - | ===== PCA ===== | ||
| ---- | ---- | ||
| ==== -RunPCA / -pca ==== | ==== -RunPCA / -pca ==== | ||
| ---- | ---- | ||
| - | Run Principal | + | Run Principal |
| === Parameters === | === Parameters === | ||
| - | == Name (Required/ | + | __**name |
| - | The name for the PCA to be created | + | The name of the PCA |
| - | == numPCs | + | * **Data Type:** String |
| - | How many principal components | + | * **Default Value:** N/A |
| - | < | + | __**numPCs |
| - | == WorkspaceMean == | + | The number of principal components |
| - | If passed | + | * **Data Type:** Integer |
| - | === Example === | + | * **Default |
| - | < | + | __**workspaceMean **__ \\ |
| + | If passed run PCA on workspace | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| ---- | ---- | ||
| ==== -RunLOF / -lof ==== | ==== -RunLOF / -lof ==== | ||
| ---- | ---- | ||
| - | Run Local Outlier Factor | + | Run Local Outlier Factor |
| === Parameters === | === Parameters === | ||
| - | == AutoExclude == | + | __**autoExclude **__ \\ |
| If passed any outliers found will be excluded automatically | If passed any outliers found will be excluded automatically | ||
| - | == Grouping == | + | * **Data Type:** Boolean (True / False) |
| - | How should data be grouped before | + | * **Default Value:** false |
| - | * Combined Groups: All data points will be compared | + | __**grouping **__ \\ |
| - | * Groups: Data will be compared within groups | + | How should data be grouped before |
| - | * Workspace: Data will be compared within workspaces | + | * **Data Type:** String |
| - | < | + | * **Default Value:** combined group |
| - | == ManualThreshold == | + | * **Options:** combined group, group, workspace |
| - | The threshold to consider when searching for outliers | + | __**manualThreshold **__ \\ |
| - | < | + | The threshold to consider when searching for outliers |
| - | == NumNeighbors == | + | * **Data Type:** Decimal |
| - | How many neighbors should each point be compared to? \\ | + | * **Default |
| - | < | + | __**numNeighbors **__ \\ |
| - | == numPasses | + | How many neighbors should each point be compared to |
| - | How many iterations of the test should be run \\ | + | * **Data Type:** Integer |
| - | < | + | * **Default |
| - | == NumPCs == | + | __**numPasses |
| - | How many principal components should the test be run on \\ | + | How many iterations of the test should be run |
| - | < | + | * **Data Type:** Integer |
| - | == PCsVariance | + | * **Default |
| - | Determine the number | + | __**numPCs **__ \\ |
| - | < | + | How many principal components should the test be run on |
| - | == ScaleToVariability == | + | * **Data Type:** Integer |
| - | If passed scale all calculated values to the variability | + | * **Default |
| - | === Example === | + | __**PCsVariance |
| - | < | + | Determine the numbe of PCs by variance explained |
| + | * **Data Type:** Decimal | ||
| + | * **Default | ||
| + | __**scaleToVariability **__ \\ | ||
| + | Scale all calculated values to the variavility | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| ---- | ---- | ||
| ==== -RunKMeans / -kmeans ==== | ==== -RunKMeans / -kmeans ==== | ||
| ---- | ---- | ||
| - | Run K-Means clustering | + | Run K-Means clustering |
| === Parameters === | === Parameters === | ||
| - | == Clusters == | + | __**clusters **__ \\ |
| - | How many clusters | + | How many clusters |
| - | < | + | * **Data Type:** Integer |
| - | == CustomSeed == | + | * **Default |
| - | If provided use as a seed for the random first centroid (produces repeatable results) | + | __**customSeed **__ \\ |
| - | == Grouping == | + | Provide |
| - | How should data be grouped before | + | * **Data Type:** Integer |
| - | * Combined Groups: All data points will be compared | + | * **Default Value:** 0 |
| - | * Groups: Data will be compared within groups | + | __**grouping **__ \\ |
| - | * Workspaces: Data will be compared within workspaces | + | How should data be grouped before |
| - | < | + | * **Data Type:** String |
| - | == Iterations == | + | * **Default Value:** combined group |
| - | How many iterations of the test should be run \\ | + | * **Options:** combined group, group, workspace |
| - | < | + | __**iterations **__ \\ |
| - | == NumPCs == | + | How many iterations of the test should be run |
| - | The number of principal components to run the test on \\ | + | * **Data Type:** Integer |
| - | < | + | * **Default |
| - | == PCsVariance | + | __**numPCs **__ \\ |
| - | Determine the number of principal components | + | The number of principal components to run the test on |
| - | < | + | * **Data Type:** Integer |
| - | == ScaleToVariability == | + | * **Default |
| - | If passed scale all calculated values to the variability explained by the PC | + | __**PCsVariance |
| - | === Example === | + | Determine the number of PCs by variance explained |
| - | < | + | * **Data Type:** Decimal |
| + | * **Default | ||
| + | __**scaleToVariability **__ \\ | ||
| + | Scale all calculated values to the variability explained by the PC | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| ---- | ---- | ||
| ==== -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 |
| - | == AutoExclude == | + | * **Default Value:** 0.1 |
| - | If passed any outliers will be excluded | + | * **Options: |
| - | == numPCs | + | __**autoExclude **__ \\ |
| - | The number of Principal Components | + | If passed any outliers |
| - | < | + | * **Data Type:** Boolean (True / False) |
| - | == PCsVariance | + | * **Default Value:** false |
| - | scale calculated values to variability explained | + | __**numPCs |
| - | < | + | The number of principal components |
| - | === Example === | + | * **Data Type:** Integer |
| - | < | + | * **Default |
| + | __**PCsVariance | ||
| + | scale calculated values to variability explained | ||
| + | * **Data Type:** Decimal | ||
| + | * **Default | ||
| + | < | ||
| ---- | ---- | ||
| ==== -RunMah / -mah ==== | ==== -RunMah / -mah ==== | ||
| ---- | ---- | ||
| - | Run a Mahalanobis | + | Run Mahalanobis |
| === Parameters === | === Parameters === | ||
| - | == AlphaValue == | + | __**alphaValue **__ \\ |
| - | The 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 |
| - | == AutoExclude == | + | * **Default Value:** 0.1 |
| + | * **Options: | ||
| + | __**autoExclude **__ \\ | ||
| If passed any outliers found will be excluded automatically | If passed any outliers found will be excluded automatically | ||
| - | == Grouping == | + | * **Data Type:** Boolean (True / False) |
| - | How should data be grouped before running: | + | * **Default Value:** false |
| - | * Combined Groups: All data points will be compared | + | __**grouping **__ \\ |
| - | * Groups: Data will be compared within groups | + | How should data be grouped before running |
| - | * Workspace: Data will be compared within workspaces | + | * **Data Type:** String |
| - | < | + | * **Default Value:** combined group |
| - | == NumPasses == | + | * **Options:** combined group, group, workspace |
| - | How many iterations of the test should be run \\ | + | __**numPasses **__ \\ |
| - | < | + | How many iterations of the test should be run |
| - | == NumPCs == | + | * **Data Type:** Integer |
| - | The number of principal components to run the test on \\ | + | * **Default |
| - | < | + | __**numPCs **__ \\ |
| - | == PCsVariance | + | The number of principal components to run the test on |
| - | Determining | + | * **Data Type:** Integer |
| - | < | + | * **Default |
| - | == ScaleToVariance == | + | __**PCsVariance |
| - | If passed | + | Determing |
| - | === Example === | + | * **Data Type:** Decimal |
| - | < | + | * **Default |
| + | __**scaleToVariance **__ \\ | ||
| + | scale calculated values to variability explained | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| - | + | ---- | |
| - | + | ||
| - | ===== Visual3D Engine ===== | + | |
| - | ---- | + | |
| ==== -RunV3D / -s / -plpath ==== | ==== -RunV3D / -s / -plpath ==== | ||
| ---- | ---- | ||
| - | Execute one or more Visual3D pipeline scripts | + | Run pipelines |
| === Parameters === | === Parameters === | ||
| - | == Script | + | __**exportLog **__ \\ |
| - | 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 | + | If passed a processing log will be exported to the file path provided |
| - | === Example === | + | * **Data Type:** String |
| - | < | + | * **Default Value:** NULL |
| + | __**onLib **__ \\ | ||
| + | If passed the scripts will be run on the loaded library | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**script (DEFAULT) (REQUIRED) **__ \\ | ||
| + | A path to the script file, multiple scripts | ||
| + | * **Data Type:** List | ||
| + | * **Default Value:** N/A | ||
| + | < | ||
| ---- | ---- | ||
| ==== -RunV3DCommand / -c ==== | ==== -RunV3DCommand / -c ==== | ||
| ---- | ---- | ||
| - | Run a single V3D pipeline command (Can be use multiple times to execute multiple commands) | + | Run a single V3D pipeline command (Can be used multiple times to execute multiple commands |
| === Parameters === | === Parameters === | ||
| - | == command (Required/ | + | __**command (DEFAULT) (REQUIRED) **__ \\ |
| - | The pipeline command | + | The pipeline command executed |
| - | === Example === | + | * **Data Type:** String |
| - | < | + | * **Default Value:** N/A |
| + | < | ||
| ---- | ---- | ||
| ==== -DirPath ==== | ==== -DirPath ==== | ||
| ---- | ---- | ||
| - | Set a global | + | Set a global |
| === Parameters === | === Parameters === | ||
| - | == path (Required/ | + | __**path (DEFAULT) (REQUIRED) **__ \\ |
| - | The path you want to set the global variable to | + | The path to set |
| - | === Example === | + | * **Data Type:** String (Directory) |
| - | < | + | * **Default Value:** N/A |
| + | < | ||
| + | ---- | ||
| + | ==== -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 | ||
| + | < | ||
| - | ===== SPM ===== | ||
| ---- | ---- | ||
| ==== -RegisterCurves / -rc ==== | ==== -RegisterCurves / -rc ==== | ||
| ---- | ---- | ||
| + | Register time series data to allign certain landmarks / events | ||
| === Parameters === | === Parameters === | ||
| - | == EventSequence == | + | __**eventSequence **__ \\ |
| - | Register | + | Register |
| - | == LocalMax == | + | * **Data Type:** Boolean (True / False) |
| - | Use local maximum | + | * **Default Value:** false |
| - | == LocalMaxLower == | + | __**localMax **__ \\ |
| + | Register by local maximum | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**localMaxLower **__ \\ | ||
| The lower bounds of the local max | The lower bounds of the local max | ||
| - | == LocalMaxUpper == | + | * **Data Type:** Integer |
| + | * **Default Value:** -1 | ||
| + | __**localMaxUpper **__ \\ | ||
| The upper bounds of the local max | The upper bounds of the local max | ||
| - | == LocalMin == | + | * **Data Type:** Integer |
| - | Use the local minimum | + | * **Default Value:** -1 |
| - | == LocalMinLower == | + | __**localMin **__ \\ |
| - | The lower bounds of the local min | + | Register by local minimum |
| - | == LocalMinUpper == | + | * **Data Type:** Boolean (True / False) |
| - | The upper bounds of the local min | + | * **Default Value:** false |
| - | == Max == | + | __**localMinLower **__ \\ |
| + | The lower bounds of the local minimum | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** -1 | ||
| + | __**localMinUpper **__ \\ | ||
| + | The upper bounds of the local minimum | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** -1 | ||
| + | __**max **__ \\ | ||
| Register by maximum | Register by maximum | ||
| - | == Min == | + | * **Data Type:** Boolean (True / False) |
| + | * **Default Value:** false | ||
| + | __**min **__ \\ | ||
| Register by minimum | Register by minimum | ||
| - | == Name == | + | * **Data Type:** Boolean (True / False) |
| - | The name for registered curve group created | + | * **Default Value:** false |
| - | === Example === | + | __**name (DEFAULT) (REQUIRED) **__ \\ |
| - | < | + | The name for the new group created |
| + | * **Data Type:** String | ||
| + | * **Default Value:** N/A | ||
| + | < | ||
| ---- | ---- | ||
| ==== -CreateGLM / -glm ==== | ==== -CreateGLM / -glm ==== | ||
| ---- | ---- | ||
| - | Create a General Linear Model | + | Create a General Linear Model using the selected groups / workspaces |
| === Parameters === | === Parameters === | ||
| - | == Grouping == | + | __**grouping **__ \\ |
| - | The grouping used for the model: | + | The grouping used for the model |
| - | < | + | * **Data Type:** String |
| - | == Name (Required/ | + | * **Default |
| - | The name of the GLM being created | + | * **Options: |
| - | === Example === | + | __**name |
| - | < | + | The name of the GLM |
| + | * **Data Type:** String | ||
| + | * **Default Value:** N/A | ||
| + | __**test **__ \\ | ||
| + | The intended test type for the model | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** two_sample | ||
| + | * **Options: | ||
| + | __**workspaceMeans **__ \\ | ||
| + | If passed use workspace means, instead of the individual traces | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| ---- | ---- | ||
| - | ==== -RunSPM1TTest | + | ==== -RunSPM1ttest |
| ---- | ---- | ||
| - | Run Statistical | + | Run Statistical |
| === Parameters === | === Parameters === | ||
| - | == Name (Required) == | + | __**alpha (REQUIRED) **__ \\ |
| - | The name of the SPM created | + | |
| - | == group (Required) == | + | |
| - | The name of the group to test | + | |
| - | == glm (Required) == | + | |
| - | The name of the GLM to use when creating the SPM | + | |
| - | == alpha (Required) == | + | |
| The alpha value to threshold with | The alpha value to threshold with | ||
| - | == twoTailed | + | * **Data Type:** Decimal |
| + | * **Default Value:** N/A | ||
| + | __**glm (REQUIRED) **__ \\ | ||
| + | The name of the GLM to use when creating the SPM | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** N/A | ||
| + | __**group (REQUIRED) **__ \\ | ||
| + | The name of the group to test | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** N/A | ||
| + | __**name (REQUIRED) **__ \\ | ||
| + | The name of the SPM being created | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** N/A | ||
| + | __**twoTailed | ||
| If two-tailed inference (as opposed to one-tailed) | If two-tailed inference (as opposed to one-tailed) | ||
| - | === Example === | + | * **Data Type:** Boolean (True / False) |
| - | < | + | * **Default Value:** false |
| + | < | ||
| ---- | ---- | ||
| - | ==== -RunSPM2TTest | + | ==== -RunSPM2ttest |
| ---- | ---- | ||
| Run Statistical Parameteric Mapping Two-Sample T-Test | Run Statistical Parameteric Mapping Two-Sample T-Test | ||
| === Parameters === | === Parameters === | ||
| - | == Name (Required) == | + | __**alpha |
| - | The name of the SPM created | + | The alpha value to threshold with |
| - | == group1 (Required) == | + | * **Data Type:** Decimal |
| + | * **Default Value:** N/A | ||
| + | __**glm (REQUIRED) **__ \\ | ||
| + | The name of the GLM to use when creating | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** N/A | ||
| + | __**group1 (REQUIRED) **__ \\ | ||
| The name of the first group to test | The name of the first group to test | ||
| - | == group2 (Required) == | + | * **Data Type:** String |
| + | * **Default Value:** N/A | ||
| + | __**group2 (REQUIRED) **__ \\ | ||
| The name of the second group to test | The name of the second group to test | ||
| - | == glm (Required) == | + | * **Data Type:** String |
| - | The name of the GLM to use when creating | + | * **Default Value:** N/A |
| - | == alpha (Required) == | + | __**name |
| - | The alpha value to threshold with | + | The name of the SPM being created |
| - | == twoTailed | + | * **Data Type:** String |
| - | It two-tailed inference (as opposed to one-tailed) | + | * **Default Value:** N/A |
| - | === Example === | + | __**twoTailed |
| - | < | + | If two-tailed inference (as opposed to one-tailed) |
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| ---- | ---- | ||
| - | ==== -RunSPMPairedTTest | + | ==== -RunSPMpairedttest |
| ---- | ---- | ||
| - | Run Statistical | + | Run Statistical |
| === Parameters === | === Parameters === | ||
| - | == Name (Required) == | + | __**alpha |
| - | The name of the SPM created | + | The alpha value to threshold with |
| - | == group1 (Required) == | + | * **Data Type:** Decimal |
| + | * **Default Value:** N/A | ||
| + | __**glm (REQUIRED) **__ \\ | ||
| + | The name of the GLM to use when creating | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** N/A | ||
| + | __**group1 (REQUIRED) **__ \\ | ||
| The name of the first group to test | The name of the first group to test | ||
| - | == group2 (Required) == | + | * **Data Type:** String |
| + | * **Default Value:** N/A | ||
| + | __**group2 (REQUIRED) **__ \\ | ||
| The name of the second group to test | The name of the second group to test | ||
| - | == glm (Required) == | + | * **Data Type:** String |
| - | The name of the GLM to use when creating | + | * **Default Value:** N/A |
| - | == alpha (Required) == | + | __**name |
| - | The alpha value to threshold with | + | The name of the SPM being created |
| - | == twoTailed | + | * **Data Type:** String |
| - | It two-tailed inference (as opposed to one-tailed) | + | * **Default Value:** N/A |
| - | === Example === | + | __**twoTailed |
| - | < | + | If two-tailed inference (as opposed to one-tailed) |
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| ---- | ---- | ||
| ==== -RunSPMOneWayAnova ==== | ==== -RunSPMOneWayAnova ==== | ||
| - | Run Statistical | + | ---- |
| + | Run Statistical | ||
| === Parameters === | === Parameters === | ||
| - | == Name (Required) == | + | __**alpha |
| - | The name of the SPM being created | + | The alpha value to threshold with |
| - | == glm (Required) == | + | * **Data Type:** Decimal |
| + | * **Default Value:** N/A | ||
| + | __**glm (REQUIRED) **__ \\ | ||
| The name of the GLM to use when creating the SPM | The name of the GLM to use when creating the SPM | ||
| - | == alpha (Required) == | + | * **Data Type:** String |
| - | The Alpha value to threshold with | + | * **Default Value:** N/A |
| - | == twoTailed | + | __**name |
| + | The name of the SPM being created | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** N/A | ||
| + | __**twoTailed | ||
| If two-tailed inference (as opposed to one-tailed) | If two-tailed inference (as opposed to one-tailed) | ||
| - | === Example === | + | * **Data Type:** Boolean (True / False) |
| - | < | + | * **Default Value:** false |
| + | < | ||
| ---- | ---- | ||
| Line 394: | Line 498: | ||
| Run Dynamic Time Warping | Run Dynamic Time Warping | ||
| === Parameters === | === Parameters === | ||
| - | == Name (Required) == | + | __**name |
| The name of the DTW test being run | The name of the DTW test being run | ||
| - | == StandardDeviations == | + | * **Data Type:** String |
| - | How many standard | + | * **Default Value:** N/A |
| - | < | + | __**standardDeviations **__ \\ |
| - | === Example === | + | How many standard |
| - | < | + | * **Data Type:** Integer |
| + | * **Default | ||
| + | * **Options: | ||
| + | < | ||
| + | ---- | ||
| + | ==== -ExportData / -ex ==== | ||
| + | ---- | ||
| + | Export queried data | ||
| + | === Parameters === | ||
| + | __**allSequencesNorm **__ \\ | ||
| + | CommandExport all sequences normalized | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**allSequencesTime **__ \\ | ||
| + | CommandExport all time based sequences | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**eventsNorm **__ \\ | ||
| + | CommandExport all events normalized | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**eventsOrig **__ \\ | ||
| + | CommandExport all time based events | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**exportFormat **__ \\ | ||
| + | What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** standard | ||
| + | * **Options: | ||
| + | __**file (REQUIRED) **__ \\ | ||
| + | Desired path for the text export to be saved | ||
| + | * **Data Type:** String (File Path) | ||
| + | * **Default Value:** N/A | ||
| + | __**groupMean **__ \\ | ||
| + | CommandExport the mean value of each group | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**groupStdDev **__ \\ | ||
| + | CommandExport the standard deviation of each group | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**normalizedTo **__ \\ | ||
| + | Normalize values to... | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** 101 | ||
| + | __**precision **__ \\ | ||
| + | How many decimal places should values be displayed to | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** 4 | ||
| + | __**workspaceMean **__ \\ | ||
| + | CommandExport the mean of each workspace | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**workspaceStdDev **__ \\ | ||
| + | CommandExport the standard deviation of each workspace | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| + | ---- | ||
| + | ==== -ExportSummaryStatistics ==== | ||
| + | ---- | ||
| + | Export summary statistics | ||
| + | === Parameters === | ||
| + | __**addMetrics **__ \\ | ||
| + | Export metrics | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**exportFormat **__ \\ | ||
| + | What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** standard | ||
| + | * **Options: | ||
| + | __**file (REQUIRED) **__ \\ | ||
| + | Desired path for the text export to be saved | ||
| + | * **Data Type:** String (File Path) | ||
| + | * **Default Value:** N/A | ||
| + | __**max **__ \\ | ||
| + | Export the maximum value | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**maxEventPoint **__ \\ | ||
| + | Export the maximum event point | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**maxStdDev **__ \\ | ||
| + | Export the maximum standard deviation | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**mean **__ \\ | ||
| + | Export the mean value | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**meanStdDev **__ \\ | ||
| + | Export the mean standard deviation | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**min **__ \\ | ||
| + | Export the minimum value | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**minEventPoint **__ \\ | ||
| + | Export the minimum event point | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**minStdDev **__ \\ | ||
| + | Export the minimum standard deviation | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**normalizeMetrics **__ \\ | ||
| + | Normalize exported metrics | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**precision **__ \\ | ||
| + | How many decimal places should values be displayed to | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** 4 | ||
| + | __**results **__ \\ | ||
| + | Export results for: Groups, Workspaces, Instances | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** groups | ||
| + | * **Options: | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -ExportRegisteredCurves ==== | ||
| + | ---- | ||
| + | Export results of curve registration | ||
| + | === Parameters === | ||
| + | __**exportFormat **__ \\ | ||
| + | What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** standard | ||
| + | * **Options: | ||
| + | __**file (REQUIRED) **__ \\ | ||
| + | Desired path for the text export to be saved | ||
| + | * **Data Type:** String (File Path) | ||
| + | * **Default Value:** N/A | ||
| + | __**landmarkAll **__ \\ | ||
| + | Export all landmarks | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**landmarkMeans **__ \\ | ||
| + | Export the landmark mean value | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**precision **__ \\ | ||
| + | How many decimal places should values be displayed to | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** 4 | ||
| + | __**registeredCurves **__ \\ | ||
| + | Export registered curves | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**warpingFunctions **__ \\ | ||
| + | Export all warping functions | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -ExportDTW ==== | ||
| + | ---- | ||
| + | Export Dynamic Time Warping results | ||
| + | === Parameters === | ||
| + | __**costFunctions **__ \\ | ||
| + | Export cost functions | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**exportFormat **__ \\ | ||
| + | What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** standard | ||
| + | * **Options: | ||
| + | __**file (REQUIRED) **__ \\ | ||
| + | Desired path for the text export to be saved | ||
| + | * **Data Type:** String (File Path) | ||
| + | * **Default Value:** N/A | ||
| + | __**foundAnomalies **__ \\ | ||
| + | Export all outliers found with dynamic time warping | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**precision **__ \\ | ||
| + | How many decimal places should values be displayed to | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** 4 | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -ExportSPM ==== | ||
| + | ---- | ||
| + | Export Statistical Parameteric Mapping results | ||
| + | === Parameters === | ||
| + | __**bMatrix **__ \\ | ||
| + | Export the B Matrix used | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**exportFormat **__ \\ | ||
| + | What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** standard | ||
| + | * **Options: | ||
| + | __**file (REQUIRED) **__ \\ | ||
| + | Desired path for the text export to be saved | ||
| + | * **Data Type:** String (File Path) | ||
| + | * **Default Value:** N/A | ||
| + | __**precision **__ \\ | ||
| + | How many decimal places should values be displayed to | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** 4 | ||
| + | __**residualMatrix **__ \\ | ||
| + | Export the residual matrix | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**spm **__ \\ | ||
| + | Export the statistical parameteric map | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -ExportPCA ==== | ||
| + | ---- | ||
| + | Export Principal Component Analysis results | ||
| + | === Parameters === | ||
| + | __**eigenVectors **__ \\ | ||
| + | Export the eigen vectors | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**exportFormat **__ \\ | ||
| + | What format should be exported: Standard ASCII, Transposed ASCII, SPSS ASCII, P2D | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** standard | ||
| + | * **Options: | ||
| + | __**file (REQUIRED) **__ \\ | ||
| + | Desired path for the text export to be saved | ||
| + | * **Data Type:** String (File Path) | ||
| + | * **Default Value:** N/A | ||
| + | __**groupScores **__ \\ | ||
| + | Export group scores | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**groupStdDev **__ \\ | ||
| + | Export group standard deviation | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**kMeans **__ \\ | ||
| + | Export K-Means results | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**lof **__ \\ | ||
| + | Export local outlier factor results | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**lofThreshold **__ \\ | ||
| + | Export threshould to determine an LOF outlier | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**mahDis **__ \\ | ||
| + | Export the mahalanobis distance results | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**mahDisThreshold **__ \\ | ||
| + | Export the threshold used to determine a mahalanobis distance outlier | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**mean595 **__ \\ | ||
| + | Export the mean plus or minus 5 and 95% | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**meanSD **__ \\ | ||
| + | Export the mean plus or minus one standard deviation | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**precision **__ \\ | ||
| + | How many decimal places should values be displayed to | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** 4 | ||
| + | __**spe **__ \\ | ||
| + | Export squared prediction error results | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**speThreshold **__ \\ | ||
| + | Export the threshold to determine an SPE outlier | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**varianceExplained **__ \\ | ||
| + | Export the variance explained | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**workspaceScores **__ \\ | ||
| + | Export workspace scores | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| - | ===== Exports ====== | ||
| ---- | ---- | ||
| ==== -ExportPlotSignalTime / -ExportPlotST / -EPST ==== | ==== -ExportPlotSignalTime / -ExportPlotST / -EPST ==== | ||
| ---- | ---- | ||
| - | Export | + | Export a signal time plot using the currently selected groups / workspaces |
| === Parameters === | === Parameters === | ||
| - | == FilePath (Required/ | + | __**dataStyle **__ \\ |
| - | The file path the plot will be saved to, pass the desired image extension. Accepted image formats are .png, .pdf, .bmp, and .jpg | + | The data style to use when generating plot. |
| - | == Height == | + | * **Data Type:** String |
| - | The height in pixels of the generated plot \\ | + | * **Default Value:** Workspace |
| - | < | + | * **Options: |
| - | == Width == | + | __**filePath (DEFAULT) (REQUIRED) **__ \\ |
| - | The width in pixels of the generated plot \\ | + | The file path the plot will be saved to. |
| - | < | + | * **Data Type:** String (File Path) |
| - | == Title == | + | * **Default |
| - | The title displayed at the top of the plot | + | __**groupDispersion **__ \\ |
| - | == XLabel == | + | If passed group dispersion will be plotted |
| - | The label displayed along the X Axis of the plot | + | * **Data Type:** Boolean (True / False) |
| - | == YLabel == | + | * **Default Value:** false |
| - | The label displayed along the Y Axis of the plot | + | __**groupDispersionType **__ \\ |
| - | == Legend == | + | The type of dispersion to be displayed for groups |
| - | 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. | + | * **Data Type:** String |
| - | == DataStyle == | + | * **Default Value:** One Standard Deviation |
| - | Which data style type to use when generating | + | * **Options: |
| - | < | + | __**groupMean **__ \\ |
| - | == GroupDispersion == | + | |
| - | If passed | + | |
| - | == GroupDispersionType == | + | |
| - | The method | + | |
| - | < | + | |
| - | == GroupMean == | + | |
| If passed group mean will be plotted | If passed group mean will be plotted | ||
| - | == WorkspaceDispersion == | + | * **Data Type:** Boolean (True / False) |
| - | If passed the workspace dispersion will be plotted | + | * **Default Value:** false |
| - | == WorkspaceDispersionType == | + | __**height **__ \\ |
| - | The method | + | The height of the image exported. |
| - | < | + | * **Data Type:** Integer |
| - | == WorkspaceMean == | + | * **Default Value:** 1000 |
| + | __**legend **__ \\ | ||
| + | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** NULL | ||
| + | * **Options: | ||
| + | __**rawTraces **__ \\ | ||
| + | If passed | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**title **__ \\ | ||
| + | The title of the plot. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**width **__ \\ | ||
| + | The width of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**workspaceDispersion **__ \\ | ||
| + | If passed | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**workspaceDispersionType **__ \\ | ||
| + | The type of dispersion to be displayed for workspaces | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** One Standard Deviation | ||
| + | * **Options: | ||
| + | __**workspaceMean **__ \\ | ||
| If passed workspace mean will be plotted | If passed workspace mean will be plotted | ||
| - | == XRange | + | * **Data Type:** Boolean (True / False) |
| - | The range of values displayed on the X Axis of the plot, format: "min,max" | + | * **Default Value:** false |
| - | == YRange | + | __**xLabel **__ \\ |
| - | The range of values displayed on the Y Axis of the plot, format: "min,max" | + | Label for the X-Axis. |
| - | == RawTraces == | + | * **Data Type:** String |
| - | If passed individual traces will be plotted, if no other items are plotted, raw traces will be plotted by default | + | * **Default Value:** ### |
| - | === Example === | + | __**XRange |
| - | < | + | The display |
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**yLabel **__ \\ | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange | ||
| + | The display | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| ---- | ---- | ||
| ==== -ExportPlotMetric / -ExportPlotM / -EPM ==== | ==== -ExportPlotMetric / -ExportPlotM / -EPM ==== | ||
| ---- | ---- | ||
| - | Export | + | Export a metric plot using the currently selected groups / workspaces |
| === Parameters === | === Parameters === | ||
| - | == FilePath (Required/Default) | + | __**dataStyle **__ \\ |
| - | The file path the plot will be saved to, pass the desired image extension. Accepted image formats are .png, .pdf, .bmp, and .jpg | + | The data style to use when generating plot. |
| - | == Height == | + | * **Data Type:** String |
| - | The height in pixels of the generated plot \\ | + | * **Default |
| - | < | + | * **Options: |
| - | == Width == | + | __**filePath (DEFAULT) (REQUIRED) **__ \\ |
| - | The width in pixels | + | The file path the plot will be saved to. |
| - | < | + | * **Data Type:** String (File Path) |
| - | == Title == | + | * **Default Value:** N/A |
| - | The title displayed at the top of the plot | + | __**groupDispersion **__ \\ |
| - | == XLabel == | + | If passed group dispersion will be plotted |
| - | The label displayed along the X Axis of the plot | + | * **Data Type:** Boolean (True / False) |
| - | == YLabel == | + | * **Default |
| - | The label displayed along the Y Axis of the plot | + | __**groupDispersionType **__ \\ |
| - | == Legend == | + | The type of dispersion to be displayed for groups |
| - | Where the legend | + | * **Data Type:** String |
| - | === Example === | + | * **Default Value:** One Standard Deviation |
| - | < | + | * **Options: |
| + | __**groupMean **__ \\ | ||
| + | If passed group mean will be plotted | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default | ||
| + | __**height **__ \\ | ||
| + | The height | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**legend **__ \\ | ||
| + | Which corner should | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** NULL | ||
| + | * **Options: | ||
| + | __**meanPlotStyle **__ \\ | ||
| + | How should means be displayed | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** Bar Chart | ||
| + | * **Options: | ||
| + | __**metricGrouping **__ \\ | ||
| + | How should workspace means be grouped? | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** No Group | ||
| + | * **Options: | ||
| + | __**rawTraces **__ \\ | ||
| + | If passed indivdual traces will be plotted | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**title **__ \\ | ||
| + | The title of the plot. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**width **__ \\ | ||
| + | The width of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**workspaceDispersion **__ \\ | ||
| + | If passed | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**workspaceDispersionType **__ \\ | ||
| + | The type of dispersion to be displayed | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** One Standard Deviation | ||
| + | * **Options: | ||
| + | __**workspaceMean **__ \\ | ||
| + | If passed workspace mean will be plotted | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**xLabel **__ \\ | ||
| + | Label for the X-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**XRange **__ \\ | ||
| + | The display range of the X Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**yLabel **__ \\ | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange **__ \\ | ||
| + | The display range of the Y Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| ---- | ---- | ||
| ==== -ExportPlotPairSignal / -ExportPlotPS / -EPPS ==== | ==== -ExportPlotPairSignal / -ExportPlotPS / -EPPS ==== | ||
| ---- | ---- | ||
| - | Export | + | Export a Signal Signal plot using the currently selected groups / workspaces |
| === Parameters === | === Parameters === | ||
| - | == filePath (Required) == | + | __**dataStyle |
| - | The path to the desired export location | + | The data style to use when generating plot. |
| - | == pair (Required) == | + | * **Data Type:** String |
| - | Add a pair of two groups, seperate group names with ' | + | * **Default Value:** Workspace |
| - | == dataStyle | + | * **Options:** Workspace, Group, Sub Group, Cluster |
| - | The data style to use when generating | + | __**filePath (DEFAULT) (REQUIRED) **__ \\ |
| - | == groupDispersion | + | The file path the plot will be saved to. |
| + | * **Data Type:** String (File Path) | ||
| + | * **Default Value:** N/A | ||
| + | __**groupDispersion | ||
| If passed group dispersion will be plotted | If passed group dispersion will be plotted | ||
| - | == groupDispersionType | + | * **Data Type:** Boolean (True / False) |
| + | * **Default Value:** false | ||
| + | __**groupDispersionType | ||
| The type of dispersion to be displayed for groups | The type of dispersion to be displayed for groups | ||
| - | == groupMean | + | * **Data Type:** String |
| - | If passed | + | * **Default Value:** One Standard Deviation |
| - | == height | + | * **Options: |
| - | The height | + | __**groupMean |
| - | == legend | + | If passed group mean will be plotted |
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**height | ||
| + | The height of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**legend | ||
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| - | == rawTraces | + | * **Data Type:** String |
| - | If passed | + | * **Default Value:** NULL |
| - | == title == | + | * **Options: |
| - | The title of the plot | + | __**pair (REQUIRED) **__ \\ |
| - | == width == | + | Add a pair of two groups, seperare group names with ' |
| - | The width in pixels | + | * **Data Type:** List |
| - | == workspaceDispersion | + | * **Default Value:** N/A |
| - | If passed | + | __**rawTraces |
| - | == workspaceDispersionType | + | If passed |
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**title **__ \\ | ||
| + | The title of the plot. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**width **__ \\ | ||
| + | The width of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**workspaceDispersion | ||
| + | If passed workspace dispersion will be plotted | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**workspaceDispersionType | ||
| The type of dispersion to be displayed for workspaces | The type of dispersion to be displayed for workspaces | ||
| - | == workspaceMean | + | * **Data Type:** String |
| + | * **Default Value:** One Standard Deviation | ||
| + | * **Options: | ||
| + | __**workspaceMean | ||
| If passed workspace mean will be plotted | If passed workspace mean will be plotted | ||
| - | == xLabel | + | * **Data Type:** Boolean (True / False) |
| - | Label for the X Axis | + | * **Default Value:** false |
| - | == xRange == | + | __**xLabel |
| - | The display range of the X Axis: "High,Low" | + | Label for the X-Axis. |
| - | == yLabel | + | * **Data Type:** String |
| - | Label for the Y Axis | + | * **Default Value:** ### |
| - | == yRange == | + | __**XRange **__ \\ |
| - | The display range of the Y Axis: "High,Low" | + | The display range of the X Axis: "Max,Min" |
| - | === Example === | + | * **Data Type:** String |
| - | < | + | * **Default Value:** ### |
| + | __**yLabel | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange **__ \\ | ||
| + | The display range of the Y Axis: "Max,Min" | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| ---- | ---- | ||
| ==== -ExportPlotPairMetric / -ExportPlotPM / -EPPM ==== | ==== -ExportPlotPairMetric / -ExportPlotPM / -EPPM ==== | ||
| ---- | ---- | ||
| - | Export | + | Export a Metric Metric plot using the currently selected groups / workspaces |
| === Parameters === | === Parameters === | ||
| - | == dataStyle | + | __**dataStyle |
| - | The data style to use when generating plot | + | The data style to use when generating plot. |
| - | == filePath | + | * **Data Type:** String |
| - | The file path the plot will be saved to | + | * **Default Value:** Workspace |
| - | == groupDispersion | + | * **Options: |
| + | __**filePath | ||
| + | The file path the plot will be saved to. | ||
| + | * **Data Type:** String (File Path) | ||
| + | * **Default Value:** N/A | ||
| + | __**groupDispersion | ||
| If passed group dispersion will be plotted | If passed group dispersion will be plotted | ||
| - | == groupDispersionType | + | * **Data Type:** Boolean (True / False) |
| + | * **Default Value:** false | ||
| + | __**groupDispersionType | ||
| The type of dispersion to be displayed for groups | The type of dispersion to be displayed for groups | ||
| - | == groupMean | + | * **Data Type:** String |
| + | * **Default Value:** One Standard Deviation | ||
| + | * **Options: | ||
| + | __**groupMean | ||
| If passed group mean will be plotted | If passed group mean will be plotted | ||
| - | == height | + | * **Data Type:** Boolean (True / False) |
| - | The height | + | * **Default Value:** false |
| - | == jitterX | + | __**height |
| - | The random offset of each pointer | + | The height of the image exported. |
| - | == JitterY == | + | * **Data Type:** Integer |
| + | * **Default Value:** 1000 | ||
| + | __**jitterX | ||
| + | The random offset of each point on the X Axis | ||
| + | * **Data Type:** Decimal | ||
| + | * **Default Value:** 0 | ||
| + | __**jitterY **__ \\ | ||
| The random offset of each pointer on the Y Axis | The random offset of each pointer on the Y Axis | ||
| - | == Legend == | + | * **Data Type:** Decimal |
| + | * **Default Value:** 0 | ||
| + | __**legend **__ \\ | ||
| Which corner should the legend be displayed in, if not passed no legend will be displayed | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| - | == Pair == | + | * **Data Type:** String |
| - | Add a pair of two groups, | + | * **Default Value:** NULL |
| - | == rawTraces | + | * **Options: |
| - | If passed | + | __**pair (REQUIRED) **__ \\ |
| - | == title == | + | Add a pair of two groups, |
| - | The title of the plot | + | * **Data Type:** List |
| - | == width == | + | * **Default Value:** N/A |
| - | The width in pixels | + | __**rawTraces |
| - | == workspaceDispersion | + | If passed |
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**title **__ \\ | ||
| + | The title of the plot. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**width **__ \\ | ||
| + | The width of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**workspaceDispersion | ||
| If passed workspace dispersion will be plotted | If passed workspace dispersion will be plotted | ||
| - | == workspaceDispersionType | + | * **Data Type:** Boolean (True / False) |
| - | The type of dispersion to be displayed for the workspaces | + | * **Default Value:** false |
| - | == workspaceMean | + | __**workspaceDispersionType |
| + | The type of dispersion to be displayed for workspaces | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** One Standard Deviation | ||
| + | * **Options: | ||
| + | __**workspaceMean | ||
| If passed workspace mean will be plotted | If passed workspace mean will be plotted | ||
| - | == xLabel | + | * **Data Type:** Boolean (True / False) |
| - | Label for the X-Axis | + | * **Default Value:** false |
| - | == xRange == | + | __**xLabel |
| - | The display range of the X-Axis: "High,Low" | + | Label for the X-Axis. |
| - | == yLabel | + | * **Data Type:** String |
| - | Label for the Y-Axis | + | * **Default Value:** ### |
| - | == yRange == | + | __**XRange **__ \\ |
| - | The display range of the Y Axis: "High,Low" | + | The display range of the X Axis: "Max,Min" |
| - | === Example === | + | * **Data Type:** String |
| - | < | + | * **Default Value:** ### |
| + | __**yLabel | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange **__ \\ | ||
| + | The display range of the Y Axis: "Max,Min" | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| ---- | ---- | ||
| - | ==== -ExportPlotSPM / -EPSPM ==== | + | ==== -ExportPlotSPM / -EPSPM ==== |
| ---- | ---- | ||
| - | Export the active | + | Export the current |
| === Parameters === | === Parameters === | ||
| - | == FilePath (Required/Default) | + | __**dataStyle **__ \\ |
| - | The file path the plot will be saved to, pass the desired | + | The data style to use when generating plot. |
| - | == Height == | + | * **Data Type:** String |
| - | The height in pixels | + | * **Default |
| - | < | + | * **Options: |
| - | == Width == | + | __**filePath (DEFAULT) (REQUIRED) **__ \\ |
| - | The width in pixels | + | The file path the plot will be saved to. |
| - | < | + | * **Data Type:** String (File Path) |
| - | == Title == | + | * **Default Value:** N/A |
| - | The title displayed at the top of the plot | + | __**height **__ \\ |
| - | == XLabel == | + | The height of the image exported. |
| - | The label displayed along the X Axis of the plot | + | * **Data Type:** Integer |
| - | == YLabel == | + | * **Default Value:** 1000 |
| - | The label displayed along the Y Axis of the plot | + | __**legend **__ \\ |
| - | == Legend == | + | Which corner should the legend be displayed in, if not passed no legend will be displayed |
| - | 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. | + | * **Data Type:** String |
| - | == DataStyle == | + | * **Default Value:** NULL |
| - | What data style used when plotting, options are: Workspace, Group, Sub Group, Cluster \\ | + | * **Options: |
| - | === Example === | + | __**title **__ \\ |
| - | < | + | The title of the plot. |
| + | * **Data Type:** String | ||
| + | * **Default | ||
| + | __**width **__ \\ | ||
| + | The width of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default | ||
| + | __**xLabel **__ \\ | ||
| + | Label for the X-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**XRange **__ \\ | ||
| + | The display range of the X Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**yLabel **__ \\ | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange **__ \\ | ||
| + | The display range of the Y Axis: "Max,Min" | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| ---- | ---- | ||
| ==== -ExportPlotResiduals / -ExportPlotR / -EPR ==== | ==== -ExportPlotResiduals / -ExportPlotR / -EPR ==== | ||
| ---- | ---- | ||
| - | Export the active | + | Export the current |
| === Parameters === | === Parameters === | ||
| - | == dataStyle | + | __**dataStyle |
| - | The data style to use when generating plot | + | The data style to use when generating plot. |
| - | == filePath | + | * **Data Type:** String |
| - | The file path the plot will be saved to | + | * **Default Value:** Workspace |
| - | == height | + | * **Options: |
| - | The height | + | __**filePath |
| - | == legend | + | The file path the plot will be saved to. |
| - | Which corner should the legend be displayed in, if not passed no legend will be displayed, Options: Top Left, Top Right, Bottom Left, Bottom Right | + | * **Data Type:** String (File Path) |
| - | == title == | + | * **Default Value:** N/A |
| - | The title of the plot | + | __**height |
| - | == width == | + | The height of the image exported. |
| - | The width in pixels | + | * **Data Type:** Integer |
| - | == xLabel | + | * **Default Value:** 1000 |
| - | Label for the X-Axis | + | __**legend |
| - | == xRange == | + | Which corner should the legend be displayed in, if not passed no legend will be displayed |
| - | The display range of the X Axis: "High,Low" | + | * **Data Type:** String |
| - | == yLabel | + | * **Default Value:** NULL |
| - | Label for the Y-Axis | + | * **Options:** , Top Left, Top Right, Bottom Left, Bottom Right |
| - | == yRange == | + | __**title **__ \\ |
| - | The display range of the Y Axis: "High,Low" | + | The title of the plot. |
| - | === Example === | + | * **Data Type:** String |
| - | < | + | * **Default Value:** ### |
| + | __**width **__ \\ | ||
| + | The width of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**xLabel | ||
| + | Label for the X-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**XRange **__ \\ | ||
| + | The display range of the X Axis: "Max,Min" | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**yLabel | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange **__ \\ | ||
| + | The display range of the Y Axis: "Max,Min" | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| ---- | ---- | ||
| - | ==== -ExportData | + | ==== -ExportPlotB |
| ---- | ---- | ||
| - | Export queried data results in an ascii text file | + | |
| - | === Parameter | + | === Parameters |
| - | == File (Required) == | + | __**dataStyle **__ \\ |
| - | The path and name of the .txt file to export | + | The data style to use when generating plot. |
| - | == Precision == | + | * **Data Type:** String |
| - | How many decimal places to display in exported values \\ | + | * **Default Value:** Workspace |
| - | < | + | * **Options: |
| - | == ExportFormat == | + | __**filePath |
| - | The format | + | The file path the plot will be saved to. |
| - | < | + | * **Data Type:** String (File Path) |
| - | == NormalizedTo == | + | * **Default |
| - | Number | + | __**height **__ \\ |
| - | < | + | The height |
| - | == GroupMean == | + | * **Data Type:** Integer |
| - | If passed | + | * **Default Value:** 1000 |
| - | == GroupStdDev == | + | __**legend **__ \\ |
| - | If passed | + | Which corner should the legend be displayed in, if not passed no legend will be displayed |
| - | == AllSequencesNorm == | + | * **Data Type:** String |
| - | If passed all normalized sequences will be exported | + | * **Default Value:** NULL |
| - | == AllSequencesTime == | + | * **Options: |
| - | If passed all time based sequences will be exported | + | __**title **__ \\ |
| - | === Example === | + | The title of the plot. |
| - | < | + | * **Data Type:** String |
| + | * **Default | ||
| + | __**width **__ \\ | ||
| + | The width of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**xLabel **__ \\ | ||
| + | Label for the X-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default | ||
| + | __**XRange **__ \\ | ||
| + | The display range of the X Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**yLabel **__ \\ | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange **__ \\ | ||
| + | The display range of the Y Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| ---- | ---- | ||
| - | ==== -ExportPCA | + | ==== -ExportPlotVarianceExplained / -ExportPlotVE / -EPVE ==== |
| ---- | ---- | ||
| - | Export | + | Export |
| - | === Parameter | + | === Parameters |
| - | == File (Required) == | + | __**dataStyle **__ \\ |
| - | The path and name of the .txt file to export | + | The data style to use when generating plot. |
| - | == Precision == | + | * **Data Type:** String |
| - | How many decimal places to display in exported values \\ | + | * **Default Value:** Workspace |
| - | < | + | * **Options: |
| - | == ExportFormat == | + | __**filePath |
| - | The format | + | The file path the plot will be saved to. |
| - | < | + | * **Data Type:** String (File Path) |
| - | == ExportFormat == | + | * **Default |
| - | The format | + | __**height **__ \\ |
| - | == WorkspaceScores == | + | The height |
| - | If passed the workspace scores will be exported | + | * **Data Type:** Integer |
| - | == GroupScores == | + | * **Default Value:** 1000 |
| - | If passed | + | __**legend **__ \\ |
| - | == GroupStdDev == | + | Which corner should the legend be displayed in, if not passed no legend will be displayed |
| - | If passed the group standard deviation will be exported | + | * **Data Type:** String |
| - | == VarianceExplained == | + | * **Default Value:** NULL |
| - | If passed | + | * **Options: |
| - | == EigenVectors == | + | __**title **__ \\ |
| - | If passed all eigen vectors will be exported | + | The title of the plot. |
| - | == MeanSD == | + | * **Data Type:** String |
| - | If passed | + | * **Default |
| - | == Mean595 == | + | __**width **__ \\ |
| - | If passed | + | The width of the image exported. |
| - | === Example === | + | * **Data Type:** Integer |
| - | < | + | * **Default Value:** 1000 |
| + | __**xLabel **__ \\ | ||
| + | Label for the X-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**XRange **__ \\ | ||
| + | The display range of the X Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**yLabel **__ \\ | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange **__ \\ | ||
| + | The display range of the Y Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| ---- | ---- | ||
| - | ==== -ExportSummaryStatistics | + | ==== -ExportPlotLoadingVector / -ExportPlotLV / -EPLV ==== |
| ---- | ---- | ||
| - | Export | + | Export |
| === Parameters === | === Parameters === | ||
| - | == File (Required) == | + | __**dataStyle **__ \\ |
| - | The path and name of the .txt file to export | + | The data style to use when generating plot. |
| - | == Precision == | + | * **Data Type:** String |
| - | How many decimal places to display in exported values | + | * **Default Value:** Workspace |
| - | < | + | * **Options: |
| - | == ExportFormat == | + | __**filePath |
| - | The format | + | The file path the plot will be saved to. |
| - | < | + | * **Data Type:** String (File Path) |
| - | == ExportFormat == | + | * **Default Value:** N/A |
| - | The format | + | __**flipPC **__ \\ |
| - | == Max == | + | If passed, invert PC |
| - | If passed | + | * **Data Type:** Boolean (True / False) |
| - | == MaxEventPoint == | + | * **Default |
| - | If passed the maximum event point will be exported | + | __**height **__ \\ |
| - | == MaxStdDev == | + | The height |
| - | If passed | + | * **Data Type:** Integer |
| - | == Mean == | + | * **Default Value:** 1000 |
| - | If passed the mean value will be exported | + | __**legend **__ \\ |
| - | == MeanStdDev == | + | Which corner should the legend be displayed in, if not passed no legend will be displayed |
| - | If passed | + | * **Data Type:** String |
| - | == Min == | + | * **Default Value:** NULL |
| - | If passed the the minimum value will be exported | + | * **Options: |
| - | == MinEventPoint == | + | __**pcNumber **__ \\ |
| - | If passed the minimum event point will be exported | + | The principal component to plot. |
| - | == MinStdDev == | + | * **Data Type:** Integer |
| - | If passed | + | * **Default |
| - | == NormalizeMetrics == | + | __**title **__ \\ |
| - | Normalize exported metrics | + | The title of the plot. |
| - | == Results == | + | * **Data Type:** String |
| - | Export results for: Groups, Workspaces, Instances | + | * **Default Value:** ### |
| - | === Example === | + | __**width **__ \\ |
| - | < | + | The width of the image exported. |
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**xLabel **__ \\ | ||
| + | Label for the X-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**XRange **__ \\ | ||
| + | The display range of the X Axis: "Max,Min" | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**yLabel **__ \\ | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange **__ \\ | ||
| + | The display range of the Y Axis: "Max,Min" | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| ---- | ---- | ||
| - | ==== -ExportRegisteredCurves | + | ==== -ExportPlotWorkspaceScores / -ExportPlotWS / -EPWS ==== |
| ---- | ---- | ||
| - | Export | + | Export |
| === Parameters === | === Parameters === | ||
| - | == File (Required) == | + | __**dataStyle **__ \\ |
| - | The path and name of the .txt file to export | + | The data style to use when generating plot. |
| - | == Precision == | + | * **Data Type:** String |
| - | How many decimal places to display in exported values \\ | + | * **Default Value:** Workspace |
| - | < | + | * **Options: |
| - | == ExportFormat == | + | __**filePath |
| - | The format | + | The file path the plot will be saved to. |
| - | < | + | * **Data Type:** String (File Path) |
| - | == ExportFormat == | + | * **Default |
| - | The format | + | __**height **__ \\ |
| - | == LandmarkAll == | + | The height |
| - | If passed all landmarks will be exported | + | * **Data Type:** Integer |
| - | == LandmarkMeans == | + | * **Default Value:** 1000 |
| - | If passed | + | __**legend **__ \\ |
| - | == RegisteredCurves == | + | Which corner should the legend be displayed in, if not passed no legend will be displayed |
| - | If passed registered curves will be exported | + | * **Data Type:** String |
| - | == WarpingFunctions == | + | * **Default Value:** NULL |
| - | If passed warping functions will be exported | + | * **Options: |
| - | === Example === | + | __**normalizeScores **__ \\ |
| - | < | + | If passed workspace scores will be normalized |
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default | ||
| + | __**title **__ \\ | ||
| + | The title of the plot. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**width **__ \\ | ||
| + | The width of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**XAxisPC **__ \\ | ||
| + | Principal Component represented on the X Axis | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1 | ||
| + | __**xLabel **__ \\ | ||
| + | Label for the X-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**XRange **__ \\ | ||
| + | The display range of the X Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YAxisPC **__ \\ | ||
| + | Prinicipal Component represented on the Y Axis | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 2 | ||
| + | __**yLabel **__ \\ | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange **__ \\ | ||
| + | The display range of the Y Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| ---- | ---- | ||
| - | ==== -ExportDTW | + | ==== -ExportPlotGroupScores / -ExportPlotGS / -EPGS ==== |
| ---- | ---- | ||
| - | Export | + | Export |
| === Parameters === | === Parameters === | ||
| - | == File (Required) == | + | __**dataStyle **__ \\ |
| - | The path and name of the .txt file to export | + | The data style to use when generating plot. |
| - | == Precision == | + | * **Data Type:** String |
| - | How many decimal places to display in exported values \\ | + | * **Default Value:** Workspace |
| - | < | + | * **Options: |
| - | == ExportFormat == | + | __**filePath |
| - | The format | + | The file path the plot will be saved to. |
| - | < | + | * **Data Type:** String (File Path) |
| - | == ExportFormat == | + | * **Default |
| - | The format | + | __**height **__ \\ |
| - | == CostFunctions == | + | The height |
| - | If passed cost functions will be exported | + | * **Data Type:** Integer |
| - | == FoundAnomalies == | + | * **Default Value:** 1000 |
| - | If passed all anomalies will be exported | + | __**legend **__ \\ |
| - | === Example === | + | Which corner should the legend be displayed in, if not passed no legend will be displayed |
| - | < | + | * **Data Type:** String |
| + | * **Default Value:** NULL | ||
| + | * **Options: | ||
| + | __**title **__ \\ | ||
| + | The title of the plot. | ||
| + | * **Data Type:** String | ||
| + | * **Default | ||
| + | __**width **__ \\ | ||
| + | The width of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**xLabel **__ \\ | ||
| + | Label for the X-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**XRange **__ \\ | ||
| + | The display range of the X Axis: "Max,Min" | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**yLabel **__ \\ | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange **__ \\ | ||
| + | The display range of the Y Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| ---- | ---- | ||
| - | ==== -ExportSPM | + | ==== -ExportPlotReconstruction / -ExportPlotR / -EPR ==== |
| ---- | ---- | ||
| - | Export | + | Export |
| === Parameters === | === Parameters === | ||
| - | == File (Required) == | + | __**dataStyle **__ \\ |
| - | The path and name of the .txt file to export | + | The data style to use when generating plot. |
| - | == Precision == | + | * **Data Type:** String |
| - | How many decimal places | + | * **Default Value:** Workspace |
| - | < | + | * **Options: |
| - | == ExportFormat == | + | __**filePath |
| - | The format | + | The file path the plot will be saved to. |
| - | < | + | * **Data Type:** String (File Path) |
| - | == ExportFormat == | + | * **Default Value:** N/A |
| - | The format | + | __**group **__ \\ |
| - | == BMatrix == | + | What group to reconstruct, |
| - | If passed | + | * **Data Type:** List |
| - | == ResidualMatrix == | + | * **Default Value:** NULL |
| - | If passed | + | __**groupMean **__ \\ |
| - | == SPM == | + | If passed group mean will be plotted |
| - | If passed | + | * **Data Type:** Boolean (True / False) |
| - | === Example === | + | * **Default |
| - | < | + | __**height **__ \\ |
| + | The height | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**legend **__ \\ | ||
| + | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** NULL | ||
| + | * **Options: | ||
| + | __**pc **__ \\ | ||
| + | What PCs to reconstruct, | ||
| + | * **Data Type:** List | ||
| + | * **Default | ||
| + | __**title **__ \\ | ||
| + | The title of the plot. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**width **__ \\ | ||
| + | The width of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**workspace **__ \\ | ||
| + | What workspace to reconstruct, pass multiple times to select multiple workspaces, do not pass to select all | ||
| + | * **Data Type:** List | ||
| + | * **Default Value:** NULL | ||
| + | __**xLabel **__ \\ | ||
| + | Label for the X-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**XRange **__ \\ | ||
| + | The display range of the X Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**yLabel **__ \\ | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange **__ \\ | ||
| + | The display range of the Y Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| + | ---- | ||
| + | ==== -ExportPlotExtreme / -ExportPlotE / -EPE ==== | ||
| + | ---- | ||
| + | Export the current PCAs extreme plot | ||
| + | === Parameters === | ||
| + | __**dataStyle **__ \\ | ||
| + | The data style to use when generating plot. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** Workspace | ||
| + | * **Options: | ||
| + | __**filePath (DEFAULT) (REQUIRED) **__ \\ | ||
| + | The file path the plot will be saved to. | ||
| + | * **Data Type:** String (File Path) | ||
| + | * **Default Value:** N/A | ||
| + | __**height **__ \\ | ||
| + | The height of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**legend **__ \\ | ||
| + | Which corner should the legend be displayed in, if not passed no legend will be displayed | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** NULL | ||
| + | * **Options: | ||
| + | __**pcNumber **__ \\ | ||
| + | |||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1 | ||
| + | __**plotType **__ \\ | ||
| + | |||
| + | * **Data Type:** String | ||
| + | * **Default Value:** StdDevRecon | ||
| + | * **Options: | ||
| + | __**title **__ \\ | ||
| + | The title of the plot. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**width **__ \\ | ||
| + | The width of the image exported. | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 1000 | ||
| + | __**xLabel **__ \\ | ||
| + | Label for the X-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**XRange **__ \\ | ||
| + | The display range of the X Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**yLabel **__ \\ | ||
| + | Label for the Y-Axis. | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | __**YRange **__ \\ | ||
| + | The display range of the Y Axis: " | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** ### | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -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 | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -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 | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -CreateWatcher / -cw ==== | ||
| + | ---- | ||
| + | Creates a new directory watcher | ||
| + | === Parameters === | ||
| + | __**delay **__ \\ | ||
| + | The number of ms to wait before executing scripts after watcher is triggered | ||
| + | * **Data Type:** Integer | ||
| + | * **Default Value:** 3000 | ||
| + | __**directory (REQUIRED) **__ \\ | ||
| + | The directories to be watched, pass multiple times to add more directories | ||
| + | * **Data Type:** List | ||
| + | * **Default Value:** N/A | ||
| + | __**name (REQUIRED) **__ \\ | ||
| + | The name of the watcher being created | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** N/A | ||
| + | __**overwrite **__ \\ | ||
| + | If passed and existing watchers with the same name will be overwritten | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**recursive **__ \\ | ||
| + | If passed all subdirectories will be watched as well | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | __**script (REQUIRED) **__ \\ | ||
| + | A list of paths to the scripts to execute when the watcher is triggered | ||
| + | * **Data Type:** List | ||
| + | * **Default Value:** N/A | ||
| + | __**triggerOnDelete **__ \\ | ||
| + | If passed watcher will be triggered when a file is deleted as well as added or edited | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -ActivateWatcher / -aw ==== | ||
| + | ---- | ||
| + | Activate the passed watcher(s) if not already activated | ||
| + | === Parameters === | ||
| + | __**name (DEFAULT) **__ \\ | ||
| + | The name of the watcher to be activated, pass multiple times to activate multiple watchers. | ||
| + | if not passed all watcher will be activated. | ||
| + | * **Data Type:** List | ||
| + | * **Default Value:** NULL | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -DeactivateWatcher / -daw ==== | ||
| + | ---- | ||
| + | Deactivate the passed watcher(s), if no watcher is passed deactivate all watchers | ||
| + | === Parameters === | ||
| + | __**name (DEFAULT) **__ \\ | ||
| + | The name of the watcher to be deactivated | ||
| + | * **Data Type:** List | ||
| + | * **Default Value:** NULL | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -DeleteWatcher / -dw ==== | ||
| + | ---- | ||
| + | Deletes the passed watcher if it exists | ||
| + | === Parameters === | ||
| + | __**name (DEFAULT) (REQUIRED) **__ \\ | ||
| + | The name of the watcher to be deleted | ||
| + | * **Data Type:** String | ||
| + | * **Default Value:** N/A | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -ListWatchers / -lw ==== | ||
| + | ---- | ||
| + | List all watchers | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -LaunchMinimized ==== | ||
| + | ---- | ||
| + | Set Sift to lauch minimized to the system tray by default. | ||
| + | === Parameters === | ||
| + | __**disable **__ \\ | ||
| + | If passed Sift will will no longer launch minimized to the system tray. | ||
| + | * **Data Type:** Boolean (True / False) | ||
| + | * **Default Value:** false | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -LaunchBackgroundInstance / -LaunchTray ==== | ||
| + | ---- | ||
| + | Immediatly launch a background instance of Sift in the system tray. | ||
| + | < | ||
| + | |||
| + | ---- | ||
| + | ==== -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 | ||
| + | < | ||
| + | -RunSummaryMetrics Group " | ||
| + | |||
| + | ---- | ||
| + | ==== -Exit / -x ==== | ||
| + | ---- | ||
| + | Exit Sift | ||
| + | < | ||
sift/command_line.1757606751.txt.gz · Last modified: 2025/09/11 16:05 by sgranger