#!/usr/bin/env python
"""Definition of plotable object
Mainly based on matplotlib.
:todo:
Nothing.
:bug:
None known.
:organization:
INRIA
szymon.stoma
82471946
"""
# Module documentation variables:
__authors__ = """David Da Silva, Szymon Stoma"""
__contact__ = ""
__license__ = "Cecill-C"
__date__ = "<Timestamp>"
__version__ = "0.1"
__docformat__ = "restructuredtext en"
__revision__ = "$Id$"
import copy
#from matplotlib import rc, rcParams, use
"""
if sys.platform.startswith('win'):
#print 'LateX writing is not available under Windows, try real OS'
rc('text', usetex=False )
else:
rc('text', usetex=True )
"""
#use('Qt4Agg')
#from matplotlib.backends.backend_qt4 import qApp
import pylab
[docs]
class VisualSequence(object):
"""Object containing basic plot information.
<Long description of the function functionality.>
"""
def __init__(self, x=[], y=[], z=[], legend="", linestyle="",
marker="", color="", bins=10, **keys):
"""Object used to store plot information.
Uses the syntax of matplotlib (see its documentation for details).
:parameters:
x : `float`
X coordinates
y : `float`
values f(X)
legend : `string`
legend of a line
linestyle : `string`
One of - : -. -
marker : `string`
One of + , o . s v x > <,
color : `string`
A matplotlib color arg
"""
# data segment -- should be shared between the views
self.abs = x
self.ord = y
#self.x = x
#self.y = y
self.z = z
# properties segment -- should be changed for each view
self.legend = str(legend)
self.linestyle = str(linestyle)
self.marker = str(marker)
self.color = str(color)
self.bins = int(bins)
[docs]
def get_x(self):
"""Returrns the X array."""
if len(self.abs) == len(self.ord):
return self.abs
else:
return list(range(len(self.ord)))
[docs]
def set_x(self, value):
"""Set the x array of values"""
self.abs = value
[docs]
def get_y(self):
"""Get the y array of values."""
return self.ord
[docs]
def set_y(self, value):
"""Set the y array of values."""
self.ord = value
x = property(get_x, set_x)
y = property(get_y, set_y)
[docs]
def change_VisualSequence_PointLineView(vis_seq, new_legend,
new_linestyle, new_marker, new_color):
"""Returns vis_seq object with values changed from default
:parameters:
vis_seq : `VisualSequence`
object to be modified
new_legend : `string`
legend of a line
new_linestyle : `string`
One of - : -. -
new_marker : `string`
One of + , o . s v x > <,
new_color : `string`
A matplotlib color arg
:rtype: `VisualSequence`
:return: Updated object.
"""
plotable = copy.copy(vis_seq)
if not new_linestyle == "Default":
plotable.linestyle = str(new_linestyle)
if not new_marker == "Default":
plotable.marker = str(new_marker)
if not new_color == "Default":
plotable.color = str(new_color)
if not new_legend == "Default":
plotable.legend = str(new_legend)
return plotable
[docs]
def display_VisualSequence(vis_seq_list=list(), visualisation="",
title="", xlabel="", ylabel="", figure=0, **keys):
"""Plots 2D visual sequences.
:parameters:
vis_seq_list : `VisualSequence`
Contains a list of object to display
title : `string`
Title of the plot.
xlabel : `string`
X axis description
ylabel : `string`
Y label description
"""
if visualisation == 'Hist':
return display_VisualSequence_as_Hist(vis_seq=vis_seq_list, title=title,
xlabel=xlabel, ylabel=ylabel, figure=figure, **keys)
elif visualisation == 'PointLine':
return display_VisualSequence_as_PointLine(vis_seq_list=vis_seq_list,
title=title, xlabel=xlabel,
ylabel=ylabel,
figure=figure, **keys)
raise TypeError("Any know plot type")
[docs]
def display_VisualSequence_as_PointLine(vis_seq_list=list(), title="",
xlabel="", ylabel="", figure=0,
**keys):
"""Plots 2D visual sequences.
:parameters:
vis_seq_list : `VisualSequence`
Contains a list of object to display
title : `string`
Title of the plot.
xlabel : `string`
X axis description
ylabel : `string`
Y label description
"""
objList = vis_seq_list
pylab.figure(figure)
pylab.cla()
legend_printed = False
try:
iter(objList)
legend = []
for obj in objList:
pylab.plot(obj.x, obj.y, linestyle=obj.linestyle,
marker=obj.marker, color=obj.color,
markerfacecolor=obj.color, **keys)
if obj.legend:
legend.append(obj.legend)
legend_printed = True
if legend_printed:
pylab.legend(tuple(legend), loc='best', shadow=True)
except TypeError:
# do sth with exceptions
obj = vis_seq_list
#print figure
pylab.plot(obj.x, obj.y, linestyle=obj.linestyle,
marker=obj.marker, color=obj.color,
markerfacecolor=obj.color, **keys)
xmin, xmax = pylab.xlim()
xr = (xmax - xmin) / 20.
pylab.xlim(xmin - xr, xmax + xr)
ymin, ymax = pylab.ylim()
yr = (ymax - ymin) / 20.
pylab.ylim(ymin - yr, ymax + yr)
pylab.title(title)
pylab.xlabel(xlabel)
pylab.ylabel(ylabel)
pylab.show()
[docs]
def change_VisualSequence_HistView(vis_seq, new_bins, new_color):
"""Returns vis_seq object with values changed from default
:param vis_seq: object to be modified
:param new_bins: binning for the histogram
:param new_color: a matplotlib color arg
:type vis_seq: `VisualSequence`
:type new_bins: int
:type new_color: `string`
:return: Updated object.
"""
plotable = copy.copy(vis_seq)
if not new_color == "Default":
plotable.color = str(new_color)
if not new_bins == 10:
plotable.new_bins = int(new_bins)
return plotable
[docs]
def display_VisualSequence_as_Hist(vis_seq=[], title="", xlabel="",
ylabel="", figure=0, **keys):
"""plots 2d visual sequences.
:param vis_seq: contains a list of object to display
:param title: title of the plot
:param xlabel: x-axis description
:param ylabel: y-axis description
:param figure: figure's number
:type vis_seq: `VisualSequence`
:type title: `string`
:type ylabel: `string`
:type xlabel: `string`
"""
pylab.figure(figure)
pylab.cla()
pylab.hist(vis_seq.y, vis_seq.bins, range=vis_seq.x, **keys)
pylab.title(title)
pylab.xlabel(xlabel)
pylab.ylabel(ylabel)
pylab.show()
[docs]
def tuples2VisualSequence(seq1=[], marker="o", color="b", **keys):
"""generates visual sequence2D from a list a 2uples (x,y)
:param seq1: contains the list of (x,y)
:param marker: the marker for the point-line
:param color: the color
:type seq1: `iterable`
:type marker: `string`
:type color: `string`
"""
sx, sy = list(zip(*seq1))
return VisualSequence(x=sx, y=sy, z=None, marker=marker, color=color, **keys)
[docs]
def seqs2VisualSequence(seq1=[], seq2=[], marker="o", color="b", **keys):
"""generates visual sequence2D with list1 as x and list2 as y
:param seq1: contains the x-sequence
:param seq2: contains the y-sequence
:param marker: the marker for the point-line
:param color: the color
:type seq1: `iterable`
:type seq2: `iterable`
:type marker: `string`
:type color: `string`
"""
return VisualSequence(x=seq1, y=seq2, z=None, marker=marker, color=color, **keys)
[docs]
def dict2VisualSequence(dict2vis_seq={}, marker="o", color="g", **keys):
"""generates visual sequence2D with keys as x and values as y
:param dict2vis_seq: contains a list of object to display
:param marker: the marker for the point-line
:param color: the color
:type dict2vis_seq: `dict{float:float}`
:type marker: `string`
:type color: `string`
"""
r = list(dict2vis_seq.items())
r.sort()
return VisualSequence(
x=[r[i][0] for i in range(len(r))],
y=[r[i][1] for i in range(len(r))],
z=None,
marker=marker,
color=color, **keys)
