matplotlib.github.com/3.4.0/_modules/matplotlib/gridspec.html at main · ACPMAD/matplotlib.github.com

History

952 lines (812 loc) · 128 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>matplotlib.gridspec — Matplotlib 3.4.0 documentation</title>

title="Search within Matplotlib 3.4.0 documentation"

href="../../_static/opensearch.xml"/>

</head><body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.4.0). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>

<!--

</div>

-->

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.4.0</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<ul>

<li><a href="../../users/installing.html">Installation</a></li>

<li><a href="../../contents.html">Documentation</a></li>

<li><a href="../../gallery/index.html">Examples</a></li>

<li><a href="../../tutorials/index.html">Tutorials</a></li>

<li><a href="../../devel/index.html">Contributing</a></li>

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li><a href="../../contents.html">contents</a> »</li>

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

<li class="nav-item nav-item-2"><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

<li class="nav-item nav-item-this"><a href="">matplotlib.gridspec</a></li>

</ul>

</div>

</div>

<h1>Source code for matplotlib.gridspec</h1><div class="highlight"><pre>

r"""

:mod:`~matplotlib.gridspec` contains classes that help to layout multiple

`~.axes.Axes` in a grid-like pattern within a figure.

The `GridSpec` specifies the overall grid structure. Individual cells within

the grid are referenced by `SubplotSpec`\s.

See the tutorial :doc:`/tutorials/intermediate/gridspec` for a comprehensive

usage guide.

"""

import copy

import logging

from numbers import Integral

import numpy as np

import matplotlib as mpl

from matplotlib import _api, _pylab_helpers, tight_layout, rcParams

from matplotlib.transforms import Bbox

import matplotlib._layoutgrid as layoutgrid

_log = logging.getLogger(__name__)

<div class="viewcode-block" id="GridSpecBase"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase">[docs]</a>class GridSpecBase:

"""

A base class of GridSpec that specifies the geometry of the grid

that a subplot will be placed.

"""

<div class="viewcode-block" id="GridSpecBase.__init__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase.__init__">[docs]</a> def __init__(self, nrows, ncols, height_ratios=None, width_ratios=None):

"""

Parameters

----------

nrows, ncols : int

The number of rows and columns of the grid.

width_ratios : array-like of length *ncols*, optional

Defines the relative widths of the columns. Each column gets a

relative width of ``width_ratios[i] / sum(width_ratios)``.

If not given, all columns will have the same width.

height_ratios : array-like of length *nrows*, optional

Defines the relative heights of the rows. Each column gets a

relative height of ``height_ratios[i] / sum(height_ratios)``.

If not given, all rows will have the same height.

"""

if not isinstance(nrows, Integral) or nrows <= 0:

raise ValueError(

f"Number of rows must be a positive integer, not {nrows}")

if not isinstance(ncols, Integral) or ncols <= 0:

raise ValueError(

f"Number of columns must be a positive integer, not {ncols}")

self._nrows, self._ncols = nrows, ncols

self.set_height_ratios(height_ratios)

self.set_width_ratios(width_ratios)</div>

<div class="viewcode-block" id="GridSpecBase.__repr__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase.__repr__">[docs]</a> def __repr__(self):

height_arg = (', height_ratios=%r' % (self._row_height_ratios,)

if len(set(self._row_height_ratios)) != 1 else '')

width_arg = (', width_ratios=%r' % (self._col_width_ratios,)

if len(set(self._col_width_ratios)) != 1 else '')

return '{clsname}({nrows}, {ncols}{optionals})'.format(

clsname=self.__class__.__name__,

nrows=self._nrows,

ncols=self._ncols,

optionals=height_arg + width_arg,

)</div>

nrows = property(lambda self: self._nrows,

doc="The number of rows in the grid.")

ncols = property(lambda self: self._ncols,

doc="The number of columns in the grid.")

<div class="viewcode-block" id="GridSpecBase.get_geometry"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase.get_geometry">[docs]</a> def get_geometry(self):

"""

Return a tuple containing the number of rows and columns in the grid.

"""

return self._nrows, self._ncols</div>

<div class="viewcode-block" id="GridSpecBase.get_subplot_params"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase.get_subplot_params">[docs]</a> def get_subplot_params(self, figure=None):

# Must be implemented in subclasses

pass</div>

<div class="viewcode-block" id="GridSpecBase.new_subplotspec"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase.new_subplotspec">[docs]</a> def new_subplotspec(self, loc, rowspan=1, colspan=1):

"""

Create and return a `.SubplotSpec` instance.

Parameters

----------

loc : (int, int)

The position of the subplot in the grid as

``(row_index, column_index)``.

rowspan, colspan : int, default: 1

The number of rows and columns the subplot should span in the grid.

"""

loc1, loc2 = loc

subplotspec = self[loc1:loc1+rowspan, loc2:loc2+colspan]

return subplotspec</div>

<div class="viewcode-block" id="GridSpecBase.set_width_ratios"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase.set_width_ratios">[docs]</a> def set_width_ratios(self, width_ratios):

"""

Set the relative widths of the columns.

*width_ratios* must be of length *ncols*. Each column gets a relative

width of ``width_ratios[i] / sum(width_ratios)``.

"""

if width_ratios is None:

width_ratios = [1] * self._ncols

elif len(width_ratios) != self._ncols:

raise ValueError('Expected the given number of width ratios to '

'match the number of columns of the grid')

self._col_width_ratios = width_ratios</div>

<div class="viewcode-block" id="GridSpecBase.get_width_ratios"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase.get_width_ratios">[docs]</a> def get_width_ratios(self):

"""

Return the width ratios.

This is *None* if no width ratios have been set explicitly.

"""

return self._col_width_ratios</div>

<div class="viewcode-block" id="GridSpecBase.set_height_ratios"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase.set_height_ratios">[docs]</a> def set_height_ratios(self, height_ratios):

"""

Set the relative heights of the rows.

*height_ratios* must be of length *nrows*. Each row gets a relative

height of ``height_ratios[i] / sum(height_ratios)``.

"""

if height_ratios is None:

height_ratios = [1] * self._nrows

elif len(height_ratios) != self._nrows:

raise ValueError('Expected the given number of height ratios to '

'match the number of rows of the grid')

self._row_height_ratios = height_ratios</div>

<div class="viewcode-block" id="GridSpecBase.get_height_ratios"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase.get_height_ratios">[docs]</a> def get_height_ratios(self):

"""

Return the height ratios.

This is *None* if no height ratios have been set explicitly.

"""

return self._row_height_ratios</div>

<div class="viewcode-block" id="GridSpecBase.get_grid_positions"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase.get_grid_positions">[docs]</a> def get_grid_positions(self, fig, raw=False):

"""

Return the positions of the grid cells in figure coordinates.

Parameters

----------

fig : `~matplotlib.figure.Figure`

The figure the grid should be applied to. The subplot parameters

(margins and spacing between subplots) are taken from *fig*.

raw : bool, default: False

If *True*, the subplot parameters of the figure are not taken

into account. The grid spans the range [0, 1] in both directions

without margins and there is no space between grid cells. This is

used for constrained_layout.

Returns

-------

bottoms, tops, lefts, rights : array

The bottom, top, left, right positions of the grid cells in

figure coordinates.

"""

nrows, ncols = self.get_geometry()

if raw:

left = 0.

right = 1.

bottom = 0.

top = 1.

wspace = 0.

hspace = 0.

else:

subplot_params = self.get_subplot_params(fig)

left = subplot_params.left

right = subplot_params.right

bottom = subplot_params.bottom

top = subplot_params.top

wspace = subplot_params.wspace

hspace = subplot_params.hspace

tot_width = right - left

tot_height = top - bottom

# calculate accumulated heights of columns

cell_h = tot_height / (nrows + hspace*(nrows-1))

sep_h = hspace * cell_h

norm = cell_h * nrows / sum(self._row_height_ratios)

cell_heights = [r * norm for r in self._row_height_ratios]

sep_heights = [0] + ([sep_h] * (nrows-1))

cell_hs = np.cumsum(np.column_stack([sep_heights, cell_heights]).flat)

# calculate accumulated widths of rows

cell_w = tot_width / (ncols + wspace*(ncols-1))

sep_w = wspace * cell_w

norm = cell_w * ncols / sum(self._col_width_ratios)

cell_widths = [r * norm for r in self._col_width_ratios]

sep_widths = [0] + ([sep_w] * (ncols-1))

cell_ws = np.cumsum(np.column_stack([sep_widths, cell_widths]).flat)

fig_tops, fig_bottoms = (top - cell_hs).reshape((-1, 2)).T

fig_lefts, fig_rights = (left + cell_ws).reshape((-1, 2)).T

return fig_bottoms, fig_tops, fig_lefts, fig_rights</div>

@staticmethod

def _check_gridspec_exists(figure, nrows, ncols):

"""

Check if the figure already has a gridspec with these dimensions,

or create a new one

"""

for ax in figure.get_axes():

if hasattr(ax, 'get_subplotspec'):

gs = ax.get_subplotspec().get_gridspec()

if hasattr(gs, 'get_topmost_subplotspec'):

# This is needed for colorbar gridspec layouts.

# This is probably OK because this whole logic tree

# is for when the user is doing simple things with the

# add_subplot command. For complicated layouts

# like subgridspecs the proper gridspec is passed in...

gs = gs.get_topmost_subplotspec().get_gridspec()

if gs.get_geometry() == (nrows, ncols):

return gs

# else gridspec not found:

return GridSpec(nrows, ncols, figure=figure)

<div class="viewcode-block" id="GridSpecBase.__getitem__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase.__getitem__">[docs]</a> def __getitem__(self, key):

"""Create and return a `.SubplotSpec` instance."""

def _normalize(key, size, axis): # Includes last index.

orig_key = key

if isinstance(key, slice):

start, stop, _ = key.indices(size)

if stop > start:

return start, stop - 1

raise IndexError("GridSpec slice would result in no space "

"allocated for subplot")

else:

if key < 0:

key = key + size

if 0 <= key < size:

return key, key

elif axis is not None:

raise IndexError(f"index {orig_key} is out of bounds for "

f"axis {axis} with size {size}")

else: # flat index

f"GridSpec with size {size}")

if isinstance(key, tuple):

try:

k1, k2 = key

except ValueError as err:

raise ValueError("Unrecognized subplot spec") from err

num1, num2 = np.ravel_multi_index(

[_normalize(k1, nrows, 0), _normalize(k2, ncols, 1)],

(nrows, ncols))

else: # Single key

num1, num2 = _normalize(key, nrows * ncols, None)

return SubplotSpec(self, num1, num2)</div>

<div class="viewcode-block" id="GridSpecBase.subplots"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecBase.html#matplotlib.gridspec.GridSpecBase.subplots">[docs]</a> def subplots(self, *, sharex=False, sharey=False, squeeze=True,

subplot_kw=None):

"""

Add all subplots specified by this `GridSpec` to its parent figure.

See `.Figure.subplots` for detailed documentation.

"""

figure = self.figure

if figure is None:

raise ValueError("GridSpec.subplots() only works for GridSpecs "

"created with a parent figure")

if isinstance(sharex, bool):

sharex = "all" if sharex else "none"

if isinstance(sharey, bool):

sharey = "all" if sharey else "none"

# This check was added because it is very easy to type

# `subplots(1, 2, 1)` when `subplot(1, 2, 1)` was intended.

# In most cases, no error will ever occur, but mysterious behavior

# will result because what was intended to be the subplot index is

# instead treated as a bool for sharex. This check should go away

# once sharex becomes kwonly.

if isinstance(sharex, Integral):

_api.warn_external(

"sharex argument to subplots() was an integer. Did you "

"intend to use subplot() (without 's')?")

_api.check_in_list(["all", "row", "col", "none"],

sharex=sharex, sharey=sharey)

if subplot_kw is None:

subplot_kw = {}

# don't mutate kwargs passed by user...

subplot_kw = subplot_kw.copy()

# Create array to hold all axes.

axarr = np.empty((self._nrows, self._ncols), dtype=object)

for row in range(self._nrows):

for col in range(self._ncols):

shared_with = {"none": None, "all": axarr[0, 0],

"row": axarr[row, 0], "col": axarr[0, col]}

subplot_kw["sharex"] = shared_with[sharex]

subplot_kw["sharey"] = shared_with[sharey]

axarr[row, col] = figure.add_subplot(

self[row, col], **subplot_kw)

# turn off redundant tick labeling

if sharex in ["col", "all"]:

for ax in axarr[:-1, :].flat: # Remove bottom labels/offsettexts.

ax.xaxis.set_tick_params(which="both", labelbottom=False)

if ax.xaxis.offsetText.get_position()[1] == 0:

ax.xaxis.offsetText.set_visible(False)

for ax in axarr[1:, :].flat: # Remove top labels/offsettexts.

ax.xaxis.set_tick_params(which="both", labeltop=False)

if sharey in ["row", "all"]:

for ax in axarr[:, 1:].flat: # Remove left labels/offsettexts.

ax.yaxis.set_tick_params(which="both", labelleft=False)

if ax.yaxis.offsetText.get_position()[0] == 0:

ax.yaxis.offsetText.set_visible(False)

for ax in axarr[:, :-1].flat: # Remove right labels/offsettexts.

ax.yaxis.set_tick_params(which="both", labelright=False)

if squeeze:

# Discarding unneeded dimensions that equal 1. If we only have one

# subplot, just return it instead of a 1-element array.

return axarr.item() if axarr.size == 1 else axarr.squeeze()

else:

# Returned axis array will be always 2-d, even if nrows=ncols=1.

return axarr</div></div>

<div class="viewcode-block" id="GridSpec"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec">[docs]</a>class GridSpec(GridSpecBase):

"""

A grid layout to place subplots within a figure.

The location of the grid cells is determined in a similar way to

`~.figure.SubplotParams` using *left*, *right*, *top*, *bottom*, *wspace*

and *hspace*.

"""

<div class="viewcode-block" id="GridSpec.__init__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec.__init__">[docs]</a> def __init__(self, nrows, ncols, figure=None,

left=None, bottom=None, right=None, top=None,

wspace=None, hspace=None,

width_ratios=None, height_ratios=None):

"""

Parameters

----------

nrows, ncols : int

The number of rows and columns of the grid.

figure : `~.figure.Figure`, optional

Only used for constrained layout to create a proper layoutgrid.

left, right, top, bottom : float, optional

Extent of the subplots as a fraction of figure width or height.

Left cannot be larger than right, and bottom cannot be larger than

top. If not given, the values will be inferred from a figure or

rcParams at draw time. See also `GridSpec.get_subplot_params`.

wspace : float, optional

The amount of width reserved for space between subplots,

expressed as a fraction of the average axis width.

If not given, the values will be inferred from a figure or

rcParams when necessary. See also `GridSpec.get_subplot_params`.

hspace : float, optional

The amount of height reserved for space between subplots,

expressed as a fraction of the average axis height.

If not given, the values will be inferred from a figure or

rcParams when necessary. See also `GridSpec.get_subplot_params`.

width_ratios : array-like of length *ncols*, optional

Defines the relative widths of the columns. Each column gets a

relative width of ``width_ratios[i] / sum(width_ratios)``.

If not given, all columns will have the same width.

height_ratios : array-like of length *nrows*, optional

Defines the relative heights of the rows. Each column gets a

relative height of ``height_ratios[i] / sum(height_ratios)``.

If not given, all rows will have the same height.

"""

self.left = left

self.bottom = bottom

self.right = right

self.top = top

self.wspace = wspace

self.hspace = hspace

self.figure = figure

super().__init__(nrows, ncols,

width_ratios=width_ratios,

height_ratios=height_ratios)

# set up layoutgrid for constrained_layout:

self._layoutgrid = None

if self.figure is None or not self.figure.get_constrained_layout():

self._layoutgrid = None

else:

self._toplayoutbox = self.figure._layoutgrid

self._layoutgrid = layoutgrid.LayoutGrid(

parent=self.figure._layoutgrid,

parent_inner=True,

name=(self.figure._layoutgrid.name + '.gridspec' +

layoutgrid.seq_id()),

ncols=ncols, nrows=nrows, width_ratios=width_ratios,

height_ratios=height_ratios)</div>

_AllowedKeys = ["left", "bottom", "right", "top", "wspace", "hspace"]

<div class="viewcode-block" id="GridSpec.__getstate__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec.__getstate__">[docs]</a> def __getstate__(self):

return {**self.__dict__, "_layoutgrid": None}</div>

<div class="viewcode-block" id="GridSpec.update"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec.update">[docs]</a> def update(self, **kwargs):

"""

Update the subplot parameters of the grid.

Parameters that are not explicitly given are not changed. Setting a

parameter to *None* resets it to :rc:`figure.subplot.*`.

Parameters

----------

left, right, top, bottom : float or None, optional

Extent of the subplots as a fraction of figure width or height.

wspace, hspace : float, optional

Spacing between the subplots as a fraction of the average subplot

width / height.

"""

for k, v in kwargs.items():

if k in self._AllowedKeys:

setattr(self, k, v)

else:

raise AttributeError(f"{k} is an unknown keyword")

for figmanager in _pylab_helpers.Gcf.figs.values():

for ax in figmanager.canvas.figure.axes:

if isinstance(ax, mpl.axes.SubplotBase):

ss = ax.get_subplotspec().get_topmost_subplotspec()

if ss.get_gridspec() == self:

ax._set_position(

ax.get_subplotspec().get_position(ax.figure))</div>

<div class="viewcode-block" id="GridSpec.get_subplot_params"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec.get_subplot_params">[docs]</a> def get_subplot_params(self, figure=None):

"""

Return the `~.SubplotParams` for the GridSpec.

In order of precedence the values are taken from

- non-*None* attributes of the GridSpec

- the provided *figure*

- :rc:`figure.subplot.*`

"""

if figure is None:

kw = {k: rcParams["figure.subplot."+k] for k in self._AllowedKeys}

subplotpars = mpl.figure.SubplotParams(**kw)

else:

subplotpars = copy.copy(figure.subplotpars)

subplotpars.update(**{k: getattr(self, k) for k in self._AllowedKeys})

return subplotpars</div>

<div class="viewcode-block" id="GridSpec.locally_modified_subplot_params"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec.locally_modified_subplot_params">[docs]</a> def locally_modified_subplot_params(self):

"""

Return a list of the names of the subplot parameters explicitly set

in the GridSpec.

This is a subset of the attributes of `.SubplotParams`.

"""

return [k for k in self._AllowedKeys if getattr(self, k)]</div>

<div class="viewcode-block" id="GridSpec.tight_layout"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec.tight_layout">[docs]</a> def tight_layout(self, figure, renderer=None,

pad=1.08, h_pad=None, w_pad=None, rect=None):

"""

Adjust subplot parameters to give specified padding.

Parameters

----------

pad : float

Padding between the figure edge and the edges of subplots, as a

fraction of the font-size.

h_pad, w_pad : float, optional

Padding (height/width) between edges of adjacent subplots.

Defaults to *pad*.

rect : tuple of 4 floats, default: (0, 0, 1, 1), i.e. the whole figure

(left, bottom, right, top) rectangle in normalized figure

coordinates that the whole subplots area (including labels) will

fit into.

"""

subplotspec_list = tight_layout.get_subplotspec_list(

figure.axes, grid_spec=self)

if None in subplotspec_list:

_api.warn_external("This figure includes Axes that are not "

"compatible with tight_layout, so results "

"might be incorrect.")

if renderer is None:

renderer = tight_layout.get_renderer(figure)

kwargs = tight_layout.get_tight_layout_figure(

figure, figure.axes, subplotspec_list, renderer,

pad=pad, h_pad=h_pad, w_pad=w_pad, rect=rect)

if kwargs:

self.update(**kwargs)</div></div>

<div class="viewcode-block" id="GridSpecFromSubplotSpec"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecFromSubplotSpec.html#matplotlib.gridspec.GridSpecFromSubplotSpec">[docs]</a>class GridSpecFromSubplotSpec(GridSpecBase):

"""

GridSpec whose subplot layout parameters are inherited from the

location specified by a given SubplotSpec.

"""

<div class="viewcode-block" id="GridSpecFromSubplotSpec.__init__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecFromSubplotSpec.html#matplotlib.gridspec.GridSpecFromSubplotSpec.__init__">[docs]</a> def __init__(self, nrows, ncols,

subplot_spec,

height_ratios=None, width_ratios=None):

"""

The number of rows and number of columns of the grid need to

be set. An instance of SubplotSpec is also needed to be set

from which the layout parameters will be inherited. The wspace

and hspace of the layout can be optionally specified or the

default values (from the figure or rcParams) will be used.

"""

self._wspace = wspace

self._hspace = hspace

self._subplot_spec = subplot_spec

self.figure = self._subplot_spec.get_gridspec().figure

width_ratios=width_ratios,

height_ratios=height_ratios)

# do the layoutgrids for constrained_layout:

subspeclb = subplot_spec.get_gridspec()._layoutgrid

if subspeclb is None:

self._layoutgrid = None

else:

# this _toplayoutbox is a container that spans the cols and

# rows in the parent gridspec. Not yet implemented,

# but we do this so that it is possible to have subgridspec

# level artists.

self._toplayoutgrid = layoutgrid.LayoutGrid(

parent=subspeclb,

name=subspeclb.name + '.top' + layoutgrid.seq_id(),

nrows=1, ncols=1,

parent_pos=(subplot_spec.rowspan, subplot_spec.colspan))

parent=self._toplayoutgrid,

name=(self._toplayoutgrid.name + '.gridspec' +

layoutgrid.seq_id()),

nrows=nrows, ncols=ncols,

width_ratios=width_ratios, height_ratios=height_ratios)</div>

<div class="viewcode-block" id="GridSpecFromSubplotSpec.get_subplot_params"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecFromSubplotSpec.html#matplotlib.gridspec.GridSpecFromSubplotSpec.get_subplot_params">[docs]</a> def get_subplot_params(self, figure=None):

"""Return a dictionary of subplot layout parameters."""

hspace = (self._hspace if self._hspace is not None

else figure.subplotpars.hspace if figure is not None

else rcParams["figure.subplot.hspace"])

wspace = (self._wspace if self._wspace is not None

else figure.subplotpars.wspace if figure is not None

else rcParams["figure.subplot.wspace"])

figbox = self._subplot_spec.get_position(figure)

left, bottom, right, top = figbox.extents

return mpl.figure.SubplotParams(left=left, right=right,

bottom=bottom, top=top,

wspace=wspace, hspace=hspace)</div>

<div class="viewcode-block" id="GridSpecFromSubplotSpec.get_topmost_subplotspec"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.GridSpecFromSubplotSpec.html#matplotlib.gridspec.GridSpecFromSubplotSpec.get_topmost_subplotspec">[docs]</a> def get_topmost_subplotspec(self):

"""

Return the topmost `.SubplotSpec` instance associated with the subplot.

"""

return self._subplot_spec.get_topmost_subplotspec()</div></div>

<div class="viewcode-block" id="SubplotSpec"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec">[docs]</a>class SubplotSpec:

"""

Specifies the location of a subplot in a `GridSpec`.

.. note::

Likely, you'll never instantiate a `SubplotSpec` yourself. Instead you

will typically obtain one from a `GridSpec` using item-access.

Parameters

----------

gridspec : `~matplotlib.gridspec.GridSpec`

The GridSpec, which the subplot is referencing.

num1, num2 : int

The subplot will occupy the num1-th cell of the given

gridspec. If num2 is provided, the subplot will span between

num1-th cell and num2-th cell *inclusive*.

The index starts from 0.

"""

<div class="viewcode-block" id="SubplotSpec.__init__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.__init__">[docs]</a> def __init__(self, gridspec, num1, num2=None):

self._gridspec = gridspec

self.num1 = num1

self.num2 = num2</div>

<div class="viewcode-block" id="SubplotSpec.__repr__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.__repr__">[docs]</a> def __repr__(self):

return (f"{self.get_gridspec()}["

f"{self.rowspan.start}:{self.rowspan.stop}, "

f"{self.colspan.start}:{self.colspan.stop}]")</div>

@staticmethod

def _from_subplot_args(figure, args):

"""

Construct a `.SubplotSpec` from a parent `.Figure` and either

- a `.SubplotSpec` -- returned as is;

- one or three numbers -- a MATLAB-style subplot specifier.

"""

message = ("Passing non-integers as three-element position "

"specification is deprecated since %(since)s and will be "

"removed %(removal)s.")

if len(args) == 1:

arg, = args

if isinstance(arg, SubplotSpec):

return arg

else:

if not isinstance(arg, Integral):

_api.warn_deprecated("3.3", message=message)

arg = str(arg)

try:

rows, cols, num = map(int, str(arg))

except ValueError:

raise ValueError(

f"Single argument to subplot must be a three-digit "

f"integer, not {arg}") from None

i = j = num

elif len(args) == 3:

rows, cols, num = args

if not (isinstance(rows, Integral) and isinstance(cols, Integral)):

rows, cols = map(int, [rows, cols])

gs = GridSpec(rows, cols, figure=figure)

if isinstance(num, tuple) and len(num) == 2:

if not all(isinstance(n, Integral) for n in num):

i, j = map(int, num)

else:

i, j = num

else:

if not isinstance(num, Integral):

num = int(num)

if num < 1 or num > rows*cols:

raise ValueError(

f"num must be 1 <= num <= {rows*cols}, not {num}")

i = j = num

else:

raise TypeError(f"subplot() takes 1 or 3 positional arguments but "

f"{len(args)} were given")

gs = GridSpec._check_gridspec_exists(figure, rows, cols)

if gs is None:

return gs[i-1:j]

# num2 is a property only to handle the case where it is None and someone

# mutates num1.

@property

def num2(self):

return self.num1 if self._num2 is None else self._num2

@num2.setter

def num2(self, value):

self._num2 = value

<div class="viewcode-block" id="SubplotSpec.__getstate__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.__getstate__">[docs]</a> def __getstate__(self):

return {**self.__dict__}</div>

<div class="viewcode-block" id="SubplotSpec.get_gridspec"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.get_gridspec">[docs]</a> def get_gridspec(self):

return self._gridspec</div>

<div class="viewcode-block" id="SubplotSpec.get_geometry"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.get_geometry">[docs]</a> def get_geometry(self):

"""

Return the subplot geometry as tuple ``(n_rows, n_cols, start, stop)``.

The indices *start* and *stop* define the range of the subplot within

the `GridSpec`. *stop* is inclusive (i.e. for a single cell

``start == stop``).

"""

rows, cols = self.get_gridspec().get_geometry()

return rows, cols, self.num1, self.num2</div>

<div class="viewcode-block" id="SubplotSpec.get_rows_columns"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.get_rows_columns">[docs]</a> @_api.deprecated("3.3", alternative="rowspan, colspan")

def get_rows_columns(self):

"""

Return the subplot row and column numbers as a tuple

``(n_rows, n_cols, row_start, row_stop, col_start, col_stop)``.

"""

gridspec = self.get_gridspec()

nrows, ncols = gridspec.get_geometry()

row_start, col_start = divmod(self.num1, ncols)

row_stop, col_stop = divmod(self.num2, ncols)

return nrows, ncols, row_start, row_stop, col_start, col_stop</div>

@property

def rowspan(self):

"""The rows spanned by this subplot, as a `range` object."""

ncols = self.get_gridspec().ncols

return range(self.num1 // ncols, self.num2 // ncols + 1)

@property

def colspan(self):

"""The columns spanned by this subplot, as a `range` object."""

# We explicitly support num2 referring to a column on num1's *left*, so

# we must sort the column indices here so that the range makes sense.

c1, c2 = sorted([self.num1 % ncols, self.num2 % ncols])

return range(c1, c2 + 1)

<div class="viewcode-block" id="SubplotSpec.is_first_row"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.is_first_row">[docs]</a> def is_first_row(self):

return self.rowspan.start == 0</div>

<div class="viewcode-block" id="SubplotSpec.is_last_row"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.is_last_row">[docs]</a> def is_last_row(self):

return self.rowspan.stop == self.get_gridspec().nrows</div>

<div class="viewcode-block" id="SubplotSpec.is_first_col"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.is_first_col">[docs]</a> def is_first_col(self):

return self.colspan.start == 0</div>

<div class="viewcode-block" id="SubplotSpec.is_last_col"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.is_last_col">[docs]</a> def is_last_col(self):

return self.colspan.stop == self.get_gridspec().ncols</div>

<div class="viewcode-block" id="SubplotSpec.get_position"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.get_position">[docs]</a> @_api.delete_parameter("3.4", "return_all")

def get_position(self, figure, return_all=False):

"""

Update the subplot position from ``figure.subplotpars``.

"""

gridspec = self.get_gridspec()

rows, cols = np.unravel_index([self.num1, self.num2], (nrows, ncols))

fig_bottoms, fig_tops, fig_lefts, fig_rights = \

gridspec.get_grid_positions(figure)

fig_bottom = fig_bottoms[rows].min()

fig_top = fig_tops[rows].max()

fig_left = fig_lefts[cols].min()

fig_right = fig_rights[cols].max()

figbox = Bbox.from_extents(fig_left, fig_bottom, fig_right, fig_top)

if return_all:

return figbox, rows[0], cols[0], nrows, ncols

else:

return figbox</div>

<div class="viewcode-block" id="SubplotSpec.get_topmost_subplotspec"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.get_topmost_subplotspec">[docs]</a> def get_topmost_subplotspec(self):

"""

Return the topmost `SubplotSpec` instance associated with the subplot.

"""

gridspec = self.get_gridspec()

if hasattr(gridspec, "get_topmost_subplotspec"):

return gridspec.get_topmost_subplotspec()

else:

return self</div>

<div class="viewcode-block" id="SubplotSpec.__eq__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.__eq__">[docs]</a> def __eq__(self, other):

"""

Two SubplotSpecs are considered equal if they refer to the same

position(s) in the same `GridSpec`.

"""

# other may not even have the attributes we are checking.

return ((self._gridspec, self.num1, self.num2)

== (getattr(other, "_gridspec", object()),

getattr(other, "num1", object()),

getattr(other, "num2", object())))</div>

<div class="viewcode-block" id="SubplotSpec.__hash__"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.__hash__">[docs]</a> def __hash__(self):

return hash((self._gridspec, self.num1, self.num2))</div>

<div class="viewcode-block" id="SubplotSpec.subgridspec"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.gridspec.SubplotSpec.html#matplotlib.gridspec.SubplotSpec.subgridspec">[docs]</a> def subgridspec(self, nrows, ncols, **kwargs):

"""

Create a GridSpec within this subplot.

The created `.GridSpecFromSubplotSpec` will have this `SubplotSpec` as

a parent.

Parameters

----------

nrows : int

Number of rows in grid.

ncols : int

Number or columns in grid.

Returns

-------

`.GridSpecFromSubplotSpec`

Other Parameters

----------------

**kwargs

All other parameters are passed to `.GridSpecFromSubplotSpec`.

See Also

--------

matplotlib.pyplot.subplots

Examples

--------

Adding three subplots in the space occupied by a single subplot::

fig = plt.figure()

gs0 = fig.add_gridspec(3, 1)

ax1 = fig.add_subplot(gs0[0])

ax2 = fig.add_subplot(gs0[1])

gssub = gs0[2].subgridspec(1, 3)

for i in range(3):

fig.add_subplot(gssub[0, i])

"""

return GridSpecFromSubplotSpec(nrows, ncols, self, **kwargs)</div></div>

</pre></div>

</div>

</div>

Last updated on Mar 26, 2021.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1.

Doc version v3.4.0-2-gcb03754703.

</div>

</footer>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

gridspec.html

Latest commit

History

gridspec.html

File metadata and controls