"""
Scatter Plots
"""
from sage.plot.primitive import GraphicPrimitive
from sage.misc.decorators import options
class ScatterPlot(GraphicPrimitive):
"""
Scatter plot graphics primitive.
Input consists of two lists/arrays of the same length, whose
values give the horizontal and vertical coordinates of each
point in the scatter plot. Options may be passed in
dictionary format.
EXAMPLES::
sage: from sage.plot.scatter_plot import ScatterPlot
sage: ScatterPlot([0,1,2], [3.5,2,5.1], {'facecolor':'white', 'marker':'s'})
Scatter plot graphics primitive on 3 data points
"""
def __init__(self, xdata, ydata, options):
"""
Scatter plot graphics primitive.
EXAMPLES::
sage: import numpy
sage: from sage.plot.scatter_plot import ScatterPlot
sage: ScatterPlot(numpy.array([0,1,2]), numpy.array([3.5,2,5.1]), {'facecolor':'white', 'marker':'s'})
Scatter plot graphics primitive on 3 data points
"""
self.xdata = xdata
self.ydata = ydata
GraphicPrimitive.__init__(self, options)
def get_minmax_data(self):
"""
Returns a dictionary with the bounding box data.
EXAMPLES::
sage: s = scatter_plot([[0,1],[2,4],[3.2,6]])
sage: d = s.get_minmax_data()
sage: d['xmin']
0.0
sage: d['ymin']
1.0
"""
return {'xmin': self.xdata.min(),
'xmax': self.xdata.max(),
'ymin': self.ydata.min(),
'ymax': self.ydata.max()}
def _allowed_options(self):
"""
Return the dictionary of allowed options for the scatter plot
graphics primitive.
EXAMPLES::
sage: from sage.plot.scatter_plot import ScatterPlot
sage: list(sorted(ScatterPlot([-1,2], [17,4], {})._allowed_options().iteritems()))
[('alpha', 'How transparent the marker border is.'),
('clip', 'Whether or not to clip.'),
('edgecolor', 'The color of the marker border.'),
('facecolor', 'The color of the marker face.'),
('hue', 'The color given as a hue.'),
('marker', 'What shape to plot the points.'),
('markersize', 'the size of the markers.'),
('rgbcolor', 'The color as an RGB tuple.'),
('zorder', 'The layer level in which to draw.')]
"""
return {'markersize': 'the size of the markers.',
'marker': 'What shape to plot the points.',
'alpha':'How transparent the marker border is.',
'rgbcolor':'The color as an RGB tuple.',
'hue':'The color given as a hue.',
'facecolor':'The color of the marker face.',
'edgecolor':'The color of the marker border.',
'zorder':'The layer level in which to draw.',
'clip': 'Whether or not to clip.'}
def _repr_(self):
"""
Text representation of a scatter plot graphics primitive.
EXAMPLES::
sage: import numpy
sage: from sage.plot.scatter_plot import ScatterPlot
sage: ScatterPlot(numpy.array([0,1,2]), numpy.array([3.5,2,5.1]), {})
Scatter plot graphics primitive on 3 data points
"""
return 'Scatter plot graphics primitive on %s data points'%len(self.xdata)
def _render_on_subplot(self, subplot):
"""
Render this scatter plot in a subplot. This is the key function that
defines how this scatter plot graphics primitive is rendered in
matplotlib's library.
EXAMPLES::
sage: scatter_plot([[0,1],[2,2],[4.3,1.1]], marker='s')
::
sage: scatter_plot([[n,n] for n in range(5)])
"""
from matplotlib.pyplot import scatter
options = self.options()
p = subplot.scatter(self.xdata, self.ydata, alpha=options['alpha'],
zorder=options['zorder'], marker=options['marker'],
s=options['markersize'], facecolors=options['facecolor'],
edgecolors=options['edgecolor'], clip_on=options['clip'])
if not options['clip']:
self._bbox_extra_artists=[p]
@options(alpha=1, markersize=50, marker='o', zorder=5, facecolor='#fec7b8', edgecolor='black', clip=True, aspect_ratio='automatic')
def scatter_plot(datalist, **options):
"""
Returns a Graphics object of a scatter plot containing all points in
the datalist. Type ``scatter_plot.options`` to see all available
plotting options.
INPUT:
- ``datalist`` -- a list of tuples ``(x,y)``
- ``alpha`` -- default: 1
- ``markersize`` -- default: 50
- ``marker`` - The style of the markers (default ``"o"``), which is one of
- ``"None"`` or ``" "`` or ``""`` (nothing)
- ``","`` (pixel), ``"."`` (point)
- ``"_"`` (horizontal line), ``"|"`` (vertical line)
- ``"o"`` (circle), ``"p"`` (pentagon), ``"s"`` (square), ``"x"`` (x), ``"+"`` (plus), ``"*"`` (star)
- ``"D"`` (diamond), ``"d"`` (thin diamond)
- ``"H"`` (hexagon), ``"h"`` (alternative hexagon)
- ``"<"`` (triangle left), ``">"`` (triangle right), ``"^"`` (triangle up), ``"v"`` (triangle down)
- ``"1"`` (tri down), ``"2"`` (tri up), ``"3"`` (tri left), ``"4"`` (tri right)
- ``0`` (tick left), ``1`` (tick right), ``2`` (tick up), ``3`` (tick down)
- ``4`` (caret left), ``5`` (caret right), ``6`` (caret up), ``7`` (caret down)
- ``"$...$"`` (math TeX string)
- ``facecolor`` -- default: ``'#fec7b8'``
- ``edgecolor`` -- default: ``'black'``
- ``zorder`` -- default: 5
EXAMPLES::
sage: scatter_plot([[0,1],[2,2],[4.3,1.1]], marker='s')
Extra options will get passed on to :meth:`~Graphics.show`, as long as they are valid::
sage: scatter_plot([(0, 0), (1, 1)], markersize=100, facecolor='green', ymax=100)
sage: scatter_plot([(0, 0), (1, 1)], markersize=100, facecolor='green').show(ymax=100) # These are equivalent
"""
import numpy
from sage.plot.all import Graphics
g = Graphics()
g._set_extra_kwds(Graphics._extract_kwds_for_show(options))
data = numpy.array(datalist, dtype='float')
if len(data) != 0:
xdata = data[:,0]
ydata = data[:,1]
g.add_primitive(ScatterPlot(xdata, ydata, options=options))
return g
