matplotlib.github.com/3.10.8/users/explain/axes/mosaic.html at main · matplotlib/matplotlib.github.com

History

1077 lines (841 loc) · 99.8 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

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE html>

<head>

<title>Complex and semantic figure composition (subplot_mosaic) — Matplotlib 3.10.8 documentation</title>

document.documentElement.dataset.mode = localStorage.getItem("mode") || "";

document.documentElement.dataset.theme = localStorage.getItem("theme") || "";

</script>

DOCUMENTATION_OPTIONS.theme_version = '0.15.4';

DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://matplotlib.org/devdocs/_static/switcher.json?v3.10.8-7-g1957ba3918';

DOCUMENTATION_OPTIONS.theme_switcher_version_match = '3.10.8';

DOCUMENTATION_OPTIONS.show_version_warning_banner = true;

</script>

title="Search within Matplotlib 3.10.8 documentation"

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

</head>

<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>

Back to top</button>

<input type="checkbox"

class="sidebar-toggle"

id="pst-primary-sidebar-checkbox"/>

<input type="checkbox"

class="sidebar-toggle"

id="pst-secondary-sidebar-checkbox"/>

<form class="bd-search d-flex align-items-center"

action="../../../search.html"

method="get">

<input type="search"

class="form-control"

name="q"

id="search-input"

placeholder="Search the docs ..."

aria-label="Search the docs ..."

autocomplete="off"

autocorrect="off"

autocapitalize="off"

spellcheck="false"/>

</form></div>

</div>

</div>

</button>

</a></div>

</div>

<a class="reference internal nav-link" href="../../../plot_types/index.html">Plot types</a>

</li>

<a class="reference internal nav-link" href="../../index.html">User guide</a>

</li>

<a class="reference internal nav-link" href="../../../tutorials/index.html">Tutorials</a>

</li>

<a class="reference internal nav-link" href="../../../gallery/index.html">Examples</a>

</li>

<a class="reference internal nav-link" href="../../../api/index.html">Reference</a>

</li>

<a class="reference internal nav-link" href="../../../devel/index.html">Contribute</a>

</li>

<a class="reference internal nav-link" href="../../release_notes.html">Releases</a>

</li>

</ul></div>

</div>

document.write(`

</button>

`);

</script>

</div>

document.write(`

</button>

`);

</script></div>

document.write(`

<button id="pst-version-switcher-button-2"

type="button"

class="version-switcher__button btn btn-sm dropdown-toggle"

data-bs-toggle="dropdown"

aria-haspopup="listbox"

aria-controls="pst-version-switcher-list-2"

aria-label="Version switcher list"

Choose version

</button>

<div id="pst-version-switcher-list-2"

class="version-switcher__menu dropdown-menu list-group-flush py-0"

role="listbox" aria-labelledby="pst-version-switcher-button-2">

</div>

`);

</script></div>

<div class="navbar-item"><ul class="navbar-icon-links"

aria-label="Icon Links">

Gitter</a>

</li>

Discourse</a>

</li>

GitHub</a>

</li>

Twitter</a>

</li>

</ul></div>

</div>

document.write(`

</button>

`);

</script>

</div>

</button>

</div>

</header>

<a class="reference internal nav-link" href="../../../plot_types/index.html">Plot types</a>

</li>

<a class="reference internal nav-link" href="../../index.html">User guide</a>

</li>

<a class="reference internal nav-link" href="../../../tutorials/index.html">Tutorials</a>

</li>

<a class="reference internal nav-link" href="../../../gallery/index.html">Examples</a>

</li>

<a class="reference internal nav-link" href="../../../api/index.html">Reference</a>

</li>

<a class="reference internal nav-link" href="../../../devel/index.html">Contribute</a>

</li>

<a class="reference internal nav-link" href="../../release_notes.html">Releases</a>

</li>

</ul></div>

</div>

document.write(`

</button>

`);

</script></div>

document.write(`

<button id="pst-version-switcher-button-3"

type="button"

class="version-switcher__button btn btn-sm dropdown-toggle"

data-bs-toggle="dropdown"

aria-haspopup="listbox"

aria-controls="pst-version-switcher-list-3"

aria-label="Version switcher list"

Choose version

</button>

<div id="pst-version-switcher-list-3"

class="version-switcher__menu dropdown-menu list-group-flush py-0"

role="listbox" aria-labelledby="pst-version-switcher-button-3">

</div>

`);

</script></div>

<div class="navbar-item"><ul class="navbar-icon-links"

aria-label="Icon Links">

Gitter</a>

</li>

Discourse</a>

</li>

GitHub</a>

</li>

Twitter</a>

</li>

</ul></div>

</div>

<nav class="bd-docs-nav bd-links"

aria-label="Section Navigation">

Section Navigation

<li class="toctree-l1"><a class="reference internal" href="../quick_start.html">Quick start guide</a></li>

</ul>

<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Frequently Asked Questions</a></li>

</ul>

<li class="toctree-l1 has-children"><a class="reference internal" href="../figure/index.html">Figures and backends</a><details><summary></summary><ul>

<li class="toctree-l2"><a class="reference internal" href="../figure/figure_intro.html">Introduction to figures</a></li>

<li class="toctree-l2"><a class="reference internal" href="../figure/backends.html">Output backends</a></li>

<li class="toctree-l2"><a class="reference internal" href="../figure/api_interfaces.html">Matplotlib Application Interfaces (APIs)</a></li>

<li class="toctree-l2"><a class="reference internal" href="../figure/interactive.html">Interacting with figures</a></li>

<li class="toctree-l2"><a class="reference internal" href="../figure/interactive_guide.html">Interactive figures and asynchronous programming</a></li>

<li class="toctree-l2"><a class="reference internal" href="../figure/event_handling.html">Event handling</a></li>

<li class="toctree-l2"><a class="reference internal" href="../figure/writing_a_backend_pyplot_interface.html">Writing a backend -- the pyplot interface</a></li>

</ul>

</details></li>

</ul>

<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">Axes and subplots</a><details open="open"><summary></summary><ul class="current">

<li class="toctree-l2"><a class="reference internal" href="axes_intro.html">Introduction to Axes (or Subplots)</a></li>

<li class="toctree-l2"><a class="reference internal" href="arranging_axes.html">Arranging multiple Axes in a Figure</a></li>

<li class="toctree-l2"><a class="reference internal" href="colorbar_placement.html">Placing colorbars</a></li>

<li class="toctree-l2"><a class="reference internal" href="autoscale.html">Autoscaling axes</a></li>

<li class="toctree-l2"><a class="reference internal" href="axes_scales.html">Axis scales</a></li>

<li class="toctree-l2"><a class="reference internal" href="axes_ticks.html">Axis ticks</a></li>

<li class="toctree-l2"><a class="reference internal" href="axes_units.html">Plotting dates and strings</a></li>

<li class="toctree-l2"><a class="reference internal" href="legend_guide.html">Legends</a></li>

<li class="toctree-l2 current active"><a class="current reference internal" href="#">Subplot mosaic</a></li>

<li class="toctree-l2"><a class="reference internal" href="constrainedlayout_guide.html">Constrained layout guide</a></li>

<li class="toctree-l2"><a class="reference internal" href="tight_layout_guide.html">Tight layout guide (mildly discouraged)</a></li>

</ul>

</details></li>

</ul>

<li class="toctree-l1 has-children"><a class="reference internal" href="../artists/index.html">Artists</a><details><summary></summary><ul>

<li class="toctree-l2"><a class="reference internal" href="../artists/artist_intro.html">Introduction to Artists</a></li>

<li class="toctree-l2"><a class="reference internal" href="../artists/color_cycle.html">Automated color cycle</a></li>

<li class="toctree-l2"><a class="reference internal" href="../artists/performance.html">Optimizing Artists for performance</a></li>

<li class="toctree-l2"><a class="reference internal" href="../artists/paths.html">Paths</a></li>

<li class="toctree-l2"><a class="reference internal" href="../artists/patheffects_guide.html">Path effects guide</a></li>

<li class="toctree-l2"><a class="reference internal" href="../artists/imshow_extent.html">Understanding the extent keyword argument of imshow</a></li>

<li class="toctree-l2"><a class="reference internal" href="../artists/transforms_tutorial.html">Transformations Tutorial</a></li>

</ul>

</details></li>

</ul>

<li class="toctree-l1"><a class="reference internal" href="../customizing.html">Customizing Matplotlib with style sheets and rcParams</a></li>

</ul>

<li class="toctree-l1 has-children"><a class="reference internal" href="../colors/index.html">Colors</a><details><summary></summary><ul>

<li class="toctree-l2"><a class="reference internal" href="../colors/colors.html">Specifying colors</a></li>

<li class="toctree-l2"><a class="reference internal" href="../colors/colorbar_only.html">Customized Colorbars Tutorial</a></li>

<li class="toctree-l2"><a class="reference internal" href="../colors/colormap-manipulation.html">Creating Colormaps in Matplotlib</a></li>

<li class="toctree-l2"><a class="reference internal" href="../colors/colormapnorms.html">Colormap normalization</a></li>

<li class="toctree-l2"><a class="reference internal" href="../colors/colormaps.html">Choosing Colormaps in Matplotlib</a></li>

</ul>

</details></li>

</ul>

<li class="toctree-l2"><a class="reference internal" href="../text/text_intro.html">Text in Matplotlib</a></li>

<li class="toctree-l2"><a class="reference internal" href="../text/text_props.html">Text properties and layout</a></li>

<li class="toctree-l2"><a class="reference internal" href="../text/annotations.html">Annotations</a></li>

<li class="toctree-l2"><a class="reference internal" href="../text/fonts.html">Fonts in Matplotlib</a></li>

<li class="toctree-l2"><a class="reference internal" href="../text/mathtext.html">Writing mathematical expressions</a></li>

<li class="toctree-l2"><a class="reference internal" href="../text/pgf.html">Text rendering with XeLaTeX/LuaLaTeX via the <code class="docutils literal notranslate">pgf</code> backend</a></li>

<li class="toctree-l2"><a class="reference internal" href="../text/usetex.html">Text rendering with LaTeX</a></li>

</ul>

</details></li>

</ul>

<li class="toctree-l1 has-children"><a class="reference internal" href="../animations/index.html">Animations using Matplotlib</a><details><summary></summary><ul>

<li class="toctree-l2"><a class="reference internal" href="../animations/animations.html">Animations using Matplotlib</a></li>

<li class="toctree-l2"><a class="reference internal" href="../animations/blitting.html">Faster rendering by using blitting</a></li>

</ul>

</details></li>

</ul>

<li class="toctree-l1 has-children"><a class="reference internal" href="../toolkits/index.html">User Toolkits</a><details><summary></summary><ul>

<li class="toctree-l2"><a class="reference internal" href="../toolkits/axisartist.html">The axisartist toolkit</a></li>

<li class="toctree-l2"><a class="reference internal" href="../toolkits/axes_grid.html">The axes_grid1 toolkit</a></li>

<li class="toctree-l2"><a class="reference internal" href="../toolkits/mplot3d.html">The mplot3d toolkit</a></li>

</ul>

</details></li>

</ul>

<li class="toctree-l1"><a class="reference internal" href="../../getting_started/index.html">Getting started</a></li>

<li class="toctree-l1 has-children"><a class="reference internal" href="../../../install/index.html">Installation</a><details><summary></summary><ul>

<li class="toctree-l2"><a class="reference internal" href="../../../install/environment_variables_faq.html">Environment variables</a></li>

<li class="toctree-l2"><a class="reference internal" href="../../../install/dependencies.html">Dependencies</a></li>

</ul>

</details></li>

</ul>

</div>

</nav></div>

</div>

</div>

</div>

</a>

</li>

<li class="breadcrumb-item"><a href="../../index.html" class="nav-link">Using Matplotlib</a></li>

<li class="breadcrumb-item"><a href="index.html" class="nav-link">Axes and subplots</a></li>

<li class="breadcrumb-item active" aria-current="page">Complex and...</li>

</ul>

</nav>

</div>

Note

to download the full example code.

</div>

<h1>Complex and semantic figure composition (subplot_mosaic)<a class="headerlink" href="#complex-and-semantic-figure-composition-subplot-mosaic" title="Link to this heading">#</a></h1>

Laying out Axes in a Figure in a non-uniform grid can be both tedious

and verbose. For dense, even grids we have <a class="reference internal" href="../../../api/_as_gen/matplotlib.figure.Figure.subplots.html#matplotlib.figure.Figure.subplots" title="matplotlib.figure.Figure.subplots"><code class="xref py py-obj docutils literal notranslate">Figure.subplots</code></a> but for

more complex layouts, such as Axes that span multiple columns / rows

of the layout or leave some areas of the Figure blank, you can use

<a class="reference internal" href="../../../api/_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec" title="matplotlib.gridspec.GridSpec"><code class="xref py py-obj docutils literal notranslate">gridspec.GridSpec</code></a> (see <a class="reference internal" href="arranging_axes.html#arranging-axes">Arranging multiple Axes in a Figure</a>) or

manually place your Axes. <a class="reference internal" href="../../../api/_as_gen/matplotlib.figure.Figure.subplot_mosaic.html#matplotlib.figure.Figure.subplot_mosaic" title="matplotlib.figure.Figure.subplot_mosaic"><code class="xref py py-obj docutils literal notranslate">Figure.subplot_mosaic</code></a> aims to provide an

interface to visually lay out your Axes (as either ASCII art or nested

lists) to streamline this process.

This interface naturally supports naming your Axes.

<a class="reference internal" href="../../../api/_as_gen/matplotlib.figure.Figure.subplot_mosaic.html#matplotlib.figure.Figure.subplot_mosaic" title="matplotlib.figure.Figure.subplot_mosaic"><code class="xref py py-obj docutils literal notranslate">Figure.subplot_mosaic</code></a> returns a dictionary keyed on the

labels used to lay out the Figure. By returning data structures with

names, it is easier to write plotting code that is independent of the

Figure layout.

This is inspired by a <a class="reference external" href="https://github.com/matplotlib/matplotlib/pull/4384">proposed MEP</a> and the

<a class="reference external" href="https://github.com/thomasp85/patchwork">patchwork</a> library for R.

While we do not implement the operator overloading style, we do

provide a Pythonic API for specifying (nested) Axes layouts.

<div class="highlight-Python notranslate"><div class="highlight"><pre>import matplotlib.pyplot as plt

import numpy as np

# Helper function used for visualization in the following examples

def identify_axes(<a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">ax_dict</a>, fontsize=48):

"""

Helper to identify the Axes in the examples below.

Draws the label in a large font in the center of the Axes.

Parameters

----------

ax_dict : dict[str, Axes]

Mapping between the title / label and the Axes.

fontsize : int, optional

How big the label should be.

"""

kw = dict(ha="center", va="center", fontsize=fontsize, color="darkgrey")

for k, ax in <a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">ax_dict</a>.items():

ax.text(0.5, 0.5, k, transform=ax.transAxes, **kw)

</pre></div>

</div>

If we want a 2x2 grid we can use <a class="reference internal" href="../../../api/_as_gen/matplotlib.figure.Figure.subplots.html#matplotlib.figure.Figure.subplots" title="matplotlib.figure.Figure.subplots"><code class="xref py py-obj docutils literal notranslate">Figure.subplots</code></a> which returns a 2D array

of <a class="reference internal" href="../../../api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate">axes.Axes</code></a> which we can index into to do our plotting.

<div class="highlight-Python notranslate"><div class="highlight"><pre><a href="https://numpy.org/doc/stable/reference/random/generated/numpy.random.seed.html#numpy.random.seed" title="numpy.random.seed" class="sphx-glr-backref-module-numpy-random sphx-glr-backref-type-py-function">np.random.seed</a>(19680801)

<a href="../../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure" class="sphx-glr-backref-module-matplotlib-figure sphx-glr-backref-type-py-class sphx-glr-backref-instance">fig</a> = <a href="../../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="matplotlib.pyplot.figure" class="sphx-glr-backref-module-matplotlib-pyplot sphx-glr-backref-type-py-function">plt.figure</a>(layout="constrained")

<a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance">ax_array</a> = <a href="../../../api/_as_gen/matplotlib.figure.Figure.subplots.html#matplotlib.figure.Figure.subplots" title="matplotlib.figure.Figure.subplots" class="sphx-glr-backref-module-matplotlib-figure sphx-glr-backref-type-py-method">fig.subplots</a>(2, 2, squeeze=False)

<a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance">ax_array</a>[0, 0].bar(["a", "b", "c"], [5, 7, 9])

<a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance">ax_array</a>[1, 0].hist(<a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance">hist_data</a>, bins="auto")

identify_axes(

{(<a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">j</a>, k): a for <a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">j</a>, r in enumerate(<a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance">ax_array</a>) for k, a in enumerate(r)},

)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_001.png" srcset="../../../_images/sphx_glr_mosaic_001.png, ../../../_images/sphx_glr_mosaic_001_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>Using <a class="reference internal" href="../../../api/_as_gen/matplotlib.figure.Figure.subplot_mosaic.html#matplotlib.figure.Figure.subplot_mosaic" title="matplotlib.figure.Figure.subplot_mosaic"><code class="xref py py-obj docutils literal notranslate">Figure.subplot_mosaic</code></a> we can produce the same mosaic but give the

Axes semantic names

<div class="highlight-Python notranslate"><div class="highlight"><pre><a href="../../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure" class="sphx-glr-backref-module-matplotlib-figure sphx-glr-backref-type-py-class sphx-glr-backref-instance">fig</a> = <a href="../../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="matplotlib.pyplot.figure" class="sphx-glr-backref-module-matplotlib-pyplot sphx-glr-backref-type-py-function">plt.figure</a>(layout="constrained")

[

["bar", "plot"],

["hist", "image"],

],

)

<a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">ax_dict</a>["bar"].bar(["a", "b", "c"], [5, 7, 9])

<a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">ax_dict</a>["hist"].hist(<a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance">hist_data</a>)

identify_axes(<a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">ax_dict</a>)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_002.png" srcset="../../../_images/sphx_glr_mosaic_002.png, ../../../_images/sphx_glr_mosaic_002_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>A key difference between <a class="reference internal" href="../../../api/_as_gen/matplotlib.figure.Figure.subplots.html#matplotlib.figure.Figure.subplots" title="matplotlib.figure.Figure.subplots"><code class="xref py py-obj docutils literal notranslate">Figure.subplots</code></a> and

returns an array for index access, the latter returns a dictionary

mapping the labels to the <a class="reference internal" href="../../../api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate">axes.Axes</code></a> instances created

<div class="highlight-Python notranslate"><div class="highlight"><pre>print(<a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">ax_dict</a>)

</pre></div>

</div>

<div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre>{'bar': <Axes: label='bar'>, 'plot': <Axes: label='plot'>, 'hist': <Axes: label='hist'>, 'image': <Axes: label='image'>}

</pre></div>

</div>

<h2>String short-hand<a class="headerlink" href="#string-short-hand" title="Link to this heading">#</a></h2>

By restricting our Axes labels to single characters we can

"draw" the Axes we want as "ASCII art". The following

AB

CD

"""

</pre></div>

</div>

will give us 4 Axes laid out in a 2x2 grid and generates the same

figure mosaic as above (but now labeled with <code class="docutils literal notranslate">{"A", "B", "C",

"D"}</code> rather than <code class="docutils literal notranslate">{"bar", "plot", "hist", "image"}</code>).

<a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">ax_dict</a> = <a href="../../../api/_as_gen/matplotlib.figure.Figure.subplot_mosaic.html#matplotlib.figure.Figure.subplot_mosaic" title="matplotlib.figure.Figure.subplot_mosaic" class="sphx-glr-backref-module-matplotlib-figure sphx-glr-backref-type-py-method">fig.subplot_mosaic</a>(<a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance">mosaic</a>)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_003.png" srcset="../../../_images/sphx_glr_mosaic_003.png, ../../../_images/sphx_glr_mosaic_003_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>Alternatively, you can use the more compact string notation

</pre></div>

</div>

will give you the same composition, where the <code class="docutils literal notranslate">";"</code> is used

as the row separator instead of newline.

<a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">ax_dict</a> = <a href="../../../api/_as_gen/matplotlib.figure.Figure.subplot_mosaic.html#matplotlib.figure.Figure.subplot_mosaic" title="matplotlib.figure.Figure.subplot_mosaic" class="sphx-glr-backref-module-matplotlib-figure sphx-glr-backref-type-py-method">fig.subplot_mosaic</a>(<a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance">mosaic</a>)

</pre></div>

</div>

<h2>Axes spanning multiple rows/columns<a class="headerlink" href="#axes-spanning-multiple-rows-columns" title="Link to this heading">#</a></h2>

Something we can do with <a class="reference internal" href="../../../api/_as_gen/matplotlib.figure.Figure.subplot_mosaic.html#matplotlib.figure.Figure.subplot_mosaic" title="matplotlib.figure.Figure.subplot_mosaic"><code class="xref py py-obj docutils literal notranslate">Figure.subplot_mosaic</code></a>, that we cannot

do with <a class="reference internal" href="../../../api/_as_gen/matplotlib.figure.Figure.subplots.html#matplotlib.figure.Figure.subplots" title="matplotlib.figure.Figure.subplots"><code class="xref py py-obj docutils literal notranslate">Figure.subplots</code></a>, is to specify that an Axes should span

several rows or columns.

If we want to re-arrange our four Axes to have <code class="docutils literal notranslate">"C"</code> be a horizontal

span on the bottom and <code class="docutils literal notranslate">"D"</code> be a vertical span on the right we would do

<div class="highlight-Python notranslate"><div class="highlight"><pre><a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">axd</a> = <a href="../../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="matplotlib.pyplot.figure" class="sphx-glr-backref-module-matplotlib-pyplot sphx-glr-backref-type-py-function">plt.figure</a>(layout="constrained").subplot_mosaic(

"""

ABD

CCD

"""

)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_005.png" srcset="../../../_images/sphx_glr_mosaic_005.png, ../../../_images/sphx_glr_mosaic_005_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>If we do not want to fill in all the spaces in the Figure with Axes,

we can specify some spaces in the grid to be blank

"""

A.C

BBB

.D.

"""

)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_006.png" srcset="../../../_images/sphx_glr_mosaic_006.png, ../../../_images/sphx_glr_mosaic_006_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>If we prefer to use another character (rather than a period <code class="docutils literal notranslate">"."</code>)

to mark the empty space, we can use empty_sentinel to specify the

character to use.

"""

aX

Xb

""",

empty_sentinel="X",

)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_007.png" srcset="../../../_images/sphx_glr_mosaic_007.png, ../../../_images/sphx_glr_mosaic_007_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>Internally there is no meaning attached to the letters we use, any

Unicode code point is valid!

"""αб

ℝ☢"""

)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_008.png" srcset="../../../_images/sphx_glr_mosaic_008.png, ../../../_images/sphx_glr_mosaic_008_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>It is not recommended to use white space as either a label or an

empty sentinel with the string shorthand because it may be stripped

while processing the input.

</section>

<h2>Controlling mosaic creation<a class="headerlink" href="#controlling-mosaic-creation" title="Link to this heading">#</a></h2>

This feature is built on top of <a class="reference internal" href="../../../api/gridspec_api.html#module-matplotlib.gridspec" title="matplotlib.gridspec"><code class="xref py py-obj docutils literal notranslate">gridspec</code></a> and you can pass the

keyword arguments through to the underlying <a class="reference internal" href="../../../api/_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec" title="matplotlib.gridspec.GridSpec"><code class="xref py py-obj docutils literal notranslate">gridspec.GridSpec</code></a>

(the same as <a class="reference internal" href="../../../api/_as_gen/matplotlib.figure.Figure.subplots.html#matplotlib.figure.Figure.subplots" title="matplotlib.figure.Figure.subplots"><code class="xref py py-obj docutils literal notranslate">Figure.subplots</code></a>).

In this case we want to use the input to specify the arrangement,

but set the relative widths of the rows / columns. For convenience,

<a class="reference internal" href="../../../api/_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec" title="matplotlib.gridspec.GridSpec"><code class="xref py py-obj docutils literal notranslate">gridspec.GridSpec</code></a>'s height_ratios and width_ratios are exposed in the

"""

.a.

bAc

.d.

""",

# set the height ratios between the rows

height_ratios=[1, 3.5, 1],

# set the width ratios between the columns

width_ratios=[1, 3.5, 1],

)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_009.png" srcset="../../../_images/sphx_glr_mosaic_009.png, ../../../_images/sphx_glr_mosaic_009_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>Other <a class="reference internal" href="../../../api/_as_gen/matplotlib.gridspec.GridSpec.html#matplotlib.gridspec.GridSpec" title="matplotlib.gridspec.GridSpec"><code class="xref py py-obj docutils literal notranslate">gridspec.GridSpec</code></a> keywords can be passed via gridspec_kw. For

example, use the {left, right, bottom, top} keyword arguments to

position the overall mosaic to put multiple versions of the same

mosaic in a figure.

BC"""

gridspec_kw={

"bottom": 0.25,

"top": 0.95,

"left": 0.1,

"right": 0.5,

"wspace": 0.5,

"hspace": 0.5,

},

)

gridspec_kw={

"bottom": 0.05,

"top": 0.75,

"left": 0.6,

"right": 0.95,

"wspace": 0.5,

"hspace": 0.5,

},

)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_010.png" srcset="../../../_images/sphx_glr_mosaic_010.png, ../../../_images/sphx_glr_mosaic_010_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>Alternatively, you can use the sub-Figure functionality:

BC"""

<a href="../../../api/_as_gen/matplotlib.figure.SubFigure.html#matplotlib.figure.SubFigure" title="matplotlib.figure.SubFigure" class="sphx-glr-backref-module-matplotlib-figure sphx-glr-backref-type-py-class sphx-glr-backref-instance">left</a>, <a href="../../../api/_as_gen/matplotlib.figure.SubFigure.html#matplotlib.figure.SubFigure" title="matplotlib.figure.SubFigure" class="sphx-glr-backref-module-matplotlib-figure sphx-glr-backref-type-py-class sphx-glr-backref-instance">right</a> = <a href="../../../api/_as_gen/matplotlib.figure.Figure.subfigures.html#matplotlib.figure.Figure.subfigures" title="matplotlib.figure.Figure.subfigures" class="sphx-glr-backref-module-matplotlib-figure sphx-glr-backref-type-py-method">fig.subfigures</a>(nrows=1, ncols=2)

<a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">axd</a> = <a href="../../../api/_as_gen/matplotlib.figure.SubFigure.subplot_mosaic.html#matplotlib.figure.SubFigure.subplot_mosaic" title="matplotlib.figure.SubFigure.subplot_mosaic" class="sphx-glr-backref-module-matplotlib-figure sphx-glr-backref-type-py-method">left.subplot_mosaic</a>(<a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance">mosaic</a>)

<a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">axd</a> = <a href="../../../api/_as_gen/matplotlib.figure.SubFigure.subplot_mosaic.html#matplotlib.figure.SubFigure.subplot_mosaic" title="matplotlib.figure.SubFigure.subplot_mosaic" class="sphx-glr-backref-module-matplotlib-figure sphx-glr-backref-type-py-method">right.subplot_mosaic</a>(<a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance">mosaic</a>)

</pre></div>

</div>

<h2>Controlling subplot creation<a class="headerlink" href="#controlling-subplot-creation" title="Link to this heading">#</a></h2>

We can also pass through arguments used to create the subplots

(again, the same as <a class="reference internal" href="../../../api/_as_gen/matplotlib.figure.Figure.subplots.html#matplotlib.figure.Figure.subplots" title="matplotlib.figure.Figure.subplots"><code class="xref py py-obj docutils literal notranslate">Figure.subplots</code></a>) which will apply to all

of the Axes created.

"AB", subplot_kw={"projection": "polar"}

)

</pre></div>

</div>

<h3>Per-Axes subplot keyword arguments<a class="headerlink" href="#per-axes-subplot-keyword-arguments" title="Link to this heading">#</a></h3>

If you need to control the parameters passed to each subplot individually use

per_subplot_kw to pass a mapping between the Axes identifiers (or

tuples of Axes identifiers) to dictionaries of keywords to be passed.

Added in version 3.7.

</div>

<div class="highlight-Python notranslate"><div class="highlight"><pre><a href="../../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure" class="sphx-glr-backref-module-matplotlib-figure sphx-glr-backref-type-py-class sphx-glr-backref-instance">fig</a>, <a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">axd</a> = <a href="../../../api/_as_gen/matplotlib.pyplot.subplot_mosaic.html#matplotlib.pyplot.subplot_mosaic" title="matplotlib.pyplot.subplot_mosaic" class="sphx-glr-backref-module-matplotlib-pyplot sphx-glr-backref-type-py-function">plt.subplot_mosaic</a>(

"AB;CD",

per_subplot_kw={

"A": {"projection": "polar"},

("C", "D"): {"xscale": "log"}

},

)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_013.png" srcset="../../../_images/sphx_glr_mosaic_013.png, ../../../_images/sphx_glr_mosaic_013_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>If the layout is specified with the string short-hand, then we know the

Axes labels will be one character and can unambiguously interpret longer

strings in per_subplot_kw to specify a set of Axes to apply the

keywords to:

<div class="highlight-Python notranslate"><div class="highlight"><pre><a href="../../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure" class="sphx-glr-backref-module-matplotlib-figure sphx-glr-backref-type-py-class sphx-glr-backref-instance">fig</a>, <a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">axd</a> = <a href="../../../api/_as_gen/matplotlib.pyplot.subplot_mosaic.html#matplotlib.pyplot.subplot_mosaic" title="matplotlib.pyplot.subplot_mosaic" class="sphx-glr-backref-module-matplotlib-pyplot sphx-glr-backref-type-py-function">plt.subplot_mosaic</a>(

"AB;CD",

per_subplot_kw={

"AD": {"projection": "polar"},

"BC": {"facecolor": ".9"}

},

)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_014.png" srcset="../../../_images/sphx_glr_mosaic_014.png, ../../../_images/sphx_glr_mosaic_014_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>If subplot_kw and per_subplot_kw are used together, then they are

merged with per_subplot_kw taking priority:

"AB;CD",

subplot_kw={"facecolor": "xkcd:tangerine"},

per_subplot_kw={

"B": {"facecolor": "xkcd:water blue"},

"D": {"projection": "polar", "facecolor": "w"},

}

)

</pre></div>

</div>

</section>

<h2>Nested list input<a class="headerlink" href="#nested-list-input" title="Link to this heading">#</a></h2>

Everything we can do with the string shorthand we can also do when

passing in a list (internally we convert the string shorthand to a nested

list), for example using spans, blanks, and gridspec_kw:

[

["main", "zoom"],

["main", "BLANK"],

],

empty_sentinel="BLANK",

width_ratios=[2, 1],

)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_016.png" srcset="../../../_images/sphx_glr_mosaic_016.png, ../../../_images/sphx_glr_mosaic_016_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>In addition, using the list input we can specify nested mosaics. Any element

of the inner list can be another set of nested lists:

<div class="highlight-Python notranslate"><div class="highlight"><pre><a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">inner</a> = [

["inner A"],

["inner B"],

]

<a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">outer_nested_mosaic</a> = [

["main", <a href="https://docs.python.org/3/library/stdtypes.html#list" title="builtins.list" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">inner</a>],

["bottom", "bottom"],

]

<a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">axd</a> = <a href="../../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="matplotlib.pyplot.figure" class="sphx-glr-backref-module-matplotlib-pyplot sphx-glr-backref-type-py-function">plt.figure</a>(layout="constrained").subplot_mosaic(

)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_017.png" srcset="../../../_images/sphx_glr_mosaic_017.png, ../../../_images/sphx_glr_mosaic_017_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>We can also pass in a 2D NumPy array to do things like

<div class="highlight-Python notranslate"><div class="highlight"><pre><a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance">mosaic</a> = <a href="https://numpy.org/doc/stable/reference/generated/numpy.zeros.html#numpy.zeros" title="numpy.zeros" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-function">np.zeros</a>((4, 4), dtype=int)

for <a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">j</a> in range(4):

<a href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="numpy.ndarray" class="sphx-glr-backref-module-numpy sphx-glr-backref-type-py-class sphx-glr-backref-instance">mosaic</a>[<a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">j</a>, <a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">j</a>] = <a href="https://docs.python.org/3/library/functions.html#int" title="builtins.int" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">j</a> + 1

<a href="https://docs.python.org/3/library/stdtypes.html#dict" title="builtins.dict" class="sphx-glr-backref-module-builtins sphx-glr-backref-type-py-class sphx-glr-backref-instance">axd</a> = <a href="../../../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="matplotlib.pyplot.figure" class="sphx-glr-backref-module-matplotlib-pyplot sphx-glr-backref-type-py-function">plt.figure</a>(layout="constrained").subplot_mosaic(

empty_sentinel=0,

)

</pre></div>

</div>

<img src="../../../_images/sphx_glr_mosaic_018.png" srcset="../../../_images/sphx_glr_mosaic_018.png, ../../../_images/sphx_glr_mosaic_018_2_00x.png 2.00x" alt="mosaic" class = "sphx-glr-single-img"/>Total running time of the script: (0 minutes 12.798 seconds)

<a class="reference download internal" download="" href="../../../_downloads/c845cd1b7e5d796333d92f240787aaae/mosaic.ipynb"><code class="xref download docutils literal notranslate">Download Jupyter notebook: mosaic.ipynb</code></a>

</div>

<a class="reference download internal" download="" href="../../../_downloads/af8c3c8cd4b98795b4f4562826726e37/mosaic.py"><code class="xref download docutils literal notranslate">Download Python source code: mosaic.py</code></a>

</div>

<a class="reference download internal" download="" href="../../../_downloads/f512dde983169fb7bc52414b27a73f66/mosaic.zip"><code class="xref download docutils literal notranslate">Download zipped: mosaic.zip</code></a>

</div>

<a class="reference external" href="https://sphinx-gallery.github.io">Gallery generated by Sphinx-Gallery</a>

</section>

</article>

</div>

<div

id="pst-page-navigation-heading-2"

class="page-toc tocsection onthispage">

On this page

</div>

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

mosaic.html

Latest commit

History

mosaic.html

File metadata and controls