View

(Source code, png, hires.png, pdf)

class View(graph, pixelsize=None, figure=None, figure_kw=None, axes=[], plot_kw=None, axes_kw=None, bar_kw=None, pie_kw=None, polygon_kw=None, polygoncollection_kw=None, contour_kw=None, step_kw=None, clabel_kw=None, text_kw=None, legend_kw=None, add_legend=True, square_axes=False, **kwargs)

Create the figure.

Parameters

graphDrawable

A Graph or Drawable object.

pixelsize2-tuple of int

The requested size in pixels (width, height).

figurematplotlib.figure.Figure

The figure to draw on.

figure_kwdict, optional

Passed on to matplotlib.pyplot.figure kwargs

axesmatplotlib.axes.Axes

The axes to draw on.

plot_kwdict, optional

Used when drawing Cloud, Curve drawables Passed on as matplotlib.axes.Axes.plot kwargs

axes_kwdict, optional

Passed on to matplotlib.figure.Figure.add_subplot kwargs

bar_kwdict, optional

Used when drawing BarPlot drawables Passed on to matplotlib.pyplot.bar kwargs

pie_kwdict, optional

Used when drawing Pie drawables Passed on to matplotlib.pyplot.pie kwargs

polygon_kwdict, optional

Used when drawing Polygon drawables Passed on to matplotlib.patches.Polygon kwargs

polygoncollection_kwdict, optional

Used when drawing PolygonArray drawables Passed on to matplotlib.collection.PolygonCollection kwargs

contour_kwdict, optional

Used when drawing Contour drawables Passed on to matplotlib.pyplot.contour kwargs

clabel_kwdict, optional

Used when drawing Contour drawables Passed on to matplotlib.pyplot.clabel kwargs

step_kwdict, optional

Used when drawing Staircase drawables Passed on to matplotlib.pyplot.step kwargs

text_kwdict, optional

Used when drawing Pairs, Text drawables Passed on to matplotlib.axes.Axes.text kwargs

legend_kwdict, optional

Passed on to matplotlib.axes.Axes.legend kwargs

add_legendbool, optional

Adds a legend if True. Default is True.

square_axesbool, optional

Forces the axes to share the same scale if True. Default is False.

Examples

>>> import openturns as ot
>>> from openturns.viewer import View
>>> graph = ot.Normal().drawPDF()
>>> view = View(graph, plot_kw={'color':'blue'})
>>> view.save('graph.png', dpi=100)
>>> view.show()

Methods

ShowAll(**kwargs)	Display all graphs.
close()	Close the figure.
getAxes()	Get the list of Axes objects.
getFigure()	Accessor to the underlying figure object.
save(fname, **kwargs)	Save the graph as file.
show(**kwargs)	Display the graph.

__init__(graph, pixelsize=None, figure=None, figure_kw=None, axes=[], plot_kw=None, axes_kw=None, bar_kw=None, pie_kw=None, polygon_kw=None, polygoncollection_kw=None, contour_kw=None, step_kw=None, clabel_kw=None, text_kw=None, legend_kw=None, add_legend=True, square_axes=False, **kwargs)

static ShowAll(**kwargs)

Display all graphs.

Examples

>>> import openturns as ot
>>> import openturns.viewer as otv
>>> n = ot.Normal()
>>> graph = n.drawPDF()
>>> view = otv.View(graph)
>>> u = ot.Uniform()
>>> graph = u.drawPDF()
>>> view = otv.View(graph)
>>> otv.View.ShowAll()

close()

Close the figure.

Examples

>>> import openturns as ot
>>> import openturns.viewer as otv
>>> n = ot.Normal()
>>> graph = n.drawPDF()
>>> view = otv.View(graph)
>>> view.close()

getAxes()

Get the list of Axes objects.

See matplotlib.axes.Axes for further information.

Examples

>>> import openturns as ot
>>> import openturns.viewer as otv
>>> n = ot.Normal()
>>> graph = n.drawPDF()
>>> view = otv.View(graph)
>>> axes = view.getAxes()
>>> _ = axes[0].set_ylim(-0.1, 1.0);

getFigure()

Accessor to the underlying figure object.

See matplotlib.figure.Figure for further information.

Examples

>>> import openturns as ot
>>> from openturns.viewer import View
>>> graph = ot.Normal().drawPDF()
>>> view = View(graph)
>>> fig = view.getFigure()
>>> _ = fig.suptitle("The suptitle");

save(fname, **kwargs)

Save the graph as file.

Parameters

fname: bool, optional

A string containing a path to a filename from which file format is deduced.

kwargs:

See matplotlib.figure.Figure.savefig documentation for valid keyword arguments.

Examples

>>> import openturns as ot
>>> from openturns.viewer import View
>>> graph = ot.Normal().drawPDF()
>>> view = View(graph)
>>> view.save('graph.png', dpi=100)

show(**kwargs)

Display the graph.

See matplotlib.figure.Figure.show

Examples

>>> import openturns as ot
>>> import openturns.viewer as otv
>>> n = ot.Normal()
>>> graph = n.drawPDF()
>>> view = otv.View(graph)
>>> view.show()