matplotlib.github.com/3.0.3/api/transformations.html at main · eyinkj/matplotlib.github.com · GitHub

Repository navigation

History

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 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

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

<head>

<title>transformations — Matplotlib 3.0.3 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.0.3 documentation"

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

</head>

<body>

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

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

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

</div>

<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>

<a href="tri_api.html" title="triangular grids"

accesskey="N">next</a> |</li>

<a href="tight_layout_api.html" title="tight_layout"

accesskey="P">previous</a> |</li>

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

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

<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

<h3><a href="../contents.html">Table of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">transformations</a><ul>

<li><a class="reference internal" href="#module-matplotlib.transforms"><code class="docutils literal notranslate">matplotlib.transforms</code></a></li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

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

<li><a href="index.html">The Matplotlib API</a><ul>

<li>Previous: <a href="tight_layout_api.html" title="previous chapter">tight_layout</a></li>

<li>Next: <a href="tri_api.html" title="next chapter">triangular grids</a></li>

</ul></li>

</ul>

</div>

<div id="sidebar-pagesource" role="note" aria-label="source link"

style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">

<a href="../_sources/api/transformations.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

<h1>transformations<a class="headerlink" href="#transformations" title="Permalink to this headline">¶</a></h1>

</map><div class="section" id="module-matplotlib.transforms">

<h2><a class="reference internal" href="#module-matplotlib.transforms" title="matplotlib.transforms"><code class="xref py py-mod docutils literal notranslate">matplotlib.transforms</code></a><a class="headerlink" href="#module-matplotlib.transforms" title="Permalink to this headline">¶</a></h2>

matplotlib includes a framework for arbitrary geometric

transformations that is used determine the final position of all

elements drawn on the canvas.

Transforms are composed into trees of <a class="reference internal" href="#matplotlib.transforms.TransformNode" title="matplotlib.transforms.TransformNode"><code class="xref py py-class docutils literal notranslate">TransformNode</code></a> objects

whose actual value depends on their children. When the contents of

children change, their parents are automatically invalidated. The

next time an invalidated transform is accessed, it is recomputed to

reflect those changes. This invalidation/caching approach prevents

unnecessary recomputations of transforms, and contributes to better

interactive performance.

For example, here is a graph of the transform tree used to plot data

to the graph:

The framework can be used for both affine and non-affine

transformations. However, for speed, we want use the backend

renderers to perform affine transformations whenever possible.

Therefore, it is possible to perform just the affine or non-affine

part of a transformation on a set of data. The affine is always

assumed to occur after the non-affine. For any transform:

<div class="highlight-default notranslate"><div class="highlight"><pre>full transform == non-affine part + affine part

</pre></div>

</div>

The backends are not expected to handle non-affine transformations

themselves.

class <code class="descclassname">matplotlib.transforms.</code><code class="descname">Affine2D</code>(matrix=None, **kwargs)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><code class="xref py py-class docutils literal notranslate">matplotlib.transforms.Affine2DBase</code></a>

A mutable 2D affine transformation.

Initialize an Affine transform from a 3x3 numpy float array:

<div class="highlight-default notranslate"><div class="highlight"><pre>a c e

b d f

0 0 1

</pre></div>

</div>

If matrix is None, initialize with the identity transform.

<code class="descname">clear</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.clear">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.clear" title="Permalink to this definition">¶</a></dt>

<dd>Reset the underlying matrix to the identity transform.

</dd></dl>

static <code class="descname">from_values</code>(a, b, c, d, e, f)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.from_values">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.from_values" title="Permalink to this definition">¶</a></dt>

<dd>(staticmethod) Create a new Affine2D instance from the given

values:

<div class="highlight-default notranslate"><div class="highlight"><pre>a c e

b d f

0 0 1

</pre></div>

</div>

.

</dd></dl>

<code class="descname">get_matrix</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.get_matrix">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.get_matrix" title="Permalink to this definition">¶</a></dt>

<dd>Get the underlying transformation matrix as a 3x3 numpy array:

<div class="highlight-default notranslate"><div class="highlight"><pre>a c e

b d f

0 0 1

</pre></div>

</div>

.

</dd></dl>

static <code class="descname">identity</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.identity">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.identity" title="Permalink to this definition">¶</a></dt>

<dd>(staticmethod) Return a new <a class="reference internal" href="#matplotlib.transforms.Affine2D" title="matplotlib.transforms.Affine2D"><code class="xref py py-class docutils literal notranslate">Affine2D</code></a> object that is

the identity transform.

Unless this transform will be mutated later on, consider using

the faster <a class="reference internal" href="#matplotlib.transforms.IdentityTransform" title="matplotlib.transforms.IdentityTransform"><code class="xref py py-class docutils literal notranslate">IdentityTransform</code></a> class instead.

</dd></dl>

<code class="descname">is_separable</code><a class="headerlink" href="#matplotlib.transforms.Affine2D.is_separable" title="Permalink to this definition">¶</a></dt>

<code class="descname">rotate</code>(theta)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.rotate">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.rotate" title="Permalink to this definition">¶</a></dt>

<dd>Add a rotation (in radians) to this transform in place.

Returns self, so this method can easily be chained with more

calls to <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate" title="matplotlib.transforms.Affine2D.rotate"><code class="xref py py-meth docutils literal notranslate">rotate()</code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate_deg" title="matplotlib.transforms.Affine2D.rotate_deg"><code class="xref py py-meth docutils literal notranslate">rotate_deg()</code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.translate" title="matplotlib.transforms.Affine2D.translate"><code class="xref py py-meth docutils literal notranslate">translate()</code></a>

and <a class="reference internal" href="#matplotlib.transforms.Affine2D.scale" title="matplotlib.transforms.Affine2D.scale"><code class="xref py py-meth docutils literal notranslate">scale()</code></a>.

</dd></dl>

<code class="descname">rotate_around</code>(x, y, theta)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.rotate_around">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.rotate_around" title="Permalink to this definition">¶</a></dt>

<dd>Add a rotation (in radians) around the point (x, y) in place.

Returns self, so this method can easily be chained with more

</dd></dl>

<code class="descname">rotate_deg</code>(degrees)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.rotate_deg">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.rotate_deg" title="Permalink to this definition">¶</a></dt>

<dd>Add a rotation (in degrees) to this transform in place.

Returns self, so this method can easily be chained with more

</dd></dl>

<code class="descname">rotate_deg_around</code>(x, y, degrees)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.rotate_deg_around">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.rotate_deg_around" title="Permalink to this definition">¶</a></dt>

<dd>Add a rotation (in degrees) around the point (x, y) in place.

Returns self, so this method can easily be chained with more

</dd></dl>

<code class="descname">scale</code>(sx, sy=None)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.scale">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.scale" title="Permalink to this definition">¶</a></dt>

<dd>Adds a scale in place.

If sy is None, the same scale is applied in both the x- and

y-directions.

Returns self, so this method can easily be chained with more

</dd></dl>

<code class="descname">set</code>(other)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.set">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.set" title="Permalink to this definition">¶</a></dt>

<dd>Set this transformation from the frozen copy of another

<a class="reference internal" href="#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><code class="xref py py-class docutils literal notranslate">Affine2DBase</code></a> object.

</dd></dl>

<code class="descname">set_matrix</code>(mtx)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.set_matrix">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.set_matrix" title="Permalink to this definition">¶</a></dt>

<dd>Set the underlying transformation matrix from a 3x3 numpy array:

<div class="highlight-default notranslate"><div class="highlight"><pre>a c e

b d f

0 0 1

</pre></div>

</div>

.

</dd></dl>

<code class="descname">skew</code>(xShear, yShear)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.skew">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.skew" title="Permalink to this definition">¶</a></dt>

<dd>Adds a skew in place.

xShear and yShear are the shear angles along the x- and

y-axes, respectively, in radians.

Returns self, so this method can easily be chained with more

</dd></dl>

<code class="descname">skew_deg</code>(xShear, yShear)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.skew_deg">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.skew_deg" title="Permalink to this definition">¶</a></dt>

<dd>Adds a skew in place.

xShear and yShear are the shear angles along the x- and

y-axes, respectively, in degrees.

Returns self, so this method can easily be chained with more

</dd></dl>

<code class="descname">translate</code>(tx, ty)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.translate">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2D.translate" title="Permalink to this definition">¶</a></dt>

<dd>Adds a translation in place.

Returns self, so this method can easily be chained with more

</dd></dl>

class <code class="descclassname">matplotlib.transforms.</code><code class="descname">Affine2DBase</code>(*args, **kwargs)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.transforms.AffineBase" title="matplotlib.transforms.AffineBase"><code class="xref py py-class docutils literal notranslate">matplotlib.transforms.AffineBase</code></a>

The base class of all 2D affine transformations.

2D affine transformations are performed using a 3x3 numpy array:

<div class="highlight-default notranslate"><div class="highlight"><pre>a c e

b d f

0 0 1

</pre></div>

</div>

This class provides the read-only interface. For a mutable 2D

affine transformation, use <a class="reference internal" href="#matplotlib.transforms.Affine2D" title="matplotlib.transforms.Affine2D"><code class="xref py py-class docutils literal notranslate">Affine2D</code></a>.

Subclasses of this class will generally only need to override a

constructor and <code class="xref py py-meth docutils literal notranslate">get_matrix()</code> that generates a custom 3x3 matrix.

<code class="descname">frozen</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase.frozen">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.frozen" title="Permalink to this definition">¶</a></dt>

<dd>Returns a frozen copy of this transform node. The frozen copy

will not update when its children change. Useful for storing

a previously known state of a transform where

<code class="docutils literal notranslate">copy.deepcopy()</code> might normally be used.

</dd></dl>

<code class="descname">has_inverse</code> = True<a class="headerlink" href="#matplotlib.transforms.Affine2DBase.has_inverse" title="Permalink to this definition">¶</a></dt>

<code class="descname">input_dims</code> = 2<a class="headerlink" href="#matplotlib.transforms.Affine2DBase.input_dims" title="Permalink to this definition">¶</a></dt>

<code class="descname">inverted</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase.inverted">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.inverted" title="Permalink to this definition">¶</a></dt>

<dd>Return the corresponding inverse transformation.

The return value of this method should be treated as

temporary. An update to self does not cause a corresponding

update to its inverted copy.

<code class="docutils literal notranslate">x === self.inverted().transform(self.transform(x))</code>

</dd></dl>

<code class="descname">is_separable</code><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.is_separable" title="Permalink to this definition">¶</a></dt>

static <code class="descname">matrix_from_values</code>(a, b, c, d, e, f)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase.matrix_from_values">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.matrix_from_values" title="Permalink to this definition">¶</a></dt>

<dd>(staticmethod) Create a new transformation matrix as a 3x3

numpy array of the form:

<div class="highlight-default notranslate"><div class="highlight"><pre>a c e

b d f

0 0 1

</pre></div>

</div>

</dd></dl>

<code class="descname">output_dims</code> = 2<a class="headerlink" href="#matplotlib.transforms.Affine2DBase.output_dims" title="Permalink to this definition">¶</a></dt>

<code class="descname">to_values</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase.to_values">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.to_values" title="Permalink to this definition">¶</a></dt>

<dd>Return the values of the matrix as a sequence (a,b,c,d,e,f)

</dd></dl>

<code class="descname">transform_affine</code>(points)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase.transform_affine">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.transform_affine" title="Permalink to this definition">¶</a></dt>

<dd>Performs only the affine part of this transformation on the

given array of values.

<code class="docutils literal notranslate">transform(values)</code> is always equivalent to

<code class="docutils literal notranslate">transform_affine(transform_non_affine(values))</code>.

In non-affine transformations, this is generally a no-op. In

affine transformations, this is equivalent to

<code class="docutils literal notranslate">transform(values)</code>.

Accepts a numpy array of shape (N x <a class="reference internal" href="#matplotlib.transforms.Affine2DBase.input_dims" title="matplotlib.transforms.Affine2DBase.input_dims"><code class="xref py py-attr docutils literal notranslate">input_dims</code></a>) and

returns a numpy array of shape (N x <a class="reference internal" href="#matplotlib.transforms.Affine2DBase.output_dims" title="matplotlib.transforms.Affine2DBase.output_dims"><code class="xref py py-attr docutils literal notranslate">output_dims</code></a>).

Alternatively, accepts a numpy array of length <a class="reference internal" href="#matplotlib.transforms.Affine2DBase.input_dims" title="matplotlib.transforms.Affine2DBase.input_dims"><code class="xref py py-attr docutils literal notranslate">input_dims</code></a>

and returns a numpy array of length <a class="reference internal" href="#matplotlib.transforms.Affine2DBase.output_dims" title="matplotlib.transforms.Affine2DBase.output_dims"><code class="xref py py-attr docutils literal notranslate">output_dims</code></a>.

</dd></dl>

<code class="descname">transform_point</code>(point)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase.transform_point">[source]</a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.transform_point" title="Permalink to this definition">¶</a></dt>

<dd>A convenience function that returns the transformed copy of a

single point.

The point is given as a sequence of length <a class="reference internal" href="#matplotlib.transforms.Affine2DBase.input_dims" title="matplotlib.transforms.Affine2DBase.input_dims"><code class="xref py py-attr docutils literal notranslate">input_dims</code></a>.

The transformed point is returned as a sequence of length

<a class="reference internal" href="#matplotlib.transforms.Affine2DBase.output_dims" title="matplotlib.transforms.Affine2DBase.output_dims"><code class="xref py py-attr docutils literal notranslate">output_dims</code></a>.

</dd></dl>

class <code class="descclassname">matplotlib.transforms.</code><code class="descname">AffineBase</code>(*args, **kwargs)<a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase">[source]</a><a class="headerlink" href="#matplotlib.transforms.AffineBase" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal notranslate">matplotlib.transforms.Transform</code></a>

The base class of all affine transformations of any number of

dimensions.

<code class="descname">get_affine</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.get_affine">[source]</a><a class="headerlink" href="#matplotlib.transforms.AffineBase.get_affine" title="Permalink to this definition">¶</a></dt>

<dd>Get the affine part of this transform.

</dd></dl>

<code class="descname">is_affine</code> = True<a class="headerlink" href="#matplotlib.transforms.AffineBase.is_affine" title="Permalink to this definition">¶</a></dt>

<code class="descname">transform</code>(values)<a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.transform">[source]</a><a class="headerlink" href="#matplotlib.transforms.AffineBase.transform" title="Permalink to this definition">¶</a></dt>

<dd>Performs the transformation on the given array of values.

Accepts a numpy array of shape (N x <code class="xref py py-attr docutils literal notranslate">input_dims</code>) and

returns a numpy array of shape (N x <code class="xref py py-attr docutils literal notranslate">output_dims</code>).

Alternatively, accepts a numpy array of length <code class="xref py py-attr docutils literal notranslate">input_dims</code>

and returns a numpy array of length <code class="xref py py-attr docutils literal notranslate">output_dims</code>.

</dd></dl>

<code class="descname">transform_affine</code>(values)<a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.transform_affine">[source]</a><a class="headerlink" href="#matplotlib.transforms.AffineBase.transform_affine" title="Permalink to this definition">¶</a></dt>

<dd>Performs only the affine part of this transformation on the

given array of values.

<code class="docutils literal notranslate">transform(values)</code> is always equivalent to

<code class="docutils literal notranslate">transform_affine(transform_non_affine(values))</code>.

In non-affine transformations, this is generally a no-op. In

affine transformations, this is equivalent to

<code class="docutils literal notranslate">transform(values)</code>.

Accepts a numpy array of shape (N x <code class="xref py py-attr docutils literal notranslate">input_dims</code>) and

returns a numpy array of shape (N x <code class="xref py py-attr docutils literal notranslate">output_dims</code>).

Alternatively, accepts a numpy array of length <code class="xref py py-attr docutils literal notranslate">input_dims</code>

and returns a numpy array of length <code class="xref py py-attr docutils literal notranslate">output_dims</code>.

</dd></dl>

<code class="descname">transform_non_affine</code>(points)<a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.transform_non_affine">[source]</a><a class="headerlink" href="#matplotlib.transforms.AffineBase.transform_non_affine" title="Permalink to this definition">¶</a></dt>

<dd>Performs only the non-affine part of the transformation.

<code class="docutils literal notranslate">transform(values)</code> is always equivalent to

<code class="docutils literal notranslate">transform_affine(transform_non_affine(values))</code>.

In non-affine transformations, this is generally equivalent to

<code class="docutils literal notranslate">transform(values)</code>. In affine transformations, this is

always a no-op.

Accepts a numpy array of shape (N x <code class="xref py py-attr docutils literal notranslate">input_dims</code>) and

returns a numpy array of shape (N x <code class="xref py py-attr docutils literal notranslate">output_dims</code>).

Alternatively, accepts a numpy array of length <code class="xref py py-attr docutils literal notranslate">input_dims</code>

and returns a numpy array of length <code class="xref py py-attr docutils literal notranslate">output_dims</code>.

</dd></dl>

<code class="descname">transform_path</code>(path)<a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.transform_path">[source]</a><a class="headerlink" href="#matplotlib.transforms.AffineBase.transform_path" title="Permalink to this definition">¶</a></dt>

<dd>Returns a transformed path.

path: a <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal notranslate">Path</code></a> instance.

In some cases, this transform may insert curves into the path

that began as line segments.

</dd></dl>

<code class="descname">transform_path_affine</code>(path)<a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.transform_path_affine">[source]</a><a class="headerlink" href="#matplotlib.transforms.AffineBase.transform_path_affine" title="Permalink to this definition">¶</a></dt>

<dd>Returns a path, transformed only by the affine part of

this transform.

<code class="docutils literal notranslate">transform_path(path)</code> is equivalent to

<code class="docutils literal notranslate">transform_path_affine(transform_path_non_affine(values))</code>.

</dd></dl>

<code class="descname">transform_path_non_affine</code>(path)<a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.transform_path_non_affine">[source]</a><a class="headerlink" href="#matplotlib.transforms.AffineBase.transform_path_non_affine" title="Permalink to this definition">¶</a></dt>

<dd>Returns a path, transformed only by the non-affine

part of this transform.

<code class="docutils literal notranslate">transform_path(path)</code> is equivalent to

<code class="docutils literal notranslate">transform_path_affine(transform_path_non_affine(values))</code>.

</dd></dl>

class <code class="descclassname">matplotlib.transforms.</code><code class="descname">Bbox</code>(points, **kwargs)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.transforms.BboxBase" title="matplotlib.transforms.BboxBase"><code class="xref py py-class docutils literal notranslate">matplotlib.transforms.BboxBase</code></a>

A mutable bounding box.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>points : ndarray</dt>

<dd>A 2x2 numpy array of the form <code class="docutils literal notranslate">[[x0, y0], [x1, y1]]</code>.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

If you need to create a <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a> object from another form

of data, consider the static methods <a class="reference internal" href="#matplotlib.transforms.Bbox.unit" title="matplotlib.transforms.Bbox.unit"><code class="xref py py-meth docutils literal notranslate">unit()</code></a>,

<a class="reference internal" href="#matplotlib.transforms.Bbox.from_bounds" title="matplotlib.transforms.Bbox.from_bounds"><code class="xref py py-meth docutils literal notranslate">from_bounds()</code></a> and <a class="reference internal" href="#matplotlib.transforms.Bbox.from_extents" title="matplotlib.transforms.Bbox.from_extents"><code class="xref py py-meth docutils literal notranslate">from_extents()</code></a>.

<code class="descname">bounds</code><a class="headerlink" href="#matplotlib.transforms.Bbox.bounds" title="Permalink to this definition">¶</a></dt>

<dd>Returns (<a class="reference internal" href="#matplotlib.transforms.Bbox.x0" title="matplotlib.transforms.Bbox.x0"><code class="xref py py-attr docutils literal notranslate">x0</code></a>, <a class="reference internal" href="#matplotlib.transforms.Bbox.y0" title="matplotlib.transforms.Bbox.y0"><code class="xref py py-attr docutils literal notranslate">y0</code></a>, <code class="xref py py-attr docutils literal notranslate">width</code>,

<code class="xref py py-attr docutils literal notranslate">height</code>).

</dd></dl>

static <code class="descname">from_bounds</code>(x0, y0, width, height)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.from_bounds">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.from_bounds" title="Permalink to this definition">¶</a></dt>

<dd>(staticmethod) Create a new <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a> from x0, y0,

width and height.

width and height may be negative.

</dd></dl>

static <code class="descname">from_extents</code>(*args)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.from_extents">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.from_extents" title="Permalink to this definition">¶</a></dt>

<dd>(staticmethod) Create a new Bbox from left, bottom,

right and top.

The y-axis increases upwards.

</dd></dl>

<code class="descname">get_points</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.get_points">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.get_points" title="Permalink to this definition">¶</a></dt>

<dd>Get the points of the bounding box directly as a numpy array

of the form: <code class="docutils literal notranslate">[[x0, y0], [x1, y1]]</code>.

</dd></dl>

<code class="descname">ignore</code>(value)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.ignore">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.ignore" title="Permalink to this definition">¶</a></dt>

<dd>Set whether the existing bounds of the box should be ignored

by subsequent calls to <a class="reference internal" href="#matplotlib.transforms.Bbox.update_from_data_xy" title="matplotlib.transforms.Bbox.update_from_data_xy"><code class="xref py py-meth docutils literal notranslate">update_from_data_xy()</code></a>.

<dt>value : bool</dt>

<li>When <code class="docutils literal notranslate">True</code>, subsequent calls to <a class="reference internal" href="#matplotlib.transforms.Bbox.update_from_data_xy" title="matplotlib.transforms.Bbox.update_from_data_xy"><code class="xref py py-meth docutils literal notranslate">update_from_data_xy()</code></a>

will ignore the existing bounds of the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a>.</li>

<li>When <code class="docutils literal notranslate">False</code>, subsequent calls to <a class="reference internal" href="#matplotlib.transforms.Bbox.update_from_data_xy" title="matplotlib.transforms.Bbox.update_from_data_xy"><code class="xref py py-meth docutils literal notranslate">update_from_data_xy()</code></a>

will include the existing bounds of the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a>.</li>

</ul>

</dd>

</dl>

</dd></dl>

<code class="descname">intervalx</code><a class="headerlink" href="#matplotlib.transforms.Bbox.intervalx" title="Permalink to this definition">¶</a></dt>

<dd><a class="reference internal" href="#matplotlib.transforms.Bbox.intervalx" title="matplotlib.transforms.Bbox.intervalx"><code class="xref py py-attr docutils literal notranslate">intervalx</code></a> is the pair of x coordinates that define

the bounding box. It is not guaranteed to be sorted from left to right.

</dd></dl>

<code class="descname">intervaly</code><a class="headerlink" href="#matplotlib.transforms.Bbox.intervaly" title="Permalink to this definition">¶</a></dt>

<dd><a class="reference internal" href="#matplotlib.transforms.Bbox.intervaly" title="matplotlib.transforms.Bbox.intervaly"><code class="xref py py-attr docutils literal notranslate">intervaly</code></a> is the pair of y coordinates that define

the bounding box. It is not guaranteed to be sorted from bottom to

top.

</dd></dl>

<code class="descname">minpos</code><a class="headerlink" href="#matplotlib.transforms.Bbox.minpos" title="Permalink to this definition">¶</a></dt>

<code class="descname">minposx</code><a class="headerlink" href="#matplotlib.transforms.Bbox.minposx" title="Permalink to this definition">¶</a></dt>

<code class="descname">minposy</code><a class="headerlink" href="#matplotlib.transforms.Bbox.minposy" title="Permalink to this definition">¶</a></dt>

<code class="descname">mutated</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.mutated">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.mutated" title="Permalink to this definition">¶</a></dt>

<dd>Return whether the bbox has changed since init.

</dd></dl>

<code class="descname">mutatedx</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.mutatedx">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.mutatedx" title="Permalink to this definition">¶</a></dt>

<dd>Return whether the x-limits have changed since init.

</dd></dl>

<code class="descname">mutatedy</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.mutatedy">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.mutatedy" title="Permalink to this definition">¶</a></dt>

<dd>Return whether the y-limits have changed since init.

</dd></dl>

static <code class="descname">null</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.null">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.null" title="Permalink to this definition">¶</a></dt>

<dd>(staticmethod) Create a new null <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a> from (inf, inf) to

(-inf, -inf).

</dd></dl>

<dd><a class="reference internal" href="#matplotlib.transforms.Bbox.p0" title="matplotlib.transforms.Bbox.p0"><code class="xref py py-attr docutils literal notranslate">p0</code></a> is the first pair of (x, y) coordinates that

define the bounding box. It is not guaranteed to be the bottom-left

corner. For that, use <code class="xref py py-attr docutils literal notranslate">min</code>.

</dd></dl>

<dd><a class="reference internal" href="#matplotlib.transforms.Bbox.p1" title="matplotlib.transforms.Bbox.p1"><code class="xref py py-attr docutils literal notranslate">p1</code></a> is the second pair of (x, y) coordinates that

define the bounding box. It is not guaranteed to be the top-right

corner. For that, use <code class="xref py py-attr docutils literal notranslate">max</code>.

</dd></dl>

<code class="descname">set</code>(other)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.set">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.set" title="Permalink to this definition">¶</a></dt>

<dd>Set this bounding box from the "frozen" bounds of another

<a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a>.

</dd></dl>

<code class="descname">set_points</code>(points)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.set_points">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.set_points" title="Permalink to this definition">¶</a></dt>

<dd>Set the points of the bounding box directly from a numpy array

of the form: <code class="docutils literal notranslate">[[x0, y0], [x1, y1]]</code>. No error checking is

performed, as this method is mainly for internal use.

</dd></dl>

static <code class="descname">unit</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.unit">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.unit" title="Permalink to this definition">¶</a></dt>

<dd>(staticmethod) Create a new unit <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a> from (0, 0) to

(1, 1).

</dd></dl>

<code class="descname">update_from_data_xy</code>(xy, ignore=None, updatex=True, updatey=True)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.update_from_data_xy">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.update_from_data_xy" title="Permalink to this definition">¶</a></dt>

<dd>Update the bounds of the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a> based on the passed in

data. After updating, the bounds will have positive width

and height; x0 and y0 will be the minimal values.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>xy : ndarray</dt>

<dd>A numpy array of 2D points.

</dd>

<dt>ignore : bool, optional</dt>

<li>When <code class="docutils literal notranslate">True</code>, ignore the existing bounds of the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a>.</li>

<li>When <code class="docutils literal notranslate">False</code>, include the existing bounds of the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a>.</li>

<li>When <code class="docutils literal notranslate">None</code>, use the last value passed to <a class="reference internal" href="#matplotlib.transforms.Bbox.ignore" title="matplotlib.transforms.Bbox.ignore"><code class="xref py py-meth docutils literal notranslate">ignore()</code></a>.</li>

</ul>

</dd>

<dt>updatex, updatey : bool, optional</dt>

<dd>When <code class="docutils literal notranslate">True</code>, update the x/y values.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">update_from_path</code>(path, ignore=None, updatex=True, updatey=True)<a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.update_from_path">[source]</a><a class="headerlink" href="#matplotlib.transforms.Bbox.update_from_path" title="Permalink to this definition">¶</a></dt>

data. After updating, the bounds will have positive width

and height; x0 and y0 will be the minimal values.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>ignore : bool, optional</dt>

<li>when <code class="docutils literal notranslate">True</code>, ignore the existing bounds of the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a>.</li>

<li>when <code class="docutils literal notranslate">False</code>, include the existing bounds of the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a>.</li>

<li>when <code class="docutils literal notranslate">None</code>, use the last value passed to <a class="reference internal" href="#matplotlib.transforms.Bbox.ignore" title="matplotlib.transforms.Bbox.ignore"><code class="xref py py-meth docutils literal notranslate">ignore()</code></a>.</li>

</ul>

</dd>

<dt>updatex, updatey : bool, optional</dt>

<dd>When <code class="docutils literal notranslate">True</code>, update the x/y values.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<dd><a class="reference internal" href="#matplotlib.transforms.Bbox.x0" title="matplotlib.transforms.Bbox.x0"><code class="xref py py-attr docutils literal notranslate">x0</code></a> is the first of the pair of x coordinates that

define the bounding box. <a class="reference internal" href="#matplotlib.transforms.Bbox.x0" title="matplotlib.transforms.Bbox.x0"><code class="xref py py-attr docutils literal notranslate">x0</code></a> is not guaranteed to be less than

<a class="reference internal" href="#matplotlib.transforms.Bbox.x1" title="matplotlib.transforms.Bbox.x1"><code class="xref py py-attr docutils literal notranslate">x1</code></a>. If you require that, use <code class="xref py py-attr docutils literal notranslate">xmin</code>.

</dd></dl>

<dd><a class="reference internal" href="#matplotlib.transforms.Bbox.x1" title="matplotlib.transforms.Bbox.x1"><code class="xref py py-attr docutils literal notranslate">x1</code></a> is the second of the pair of x coordinates that

define the bounding box. <a class="reference internal" href="#matplotlib.transforms.Bbox.x1" title="matplotlib.transforms.Bbox.x1"><code class="xref py py-attr docutils literal notranslate">x1</code></a> is not guaranteed to be greater

than <a class="reference internal" href="#matplotlib.transforms.Bbox.x0" title="matplotlib.transforms.Bbox.x0"><code class="xref py py-attr docutils literal notranslate">x0</code></a>. If you require that, use <code class="xref py py-attr docutils literal notranslate">xmax</code>.

</dd></dl>

<dd><a class="reference internal" href="#matplotlib.transforms.Bbox.y0" title="matplotlib.transforms.Bbox.y0"><code class="xref py py-attr docutils literal notranslate">y0</code></a> is the first of the pair of y coordinates that

define the bounding box. <a class="reference internal" href="#matplotlib.transforms.Bbox.y0" title="matplotlib.transforms.Bbox.y0"><code class="xref py py-attr docutils literal notranslate">y0</code></a> is not guaranteed to be less than

<a class="reference internal" href="#matplotlib.transforms.Bbox.y1" title="matplotlib.transforms.Bbox.y1"><code class="xref py py-attr docutils literal notranslate">y1</code></a>. If you require that, use <code class="xref py py-attr docutils literal notranslate">ymin</code>.

</dd></dl>

<dd><a class="reference internal" href="#matplotlib.transforms.Bbox.y1" title="matplotlib.transforms.Bbox.y1"><code class="xref py py-attr docutils literal notranslate">y1</code></a> is the second of the pair of y coordinates that

define the bounding box. <a class="reference internal" href="#matplotlib.transforms.Bbox.y1" title="matplotlib.transforms.Bbox.y1"><code class="xref py py-attr docutils literal notranslate">y1</code></a> is not guaranteed to be greater

than <a class="reference internal" href="#matplotlib.transforms.Bbox.y0" title="matplotlib.transforms.Bbox.y0"><code class="xref py py-attr docutils literal notranslate">y0</code></a>. If you require that, use <code class="xref py py-attr docutils literal notranslate">ymax</code>.

</dd></dl>

class <code class="descclassname">matplotlib.transforms.</code><code class="descname">BboxBase</code>(shorthand_name=None)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.transforms.TransformNode" title="matplotlib.transforms.TransformNode"><code class="xref py py-class docutils literal notranslate">matplotlib.transforms.TransformNode</code></a>

This is the base class of all bounding boxes, and provides

read-only access to its data. A mutable bounding box is provided

by the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a> class.

The canonical representation is as two points, with no

restrictions on their ordering. Convenience properties are

provided to get the left, bottom, right and top edges and width

and height, but these are not stored explicitly.

Creates a new <a class="reference internal" href="#matplotlib.transforms.TransformNode" title="matplotlib.transforms.TransformNode"><code class="xref py py-class docutils literal notranslate">TransformNode</code></a>.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>shorthand_name : str</dt>

<dd>A string representing the "name" of the transform. The name carries

no significance other than to improve the readability of

<code class="docutils literal notranslate">str(transform)</code> when DEBUG=True.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

<code class="descname">anchored</code>(c, container=None)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.anchored">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.anchored" title="Permalink to this definition">¶</a></dt>

<dd>Return a copy of the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a>, shifted to position c

within a container.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dd>May be either:

<li>A sequence (cx, cy) where cx and cy range from 0

to 1, where 0 is left or bottom and 1 is right or top</li>

<li>a string:

- 'C' for centered

- 'S' for bottom-center

- 'SE' for bottom-left

- 'E' for left

- etc.</li>

</ul>

</dd>

<dt>container : Bbox, optional</dt>

<dd>The box within which the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a> is positioned; it defaults

to the initial <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a>.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">bounds</code><a class="headerlink" href="#matplotlib.transforms.BboxBase.bounds" title="Permalink to this definition">¶</a></dt>

<dd>Returns (<a class="reference internal" href="#matplotlib.transforms.BboxBase.x0" title="matplotlib.transforms.BboxBase.x0"><code class="xref py py-attr docutils literal notranslate">x0</code></a>, <a class="reference internal" href="#matplotlib.transforms.BboxBase.y0" title="matplotlib.transforms.BboxBase.y0"><code class="xref py py-attr docutils literal notranslate">y0</code></a>, <a class="reference internal" href="#matplotlib.transforms.BboxBase.width" title="matplotlib.transforms.BboxBase.width"><code class="xref py py-attr docutils literal notranslate">width</code></a>,

<a class="reference internal" href="#matplotlib.transforms.BboxBase.height" title="matplotlib.transforms.BboxBase.height"><code class="xref py py-attr docutils literal notranslate">height</code></a>).

</dd></dl>

<code class="descname">coefs</code> = {'C': (0.5, 0.5), 'E': (1.0, 0.5), 'N': (0.5, 1.0), 'NE': (1.0, 1.0), 'NW': (0, 1.0), 'S': (0.5, 0), 'SE': (1.0, 0), 'SW': (0, 0), 'W': (0, 0.5)}<a class="headerlink" href="#matplotlib.transforms.BboxBase.coefs" title="Permalink to this definition">¶</a></dt>

<code class="descname">contains</code>(x, y)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.contains">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.contains" title="Permalink to this definition">¶</a></dt>

<dd>Returns whether <code class="docutils literal notranslate">(x, y)</code> is in the bounding box or on its edge.

</dd></dl>

<code class="descname">containsx</code>(x)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.containsx">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.containsx" title="Permalink to this definition">¶</a></dt>

<dd>Returns whether x is in the closed (<a class="reference internal" href="#matplotlib.transforms.BboxBase.x0" title="matplotlib.transforms.BboxBase.x0"><code class="xref py py-attr docutils literal notranslate">x0</code></a>, <a class="reference internal" href="#matplotlib.transforms.BboxBase.x1" title="matplotlib.transforms.BboxBase.x1"><code class="xref py py-attr docutils literal notranslate">x1</code></a>) interval.

</dd></dl>

<code class="descname">containsy</code>(y)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.containsy">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.containsy" title="Permalink to this definition">¶</a></dt>

<dd>Returns whether y is in the closed (<a class="reference internal" href="#matplotlib.transforms.BboxBase.y0" title="matplotlib.transforms.BboxBase.y0"><code class="xref py py-attr docutils literal notranslate">y0</code></a>, <a class="reference internal" href="#matplotlib.transforms.BboxBase.y1" title="matplotlib.transforms.BboxBase.y1"><code class="xref py py-attr docutils literal notranslate">y1</code></a>) interval.

</dd></dl>

<code class="descname">corners</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.corners">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.corners" title="Permalink to this definition">¶</a></dt>

<dd>Return an array of points which are the four corners of this

rectangle. For example, if this <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a> is defined by

the points (a, b) and (c, d), <a class="reference internal" href="#matplotlib.transforms.BboxBase.corners" title="matplotlib.transforms.BboxBase.corners"><code class="xref py py-meth docutils literal notranslate">corners()</code></a> returns

(a, b), (a, d), (c, b) and (c, d).

</dd></dl>

<code class="descname">count_contains</code>(vertices)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.count_contains">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.count_contains" title="Permalink to this definition">¶</a></dt>

<dd>Count the number of vertices contained in the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a>.

Any vertices with a non-finite x or y value are ignored.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>vertices : Nx2 Numpy array.</dt>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">count_overlaps</code>(bboxes)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.count_overlaps">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.count_overlaps" title="Permalink to this definition">¶</a></dt>

<dd>Count the number of bounding boxes that overlap this one.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>bboxes : sequence of <a class="reference internal" href="#matplotlib.transforms.BboxBase" title="matplotlib.transforms.BboxBase"><code class="xref py py-class docutils literal notranslate">BboxBase</code></a> objects</dt>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">expanded</code>(sw, sh)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.expanded">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.expanded" title="Permalink to this definition">¶</a></dt>

<dd>Return a new <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a> which is this <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate">Bbox</code></a>

expanded around its center by the given factors sw and

sh.

</dd></dl>

<code class="descname">extents</code><a class="headerlink" href="#matplotlib.transforms.BboxBase.extents" title="Permalink to this definition">¶</a></dt>

<dd>Returns (<a class="reference internal" href="#matplotlib.transforms.BboxBase.x0" title="matplotlib.transforms.BboxBase.x0"><code class="xref py py-attr docutils literal notranslate">x0</code></a>, <a class="reference internal" href="#matplotlib.transforms.BboxBase.y0" title="matplotlib.transforms.BboxBase.y0"><code class="xref py py-attr docutils literal notranslate">y0</code></a>, <a class="reference internal" href="#matplotlib.transforms.BboxBase.x1" title="matplotlib.transforms.BboxBase.x1"><code class="xref py py-attr docutils literal notranslate">x1</code></a>,

</dd></dl>

<code class="descname">frozen</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.frozen">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.frozen" title="Permalink to this definition">¶</a></dt>

<dd><a class="reference internal" href="#matplotlib.transforms.TransformNode" title="matplotlib.transforms.TransformNode"><code class="xref py py-class docutils literal notranslate">TransformNode</code></a> is the base class for anything that

participates in the transform tree and needs to invalidate its

parents or be invalidated. This includes classes that are not

really transforms, such as bounding boxes, since some transforms

depend on bounding boxes to compute their values.

</dd></dl>

<code class="descname">fully_contains</code>(x, y)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.fully_contains">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.fully_contains" title="Permalink to this definition">¶</a></dt>

<dd>Returns whether <code class="docutils literal notranslate">x, y</code> is in the bounding box, but not on its edge.

</dd></dl>

<code class="descname">fully_containsx</code>(x)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.fully_containsx">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.fully_containsx" title="Permalink to this definition">¶</a></dt>

<dd>Returns whether x is in the open (<a class="reference internal" href="#matplotlib.transforms.BboxBase.x0" title="matplotlib.transforms.BboxBase.x0"><code class="xref py py-attr docutils literal notranslate">x0</code></a>, <a class="reference internal" href="#matplotlib.transforms.BboxBase.x1" title="matplotlib.transforms.BboxBase.x1"><code class="xref py py-attr docutils literal notranslate">x1</code></a>) interval.

</dd></dl>

<code class="descname">fully_containsy</code>(y)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.fully_containsy">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.fully_containsy" title="Permalink to this definition">¶</a></dt>

<dd>Returns whether y is in the open (<a class="reference internal" href="#matplotlib.transforms.BboxBase.y0" title="matplotlib.transforms.BboxBase.y0"><code class="xref py py-attr docutils literal notranslate">y0</code></a>, <a class="reference internal" href="#matplotlib.transforms.BboxBase.y1" title="matplotlib.transforms.BboxBase.y1"><code class="xref py py-attr docutils literal notranslate">y1</code></a>) interval.

</dd></dl>

<code class="descname">fully_overlaps</code>(other)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.fully_overlaps">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.fully_overlaps" title="Permalink to this definition">¶</a></dt>

<dd>Returns whether this bounding box overlaps with the other bounding box,

not including the edges.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>other : BboxBase</dt>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">get_points</code>()<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.get_points">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.get_points" title="Permalink to this definition">¶</a></dt>

<code class="descname">height</code><a class="headerlink" href="#matplotlib.transforms.BboxBase.height" title="Permalink to this definition">¶</a></dt>

<dd>The height of the bounding box. It may be negative if

<a class="reference internal" href="#matplotlib.transforms.BboxBase.y1" title="matplotlib.transforms.BboxBase.y1"><code class="xref py py-attr docutils literal notranslate">y1</code></a> < <a class="reference internal" href="#matplotlib.transforms.BboxBase.y0" title="matplotlib.transforms.BboxBase.y0"><code class="xref py py-attr docutils literal notranslate">y0</code></a>.

</dd></dl>

static <code class="descname">intersection</code>(bbox1, bbox2)<a class="reference internal" href="../_modules/matplotlib/transforms.html#BboxBase.intersection">[source]</a><a class="headerlink" href="#matplotlib.transforms.BboxBase.intersection" title="Permalink to this definition">¶</a></dt>

<dd>Return the intersection of the two bboxes or None

View remainder of file in raw view

matplotlib.github.com/3.0.3/api/transformations.html at main · eyinkj/matplotlib.github.com · GitHub

Navigation Menu

Repository navigation

Expand file tree

Breadcrumbs

transformations.html

Latest commit

History

Breadcrumbs

transformations.html

File metadata and controls

Footer

Footer navigation