Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: Fix typos in gridspec tutorial #8364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 23, 2017
Merged

DOC: Fix typos in gridspec tutorial #8364

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e5a7c08
Add missing whitespaces in gridspec tutorial
afvincent Mar 23, 2017
360da63
gridspec <- GridSpec when speakig of gridspec.GridSpec
afvincent Mar 23, 2017
855069d
Add a few cross-references (+ fix minor typos)
afvincent Mar 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 37 additions & 34 deletions doc/users/gridspec.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,46 +5,47 @@
Customizing Location of Subplot Using GridSpec
**********************************************

``GridSpec``
:class:`~matplotlib.gridspec.GridSpec`
specifies the geometry of the grid that a subplot will be
placed. The number of rows and number of columns of the grid
need to be set. Optionally, the subplot layout parameters
(e.g., left, right, etc.) can be tuned.

``SubplotSpec``
:class:`~matplotlib.gridspec.SubplotSpec`
specifies the location of the subplot in the given *GridSpec*.

``subplot2grid``
a helper function that is similar to "pyplot.subplot" but uses
0-based indexing and let subplot to occupy multiple cells.
:func:`~matplotlib.pyplot.subplot2grid`
a helper function that is similar to :func:`~matplotlib.pyplot.subplot`
but uses 0-based indexing and let subplot to occupy multiple cells.


Basic Example of using subplot2grid
===================================

To use subplot2grid, you provide geometry of the grid and the location
of the subplot in the grid. For a simple single-cell subplot::
To use :func:`~matplotlib.pyplot.subplot2grid`, you provide geometry of
the grid and the location of the subplot in the grid. For a simple
single-cell subplot::

ax = plt.subplot2grid((2,2),(0, 0))
ax = plt.subplot2grid((2, 2), (0, 0))

is identical to ::

ax = plt.subplot(2,2,1)
ax = plt.subplot(2, 2, 1)

Note that, unlike matplotlib's subplot, the index starts from 0 in gridspec.
Note that, unlike Matplotlib's subplot, the index starts from 0 in GridSpec.

To create a subplot that spans multiple cells, ::

ax2 = plt.subplot2grid((3,3), (1, 0), colspan=2)
ax3 = plt.subplot2grid((3,3), (1, 2), rowspan=2)
ax2 = plt.subplot2grid((3, 3), (1, 0), colspan=2)
ax3 = plt.subplot2grid((3, 3), (1, 2), rowspan=2)

For example, the following commands ::

ax1 = plt.subplot2grid((3,3), (0,0), colspan=3)
ax2 = plt.subplot2grid((3,3), (1,0), colspan=2)
ax3 = plt.subplot2grid((3,3), (1, 2), rowspan=2)
ax4 = plt.subplot2grid((3,3), (2, 0))
ax5 = plt.subplot2grid((3,3), (2, 1))
ax1 = plt.subplot2grid((3, 3), (0, 0), colspan=3)
ax2 = plt.subplot2grid((3, 3), (1, 0), colspan=2)
ax3 = plt.subplot2grid((3, 3), (1, 2), rowspan=2)
ax4 = plt.subplot2grid((3, 3), (2, 0))
ax5 = plt.subplot2grid((3, 3), (2, 1))

creates

Expand All @@ -54,47 +55,48 @@ creates
GridSpec and SubplotSpec
========================

You can create GridSpec explicitly and use them to create a Subplot.
You can create :class:`~matplotlib.gridspec.GridSpec` explicitly and use
them to create a subplot.

For example, ::

ax = plt.subplot2grid((2,2),(0, 0))
ax = plt.subplot2grid((2, 2), (0, 0))

is equal to ::

import matplotlib.gridspec as gridspec
gs = gridspec.GridSpec(2, 2)
ax = plt.subplot(gs[0, 0])

A gridspec instance provides array-like (2d or 1d) indexing that
returns the SubplotSpec instance. For, SubplotSpec that spans multiple
A GridSpec instance provides array-like (2d or 1d) indexing that
returns the SubplotSpec instance. For a SubplotSpec that spans multiple
cells, use slice. ::

ax2 = plt.subplot(gs[1,:-1])
ax2 = plt.subplot(gs[1, :-1])
ax3 = plt.subplot(gs[1:, -1])

The above example becomes ::

gs = gridspec.GridSpec(3, 3)
ax1 = plt.subplot(gs[0, :])
ax2 = plt.subplot(gs[1,:-1])
ax2 = plt.subplot(gs[1, :-1])
ax3 = plt.subplot(gs[1:, -1])
ax4 = plt.subplot(gs[-1,0])
ax5 = plt.subplot(gs[-1,-2])
ax4 = plt.subplot(gs[-1, 0])
ax5 = plt.subplot(gs[-1, -2])

.. plot:: users/plotting/examples/demo_gridspec02.py

Adjust GridSpec layout
======================

When a GridSpec is explicitly used, you can adjust the layout
parameters of subplots that are created from the gridspec. ::
parameters of subplots that are created from the GridSpec. ::

gs1 = gridspec.GridSpec(3, 3)
gs1.update(left=0.05, right=0.48, wspace=0.05)

This is similar to *subplots_adjust*, but it only affects the subplots
that are created from the given GridSpec.
This is similar to :func:`~matplotlib.pyplot.subplots_adjust`, but it only
affects the subplots that are created from the given GridSpec.

The code below ::

Expand All @@ -117,8 +119,9 @@ creates
GridSpec using SubplotSpec
==========================

You can create GridSpec from the SubplotSpec, in which case its layout
parameters are set to that of the location of the given SubplotSpec. ::
You can create GridSpec from the :class:`~matplotlib.gridspec.SubplotSpec`,
in which case its layout parameters are set to that of the location of
the given SubplotSpec. ::

gs0 = gridspec.GridSpec(1, 2)

Expand All @@ -132,8 +135,8 @@ parameters are set to that of the location of the given SubplotSpec. ::
A Complex Nested GridSpec using SubplotSpec
===========================================

Here's a more sophisticated example of nested gridspec where we put
a box around each cell of the outer 4x4 grid, by hiding appropriate
Here's a more sophisticated example of nested GridSpec where we put
a box around each cell of the outer 4x4 grid, by hiding appropriate
spines in each of the inner 3x3 grids.

.. plot:: users/plotting/examples/demo_gridspec06.py
Expand All @@ -147,8 +150,8 @@ relative heights and widths of rows and columns. Note that absolute
values are meaningless, only their relative ratios matter. ::

gs = gridspec.GridSpec(2, 2,
width_ratios=[1,2],
height_ratios=[4,1]
width_ratios=[1, 2],
height_ratios=[4, 1]
)

ax1 = plt.subplot(gs[0])
Expand Down