User Tools

Site Tools


sift:command_line

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
sift:command_line [2025/04/04 19:57] sgrangersift:command_line [2025/06/11 13:38] (current) sgranger
Line 298: Line 298:
 ==== -ExportPlotMetric / -ExportPlotM / -EPM ==== ==== -ExportPlotMetric / -ExportPlotM / -EPM ====
 Export the select metrics on a metric plot Export the select metrics on a metric plot
 +=== Parameters ===
 +== FilePath (Required/Default) ==
 +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 \\
 +<sub>//Default:// 1000</sub>
 +== Width ==
 +The width in pixels of the generated plot \\
 +<sub>//Default:// 1000</sub>
 +== 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.
 +=== Example ===
 +<code>-ExportPlotMetric filePath "C:\Export Folder\metric_plot.png" rawTraces workspaceMean workspaceDispersion workspaceDispersionType "Interquartile Range" legend "Bottom Left"</code>
 +
 +----
 +
 +==== -ExportPlotSPM /  -EPSPM ====
 +Export the active SPM
 === Parameters === === Parameters ===
 == FilePath (Required/Default) == == FilePath (Required/Default) ==
Line 317: Line 341:
 == DataStyle == == DataStyle ==
 What data style used when plotting, options are: Workspace, Group, Sub Group, Cluster \\ What data style used when plotting, options are: Workspace, Group, Sub Group, Cluster \\
-<sub> 
-== 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 \\ 
-<sub>//Default:// One Standard Deviation</sub> 
-== 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 \\ 
-<sub>//Default:// One Standard Deviation</sub> 
-== MeanPlotStyle == 
-Method used for plotting means, options are Bar Chart, Stacked Bar Chart, Box Plot 
-<sub>//Default:// Bar Chart</sub> 
-== MetricGrouping == 
-How should workspace means be grouped, options are No Group, Group, Workspace 
-<sub>//Default:// No Group</sub> 
 === Example === === Example ===
-<code>+<code>-ExportPlotSPM filePath "C:\Export Folder\spm_plot.png" legend "Bottom Left"</code>
  
 ---- ----
 +
 ==== -ExportData / -ex ==== ==== -ExportData / -ex ====
 Export queried data results in an ascii text file  Export queried data results in an ascii text file 
sift/command_line.1743796668.txt.gz · Last modified: 2025/04/04 19:57 by sgranger