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

History

706 lines (651 loc) · 54.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

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

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

<head>

<title>contour — Matplotlib 2.1.0 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.1.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.1.0 documentation"

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

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v2.1.0). 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 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="container_api.html" title="container"

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

<a href="_as_gen/matplotlib.colors.get_named_colors_mapping.html" title="matplotlib.colors.get_named_colors_mapping"

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="pyplot_summary.html">pyplot</a>| </li>

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

</ul>

</div>

</a>

</a>

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

</a>

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

<ul>

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

<li><a class="reference internal" href="#module-matplotlib.contour"><code class="docutils literal">matplotlib.contour</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="_as_gen/matplotlib.colors.get_named_colors_mapping.html" title="previous chapter">matplotlib.colors.get_named_colors_mapping</a></li>

<li>Next: <a href="container_api.html" title="next chapter">container</a></li>

</ul></li>

</ul>

</div>

<li><a href="../_sources/api/contour_api.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

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

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

These are 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="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">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-class docutils literal">Text</code></a> instance at x, y

with string text.

Valid kwargs 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">agg_filter</code></a></td>

<td>unknown</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">alpha</code></a></td>

<td>float (0.0 transparent through 1.0 opaque)</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">animated</code></a></td>

<td>[True | False]</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">backgroundcolor</code></a></td>

<td>any matplotlib color</td>

</tr>

<td>FancyBboxPatch prop dict</td>

</tr>

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

</tr>

<td>[True | False]</td>

</tr>

<td>[ (<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal">Path</code></a>, <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal">Transform</code></a>) | <a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal">Patch</code></a> | 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">color</code></a></td>

<td>any matplotlib 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">contains</code></a></td>

<td>a callable function</td>

</tr>

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

</tr>

<tr class="row-odd"><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">figure</code></a></td>

<td>a <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal">matplotlib.figure.Figure</code></a> instance</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">fontproperties</code></a> or font_properties</td>

<td>a <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-class docutils literal">matplotlib.font_manager.FontProperties</code></a> instance</td>

</tr>

<td>an id string</td>

</tr>

<tr class="row-even"><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">horizontalalignment</code></a> or ha</td>

<td>[ ‘center’ | ‘right’ | ‘left’ ]</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">label</code></a></td>

<td>string or anything printable with ‘%s’ conversion.</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">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">multialignment</code></a></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">path_effects</code></a></td>

<td>unknown</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">picker</code></a></td>

<td>[None|float|boolean|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">position</code></a></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">rasterized</code></a></td>

<td>[True | False | None]</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">rotation</code></a></td>

<td>[ angle in degrees | ‘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">rotation_mode</code></a></td>

<td>unknown</td>

</tr>

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

</tr>

<tr class="row-odd"><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">sketch_params</code></a></td>

<td>unknown</td>

</tr>

<td>unknown</td>

</tr>

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

</tr>

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

<td>[ ‘normal’ | ‘italic’ | ‘oblique’]</td>

</tr>

<td>string or anything printable with ‘%s’ conversion.</td>

</tr>

<tr class="row-even"><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">transform</code></a></td>

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

</tr>

<td>a url string</td>

</tr>

<tr class="row-even"><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">usetex</code></a></td>

<td>unknown</td>

</tr>

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

<td>[ ‘normal’ | ‘small-caps’ ]</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">verticalalignment</code></a> or ma or va</td>

<td>[ ‘center’ | ‘top’ | ‘bottom’ | ‘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">visible</code></a></td>

<td>[True | False]</td>

</tr>

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

</tr>

<td>unknown</td>

</tr>

<td>float</td>

</tr>

<td>float</td>

</tr>

<tr class="row-even"><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">zorder</code></a></td>

<td>any number</td>

</tr>

</tbody>

</table>

</div></blockquote>

<code class="descname">get_rotation</code>()<a class="headerlink" href="#matplotlib.contour.ClabelText.get_rotation" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.contour.</code><code class="descname">ContourLabeler</code><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/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal">object</code></a>

Mixin to provide labelling capability to ContourSet

<code class="descname">add_label</code>(x, y, rotation, lev, cvalue)<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">Text</code></a> class.

</dd></dl>

<code class="descname">add_label_clabeltext</code>(x, y, rotation, lev, cvalue)<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">ClabelText</code></a> class.

</dd></dl>

<code class="descname">add_label_near</code>(x, y, inline=True, inline_spacing=5, transform=None)<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.

<dt>inline:</dt>

<dd>controls whether the underlying contour is removed or

not. Default is True.</dd>

<dt>inline_spacing:</dt>

<dd>space in pixels to leave on each side of label when

placing inline. Defaults to 5. This spacing will be

exact for labels at locations where the contour is

straight, less so for labels on curved contours.</dd>

</dl>

</dd></dl>

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

<dd>This function calculates the appropriate label rotation given

the linecontour coordinates in screen units, the index of the

label location and the label width.

It will also break contour and calculate inlining if lc is

not empty (lc defaults to the empty list if None). spacing

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

Do both of these tasks at once to avoid calling mlab.path_length

multiple times, which is relatively costly.

The method used here involves calculating 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>(*args, **kwargs)<a class="headerlink" href="#matplotlib.contour.ContourLabeler.clabel" title="Permalink to this definition">¶</a></dt>

<dd>Label a contour plot.

Call signature:

<div class="highlight-default"><div class="highlight"><pre>clabel(cs, **kwargs)

</pre></div>

</div>

Adds labels to line contours in cs, where cs is a

<a class="reference internal" href="#matplotlib.contour.ContourSet" title="matplotlib.contour.ContourSet"><code class="xref py py-class docutils literal">ContourSet</code></a> object returned by

contour.

<div class="highlight-default"><div class="highlight"><pre>clabel(cs, v, **kwargs)

</pre></div>

</div>

only labels contours listed in v.

Optional keyword arguments:

<dt>fontsize:</dt>

<dd>size in points or relative size e.g., ‘smaller’, ‘x-large’</dd>

<dt>colors:</dt>

<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 matplotlib color args (string, float, rgb, etc),

different labels will be plotted in different colors in the order

specified</li>

</ul>

</dd>

<dt>inline:</dt>

<dd>controls whether the underlying contour is removed or

not. Default is True.</dd>

<dt>inline_spacing:</dt>

<dd>space in pixels to leave on each side of label when

placing inline. Defaults to 5. This spacing will be

exact for labels at locations where the contour is

straight, less so for labels on curved contours.</dd>

<dd>a format string for the label. Default is ‘%1.3f’

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-class docutils literal">Formatter</code></a> instance, that

returns a string when called with a numeric contour level.</dd>

<dt>manual:</dt>

<dd>if True, 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 be an iterable object of x,y tuples. Contour labels

will be created as if mouse is clicked at each x,y positions.

</dd>

<dt>rightside_up:</dt>

<dd>if True (default), label rotations will always be plus

or minus 90 degrees from level.</dd>

<dt>use_clabeltext:</dt>

<dd>if True (default is False), ClabelText class (instead of

matplotlib.Text) is used to create labels. ClabelText

recalculates rotation angles of texts during the drawing time,

therefore this can be used if aspect of the axes changes.</dd>

</dl>

</div></blockquote>

</dd></dl>

<code class="descname">get_label_coords</code>(distances, XX, YY, ysize, lw)<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>(lev, fmt, fsize)<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_real_label_width</code>(lev, fmt, fsize)<a class="headerlink" href="#matplotlib.contour.ContourLabeler.get_real_label_width" title="Permalink to this definition">¶</a></dt>

<dd>This computes actual onscreen label width.

This uses some black magic to determine onscreen extent of non-drawn

label. This magic may not be very robust.

This method is not being used, and may be modified or removed.

</dd></dl>

<dd>get the text of the label

</dd></dl>

<code class="descname">labels</code>(inline, inline_spacing)<a class="headerlink" href="#matplotlib.contour.ContourLabeler.labels" title="Permalink to this definition">¶</a></dt>

<code class="descname">locate_label</code>(linecontour, labelwidth)<a class="headerlink" href="#matplotlib.contour.ContourLabeler.locate_label" title="Permalink to this definition">¶</a></dt>

<dd>Find a good place to plot a label (relatively flat

part of the contour).

</dd></dl>

<code class="descname">pop_label</code>(index=-1)<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>(linecontour, labelwidth)<a class="headerlink" href="#matplotlib.contour.ContourLabeler.print_label" title="Permalink to this definition">¶</a></dt>

<dd>Return False if contours are too short for a label.

</dd></dl>

<code class="descname">set_label_props</code>(label, text, color)<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>(x, y, lw)<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, **kwargs)<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">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">matplotlib.contour.ContourLabeler</code></a>

Store a set of contour lines or filled regions.

User-callable method: clabel

<dt>Useful attributes:</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">_process_colors()</code>.</dd>

</dl>

</dd>

</dl>

Draw contour lines or filled regions, depending on

whether keyword arg ‘filled’ is False (default) or True.

The first three arguments must be:

<div>ax: axes object.

<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">len(allsegs) == len(levels)</code>, and for

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

level0segs = [polygon0, polygon1, …]

polygon0 = array_like [[x0,y0], [x1,y1], …]

</dd>

<dt>allkinds: None 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 None, len(allkinds) == len(allsegs).

level0kinds = [polygon0kinds, …]

polygon0kinds = [vertexcode0, vertexcode1, …]

If allkinds is not None, usually all polygons for a particular

contour level are grouped together so that

level0segs = [polygon0] and level0kinds = [polygon0kinds].

</dd>

</dl>

</div></blockquote>

Keyword arguments are as described in

<a class="reference internal" href="#matplotlib.contour.QuadContourSet.contour_doc" title="matplotlib.contour.QuadContourSet.contour_doc"><code class="xref py py-attr docutils literal">matplotlib.contour.QuadContourSet.contour_doc</code></a>.

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

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

<dd>Finds contour that is closest to a point. Defaults to

measuring distance in pixels (screen space - useful for manual

contour labeling), but this can be controlled via a keyword

argument.

Returns a tuple containing the contour, segment, index of

segment, x & y of segment point and distance to minimum point.

Optional keyword arguments:

<dt>indices:</dt>

<dd>Indexes of contour levels to consider when looking for

nearest point. Defaults to using all levels.</dd>

<dt>pixel:</dt>

<dd>If True, measure distance in pixel space, if not, measure

distance in axes space. Defaults to True.</dd>

</dl>

</div></blockquote>

</dd></dl>

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

<dd>returns alpha to be applied to all ContourSet artists

</dd></dl>

<code class="descname">get_transform</code>()<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">Transform</code></a>

instance used by this ContourSet.

</dd></dl>

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

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

to <code class="xref py py-func docutils literal">plt.legend()</code> which represent this ContourSet.

Args:

<dt>variable_name: the string used inside the inequality used</dt>

<dd>on the labels</dd>

</dl>

str_format: function used to format the numbers in the labels

</div></blockquote>

</dd></dl>

<code class="descname">set_alpha</code>(alpha)<a class="headerlink" href="#matplotlib.contour.ContourSet.set_alpha" title="Permalink to this definition">¶</a></dt>

<dd>sets alpha for all ContourSet artists

</dd></dl>

</dd></dl>

class <code class="descclassname">matplotlib.contour.</code><code class="descname">QuadContourSet</code>(ax, *args, **kwargs)<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">matplotlib.contour.ContourSet</code></a>

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

User-callable method: <code class="xref py py-meth docutils literal">clabel()</code>

<dt>Useful attributes:</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">_process_colors()</code> method.</dd>

</dl>

</dd>

</dl>

Draw contour lines or filled regions, depending on

whether keyword arg ‘filled’ is False (default) or True.

The first three arguments must be:

<div>ax: axes object.

<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">len(allsegs) == len(levels)</code>, and for

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

level0segs = [polygon0, polygon1, …]

polygon0 = array_like [[x0,y0], [x1,y1], …]

</dd>

<dt>allkinds: None 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 None, len(allkinds) == len(allsegs).

level0kinds = [polygon0kinds, …]

polygon0kinds = [vertexcode0, vertexcode1, …]

If allkinds is not None, usually all polygons for a particular

contour level are grouped together so that

level0segs = [polygon0] and level0kinds = [polygon0kinds].

</dd>

</dl>

</div></blockquote>

Keyword arguments are as described in

<code class="descname">contour_doc</code> = "\n Plot contours.\n\n :func:`~matplotlib.pyplot.contour` and\n :func:`~matplotlib.pyplot.contourf` draw contour lines and\n filled contours, respectively. Except as noted, function\n signatures and return values are the same for both versions.\n\n :func:`~matplotlib.pyplot.contourf` differs from the MATLAB\n version in that it does not draw the polygon edges.\n To draw edges, add line contours with\n calls to :func:`~matplotlib.pyplot.contour`.\n\n\n Call signatures::\n\n contour(Z)\n\n make a contour plot of an array *Z*. The level values are chosen\n automatically.\n\n ::\n\n contour(X,Y,Z)\n\n *X*, *Y* specify the (x, y) coordinates of the surface\n\n ::\n\n contour(Z,N)\n contour(X,Y,Z,N)\n\n contour up to *N* automatically-chosen levels.\n\n ::\n\n contour(Z,V)\n contour(X,Y,Z,V)\n\n draw contour lines at the values specified in sequence *V*,\n which must be in increasing order.\n\n ::\n\n contourf(..., V)\n\n fill the ``len(V)-1`` regions between the values in *V*,\n which must be in increasing order.\n\n ::\n\n contour(Z, **kwargs)\n\n Use keyword args to control colors, linewidth, origin, cmap ... see\n below for more details.\n\n *X* and *Y* must both be 2-D with the same shape as *Z*, or they\n must both be 1-D such that ``len(X)`` is the number of columns in\n *Z* and ``len(Y)`` is the number of rows in *Z*.\n\n ``C = contour(...)`` returns a\n :class:`~matplotlib.contour.QuadContourSet` object.\n\n Optional keyword arguments:\n\n *corner_mask*: [ *True* | *False* | 'legacy' ]\n Enable/disable corner masking, which only has an effect if *Z* is\n a masked array. If *False*, any quad touching a masked point is\n masked out. If *True*, only the triangular corners of quads\n nearest those points are always masked out, other triangular\n corners comprising three unmasked points are contoured as usual.\n If 'legacy', the old contouring algorithm is used, which is\n equivalent to *False* and is deprecated, only remaining whilst the\n new algorithm is tested fully.\n\n If not specified, the default is taken from\n rcParams['contour.corner_mask'], which is True unless it has\n been modified.\n\n *colors*: [ *None* | string | (mpl_colors) ]\n If *None*, the colormap specified by cmap will be used.\n\n If a string, like 'r' or 'red', all levels will be plotted in this\n color.\n\n If a tuple of matplotlib color args (string, float, rgb, etc),\n different levels will be plotted in different colors in the order\n specified.\n\n *alpha*: float\n The alpha blending value\n\n *cmap*: [ *None* | Colormap ]\n A cm :class:`~matplotlib.colors.Colormap` instance or\n *None*. If *cmap* is *None* and *colors* is *None*, a\n default Colormap is used.\n\n *norm*: [ *None* | Normalize ]\n A :class:`matplotlib.colors.Normalize` instance for\n scaling data values to colors. If *norm* is *None* and\n *colors* is *None*, the default linear scaling is used.\n\n *vmin*, *vmax*: [ *None* | scalar ]\n If not *None*, either or both of these values will be\n supplied to the :class:`matplotlib.colors.Normalize`\n instance, overriding the default color scaling based on\n *levels*.\n\n *levels*: [level0, level1, ..., leveln]\n A list of floating point numbers indicating the level\n curves to draw, in increasing order; e.g., to draw just\n the zero contour pass ``levels=[0]``\n\n *origin*: [ *None* | 'upper' | 'lower' | 'image' ]\n If *None*, the first value of *Z* will correspond to the\n lower left corner, location (0,0). If 'image', the rc\n value for ``image.origin`` will be used.\n\n This keyword is not active if *X* and *Y* are specified in\n the call to contour.\n\n *extent*: [ *None* | (x0,x1,y0,y1) ]\n\n If *origin* is not *None*, then *extent* is interpreted as\n in :func:`matplotlib.pyplot.imshow`: it gives the outer\n pixel boundaries. In this case, the position of Z[0,0]\n is the center of the pixel, not a corner. If *origin* is\n *None*, then (*x0*, *y0*) is the position of Z[0,0], and\n (*x1*, *y1*) is the position of Z[-1,-1].\n\n This keyword is not active if *X* and *Y* are specified in\n the call to contour.\n\n *locator*: [ *None* | ticker.Locator subclass ]\n If *locator* is *None*, the default\n :class:`~matplotlib.ticker.MaxNLocator` is used. The\n locator is used to determine the contour levels if they\n are not given explicitly via the *V* argument.\n\n *extend*: [ 'neither' | 'both' | 'min' | 'max' ]\n Unless this is 'neither', contour levels are automatically\n added to one or both ends of the range so that all data\n are included. These added ranges are then mapped to the\n special colormap values which default to the ends of the\n colormap range, but can be set via\n :meth:`matplotlib.colors.Colormap.set_under` and\n :meth:`matplotlib.colors.Colormap.set_over` methods.\n\n *xunits*, *yunits*: [ *None* | registered units ]\n Override axis units by specifying an instance of a\n :class:`matplotlib.units.ConversionInterface`.\n\n *antialiased*: [ *True* | *False* ]\n enable antialiasing, overriding the defaults. For\n filled contours, the default is *True*. For line contours,\n it is taken from rcParams['lines.antialiased'].\n\n *nchunk*: [ 0 | integer ]\n If 0, no subdivision of the domain. Specify a positive integer to\n divide the domain into subdomains of *nchunk* by *nchunk* quads.\n Chunking reduces the maximum length of polygons generated by the\n contouring algorithm which reduces the rendering workload passed\n on to the backend and also requires slightly less RAM. It can\n however introduce rendering artifacts at chunk boundaries depending\n on the backend, the *antialiased* flag and value of *alpha*.\n\n contour-only keyword arguments:\n\n *linewidths*: [ *None* | number | tuple of numbers ]\n If *linewidths* is *None*, the default width in\n ``lines.linewidth`` in ``matplotlibrc`` is used.\n\n If a number, all levels will be plotted with this linewidth.\n\n If a tuple, different levels will be plotted with different\n linewidths in the order specified.\n\n *linestyles*: [ *None* | 'solid' | 'dashed' | 'dashdot' | 'dotted' ]\n If *linestyles* is *None*, the default is 'solid' unless\n the lines are monochrome. In that case, negative\n contours will take their linestyle from the ``matplotlibrc``\n ``contour.negative_linestyle`` setting.\n\n *linestyles* can also be an iterable of the above strings\n specifying a set of linestyles to be used. If this\n iterable is shorter than the number of contour levels\n it will be repeated as necessary.\n\n contourf-only keyword arguments:\n\n *hatches*:\n A list of cross hatch patterns to use on the filled areas.\n If None, no hatching will be added to the contour.\n Hatching is supported in the PostScript, PDF, SVG and Agg\n backends only.\n\n\n Note: contourf fills intervals that are closed at the top; that\n is, for boundaries *z1* and *z2*, the filled region is::\n\n z1 < z <= z2\n\n There is one exception: if the lowest boundary coincides with\n the minimum value of the *z* array, then that minimum value\n will be included in the lowest interval.\n "<a class="headerlink" href="#matplotlib.contour.QuadContourSet.contour_doc" title="Permalink to this definition">¶</a></dt>

</dd></dl>

</div>

</div>

Last updated on Oct 13, 2017.

Created using <a

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

</div>

</body>

</footer>

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