<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>dataplot.shellscript.Plot</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="dataplot-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="dataplot-module.html">Package dataplot</a> ::
<a href="dataplot.shellscript-module.html">Package shellscript</a> ::
Class Plot
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="../private/dataplot.shellscript.Plot-class.html">show private</a> | hide private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="dataplot.shellscript.Plot-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type Plot</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<a href="dataplot.GenericPlot-class.html"><code>GenericPlot</code></a> --+
|
<b>Plot</b>
</pre><br />
<hr/>
<pre class="literalblock">
Make plots through the filesystem and command line programs.
Subclasses need to define:
1. A method get_plot_args, which returns a dictionary with at
least one key 'data' which maps to a text string that will be
written out to the input file for the command line program.
2. The attribute cmdtmp, which is a template string that will be
filled in with the dictionary returned by get_plot_args. This
string will be the command line that is executed to make the
plot. You should use the 'infile' key in your string, i.e.
cmdtmp='/usr/local/bin/hairpinplot.bash %(infile)s'
</pre>
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.shellscript.Plot-class.html#get_cline" class="summary-sig-name"><code>get_cline</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Construct command line based on template and dict.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.shellscript.Plot-class.html#get_cline_template_dict" class="summary-sig-name"><code>get_cline_template_dict</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Dict used to fill in self.cmdtmp string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.shellscript.Plot-class.html#makefile" class="summary-sig-name"><code>makefile</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Write data to infile and then execute the commandline.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.shellscript.Plot-class.html#write_data_to_infile" class="summary-sig-name"><code>write_data_to_infile</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Write data from get_plot_args into infile specified.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from GenericPlot</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>basename</span>,
<span class=summary-sig-arg>tocall</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Make a new plot to display.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#convert" class="summary-sig-name"><code>convert</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Convert from PDF to other formats using ImageMagick.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#do_chgrp" class="summary-sig-name"><code>do_chgrp</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Change group write perms if requested.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#do_chgrp_on" class="summary-sig-name"><code>do_chgrp_on</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>fn</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#from_filename" class="summary-sig-name"><code>from_filename</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#from_url" class="summary-sig-name"><code>from_url</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#get_app_dirs" class="summary-sig-name"><code>get_app_dirs</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Dig through settings.INSTALLED_APPS for full paths.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#get_filenames" class="summary-sig-name"><code>get_filenames</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return dictionary of image filenames.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#get_full_base" class="summary-sig-name"><code>get_full_base</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#get_plot_args" class="summary-sig-name"><code>get_plot_args</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Gather input data from defaults and return value of tocall.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#get_urls" class="summary-sig-name"><code>get_urls</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return dictionary of image URLs.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#makedirs" class="summary-sig-name"><code>makedirs</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Make subdirectories of media/ for this plot.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#makefiles" class="summary-sig-name"><code>makefiles</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Make initial file and conversions.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#prefix" class="summary-sig-name"><code>prefix</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>pre</span>)</span></code>
<br />
Generalized form of url/filename reporting.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#render_html" class="summary-sig-name"><code>render_html</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>tfile</span>)</span></code>
<br />
Render a HTML template with self as context 'plot'.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#to_html" class="summary-sig-name"><code>to_html</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Render the PNG image and link to the PDF.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#to_html_nolink" class="summary-sig-name"><code>to_html_nolink</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Render the PNG without link to PDF.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#to_html_thumb" class="summary-sig-name"><code>to_html_thumb</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Render the PNG thumb.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="dataplot.GenericPlot-class.html#view" class="summary-sig-name"><code>view</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Use some other program to look at rendered source image.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from object</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__delattr__('name') <==> del x.name</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__getattribute__('name') <==> x.name</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
<br />
x.__hash__() <==> hash(x)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>,
<span class=summary-sig-arg>S</span>,
<span class="summary-sig-vararg">...</span>)</span></code>
<br />
T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
helper for pickle</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
helper for pickle</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code>
<br />
x.__setattr__('name', value) <==> x.name = value</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code>
<br />
x.__str__() <==> str(x)</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from GenericPlot</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>bool</code></font></td>
<td><b><a href="dataplot.GenericPlot-class.html#autosave"><code>autosave</code></a></b> = <span title="False"><code>False </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="dataplot.GenericPlot-class.html#chgrp"><code>chgrp</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="dataplot.GenericPlot-class.html#convert_binary"><code>convert_binary</code></a></b> = <span title="'convert'"><code><span class="variable-quote">'</span>convert<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>bool</code></font></td>
<td><b><a href="dataplot.GenericPlot-class.html#enable_caching"><code>enable_caching</code></a></b> = <span title="False"><code>False </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="dataplot.GenericPlot-class.html#view_program"><code>view_program</code></a></b> = <span title="'display'"><code><span class="variable-quote">'</span>display<span class="variable-quote">'</span> </code>
</span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="get_cline"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_cline</span>(<span class=sig-arg>self</span>)</span>
</h3>
Construct command line based on template and dict.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="get_cline_template_dict"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_cline_template_dict</span>(<span class=sig-arg>self</span>)</span>
</h3>
Dict used to fill in self.cmdtmp string.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="makefile"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">makefile</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Write data to infile and then execute the commandline.</p>
This presumably makes the convert_from file.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="write_data_to_infile"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">write_data_to_infile</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Write data from get_plot_args into infile specified.</p>
Presumably this data is the input for a command-line program.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="dataplot-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Tue Apr 29 23:35:05 2008</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
