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

History

1458 lines (1326 loc) · 98.1 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

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

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

<head>

<title>cbook — 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/cbook_api.html">https://matplotlib.org/stable/api/cbook_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="cm_api.html" title="cm (colormap)"

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

<a href="backend_svg_api.html" title="matplotlib.backends.backend_svg"

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="#">cbook</a><ul>

<li><a class="reference internal" href="#module-matplotlib.cbook"><code class="docutils literal">matplotlib.cbook</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="backend_svg_api.html" title="previous chapter"><code class="docutils literal">matplotlib.backends.backend_svg</code></a></li>

<li>Next: <a href="cm_api.html" title="next chapter">cm (colormap)</a></li>

</ul></li>

</ul>

</div>

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

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

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

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

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

A collection of utility functions and classes. Originally, many

(but not all) were from the Python Cookbook – hence the name cbook.

This module is safe to import from anywhere within matplotlib;

it imports matplotlib only at runtime.

class <code class="descclassname">matplotlib.cbook.</code><code class="descname">Bunch</code>(**kwds)<a class="headerlink" href="#matplotlib.cbook.Bunch" 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>

Often we want to just collect a bunch of stuff together, naming each

item of the bunch; a dictionary’s OK for that, but a small do- nothing

class is even handier, and prettier to use. Whenever you want to

group a few variables:

<div class="highlight-default"><div class="highlight"><pre>>>> point = Bunch(datum=2, squared=4, coord=12)

>>> point.datum

By: Alex Martelli

From: https://code.activestate.com/recipes/121294/

</pre></div>

</div>

</dd></dl>

class <code class="descclassname">matplotlib.cbook.</code><code class="descname">CallbackRegistry</code>(exception_handler=<function _exception_printer>)<a class="headerlink" href="#matplotlib.cbook.CallbackRegistry" title="Permalink to this definition">¶</a></dt>

Handle registering and disconnecting for a set of signals and

callbacks:

<div class="highlight-default"><div class="highlight"><pre>>>> def oneat(x):

... print('eat', x)

>>> def ondrink(x):

... print('drink', x)

</pre></div>

</div>

<div class="highlight-default"><div class="highlight"><pre>>>> from matplotlib.cbook import CallbackRegistry

>>> callbacks = CallbackRegistry()

</pre></div>

</div>

<div class="highlight-default"><div class="highlight"><pre>>>> id_eat = callbacks.connect('eat', oneat)

>>> id_drink = callbacks.connect('drink', ondrink)

</pre></div>

</div>

<div class="highlight-default"><div class="highlight"><pre>>>> callbacks.process('drink', 123)

drink 123

>>> callbacks.process('eat', 456)

eat 456

>>> callbacks.process('be merry', 456) # nothing will be called

>>> callbacks.disconnect(id_eat)

</pre></div>

</div>

In practice, one should always disconnect all callbacks when they

are no longer needed to avoid dangling references (and thus memory

leaks). However, real code in matplotlib rarely does so, and due

to its design, it is rather difficult to place this kind of code.

To get around this, and prevent this class of memory leaks, we

instead store weak references to bound methods only, so when the

destination object needs to die, the CallbackRegistry won’t keep

it alive. The Python stdlib weakref module can not create weak

references to bound methods directly, so we need to create a proxy

object to handle weak references to bound methods (or regular free

functions). This technique was shared by Peter Parente on his

<a class="reference external" href="http://mindtrove.info/python-weak-references/">“Mindtrove” blog</a>.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">exception_handler : callable, optional

<div>If provided must have signature

<div class="highlight-default"><div class="highlight"><pre>def handler(exc: Exception) -> None:

</pre></div>

</div>

If not None this function will be called with any <code class="xref py py-obj docutils literal">Exception</code>

subclass raised by the callbacks in <a class="reference internal" href="#matplotlib.cbook.CallbackRegistry.process" title="matplotlib.cbook.CallbackRegistry.process"><code class="xref py py-obj docutils literal">CallbackRegistry.process</code></a>.

The handler may either consume the exception or re-raise.

The callable must be pickle-able.

The default handler is

<div class="highlight-default"><div class="highlight"><pre>def h(exc):

traceback.print_exc()

</pre></div>

</div>

</div></blockquote>

</td>

</tr>

</tbody>

</table>

<code class="descname">connect</code>(s, func)<a class="headerlink" href="#matplotlib.cbook.CallbackRegistry.connect" title="Permalink to this definition">¶</a></dt>

<dd>register func to be called when a signal s is generated

func will be called

</dd></dl>

<code class="descname">disconnect</code>(cid)<a class="headerlink" href="#matplotlib.cbook.CallbackRegistry.disconnect" title="Permalink to this definition">¶</a></dt>

<dd>disconnect the callback registered with callback id cid

</dd></dl>

<code class="descname">process</code>(s, *args, **kwargs)<a class="headerlink" href="#matplotlib.cbook.CallbackRegistry.process" title="Permalink to this definition">¶</a></dt>

<dd>process signal <code class="xref py py-obj docutils literal">s</code>. All of the functions registered to receive

callbacks on <code class="xref py py-obj docutils literal">s</code> will be called with <code class="docutils literal">**args</code> and <code class="docutils literal">**kwargs</code>

</dd></dl>

class <code class="descclassname">matplotlib.cbook.</code><code class="descname">GetRealpathAndStat</code><a class="headerlink" href="#matplotlib.cbook.GetRealpathAndStat" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.cbook.</code><code class="descname">Grouper</code>(init=())<a class="headerlink" href="#matplotlib.cbook.Grouper" title="Permalink to this definition">¶</a></dt>

This class provides a lightweight way to group arbitrary objects

together into disjoint sets when a full-blown graph data structure

would be overkill.

Objects can be joined using <a class="reference internal" href="#matplotlib.cbook.Grouper.join" title="matplotlib.cbook.Grouper.join"><code class="xref py py-meth docutils literal">join()</code></a>, tested for connectedness

using <a class="reference internal" href="#matplotlib.cbook.Grouper.joined" title="matplotlib.cbook.Grouper.joined"><code class="xref py py-meth docutils literal">joined()</code></a>, and all disjoint sets can be retreived by

using the object as an iterator.

The objects being joined must be hashable and weak-referenceable.

For example:

>>> class Foo(object):

... def __init__(self, s):

... self.s = s

... def __repr__(self):

... return self.s

...

>>> a, b, c, d, e, f = [Foo(x) for x in 'abcdef']

>>> grp = Grouper()

>>> grp.join(a, b)

>>> grp.join(b, c)

>>> grp.join(d, e)

>>> sorted(map(tuple, grp))

[(a, b, c), (d, e)]

>>> grp.joined(a, b)

True

False

</pre></div>

</div>

<code class="descname">clean</code>()<a class="headerlink" href="#matplotlib.cbook.Grouper.clean" title="Permalink to this definition">¶</a></dt>

<dd>Clean dead weak references from the dictionary

</dd></dl>

<code class="descname">get_siblings</code>(a)<a class="headerlink" href="#matplotlib.cbook.Grouper.get_siblings" title="Permalink to this definition">¶</a></dt>

<dd>Returns all of the items joined with a, including itself.

</dd></dl>

<dd>Join given arguments into the same set. Accepts one or more

arguments.

</dd></dl>

<code class="descname">joined</code>(a, b)<a class="headerlink" href="#matplotlib.cbook.Grouper.joined" title="Permalink to this definition">¶</a></dt>

<dd>Returns True if a and b are members of the same set.

</dd></dl>

<code class="descname">remove</code>(a)<a class="headerlink" href="#matplotlib.cbook.Grouper.remove" title="Permalink to this definition">¶</a></dt>

</dd></dl>

exception <code class="descclassname">matplotlib.cbook.</code><code class="descname">IgnoredKeywordWarning</code><a class="headerlink" href="#matplotlib.cbook.IgnoredKeywordWarning" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal">UserWarning</code>

A class for issuing warnings about keyword arguments that will be ignored

by matplotlib

</dd></dl>

class <code class="descclassname">matplotlib.cbook.</code><code class="descname">Locked</code>(path)<a class="headerlink" href="#matplotlib.cbook.Locked" title="Permalink to this definition">¶</a></dt>

Context manager to handle locks.

Based on code from conda.

conda is distributed under the terms of the BSD 3-clause license.

Consult LICENSE_CONDA or <a class="reference external" href="https://opensource.org/licenses/BSD-3-Clause">https://opensource.org/licenses/BSD-3-Clause</a>.

<code class="descname">LOCKFN</code> = '.matplotlib_lock'<a class="headerlink" href="#matplotlib.cbook.Locked.LOCKFN" title="Permalink to this definition">¶</a></dt>

exception <code class="descname">TimeoutError</code><a class="headerlink" href="#matplotlib.cbook.Locked.TimeoutError" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal">RuntimeError</code>

</dd></dl>

class <code class="descclassname">matplotlib.cbook.</code><code class="descname">Null</code>(*args, **kwargs)<a class="headerlink" href="#matplotlib.cbook.Null" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The Null class was deprecated in version 2.1.

</div>

Null objects always and reliably “do nothing.”

</dd></dl>

class <code class="descclassname">matplotlib.cbook.</code><code class="descname">RingBuffer</code>(*args, **kwargs)<a class="headerlink" href="#matplotlib.cbook.RingBuffer" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The RingBuffer class was deprecated in version 2.1.

</div>

class that implements a not-yet-full buffer

<code class="descname">append</code>(x)<a class="headerlink" href="#matplotlib.cbook.RingBuffer.append" title="Permalink to this definition">¶</a></dt>

<dd>append an element at the end of the buffer

</dd></dl>

<dd>Return a list of elements from the oldest to the newest.

</dd></dl>

class <code class="descclassname">matplotlib.cbook.</code><code class="descname">Sorter</code>(*args, **kwargs)<a class="headerlink" href="#matplotlib.cbook.Sorter" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: sorted(…, key=itemgetter(…))

</div>

Sort by attribute or item

Example usage:

<div class="highlight-default"><div class="highlight"><pre>sort = Sorter()

list = [(1, 2), (4, 8), (0, 3)]

dict = [{'a': 3, 'b': 4}, {'a': 5, 'b': 2}, {'a': 0, 'b': 0},

{'a': 9, 'b': 9}]

sort(list) # default sort

sort(list, 1) # sort by index 1

sort(dict, 'a') # sort a list of dicts by key 'a'

</pre></div>

</div>

<code class="descname">byAttribute</code>(data, attributename, inplace=1)<a class="headerlink" href="#matplotlib.cbook.Sorter.byAttribute" title="Permalink to this definition">¶</a></dt>

<code class="descname">byItem</code>(data, itemindex=None, inplace=1)<a class="headerlink" href="#matplotlib.cbook.Sorter.byItem" title="Permalink to this definition">¶</a></dt>

<code class="descname">sort</code>(data, itemindex=None, inplace=1)<a class="headerlink" href="#matplotlib.cbook.Sorter.sort" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.cbook.</code><code class="descname">Stack</code>(default=None)<a class="headerlink" href="#matplotlib.cbook.Stack" title="Permalink to this definition">¶</a></dt>

Implement a stack where elements can be pushed on and you can move

back and forth. But no pop. Should mimic home / back / forward

in a browser

<dd>move the position back and return the current element

</dd></dl>

<code class="descname">bubble</code>(o)<a class="headerlink" href="#matplotlib.cbook.Stack.bubble" title="Permalink to this definition">¶</a></dt>

<dd>raise o to the top of the stack and return o. o must be

in the stack

</dd></dl>

<code class="descname">clear</code>()<a class="headerlink" href="#matplotlib.cbook.Stack.clear" title="Permalink to this definition">¶</a></dt>

<dd>empty the stack

</dd></dl>

<code class="descname">empty</code>()<a class="headerlink" href="#matplotlib.cbook.Stack.empty" title="Permalink to this definition">¶</a></dt>

<code class="descname">forward</code>()<a class="headerlink" href="#matplotlib.cbook.Stack.forward" title="Permalink to this definition">¶</a></dt>

<dd>move the position forward and return the current element

</dd></dl>

<dd>push the first element onto the top of the stack

</dd></dl>

<dd>push object onto stack at current position - all elements

occurring later than the current position are discarded

</dd></dl>

<code class="descname">remove</code>(o)<a class="headerlink" href="#matplotlib.cbook.Stack.remove" title="Permalink to this definition">¶</a></dt>

<dd>remove element o from the stack

</dd></dl>

class <code class="descclassname">matplotlib.cbook.</code><code class="descname">Xlator</code>(*args, **kwargs)<a class="headerlink" href="#matplotlib.cbook.Xlator" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><code class="xref py py-class docutils literal">dict</code></a>

Deprecated since version 2.1: The Xlator class was deprecated in version 2.1.

</div>

All-in-one multiple-string-substitution class

Example usage:

<div class="highlight-default"><div class="highlight"><pre>text = "Larry Wall is the creator of Perl"

adict = {

"Larry Wall" : "Guido van Rossum",

"creator" : "Benevolent Dictator for Life",

"Perl" : "Python",

}

print(multiple_replace(adict, text))

xlat = Xlator(adict)

print(xlat.xlat(text))

</pre></div>

</div>

<dd>Translate text, returns the modified text.

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">align_iterators</code>(func, *iterables)<a class="headerlink" href="#matplotlib.cbook.align_iterators" title="Permalink to this definition">¶</a></dt>

<dd>This generator takes a bunch of iterables that are ordered by func

It sends out ordered tuples:

<div class="highlight-default"><div class="highlight"><pre>(func(row), [rows from all iterators matching func(row)])

</pre></div>

</div>

It is used by <a class="reference internal" href="mlab_api.html#matplotlib.mlab.recs_join" title="matplotlib.mlab.recs_join"><code class="xref py py-func docutils literal">matplotlib.mlab.recs_join()</code></a> to join record arrays

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">allequal</code>(seq)<a class="headerlink" href="#matplotlib.cbook.allequal" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The allequal function was deprecated in version 2.1.

</div>

Return True if all elements of seq compare equal. If seq is

0 or 1 length, return True

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">allpairs</code>(x)<a class="headerlink" href="#matplotlib.cbook.allpairs" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The allpairs function was deprecated in version 2.1.

</div>

return all possible pairs in sequence x

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">alltrue</code>(seq)<a class="headerlink" href="#matplotlib.cbook.alltrue" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The alltrue function was deprecated in version 2.1.

</div>

Return True if all elements of seq evaluate to True. If

seq is empty, return False.

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">boxplot_stats</code>(X, whis=1.5, bootstrap=None, labels=None, autorange=False)<a class="headerlink" href="#matplotlib.cbook.boxplot_stats" title="Permalink to this definition">¶</a></dt>

<dd>Returns list of dictionaries of statistics used to draw a series

of box and whisker plots. The <code class="xref py py-obj docutils literal">Returns</code> section enumerates the

required keys of the dictionary. Users can skip this function and

pass a user-defined set of dictionaries to the new <code class="xref py py-obj docutils literal">axes.bxp</code> method

instead of relying on MPL to do the calculations.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">X : array-like

<div>Data that will be represented in the boxplots. Should have 2 or

fewer dimensions.

</div></blockquote>

whis : float, string, or sequence (default = 1.5)

<div>As a float, determines the reach of the whiskers to the beyond the

first and third quartiles. In other words, where IQR is the

interquartile range (<code class="xref py py-obj docutils literal">Q3-Q1</code>), the upper whisker will extend to last

datum less than <code class="xref py py-obj docutils literal">Q3 + whis*IQR</code>). Similarly, the lower whisker will

extend to the first datum greater than <code class="xref py py-obj docutils literal">Q1 - whis*IQR</code>.

Beyond the whiskers, data are considered outliers

and are plotted as individual points. This can be set this to an

ascending sequence of percentile (e.g., [5, 95]) to set the

whiskers at specific percentiles of the data. Finally, <code class="xref py py-obj docutils literal">whis</code>

can be the string <code class="docutils literal">'range'</code> to force the whiskers to the

minimum and maximum of the data. In the edge case that the 25th

and 75th percentiles are equivalent, <code class="xref py py-obj docutils literal">whis</code> can be automatically

set to <code class="docutils literal">'range'</code> via the <code class="xref py py-obj docutils literal">autorange</code> option.

</div></blockquote>

bootstrap : int, optional

<div>Number of times the confidence intervals around the median

should be bootstrapped (percentile method).

</div></blockquote>

labels : array-like, optional

<div>Labels for each dataset. Length must be compatible with

dimensions of <code class="xref py py-obj docutils literal">X</code>.

</div></blockquote>

autorange : bool, optional (False)

<div>When <a class="reference external" href="https://docs.python.org/2/library/constants.html#True" title="(in Python v2.7)"><code class="xref py py-obj docutils literal">True</code></a> and the data are distributed such that the 25th and

75th percentiles are equal, <code class="docutils literal">whis</code> is set to <code class="docutils literal">'range'</code> such

that the whisker ends are at the minimum and maximum of the

data.

</div></blockquote>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">bxpstats : list of dict

<div>A list of dictionaries containing the results for each column

of data. Keys of each dictionary are the following:

</colgroup>

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

</tr>

</thead>

<tr class="row-even"><td>label</td>

<td>tick label for the boxplot</td>

</tr>

<td>arithemetic mean value</td>

</tr>

<td>50th percentile</td>

</tr>

<td>first quartile (25th percentile)</td>

</tr>

<td>third quartile (75th percentile)</td>

</tr>

<td>lower notch around the median</td>

</tr>

<td>upper notch around the median</td>

</tr>

<tr class="row-odd"><td>whislo</td>

<td>end of the lower whisker</td>

</tr>

<tr class="row-even"><td>whishi</td>

<td>end of the upper whisker</td>

</tr>

<tr class="row-odd"><td>fliers</td>

<td>outliers</td>

</tr>

</tbody>

</table>

</div></blockquote>

</td>

</tr>

</tbody>

</table>

Notes

Non-bootstrapping approach to confidence interval uses Gaussian-

based asymptotic approximation:

<img src="../_images/mathmpl/math-1742f7b9ed.png" class="center" />General approach from:

McGill, R., Tukey, J.W., and Larsen, W.A. (1978) “Variations of

Boxplots”, The American Statistician, 32:12-16.

</dd></dl>

class <code class="descclassname">matplotlib.cbook.</code><code class="descname">converter</code>(*args, **kwargs)<a class="headerlink" href="#matplotlib.cbook.converter" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The converter class was deprecated in version 2.1.

</div>

Base class for handling string -> python type with support for

missing values

<code class="descname">is_missing</code>(s)<a class="headerlink" href="#matplotlib.cbook.converter.is_missing" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">dedent</code>(s)<a class="headerlink" href="#matplotlib.cbook.dedent" title="Permalink to this definition">¶</a></dt>

<dd>Remove excess indentation from docstring s.

Discards any leading blank lines, then removes up to n whitespace

characters from each line, where n is the number of leading

whitespace characters in the first line. It differs from

textwrap.dedent in its deletion of leading blank lines and its use

of the first non-blank line to determine the indentation.

It is also faster in most cases.

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">delete_masked_points</code>(*args)<a class="headerlink" href="#matplotlib.cbook.delete_masked_points" title="Permalink to this definition">¶</a></dt>

<dd>Find all masked and/or non-finite points in a set of arguments,

and return the arguments with only the unmasked points remaining.

Arguments can be in any of 5 categories:

<li>1-D masked arrays</li>

<li>1-D ndarrays</li>

<li>ndarrays with more than one dimension</li>

<li>other non-string iterables</li>

<li>anything else</li>

</ol>

The first argument must be in one of the first four categories;

any argument with a length differing from that of the first

argument (and hence anything in category 5) then will be

passed through unchanged.

Masks are obtained from all arguments of the correct length

in categories 1, 2, and 4; a point is bad if masked in a masked

array or if it is a nan or inf. No attempt is made to

extract a mask from categories 2, 3, and 4 if <code class="xref py py-meth docutils literal">np.isfinite()</code>

does not yield a Boolean array.

All input arguments that are not passed unchanged are returned

as ndarrays after removing the points or rows corresponding to

masks in any of the arguments.

A vastly simpler version of this function was originally

written as a helper for Axes.scatter().

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">dict_delall</code>(d, keys)<a class="headerlink" href="#matplotlib.cbook.dict_delall" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The dict_delall function was deprecated in version 2.1.

</div>

delete all of the keys from the <a class="reference external" href="https://docs.python.org/2/library/stdtypes.html#dict" title="(in Python v2.7)"><code class="xref py py-class docutils literal">dict</code></a> d

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">exception_to_str</code>(s=None)<a class="headerlink" href="#matplotlib.cbook.exception_to_str" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The exception_to_str function was deprecated in version 2.1.

</div>

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">file_requires_unicode</code>(x)<a class="headerlink" href="#matplotlib.cbook.file_requires_unicode" title="Permalink to this definition">¶</a></dt>

<dd>Returns <a class="reference external" href="https://docs.python.org/2/library/constants.html#True" title="(in Python v2.7)"><code class="xref py py-obj docutils literal">True</code></a> if the given writable file-like object requires Unicode

to be written to it.

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">finddir</code>(o, match, case=False)<a class="headerlink" href="#matplotlib.cbook.finddir" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The finddir function was deprecated in version 2.1.

</div>

return all attributes of o which match string in match. if case

is True require an exact case match.

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">flatten</code>(seq, scalarp=<function is_scalar_or_string>)<a class="headerlink" href="#matplotlib.cbook.flatten" title="Permalink to this definition">¶</a></dt>

<dd>Returns a generator of flattened nested containers

For example:

>>> l = (('John', ['Hunter']), (1, 23), [[([42, (5, 23)], )]])

>>> print(list(flatten(l)))

['John', 'Hunter', 1, 23, 42, 5, 23]

</pre></div>

</div>

By: Composite of Holger Krekel and Luther Blissett

From: <a class="reference external" href="https://code.activestate.com/recipes/121294/">https://code.activestate.com/recipes/121294/</a>

and Recipe 1.12 in cookbook

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">get_label</code>(y, default_name)<a class="headerlink" href="#matplotlib.cbook.get_label" title="Permalink to this definition">¶</a></dt>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">get_recursive_filelist</code>(args)<a class="headerlink" href="#matplotlib.cbook.get_recursive_filelist" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The get_recursive_filelist function was deprecated in version 2.1.

</div>

Recurse all the files and dirs in args ignoring symbolic links

and return the files as a list of strings

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">get_sample_data</code>(fname, asfileobj=True)<a class="headerlink" href="#matplotlib.cbook.get_sample_data" title="Permalink to this definition">¶</a></dt>

<dd>Return a sample data file. fname is a path relative to the

<code class="xref py py-obj docutils literal">mpl-data/sample_data</code> directory. If asfileobj is <a class="reference external" href="https://docs.python.org/2/library/constants.html#True" title="(in Python v2.7)"><code class="xref py py-obj docutils literal">True</code></a>

return a file object, otherwise just a file path.

Set the rc parameter examples.directory to the directory where we should

look, if sample_data files are stored in a location different than

default (which is ‘mpl-data/sample_data` at the same level of ‘matplotlib`

Python module files).

If the filename ends in .gz, the file is implicitly ungzipped.

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">get_split_ind</code>(seq, N)<a class="headerlink" href="#matplotlib.cbook.get_split_ind" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The get_split_ind function was deprecated in version 2.1.

</div>

seq is a list of words. Return the index into seq such that:

<div class="highlight-default"><div class="highlight"><pre>len(' '.join(seq[:ind])<=N

</pre></div>

</div>

.

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">index_of</code>(y)<a class="headerlink" href="#matplotlib.cbook.index_of" title="Permalink to this definition">¶</a></dt>

<dd>A helper function to get the index of an input to plot

against if x values are not explicitly given.

Tries to get <code class="xref py py-obj docutils literal">y.index</code> (works if this is a pd.Series), if that

fails, return np.arange(y.shape[0]).

This will be extended in the future to deal with more types of

labeled data.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">y : scalar or array-like

<div>The proposed y-value

</div></blockquote>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">x, y : ndarray

<div>The x and y values to plot.

</div></blockquote>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_hashable</code>(obj)<a class="headerlink" href="#matplotlib.cbook.is_hashable" title="Permalink to this definition">¶</a></dt>

<dd>Returns true if obj can be hashed

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_math_text</code>(s)<a class="headerlink" href="#matplotlib.cbook.is_math_text" title="Permalink to this definition">¶</a></dt>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_numlike</code>(obj)<a class="headerlink" href="#matplotlib.cbook.is_numlike" title="Permalink to this definition">¶</a></dt>

<dd>return true if obj looks like a number

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_scalar</code>(obj)<a class="headerlink" href="#matplotlib.cbook.is_scalar" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The is_scalar function was deprecated in version 2.1.

</div>

return true if obj is not string like and is not iterable

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_scalar_or_string</code>(val)<a class="headerlink" href="#matplotlib.cbook.is_scalar_or_string" title="Permalink to this definition">¶</a></dt>

<dd>Return whether the given object is a scalar or string like.

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_sequence_of_strings</code>(obj)<a class="headerlink" href="#matplotlib.cbook.is_sequence_of_strings" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The is_sequence_of_strings function was deprecated in version 2.1.

</div>

Returns true if obj is iterable and contains strings

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_string_like</code>(obj)<a class="headerlink" href="#matplotlib.cbook.is_string_like" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The is_string_like function was deprecated in version 2.1.

</div>

Return True if obj looks like a string

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_writable_file_like</code>(obj)<a class="headerlink" href="#matplotlib.cbook.is_writable_file_like" title="Permalink to this definition">¶</a></dt>

<dd>return true if obj looks like a file object with a write method

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">issubclass_safe</code>(x, klass)<a class="headerlink" href="#matplotlib.cbook.issubclass_safe" title="Permalink to this definition">¶</a></dt>

Deprecated since version 2.1: The issubclass_safe function was deprecated in version 2.1.

</div>

return issubclass(x, klass) and return False on a TypeError

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">iterable</code>(obj)<a class="headerlink" href="#matplotlib.cbook.iterable" title="Permalink to this definition">¶</a></dt>

<dd>return true if obj is iterable

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">listFiles</code>(root, patterns='*', recurse=1, return_folders=0)<a class="headerlink" href="#matplotlib.cbook.listFiles" title="Permalink to this definition">¶</a></dt>

<dd>Recursively list files

from Parmar and Martelli in the Python Cookbook

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">local_over_kwdict</code>(local_var, kwargs, *keys)<a class="headerlink" href="#matplotlib.cbook.local_over_kwdict" title="Permalink to this definition">¶</a></dt>

<dd>Enforces the priority of a local variable over potentially conflicting

argument(s) from a kwargs dict. The following possible output values are

considered in order of priority:

<div>local_var > kwargs[keys[0]] > … > kwargs[keys[-1]]</div></blockquote>

The first of these whose value is not None will be returned. If all are

None then None will be returned. Each key in keys will be removed from the

kwargs dict in place.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body">local_var: any object

<div>The local variable (highest priority)

</div></blockquote>

<dt>kwargs: dict</dt>

<dd>Dictionary of keyword arguments; modified in place

</dd>

<dd>Name(s) of keyword arguments to process, in descending order of

priority

</dd>

</dl>

</div></blockquote>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">out: any object

<div>Either local_var or one of kwargs[key] for key in keys

</div></blockquote>

</td>

</tr>

<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body">IgnoredKeywordWarning

<div>For each key in keys that is removed from kwargs but not used as

the output value

</div></blockquote>

</td>

</tr>

</tbody>

</table>

</dd></dl>

class <code class="descclassname">matplotlib.cbook.</code><code class="descname">maxdict</code>(maxsize)<a class="headerlink" href="#matplotlib.cbook.maxdict" title="Permalink to this definition">¶</a></dt>

A dictionary with a maximum size; this doesn’t override all the

relevant methods to constrain the size, just setitem, so use with

caution

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">mkdirs</code>(newdir, mode=511)<a class="headerlink" href="#matplotlib.cbook.mkdirs" title="Permalink to this definition">¶</a></dt>

<dd>make directory newdir recursively, and set mode. Equivalent to

<div class="highlight-default"><div class="highlight"><pre>> mkdir -p NEWDIR

> chmod MODE NEWDIR

</pre></div>

</div>

</dd></dl>

<code class="descclassname">matplotlib.cbook.</code><code class="descname">normalize_kwargs</code>(kw, alias_mapping=None, required=(), forbidden=(), allowed=None)<a class="headerlink" href="#matplotlib.cbook.normalize_kwargs" title="Permalink to this definition">¶</a></dt>

<dd>Helper function to normalize kwarg inputs

The order they are resolved are:

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

cbook_api.html

Latest commit

History

cbook_api.html

File metadata and controls