class File - A PlotItem representing a file that contains gnuplot data.

Declared in module Gnuplot

Inheritance hierarchy:

Synopsis

class File(PlotItem):
    def __init__(self, file, **keyw) # Construct a File object.
    def set_option(self, using=<class Gnuplot._unset at 14019cc00>, binary=<class Gnuplot._unset at 14019cc00>, **keyw) # Set or change options associated with this plotitem.

    # Inherited from Gnuplot.PlotItem
    def __init__(self, basecommand, **keyw) # Construct a 'PlotItem'.
    def clear_option(self, name) # Clear (unset) a plot option.  No error if option was not set.
    def command(self) # Build the 'plot' command to be sent to gnuplot.
    def get_option(self, name) # Return the setting of an option.  May be overridden.
    def pipein(self, f) # Pipe necessary inline data to gnuplot.
    def set_option(self, with=<class Gnuplot._unset at 14019cc00>, title=<class Gnuplot._unset at 14019cc00>, **keyw) # Set or change a plot option for this PlotItem.

init(self, file, **keyw)

Construct a File object.

<file> can be either a string holding the filename of an existing file, or it can be an object of any class derived from AnyFile (such as a 'TempArrayFile').

Keyword arguments:

using=<int>: plot that column against line number
using=<tuple>: plot using a:b:c:d etc.
using=<string>: plot `using <string>' (allows gnuplot's arbitrary column arithmetic)
binary=<boolean>: data in file is in binary format (only recognized for grid data for splot).

The keyword arguments recognized by PlotItem can also be used here.Note that the using option is interpreted by gnuplot, so columns must be numbered starting with 1. The default title for a TempFile is notitle to avoid using the temporary file's name as the title.

init(self, basecommand, **keyw)

Construct a 'PlotItem'.

Keyword options:

with=<string>: choose how item will be plotted, e.g., with='points 3 3'.
title=<string>: set the title to be associated with the item in the plot legend.
title=None: choose notitle option (omit item from legend).

Note that omitting the title option is different than setting `title=None'; the former chooses gnuplot's default whereas the latter chooses `notitle'.

command(self)

Build the 'plot' command to be sent to gnuplot.

Build and return the plot command, with options, necessary to display this item.

pipein(self, f)

Pipe necessary inline data to gnuplot.

If the plot command requires data to be put on stdin (i.e., 'plot "-"'), this method should put that data there. Can be overridden in derived classes.

set_option(self, with=<class Gnuplot._unset at 14019cc00>, title=<class Gnuplot._unset at 14019cc00>, **keyw)

Set or change a plot option for this PlotItem.

See documentation for __init__ for information about allowed options. This function should be overridden by derived classes to allow additional options.