matplotlib.github.com/3.3.4/api/contour_api.html at main · matplotlib/matplotlib.github.com

History

790 lines (743 loc) · 75.9 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

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

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

<head>

<title>matplotlib.contour — Matplotlib 3.3.4 documentation</title>

title="Search within Matplotlib 3.3.4 documentation"

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

</head><body>

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

<!--

</div>

-->

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

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

</div>

<ul>

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

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

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

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

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

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

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

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

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

>modules</a> |</li>

<a href="dates_api.html" title="matplotlib.dates"

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

<a href="container_api.html" title="matplotlib.container"

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

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

<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>

<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate">matplotlib.contour</code></a></li>

</ul>

</div>

<h3>Related Topics</h3>

<ul>

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

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

<li>Previous: <a href="container_api.html" title="previous chapter"><code class="docutils literal notranslate">matplotlib.container</code></a></li>

<li>Next: <a href="dates_api.html" title="next chapter"><code class="docutils literal notranslate">matplotlib.dates</code></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/contour_api.rst.txt"

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

</div>

<h1><code class="docutils literal notranslate">matplotlib.contour</code><a class="headerlink" href="#module-matplotlib.contour" title="Permalink to this headline">¶</a></h1>

Classes to support contour plotting and labelling for the Axes class.

class <code class="descclassname">matplotlib.contour.</code><code class="descname">ClabelText</code>(x=0, y=0, text='', color=None, verticalalignment='baseline', horizontalalignment='left', multialignment=None, fontproperties=None, rotation=None, linespacing=None, rotation_mode=None, usetex=None, wrap=False, **kwargs)<a class="reference internal" href="../_modules/matplotlib/contour.html#ClabelText">[source]</a><a class="headerlink" href="#matplotlib.contour.ClabelText" title="Permalink to this definition">¶</a></dt>

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

Unlike the ordinary text, the get_rotation returns an updated

angle in the pixel coordinate assuming that the input rotation is

an angle in data coordinate (or whatever transform set).

Create a <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate">Text</code></a> instance at x, y with string text.

Valid keyword arguments are:

</colgroup>

<tr class="row-odd"><th class="head">Property</th>

<th class="head">Description</th>

</tr>

</thead>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_agg_filter.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal notranslate">agg_filter</code></a></td>

<td>a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_alpha.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-meth docutils literal notranslate">alpha</code></a></td>

<td>float or None</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_animated.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal notranslate">animated</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_backgroundcolor" title="matplotlib.text.Text.set_backgroundcolor"><code class="xref py py-meth docutils literal notranslate">backgroundcolor</code></a></td>

<td>color</td>

</tr>

<td>dict with properties for <a class="reference internal" href="_as_gen/matplotlib.patches.FancyBboxPatch.html#matplotlib.patches.FancyBboxPatch" title="matplotlib.patches.FancyBboxPatch"><code class="xref py py-obj docutils literal notranslate">patches.FancyBboxPatch</code></a></td>

</tr>

</tr>

</tr>

<td>Patch or (Path, Transform) or None</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_color" title="matplotlib.text.Text.set_color"><code class="xref py py-meth docutils literal notranslate">color</code></a> or c</td>

<td>color</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_contains.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal notranslate">contains</code></a></td>

<td>unknown</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_figure.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><code class="xref py py-meth docutils literal notranslate">figure</code></a></td>

<td><a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate">Figure</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontfamily" title="matplotlib.text.Text.set_fontfamily"><code class="xref py py-meth docutils literal notranslate">fontfamily</code></a> or family</td>

<td>{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontproperties" title="matplotlib.text.Text.set_fontproperties"><code class="xref py py-meth docutils literal notranslate">fontproperties</code></a> or font or font_properties</td>

<td><a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-obj docutils literal notranslate">font_manager.FontProperties</code></a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate">str</code></a> or <a class="reference external" href="https://docs.python.org/3/library/pathlib.html#pathlib.Path" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate">pathlib.Path</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontsize" title="matplotlib.text.Text.set_fontsize"><code class="xref py py-meth docutils literal notranslate">fontsize</code></a> or size</td>

<td>float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontstretch" title="matplotlib.text.Text.set_fontstretch"><code class="xref py py-meth docutils literal notranslate">fontstretch</code></a> or stretch</td>

<td>{a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontstyle" title="matplotlib.text.Text.set_fontstyle"><code class="xref py py-meth docutils literal notranslate">fontstyle</code></a> or style</td>

<td>{'normal', 'italic', 'oblique'}</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontvariant" title="matplotlib.text.Text.set_fontvariant"><code class="xref py py-meth docutils literal notranslate">fontvariant</code></a> or variant</td>

<td>{'normal', 'small-caps'}</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontweight" title="matplotlib.text.Text.set_fontweight"><code class="xref py py-meth docutils literal notranslate">fontweight</code></a> or weight</td>

<td>{a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}</td>

</tr>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_horizontalalignment" title="matplotlib.text.Text.set_horizontalalignment"><code class="xref py py-meth docutils literal notranslate">horizontalalignment</code></a> or ha</td>

<td>{'center', 'right', 'left'}</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_in_layout.html#matplotlib.artist.Artist.set_in_layout" title="matplotlib.artist.Artist.set_in_layout"><code class="xref py py-meth docutils literal notranslate">in_layout</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_label.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal notranslate">label</code></a></td>

<td>object</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_linespacing" title="matplotlib.text.Text.set_linespacing"><code class="xref py py-meth docutils literal notranslate">linespacing</code></a></td>

<td>float (multiple of font size)</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_multialignment" title="matplotlib.text.Text.set_multialignment"><code class="xref py py-meth docutils literal notranslate">multialignment</code></a> or ma</td>

<td>{'left', 'right', 'center'}</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_path_effects.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal notranslate">path_effects</code></a></td>

<td><a class="reference internal" href="patheffects_api.html#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-obj docutils literal notranslate">AbstractPathEffect</code></a></td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_picker.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal notranslate">picker</code></a></td>

<td>None or bool or callable</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_position" title="matplotlib.text.Text.set_position"><code class="xref py py-meth docutils literal notranslate">position</code></a></td>

<td>(float, float)</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_rasterized.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal notranslate">rasterized</code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_rotation" title="matplotlib.text.Text.set_rotation"><code class="xref py py-meth docutils literal notranslate">rotation</code></a></td>

<td>float or {'vertical', 'horizontal'}</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_rotation_mode" title="matplotlib.text.Text.set_rotation_mode"><code class="xref py py-meth docutils literal notranslate">rotation_mode</code></a></td>

<td>{None, 'default', 'anchor'}</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_sketch_params.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal notranslate">sketch_params</code></a></td>

<td>(scale: float, length: float, randomness: float)</td>

</tr>

</tr>

<td>object</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_transform.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal notranslate">transform</code></a></td>

<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate">Transform</code></a></td>

</tr>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_usetex" title="matplotlib.text.Text.set_usetex"><code class="xref py py-meth docutils literal notranslate">usetex</code></a></td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_verticalalignment" title="matplotlib.text.Text.set_verticalalignment"><code class="xref py py-meth docutils literal notranslate">verticalalignment</code></a> or va</td>

<td>{'center', 'top', 'bottom', 'baseline', 'center_baseline'}</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_visible.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal notranslate">visible</code></a></td>

</tr>

</tr>

<td>float</td>

</tr>

<td>float</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_zorder.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal notranslate">zorder</code></a></td>

<td>float</td>

</tr>

</tbody>

</table>

</div></blockquote>

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

<dd>Return the text angle in degrees between 0 and 360.

</dd></dl>

class <code class="descclassname">matplotlib.contour.</code><code class="descname">ContourLabeler</code><a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate">object</code></a>

Mixin to provide labelling capability to <a class="reference internal" href="#matplotlib.contour.ContourSet" title="matplotlib.contour.ContourSet"><code class="xref py py-obj docutils literal notranslate">ContourSet</code></a>.

<code class="descname">add_label</code>(self, x, y, rotation, lev, cvalue)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.add_label">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.add_label" title="Permalink to this definition">¶</a></dt>

<dd>Add contour label using <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate">Text</code></a> class.

</dd></dl>

<code class="descname">add_label_clabeltext</code>(self, x, y, rotation, lev, cvalue)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.add_label_clabeltext">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.add_label_clabeltext" title="Permalink to this definition">¶</a></dt>

<dd>Add contour label using <a class="reference internal" href="#matplotlib.contour.ClabelText" title="matplotlib.contour.ClabelText"><code class="xref py py-class docutils literal notranslate">ClabelText</code></a> class.

</dd></dl>

<code class="descname">add_label_near</code>(self, x, y, inline=True, inline_spacing=5, transform=None)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.add_label_near">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.add_label_near" title="Permalink to this definition">¶</a></dt>

<dd>Add a label near the point (x, y). If transform is None

(default), (x, y) is in data coordinates; if transform is

False, (x, y) is in display coordinates; otherwise, the

specified transform will be used to translate (x, y) into

display coordinates.

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

<dt>x, yfloat</dt><dd>The approximate location of the label.

</dd>

<dt>inlinebool, default: True</dt><dd>If True remove the segment of the contour beneath the label.

</dd>

<dt>inline_spacingint, default: 5</dt><dd>Space in pixels to leave on each side of label when placing

inline. This spacing will be exact for labels at locations where

the contour is straight, less so for labels on curved contours.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">calc_label_rot_and_inline</code>(self, slc, ind, lw, lc=None, spacing=5)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.calc_label_rot_and_inline">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.calc_label_rot_and_inline" title="Permalink to this definition">¶</a></dt>

<dd>Calculate the appropriate label rotation given the linecontour

coordinates in screen units, the index of the label location and the

label width.

If lc is not None or empty, also break contours and compute

inlining.

spacing is the empty space to leave around the label, in pixels.

Both tasks are done together to avoid calculating path lengths

multiple times, which is relatively costly.

The method used here involves computing the path length along the

contour in pixel coordinates and then looking approximately (label

width / 2) away from central point to determine rotation and then to

break contour if desired.

</dd></dl>

<code class="descname">clabel</code>(self, levels=None, *, fontsize=None, inline=True, inline_spacing=5, fmt='%1.3f', colors=None, use_clabeltext=False, manual=False, rightside_up=True, zorder=None)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.clabel">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.clabel" title="Permalink to this definition">¶</a></dt>

<dd>Label a contour plot.

Adds labels to line contours in this <a class="reference internal" href="#matplotlib.contour.ContourSet" title="matplotlib.contour.ContourSet"><code class="xref py py-obj docutils literal notranslate">ContourSet</code></a> (which inherits from

this mixin class).

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

<dt>levelsarray-like, optional</dt><dd>A list of level values, that should be labeled. The list must be

a subset of <code class="docutils literal notranslate">cs.levels</code>. If not given, all levels are labeled.

</dd>

<dt>fontsizestr or float, default: <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=font.size#a-sample-matplotlibrc-file">rcParams["font.size"]</a></code> (default: <code class="docutils literal notranslate">10.0</code>)</dt><dd>Size in points or relative size e.g., 'smaller', 'x-large'.

See <a class="reference internal" href="text_api.html#matplotlib.text.Text.set_size" title="matplotlib.text.Text.set_size"><code class="xref py py-obj docutils literal notranslate">Text.set_size</code></a> for accepted string values.

</dd>

<dt>colorscolor or colors or None, default: None</dt><dd>The label colors:

<li>If None, the color of each label matches the color of

the corresponding contour.</li>

<li>If one string color, e.g., colors = 'r' or colors =

'red', all labels will be plotted in this color.</li>

<li>If a tuple of colors (string, float, rgb, etc), different labels

will be plotted in different colors in the order specified.</li>

</ul>

</dd>

<dt>inlinebool, default: True</dt><dd>If <code class="docutils literal notranslate">True</code> the underlying contour is removed where the label is

placed.

</dd>

<dt>inline_spacingfloat, default: 5</dt><dd>Space in pixels to leave on each side of label when placing inline.

This spacing will be exact for labels at locations where the

contour is straight, less so for labels on curved contours.

</dd>

<dt>fmtstr or dict, default: '%1.3f'</dt><dd>A format string for the label.

Alternatively, this can be a dictionary matching contour levels

with arbitrary strings to use for each contour level (i.e.,

fmt[level]=string), or it can be any callable, such as a

<a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-obj docutils literal notranslate">Formatter</code></a> instance, that returns a string when called with a

numeric contour level.

</dd>

<dt>manualbool or iterable, default: False</dt><dd>If <code class="docutils literal notranslate">True</code>, contour labels will be placed manually using

mouse clicks. Click the first button near a contour to

add a label, click the second button (or potentially both

mouse buttons at once) to finish adding labels. The third

button can be used to remove the last label added, but

only if labels are not inline. Alternatively, the keyboard

can be used to select label locations (enter to end label

placement, delete or backspace act like the third mouse button,

and any other key will select a label location).

manual can also be an iterable object of (x, y) tuples.

Contour labels will be created as if mouse is clicked at each

(x, y) position.

</dd>

<dt>rightside_upbool, default: True</dt><dd>If <code class="docutils literal notranslate">True</code>, label rotations will always be plus

or minus 90 degrees from level.

</dd>

<dt>use_clabeltextbool, default: False</dt><dd>If <code class="docutils literal notranslate">True</code>, <a class="reference internal" href="#matplotlib.contour.ClabelText" title="matplotlib.contour.ClabelText"><code class="xref py py-obj docutils literal notranslate">ClabelText</code></a> class (instead of <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate">Text</code></a>) is used to

create labels. <a class="reference internal" href="#matplotlib.contour.ClabelText" title="matplotlib.contour.ClabelText"><code class="xref py py-obj docutils literal notranslate">ClabelText</code></a> recalculates rotation angles

of texts during the drawing time, therefore this can be used if

aspect of the axes changes.

</dd>

<dt>zorderfloat or None, default: <code class="docutils literal notranslate">(2 + contour.get_zorder())</code></dt><dd>zorder of the contour labels.

</dd>

</dl>

</td>

</tr>

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

<dt>labels</dt><dd>A list of <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-obj docutils literal notranslate">Text</code></a> instances for the labels.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">get_label_coords</code>(self, distances, XX, YY, ysize, lw)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.get_label_coords">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.get_label_coords" title="Permalink to this definition">¶</a></dt>

<dd>Return x, y, and the index of a label location.

Labels are plotted at a location with the smallest

deviation of the contour from a straight line

unless there is another label nearby, in which case

the next best place on the contour is picked up.

If all such candidates are rejected, the beginning

of the contour is chosen.

</dd></dl>

<code class="descname">get_label_width</code>(self, lev, fmt, fsize)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.get_label_width">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.get_label_width" title="Permalink to this definition">¶</a></dt>

<dd>Return the width of the label in points.

</dd></dl>

<code class="descname">get_text</code>(self, lev, fmt)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.get_text">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.get_text" title="Permalink to this definition">¶</a></dt>

<dd>Get the text of the label.

</dd></dl>

<code class="descname">labels</code>(self, inline, inline_spacing)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.labels">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.labels" title="Permalink to this definition">¶</a></dt>

<code class="descname">locate_label</code>(self, linecontour, labelwidth)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.locate_label">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.locate_label" title="Permalink to this definition">¶</a></dt>

<dd>Find good place to draw a label (relatively flat part of the contour).

</dd></dl>

<code class="descname">pop_label</code>(self, index=- 1)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.pop_label">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.pop_label" title="Permalink to this definition">¶</a></dt>

<dd>Defaults to removing last label, but any index can be supplied

</dd></dl>

<code class="descname">print_label</code>(self, linecontour, labelwidth)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.print_label">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.print_label" title="Permalink to this definition">¶</a></dt>

<dd>Return whether a contour is long enough to hold a label.

</dd></dl>

<code class="descname">set_label_props</code>(self, label, text, color)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourLabeler.set_label_props">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourLabeler.set_label_props" title="Permalink to this definition">¶</a></dt>

<dd>Set the label properties - color, fontsize, text.

</dd></dl>

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

<dd>Return True if a label is already near this location.

</dd></dl>

class <code class="descclassname">matplotlib.contour.</code><code class="descname">ContourSet</code>(ax, *args, levels=None, filled=False, linewidths=None, linestyles=None, hatches=None, alpha=None, origin=None, extent=None, cmap=None, colors=None, norm=None, vmin=None, vmax=None, extend='neither', antialiased=None, nchunk=0, locator=None, transform=None, **kwargs)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourSet">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourSet" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><code class="xref py py-class docutils literal notranslate">matplotlib.cm.ScalarMappable</code></a>, <a class="reference internal" href="#matplotlib.contour.ContourLabeler" title="matplotlib.contour.ContourLabeler"><code class="xref py py-class docutils literal notranslate">matplotlib.contour.ContourLabeler</code></a>

Store a set of contour lines or filled regions.

User-callable method: <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.clabel.html#matplotlib.axes.Axes.clabel" title="matplotlib.axes.Axes.clabel"><code class="xref py py-obj docutils literal notranslate">clabel</code></a>

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

<dt>levels[level0, level1, ..., leveln]</dt><dd>A list of floating point numbers indicating the contour levels.

</dd>

<dt>allsegs[level0segs, level1segs, ...]</dt><dd>List of all the polygon segments for all the levels.

For contour lines <code class="docutils literal notranslate">len(allsegs) == len(levels)</code>, and for

filled contour regions <code class="docutils literal notranslate">len(allsegs) = len(levels)-1</code>. The lists

should look like

<div class="highlight-default notranslate"><div class="highlight"><pre>level0segs = [polygon0, polygon1, ...]

polygon0 = [[x0, y0], [x1, y1], ...]

</pre></div>

</div>

</dd>

<dt>allkinds<code class="docutils literal notranslate">None</code> or [level0kinds, level1kinds, ...]</dt><dd>Optional list of all the polygon vertex kinds (code types), as

described and used in Path. This is used to allow multiply-

connected paths such as holes within filled polygons.

If not <code class="docutils literal notranslate">None</code>, <code class="docutils literal notranslate">len(allkinds) == len(allsegs)</code>. The lists

should look like

<div class="highlight-default notranslate"><div class="highlight"><pre>level0kinds = [polygon0kinds, ...]

polygon0kinds = [vertexcode0, vertexcode1, ...]

</pre></div>

</div>

If allkinds is not <code class="docutils literal notranslate">None</code>, usually all polygons for a

particular contour level are grouped together so that

<code class="docutils literal notranslate">level0segs = [polygon0]</code> and <code class="docutils literal notranslate">level0kinds = [polygon0kinds]</code>.

</dd>

<dt>**kwargs</dt><dd>Keyword arguments are as described in the docstring of

<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.contour.html#matplotlib.axes.Axes.contour" title="matplotlib.axes.Axes.contour"><code class="xref py py-obj docutils literal notranslate">contour</code></a>.

</dd>

</dl>

</td>

</tr>

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

<dt>ax</dt><dd>The axes object in which the contours are drawn.

</dd>

<dt>collections</dt><dd>A silent_list of LineCollections or PolyCollections.

</dd>

<dt>levels</dt><dd>Contour levels.

</dd>

<dt>layers</dt><dd>Same as levels for line contours; half-way between

levels for filled contours. See <code class="xref py py-meth docutils literal notranslate">_process_colors()</code>.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Draw contour lines or filled regions, depending on

whether keyword arg filled is <code class="docutils literal notranslate">False</code> (default) or <code class="docutils literal notranslate">True</code>.

Call signature:

<div class="highlight-default notranslate"><div class="highlight"><pre>ContourSet(ax, levels, allsegs, [allkinds], **kwargs)

</pre></div>

</div>

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

<dt>ax<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate">Axes</code></a></dt><dd>The <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-obj docutils literal notranslate">Axes</code></a> object to draw on.

</dd>

<dt>levels[level0, level1, ..., leveln]</dt><dd>A list of floating point numbers indicating the contour

levels.

</dd>

<dt>allsegs[level0segs, level1segs, ...]</dt><dd>List of all the polygon segments for all the levels.

For contour lines <code class="docutils literal notranslate">len(allsegs) == len(levels)</code>, and for

filled contour regions <code class="docutils literal notranslate">len(allsegs) = len(levels)-1</code>. The lists

should look like

</pre></div>

</div>

</dd>

<dt>allkinds[level0kinds, level1kinds, ...], optional</dt><dd>Optional list of all the polygon vertex kinds (code types), as

described and used in Path. This is used to allow multiply-

connected paths such as holes within filled polygons.

should look like

</pre></div>

</div>

If allkinds is not <code class="docutils literal notranslate">None</code>, usually all polygons for a

particular contour level are grouped together so that

</dd>

<dt>**kwargs</dt><dd>Keyword arguments are as described in the docstring of

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

property <code class="descname">ax</code><a class="headerlink" href="#matplotlib.contour.ContourSet.ax" title="Permalink to this definition">¶</a></dt>

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

<dd>Call this whenever the mappable is changed to notify all the

callbackSM listeners to the 'changed' signal.

</dd></dl>

<code class="descname">find_nearest_contour</code>(self, x, y, indices=None, pixel=True)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourSet.find_nearest_contour">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourSet.find_nearest_contour" title="Permalink to this definition">¶</a></dt>

<dd>Find the point in the contour plot that is closest to <code class="docutils literal notranslate">(x, y)</code>.

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

<dt>x, y: float</dt><dd>The reference point.

</dd>

<dt>indiceslist of int or None, default: None</dt><dd>Indices of contour levels to consider. If None (the default), all

levels are considered.

</dd>

<dt>pixelbool, default: True</dt><dd>If True, measure distance in pixel (screen) space, which is

useful for manual contour labeling; else, measure distance in axes

space.

</dd>

</dl>

</td>

</tr>

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

<dt>contour<a class="reference internal" href="collections_api.html#matplotlib.collections.Collection" title="matplotlib.collections.Collection"><code class="xref py py-obj docutils literal notranslate">Collection</code></a></dt><dd>The contour that is closest to <code class="docutils literal notranslate">(x, y)</code>.

</dd>

<dt>segmentint</dt><dd>The index of the <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate">Path</code></a> in contour that is closest to

<code class="docutils literal notranslate">(x, y)</code>.

</dd>

<dt>indexint</dt><dd>The index of the path segment in segment that is closest to

<code class="docutils literal notranslate">(x, y)</code>.

</dd>

<dt>xmin, yminfloat</dt><dd>The point in the contour plot that is closest to <code class="docutils literal notranslate">(x, y)</code>.

</dd>

<dt>dfloat</dt><dd>The distance from <code class="docutils literal notranslate">(xmin, ymin)</code> to <code class="docutils literal notranslate">(x, y)</code>.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

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

<dd>Return alpha to be applied to all ContourSet artists.

</dd></dl>

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

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

instance used by this ContourSet.

</dd></dl>

<code class="descname">legend_elements</code>(self, variable_name='x', str_format=<class 'str'>)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourSet.legend_elements">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourSet.legend_elements" title="Permalink to this definition">¶</a></dt>

<dd>Return a list of artists and labels suitable for passing through

to <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.legend.html#matplotlib.axes.Axes.legend" title="matplotlib.axes.Axes.legend"><code class="xref py py-obj docutils literal notranslate">legend</code></a> which represent this ContourSet.

The labels have the form "0 < x <= 1" stating the data ranges which

the artists represent.

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

<dt>variable_namestr</dt><dd>The string used inside the inequality used on the labels.

</dd>

<dt>str_formatfunction: float -> str</dt><dd>Function used to format the numbers in the labels.

</dd>

</dl>

</td>

</tr>

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

<dt>artistsList[<a class="reference internal" href="artist_api.html#matplotlib.artist.Artist" title="matplotlib.artist.Artist"><code class="xref py py-obj docutils literal notranslate">Artist</code></a>]</dt><dd>A list of the artists.

</dd>

<dt>labelsList[str]</dt><dd>A list of the labels.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">set_alpha</code>(self, alpha)<a class="reference internal" href="../_modules/matplotlib/contour.html#ContourSet.set_alpha">[source]</a><a class="headerlink" href="#matplotlib.contour.ContourSet.set_alpha" title="Permalink to this definition">¶</a></dt>

<dd>Set the alpha blending value for all ContourSet artists.

alpha must be between 0 (transparent) and 1 (opaque).

</dd></dl>

class <code class="descclassname">matplotlib.contour.</code><code class="descname">QuadContourSet</code>(ax, *args, levels=None, filled=False, linewidths=None, linestyles=None, hatches=None, alpha=None, origin=None, extent=None, cmap=None, colors=None, norm=None, vmin=None, vmax=None, extend='neither', antialiased=None, nchunk=0, locator=None, transform=None, **kwargs)<a class="reference internal" href="../_modules/matplotlib/contour.html#QuadContourSet">[source]</a><a class="headerlink" href="#matplotlib.contour.QuadContourSet" title="Permalink to this definition">¶</a></dt>

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

Create and store a set of contour lines or filled regions.

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

<dt>ax</dt><dd>The axes object in which the contours are drawn.

</dd>

<dt>collections</dt><dd>A silent_list of LineCollections or PolyCollections.

</dd>

<dt>levels</dt><dd>Contour levels.

</dd>

<dt>layers</dt><dd>Same as levels for line contours; half-way between

levels for filled contours. See <code class="xref py py-meth docutils literal notranslate">_process_colors()</code> method.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Draw contour lines or filled regions, depending on

Call signature:

</pre></div>

</div>

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

</dd>

<dt>levels[level0, level1, ..., leveln]</dt><dd>A list of floating point numbers indicating the contour

levels.

</dd>

<dt>allsegs[level0segs, level1segs, ...]</dt><dd>List of all the polygon segments for all the levels.

For contour lines <code class="docutils literal notranslate">len(allsegs) == len(levels)</code>, and for

filled contour regions <code class="docutils literal notranslate">len(allsegs) = len(levels)-1</code>. The lists

should look like

</pre></div>

</div>

</dd>

<dt>allkinds[level0kinds, level1kinds, ...], optional</dt><dd>Optional list of all the polygon vertex kinds (code types), as

described and used in Path. This is used to allow multiply-

connected paths such as holes within filled polygons.

should look like

</pre></div>

</div>

If allkinds is not <code class="docutils literal notranslate">None</code>, usually all polygons for a

particular contour level are grouped together so that

</dd>

<dt>**kwargs</dt><dd>Keyword arguments are as described in the docstring of

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

</div>

</div>

Last updated on Jan 28, 2021.

Created using

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

Doc version v3.3.4.

</div>

</footer>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

contour_api.html

Latest commit

History

contour_api.html

File metadata and controls