Package PyFoam :: Package ThirdParty :: Package Gnuplot :: Module PlotItems :: Class _FileItem
[hide private]
[frames] | no frames]

Class _FileItem

source code


A PlotItem representing a file that contains gnuplot data.

This class is not meant for users but rather as a base class for other types of FileItem.

Instance Methods [hide private]
 
__init__(self, filename, **keyw)
Represent a PlotItem that gnuplot treates as a file.
source code
 
get_base_command_string(self) source code
 
set_option_binary(self, binary) source code
 
set_option_colonsep(self, name, value) source code
    Inherited from PlotItem
 
clear_option(self, name)
Clear (unset) a plot option.
source code
 
command(self)
Build the plot command to be sent to gnuplot.
source code
 
get_command_option_string(self) source code
 
get_option(self, name)
Return the setting of an option.
source code
 
pipein(self, f)
Pipe necessary inline data to gnuplot.
source code
 
set_option(self, **keyw)
Set or change a plot option for this PlotItem.
source code
 
set_string_option(self, option, value, default, fmt)
Set an option that takes a string value.
source code
Class Variables [hide private]
  _option_list = {'axes': <function <lambda> at 0x1102bbed8>, 'b...
    Inherited from PlotItem
  _option_sequence = ['binary', 'index', 'every', 'thru', 'using...
Method Details [hide private]

__init__(self, filename, **keyw)
(Constructor)

source code 
Represent a PlotItem that gnuplot treates as a file.

This class holds the information that is needed to construct
the plot command line, including options that are specific to
file-like gnuplot input.

<filename> is a string representing the filename to be passed
to gnuplot within quotes.  It may be the name of an existing
file, '-' for inline data, or the name of a named pipe.

Keyword arguments:

    'using=<int>' -- plot that column against line number

    'using=<tuple>' -- plot using a:b:c:d etc.  Elements in
        the tuple that are None are output as the empty
        string.

    'using=<string>' -- plot `using <string>' (allows gnuplot's
        arbitrary column arithmetic)

    'every=<value>' -- plot 'every <value>'.  <value> is
        formatted as for 'using' option.

    'index=<value>' -- plot 'index <value>'.  <value> is
        formatted as for 'using' option.

    'binary=<boolean>' -- data in the file is in binary format
        (this option is only allowed for grid data for splot).

    'smooth=<string>' -- smooth the data.  Option should be
        'unique', 'csplines', 'acsplines', 'bezier', or
        'sbezier'.

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.

By default, gnuplot uses the name of the file plus any 'using'
option as the dataset title.  If you want another title, set
it explicitly using the 'title' option.

Overrides: PlotItem.__init__

get_base_command_string(self)

source code 
Overrides: PlotItem.get_base_command_string

Class Variable Details [hide private]

_option_list

Value:
{'axes': <function <lambda> at 0x1102bbed8>,
 'binary': <function <lambda> at 0x1102be5f0>,
 'every': <function <lambda> at 0x1102be6e0>,
 'index': <function <lambda> at 0x1102be668>,
 'smooth': <function <lambda> at 0x1102be7d0>,
 'title': <function <lambda> at 0x1102be050>,
 'using': <function <lambda> at 0x1102be758>,
 'with': <function <lambda> at 0x1102bbf50>,
...