Differences

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

--- sift:command_line [2025/04/04 17:56] – sgranger
+++ sift:command_line [2025/04/04 19:57] (current) – sgranger
@@ Line 254: / Line 254: @@
 == 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.
 == DataStyle ==
 Which data style type to use when generating the plot, options are: Workspace, Group, Sub Group, Cluster \\
@@ Line 271: / Line 285: @@
 == WorkspaceMean ==
 If passed workspace mean will be plotted
+== XRange ==
+The range of values displayed on the X Axis of the plot, format: "min,max"
+== YRange ==
+The range of values displayed on the Y Axis of the plot, format: "min,max"
+== RawTraces ==
+If passed individual traces will be plotted, if no other items are plotted, raw traces will be plotted by default
+=== Example ===
+<code>-ExportPlotSignalTime filePath "C:\Export Folder\signal_time_plot.png" rawTraces workspaceMean workspaceDispersion workspaceDispersionType "Interquartile Range" legend "Bottom Left"</code>
+----
+==== -ExportPlotMetric / -ExportPlotM / -EPM ====
+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 \\
@@ Line 283: / Line 313: @@
 == YLabel ==
 The label displayed along the Y Axis of the plot
-== XRange ==
-The range of values displayed on the X Axis of the plot, format: "min,max"
-== YRange ==
-The range of values displayed on the Y Axis of the plot, format: "min,max"
-== RawTraces ==
-If passed individual traces will be plotted, if no other items are plotted, raw traces will be plotted by default
 == 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 \\
+<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 ===
-<code>-ExportPlotSignalTime filePath "C:\Export Folder\signal_time_plot.png" rawTraces workspaceMean workspaceDispersion workspaceDispersionType "Interquartile Range" legend "Bottom Left"</code>
+<code>
 ----