MOA 12.03
Real Time Analytics for Data Streams
|
A task allowing to create and plot gnuplot scripts. More...
Public Types | |
enum | Terminal { CANVAS, EPSLATEX, GIF, JPEG, LATEX, PDFCAIRO, PNG, POSTSCRIPT, POSTSCRIPT_COLOR, PSLATEX, PSTEX, PSTRICKS, SVG } |
Plot output terminal. More... | |
enum | LegendLocation { TOP_LEFT_INSIDE, TOP_CENTER_INSIDE, TOP_RIGHT_INSIDE, LEFT_INSIDE, CENTER_INSIDE, RIGHT_INSIDE, BOTTOM_LEFT_INSIDE, BOTTOM_CENTER_INSIDE, BOTTOM_RIGHT_INSIDE, TOP_LEFT_OUTSIDE, TOP_CENTER_OUTSIDE, TOP_RIGHT_OUTSIDE, LEFT_OUTSIDE, CENTER_OUTSIDE, RIGHT_OUTSIDE, BOTTOM_LEFT_OUTSIDE, BOTTOM_CENTER_OUTSIDE, BOTTOM_RIGHT_OUTSIDE } |
Location of the legend on the plot. More... | |
enum | LegendType { NONE, BOX_VERTICAL, BOX_HORIZONTAL, NOBOX_VERTICAL, NOBOX_HORIZONTAL } |
Type of legend. More... | |
enum | PlotStyle { LINES, POINTS, LINESPOINTS, IMPULSES, STEPS, FSTEPS, HISTEPS, DOTS } |
Public Member Functions | |
String | getPurposeString () |
Gets the purpose of this object. | |
Class<?> | getTaskResultType () |
Defines the task's result type. | |
Public Attributes | |
StringOption | gnuplotPathOption |
Path to gunplot's binary directory, for example C:. | |
FileOption | plotOutputOption |
FileOption for selecting the plot output file. | |
ListOption | inputFilesOption |
Comma separated list of input *csv files. | |
ListOption | fileAliasesOption |
Comma separated list of aliases for the input *csv files. | |
MultiChoiceOption | outputTypeOption |
Gnuplot terminal - postscript, png, pdf etc. | |
MultiChoiceOption | plotStyleOption |
Type of plot - dots, points, lines ets. | |
IntOption | xColumnOption |
Index of the csv column from which values for the x-axis should be taken. | |
StringOption | xTitleOption |
Title of the plots' x-axis. | |
StringOption | xUnitOption |
Units displayed next to x-axis values. | |
IntOption | yColumnOption |
Index of the csv column from which values for the y-axis should be taken. | |
StringOption | yTitleOption |
Title of the plots' y-axis. | |
StringOption | yUnitOption |
Units displayed next to y-axis values. | |
IntOption | lineWidthOption |
Plotted line width. | |
IntOption | pointIntervalOption |
Interval between plotted data points. | |
FlagOption | smoothOption |
Determines whether to smooth the plot with bezier curves. | |
FlagOption | deleteScriptsOption |
Determines whether to delete gnuplot scripts after plotting. | |
MultiChoiceOption | legendLocationOption |
Legend (key) location on the plot. | |
MultiChoiceOption | legendTypeOption |
Legend elements' alignment. | |
StringOption | additionalSetOption |
Addition pre-plot gunplot commands. | |
StringOption | additionalPlotOption |
Additional plot options. | |
Protected Member Functions | |
Object | doMainTask (TaskMonitor monitor, ObjectRepository repository) |
This method performs this task. |
Location of the legend on the plot.
Object moa.tasks.Plot.doMainTask | ( | TaskMonitor | monitor, |
ObjectRepository | repository | ||
) | [protected, virtual] |
This method performs this task.
AbstractTask
implements doTask
, that uses doTaskImpl
. MainTask
implements doTaskImpl
using doMainTask
so its extensions only need to implement doMainTask
.
monitor | the TaskMonitor to use |
repository | the ObjectRepository to use |
Implements moa.tasks.MainTask.
Definition at line 378 of file Plot.java.
String moa.tasks.Plot.getPurposeString | ( | ) |
Gets the purpose of this object.
Reimplemented from moa.options.AbstractOptionHandler.
Class<?> moa.tasks.Plot.getTaskResultType | ( | ) |
Defines the task's result type.
Implements moa.tasks.Task.
new StringOption( "additionalPlotOptions", 'z', "Additional options that should be added to the gnuplot script in the plot statement. For example \"[] [0:]\" will force the y-axis to start from 0. See the gnuplot manual for more options.", " ")
Additional plot options.
For example "[] [0:]" will force the y-axis to start from 0. See the gnuplot manual for more options.
new StringOption( "additionalCommands", 'c', "Additional commands that should be added to the gnuplot script before the plot command. For example \"set tics out\" will change the default tic option and force outward facing tics. See the gnuplot manual for more commands.", " ")
Addition pre-plot gunplot commands.
For example "set tics out" will change the default tic option and force outward facing tics. See the gnuplot manual for more commands.
new FlagOption("deleteScripts", 'd', "Determines whether to delete gnuplot scripts after plotting.")
Determines whether to delete gnuplot scripts after plotting.
Definition at line 169 of file Plot.java.
Referenced by moa.tasks.Plot.doMainTask().
new ListOption( "aliases", 'a', "Aliases for files stated in the inputFiles parameter. Aliases will be presented in the plot's legend.", new StringOption("alias", ' ', "File alias.", "MyAlg"), new StringOption[] { new StringOption("", ' ', "", "OZABag"), new StringOption("", ' ', "", "HOT"), new StringOption("", ' ', "", "AWE") }, ',')
Comma separated list of aliases for the input *csv files.
If a legend is added to the plot, aliases will be presented in the legend.
Definition at line 82 of file Plot.java.
Referenced by moa.tasks.Plot.doMainTask().
new StringOption("gnuplotPath", 'e', "Directory of the gnuplot executable. For example \"C:\\Tools\\Gnuplot\\binary\".", "")
Path to gunplot's binary directory, for example C:.
Definition at line 54 of file Plot.java.
Referenced by moa.tasks.Plot.doMainTask().
new ListOption( "inputFiles", 'i', "File names or file paths of csv inputs. Values should be seperated by commas.", new StringOption("inputFile", ' ', "Input file.", "algorithm.csv"), new StringOption[] { new StringOption("", ' ', "", "algorithm1.csv"), new StringOption("", ' ', "", "algorithm2.csv"), new StringOption("", ' ', "", "algorithm3.csv") }, ',')
Comma separated list of input *csv files.
The file paths can be absolute or relative to the executing directory (moa.jar directory).
Definition at line 68 of file Plot.java.
Referenced by moa.tasks.Plot.doMainTask().
new MultiChoiceOption( "legendLocation", 'l', "Legend (key) location on the plot.", LegendLocation.getStringValues(), LegendLocation.getDescriptions(), 8)
Legend (key) location on the plot.
new MultiChoiceOption( "legendType", 'k', "Legend elements' alignment.", LegendType .getStringValues(), LegendType.getDescriptions(), 1)
Legend elements' alignment.
new FileOption("plotOutputFile", 'r', "File with the result plot (image).", null, "eps", true)
FileOption for selecting the plot output file.
Definition at line 61 of file Plot.java.
Referenced by moa.tasks.Plot.doMainTask().