matplotlib.github.com/3.2.1/_modules/matplotlib/lines.html at main · matplotlib/matplotlib.github.com

History

1670 lines (1400 loc) · 200 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>matplotlib.lines — Matplotlib 3.2.1 documentation</title>

title="Search within Matplotlib 3.2.1 documentation"

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

</head><body>

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

John Hunter Excellence in Plotting Contest 2020

<a href="https://jhepc.github.io/about.html"> submissions are open!

</a>

Entries are due June 1, 2020.

</div>

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.2.1</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>

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

<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>

<li class="nav-item nav-item-2"><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

</ul>

</div>

<h3>Related Topics</h3>

<ul>

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

<li><a href="../index.html">Module code</a><ul>

<li><a href="../matplotlib.html">matplotlib</a><ul>

</ul></li>

</ul>

</div>

<h1>Source code for matplotlib.lines</h1><div class="highlight"><pre>

"""

This module contains all the 2D line class which can draw with a

variety of line styles, markers and colors.

"""

# TODO: expose cap and join style attrs

from numbers import Integral, Number, Real

import logging

import numpy as np

from . import artist, cbook, colors as mcolors, docstring, rcParams

from .artist import Artist, allow_rasterization

from .cbook import (

_to_unmasked_float_array, ls_mapper, ls_mapper_r, STEP_LOOKUP_MAP)

from .markers import MarkerStyle

from .path import Path

from .transforms import Bbox, TransformedPath

# Imported here for backward compatibility, even though they don't

# really belong.

from . import _path

from .markers import (

CARETLEFT, CARETRIGHT, CARETUP, CARETDOWN,

CARETLEFTBASE, CARETRIGHTBASE, CARETUPBASE, CARETDOWNBASE,

TICKLEFT, TICKRIGHT, TICKUP, TICKDOWN)

_log = logging.getLogger(__name__)

def _get_dash_pattern(style):

"""Convert linestyle -> dash pattern

"""

# go from short hand -> full strings

if isinstance(style, str):

style = ls_mapper.get(style, style)

# un-dashed styles

if style in ['solid', 'None']:

offset, dashes = None, None

# dashed styles

elif style in ['dashed', 'dashdot', 'dotted']:

offset = 0

dashes = tuple(rcParams['lines.{}_pattern'.format(style)])

#

elif isinstance(style, tuple):

offset, dashes = style

else:

raise ValueError('Unrecognized linestyle: %s' % str(style))

# normalize offset to be positive and shorter than the dash cycle

if dashes is not None and offset is not None:

dsum = sum(dashes)

if dsum:

offset %= dsum

return offset, dashes

def _scale_dashes(offset, dashes, lw):

if not rcParams['lines.scale_dashes']:

return offset, dashes

scaled_offset = scaled_dashes = None

if offset is not None:

scaled_offset = offset * lw

if dashes is not None:

scaled_dashes = [x * lw if x is not None else None

for x in dashes]

return scaled_offset, scaled_dashes

<div class="viewcode-block" id="segment_hits"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.segment_hits.html#matplotlib.lines.segment_hits">[docs]</a>def segment_hits(cx, cy, x, y, radius):

"""

Return the indices of the segments in the polyline with coordinates (*cx*,

*cy*) that are within a distance *radius* of the point (*x*, *y*).

"""

# Process single points specially

if len(x) <= 1:

res, = np.nonzero((cx - x) ** 2 + (cy - y) ** 2 <= radius ** 2)

return res

# We need to lop the last element off a lot.

xr, yr = x[:-1], y[:-1]

# Only look at line segments whose nearest point to C on the line

# lies within the segment.

dx, dy = x[1:] - xr, y[1:] - yr

Lnorm_sq = dx ** 2 + dy ** 2 # Possibly want to eliminate Lnorm==0

u = ((cx - xr) * dx + (cy - yr) * dy) / Lnorm_sq

candidates = (u >= 0) & (u <= 1)

# Note that there is a little area near one side of each point

# which will be near neither segment, and another which will

# be near both, depending on the angle of the lines. The

# following radius test eliminates these ambiguities.

point_hits = (cx - x) ** 2 + (cy - y) ** 2 <= radius ** 2

candidates = candidates & ~(point_hits[:-1] | point_hits[1:])

# For those candidates which remain, determine how far they lie away

# from the line.

px, py = xr + u * dx, yr + u * dy

line_hits = (cx - px) ** 2 + (cy - py) ** 2 <= radius ** 2

line_hits = line_hits & candidates

points, = point_hits.ravel().nonzero()

lines, = line_hits.ravel().nonzero()

return np.concatenate((points, lines))</div>

def _mark_every_path(markevery, tpath, affine, ax_transform):

"""

Helper function that sorts out how to deal the input

`markevery` and returns the points where markers should be drawn.

Takes in the `markevery` value and the line path and returns the

sub-sampled path.

"""

# pull out the two bits of data we want from the path

codes, verts = tpath.codes, tpath.vertices

def _slice_or_none(in_v, slc):

'''

Helper function to cope with `codes` being an

ndarray or `None`

'''

if in_v is None:

return None

return in_v[slc]

# if just an int, assume starting at 0 and make a tuple

if isinstance(markevery, Integral):

markevery = (0, markevery)

# if just a float, assume starting at 0.0 and make a tuple

elif isinstance(markevery, Real):

markevery = (0.0, markevery)

if isinstance(markevery, tuple):

if len(markevery) != 2:

raise ValueError('`markevery` is a tuple but its len is not 2; '

'markevery={}'.format(markevery))

start, step = markevery

# if step is an int, old behavior

if isinstance(step, Integral):

# tuple of 2 int is for backwards compatibility,

if not isinstance(start, Integral):

raise ValueError(

'`markevery` is a tuple with len 2 and second element is '

'an int, but the first element is not an int; markevery={}'

.format(markevery))

# just return, we are done here

return Path(verts[slice(start, None, step)],

_slice_or_none(codes, slice(start, None, step)))

elif isinstance(step, Real):

raise ValueError(

'`markevery` is a tuple with len 2 and second element is '

'a float, but the first element is not a float or an int; '

# calc cumulative distance along path (in display coords):

disp_coords = affine.transform(tpath.vertices)

delta = np.empty((len(disp_coords), 2))

delta[0, :] = 0

delta[1:, :] = disp_coords[1:, :] - disp_coords[:-1, :]

delta = np.hypot(*delta.T).cumsum()

# calc distance between markers along path based on the axes

# bounding box diagonal being a distance of unity:

(x0, y0), (x1, y1) = ax_transform.transform([[0, 0], [1, 1]])

scale = np.hypot(x1 - x0, y1 - y0)

marker_delta = np.arange(start * scale, delta[-1], step * scale)

# find closest actual data point that is closest to

# the theoretical distance along the path:

inds = np.abs(delta[np.newaxis, :] - marker_delta[:, np.newaxis])

inds = inds.argmin(axis=1)

inds = np.unique(inds)

# return, we are done here

return Path(verts[inds], _slice_or_none(codes, inds))

else:

raise ValueError(

f"markevery={markevery!r} is a tuple with len 2, but its "

f"second element is not an int or a float")

elif isinstance(markevery, slice):

# mazol tov, it's already a slice, just return

return Path(verts[markevery], _slice_or_none(codes, markevery))

elif np.iterable(markevery):

# fancy indexing

try:

except (ValueError, IndexError):

raise ValueError(

f"fancy index")

else:

raise ValueError(f"markevery={markevery!r} is not a recognized value")

<div class="viewcode-block" id="Line2D"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D">[docs]</a>@cbook._define_aliases({

"antialiased": ["aa"],

"color": ["c"],

"drawstyle": ["ds"],

"linestyle": ["ls"],

"linewidth": ["lw"],

"markeredgecolor": ["mec"],

"markeredgewidth": ["mew"],

"markerfacecolor": ["mfc"],

"markerfacecoloralt": ["mfcalt"],

"markersize": ["ms"],

})

class Line2D(Artist):

"""

A line - the line can have both a solid linestyle connecting all

the vertices, and a marker at each vertex. Additionally, the

drawing of the solid line is influenced by the drawstyle, e.g., one

can create "stepped" lines in various styles.

"""

lineStyles = _lineStyles = { # hidden names deprecated

'-': '_draw_solid',

'--': '_draw_dashed',

'-.': '_draw_dash_dot',

':': '_draw_dotted',

'None': '_draw_nothing',

' ': '_draw_nothing',

'': '_draw_nothing',

}

_drawStyles_l = {

'default': '_draw_lines',

'steps-mid': '_draw_steps_mid',

'steps-pre': '_draw_steps_pre',

'steps-post': '_draw_steps_post',

}

_drawStyles_s = {

'steps': '_draw_steps_pre',

}

# drawStyles should now be deprecated.

drawStyles = {**_drawStyles_l, **_drawStyles_s}

# Need a list ordered with long names first:

drawStyleKeys = [*_drawStyles_l, *_drawStyles_s]

# Referenced here to maintain API. These are defined in

# MarkerStyle

markers = MarkerStyle.markers

filled_markers = MarkerStyle.filled_markers

fillStyles = MarkerStyle.fillstyles

zorder = 2

validCap = ('butt', 'round', 'projecting')

validJoin = ('miter', 'round', 'bevel')

def __str__(self):

if self._label != "":

return f"Line2D({self._label})"

elif self._x is None:

return "Line2D()"

elif len(self._x) > 3:

return "Line2D((%g,%g),(%g,%g),...,(%g,%g))" % (

self._x[0], self._y[0], self._x[0],

self._y[0], self._x[-1], self._y[-1])

else:

return "Line2D(%s)" % ",".join(

map("({:g},{:g})".format, self._x, self._y))

def __init__(self, xdata, ydata,

linewidth=None, # all Nones default to rc

linestyle=None,

color=None,

marker=None,

markersize=None,

markeredgewidth=None,

markeredgecolor=None,

markerfacecolor=None,

markerfacecoloralt='none',

fillstyle=None,

antialiased=None,

dash_capstyle=None,

solid_capstyle=None,

dash_joinstyle=None,

solid_joinstyle=None,

pickradius=5,

drawstyle=None,

markevery=None,

**kwargs

):

"""

Create a `.Line2D` instance with *x* and *y* data in sequences of

*xdata*, *ydata*.

Additional keyword arguments are `.Line2D` properties:

%(_Line2D_docstr)s

See :meth:`set_linestyle` for a description of the line styles,

:meth:`set_marker` for a description of the markers, and

:meth:`set_drawstyle` for a description of the draw styles.

"""

Artist.__init__(self)

#convert sequences to numpy arrays

if not np.iterable(xdata):

raise RuntimeError('xdata must be a sequence')

raise RuntimeError('ydata must be a sequence')

if linewidth is None:

linewidth = rcParams['lines.linewidth']

if linestyle is None:

linestyle = rcParams['lines.linestyle']

if marker is None:

marker = rcParams['lines.marker']

if markerfacecolor is None:

markerfacecolor = rcParams['lines.markerfacecolor']

if markeredgecolor is None:

markeredgecolor = rcParams['lines.markeredgecolor']

if color is None:

color = rcParams['lines.color']

if markersize is None:

markersize = rcParams['lines.markersize']

if antialiased is None:

antialiased = rcParams['lines.antialiased']

if dash_capstyle is None:

dash_capstyle = rcParams['lines.dash_capstyle']

if dash_joinstyle is None:

dash_joinstyle = rcParams['lines.dash_joinstyle']

if solid_capstyle is None:

solid_capstyle = rcParams['lines.solid_capstyle']

if solid_joinstyle is None:

solid_joinstyle = rcParams['lines.solid_joinstyle']

if isinstance(linestyle, str):

ds, ls = self._split_drawstyle_linestyle(linestyle)

if ds is not None and drawstyle is not None and ds != drawstyle:

raise ValueError("Inconsistent drawstyle ({!r}) and linestyle "

"({!r})".format(drawstyle, linestyle))

linestyle = ls

if ds is not None:

drawstyle = ds

if drawstyle is None:

drawstyle = 'default'

self._dashcapstyle = None

self._dashjoinstyle = None

self._solidjoinstyle = None

self._solidcapstyle = None

self.set_dash_capstyle(dash_capstyle)

self.set_dash_joinstyle(dash_joinstyle)

self.set_solid_capstyle(solid_capstyle)

self.set_solid_joinstyle(solid_joinstyle)

self._linestyles = None

self._drawstyle = None

self._linewidth = linewidth

# scaled dash + offset

self._dashSeq = None

self._dashOffset = 0

# unscaled dash + offset

# this is needed scaling the dash pattern by linewidth

self._us_dashSeq = None

self._us_dashOffset = 0

self.set_linewidth(linewidth)

self.set_linestyle(linestyle)

self.set_drawstyle(drawstyle)

self._color = None

self.set_color(color)

self._marker = MarkerStyle(marker, fillstyle)

self._markevery = None

self._markersize = None

self._antialiased = None

self.set_markevery(markevery)

self.set_antialiased(antialiased)

self.set_markersize(markersize)

self._markeredgecolor = None

self._markeredgewidth = None

self._markerfacecolor = None

self._markerfacecoloralt = None

self.set_markerfacecolor(markerfacecolor)

self.set_markerfacecoloralt(markerfacecoloralt)

self.set_markeredgecolor(markeredgecolor)

self.set_markeredgewidth(markeredgewidth)

# update kwargs before updating data to give the caller a

# chance to init axes (and hence unit support)

self.update(kwargs)

self.pickradius = pickradius

self.ind_offset = 0

if isinstance(self._picker, Number):

self.pickradius = self._picker

self._xorig = np.asarray([])

self._yorig = np.asarray([])

self._invalidx = True

self._invalidy = True

self._x = None

self._y = None

self._xy = None

self._path = None

self._transformed_path = None

self._subslice = False

self._x_filled = None # used in subslicing; only x is needed

self.set_data(xdata, ydata)

@cbook.deprecated("3.1")

@property

def verticalOffset(self):

return None

<div class="viewcode-block" id="Line2D.contains"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.contains">[docs]</a> def contains(self, mouseevent):

"""

Test whether the mouse event occurred on the line. The pick

radius determines the precision of the location test (usually

within five points of the value). Use

:meth:`~matplotlib.lines.Line2D.get_pickradius` or

:meth:`~matplotlib.lines.Line2D.set_pickradius` to view or

modify it.

Parameters

----------

mouseevent : `matplotlib.backend_bases.MouseEvent`

Returns

-------

contains : bool

Whether any values are within the radius.

details : dict

A dictionary ``{'ind': pointlist}``, where *pointlist* is a

list of points of the line that are within the pickradius around

the event position.

TODO: sort returned indices by distance

"""

inside, info = self._default_contains(mouseevent)

if inside is not None:

return inside, info

if not isinstance(self.pickradius, Number):

raise ValueError("pick radius should be a distance")

# Make sure we have data to plot

if self._invalidy or self._invalidx:

self.recache()

if len(self._xy) == 0:

return False, {}

# Convert points to pixels

transformed_path = self._get_transformed_path()

path, affine = transformed_path.get_transformed_path_and_affine()

path = affine.transform_path(path)

xy = path.vertices

xt = xy[:, 0]

yt = xy[:, 1]

# Convert pick radius from points to pixels

if self.figure is None:

_log.warning('no figure set when check if mouse is on line')

pixels = self.pickradius

else:

pixels = self.figure.dpi / 72. * self.pickradius

# The math involved in checking for containment (here and inside of

# segment_hits) assumes that it is OK to overflow, so temporarily set

# the error flags accordingly.

with np.errstate(all='ignore'):

# Check for collision

if self._linestyle in ['None', None]:

# If no line, return the nearby point(s)

ind, = np.nonzero(

(xt - mouseevent.x) ** 2 + (yt - mouseevent.y) ** 2

<= pixels ** 2)

else:

# If line, return the nearby segment(s)

ind = segment_hits(mouseevent.x, mouseevent.y, xt, yt, pixels)

if self._drawstyle.startswith("steps"):

ind //= 2

ind += self.ind_offset

# Return the point(s) within radius

return len(ind) > 0, dict(ind=ind)</div>

<div class="viewcode-block" id="Line2D.get_pickradius"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.get_pickradius">[docs]</a> def get_pickradius(self):

"""

Return the pick radius used for containment tests.

See `.contains` for more details.

"""

return self.pickradius</div>

<div class="viewcode-block" id="Line2D.set_pickradius"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.set_pickradius">[docs]</a> def set_pickradius(self, d):

"""Set the pick radius used for containment tests.

See `.contains` for more details.

Parameters

----------

d : float

Pick radius, in points.

"""

self.pickradius = d</div>

<div class="viewcode-block" id="Line2D.get_fillstyle"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.get_fillstyle">[docs]</a> def get_fillstyle(self):

"""

Return the marker fill style.

See also `~.Line2D.set_fillstyle`.

"""

return self._marker.get_fillstyle()</div>

<div class="viewcode-block" id="Line2D.set_fillstyle"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.set_fillstyle">[docs]</a> def set_fillstyle(self, fs):

"""

Set the marker fill style.

Parameters

----------

fs : {'full', 'left', 'right', 'bottom', 'top', 'none'}

Possible values:

- 'full': Fill the whole marker with the *markerfacecolor*.

- 'left', 'right', 'bottom', 'top': Fill the marker half at

the given side with the *markerfacecolor*. The other

half of the marker is filled with *markerfacecoloralt*.

- 'none': No filling.

For examples see

:doc:`/gallery/lines_bars_and_markers/marker_fillstyle_reference`.

"""

self._marker.set_fillstyle(fs)

self.stale = True</div>

<div class="viewcode-block" id="Line2D.set_markevery"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.set_markevery">[docs]</a> def set_markevery(self, every):

"""Set the markevery property to subsample the plot when using markers.

e.g., if `every=5`, every 5-th marker will be plotted.

Parameters

----------

every : None or int or (int, int) or slice or List[int] or float or \

(float, float)

Which markers to plot.

- every=None, every point will be plotted.

- every=N, every N-th marker will be plotted starting with

marker 0.

- every=(start, N), every N-th marker, starting at point

start, will be plotted.

- every=slice(start, end, N), every N-th marker, starting at

point start, up to but not including point end, will be plotted.

- every=[i, j, m, n], only markers at points i, j, m, and n

will be plotted.

- every=0.1, (i.e. a float) then markers will be spaced at

approximately equal distances along the line; the distance

along the line between markers is determined by multiplying the

display-coordinate distance of the axes bounding-box diagonal

by the value of every.

- every=(0.5, 0.1) (i.e. a length-2 tuple of float), the same

functionality as every=0.1 is exhibited but the first marker will

be 0.5 multiplied by the display-coordinate-diagonal-distance

along the line.

For examples see

:doc:`/gallery/lines_bars_and_markers/markevery_demo`.

Notes

-----

Setting the markevery property will only show markers at actual data

points. When using float arguments to set the markevery property

on irregularly spaced data, the markers will likely not appear evenly

spaced because the actual data points do not coincide with the

theoretical spacing between markers.

When using a start offset to specify the first marker, the offset will

be from the first data point which may be different from the first

the visible data point if the plot is zoomed in.

If zooming in on a plot when using float arguments then the actual

data points that have markers will change because the distance between

markers is always determined from the display-coordinates

axes-bounding-box-diagonal regardless of the actual axes data limits.

"""

if self._markevery != every:

self.stale = True

self._markevery = every</div>

<div class="viewcode-block" id="Line2D.get_markevery"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.get_markevery">[docs]</a> def get_markevery(self):

"""

Return the markevery setting for marker subsampling.

See also `~.Line2D.set_markevery`.

"""

return self._markevery</div>

<div class="viewcode-block" id="Line2D.set_picker"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.set_picker">[docs]</a> def set_picker(self, p):

"""Sets the event picker details for the line.

Parameters

----------

p : float or callable[[Artist, Event], Tuple[bool, dict]]

If a float, it is used as the pick radius in points.

"""

if callable(p):

self._contains = p

else:

self.pickradius = p

self._picker = p</div>

<div class="viewcode-block" id="Line2D.get_window_extent"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.get_window_extent">[docs]</a> def get_window_extent(self, renderer):

bbox = Bbox([[0, 0], [0, 0]])

trans_data_to_xy = self.get_transform().transform

bbox.update_from_data_xy(trans_data_to_xy(self.get_xydata()),

ignore=True)

# correct for marker size, if any

if self._marker:

ms = (self._markersize / 72.0 * self.figure.dpi) * 0.5

bbox = bbox.padded(ms)

return bbox</div>

@Artist.axes.setter

def axes(self, ax):

# call the set method from the base-class property

Artist.axes.fset(self, ax)

if ax is not None:

# connect unit-related callbacks

if ax.xaxis is not None:

self._xcid = ax.xaxis.callbacks.connect('units',

self.recache_always)

if ax.yaxis is not None:

self._ycid = ax.yaxis.callbacks.connect('units',

self.recache_always)

<div class="viewcode-block" id="Line2D.set_data"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.set_data">[docs]</a> def set_data(self, *args):

"""

Set the x and y data.

Parameters

----------

*args : (2, N) array or two 1D arrays

"""

if len(args) == 1:

(x, y), = args

else:

x, y = args

self.set_xdata(x)

self.set_ydata(y)</div>

<div class="viewcode-block" id="Line2D.recache_always"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.recache_always">[docs]</a> def recache_always(self):

self.recache(always=True)</div>

<div class="viewcode-block" id="Line2D.recache"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.recache">[docs]</a> def recache(self, always=False):

if always or self._invalidx:

xconv = self.convert_xunits(self._xorig)

x = _to_unmasked_float_array(xconv).ravel()

else:

x = self._x

if always or self._invalidy:

yconv = self.convert_yunits(self._yorig)

y = _to_unmasked_float_array(yconv).ravel()

else:

y = self._y

self._xy = np.column_stack(np.broadcast_arrays(x, y)).astype(float)

self._x, self._y = self._xy.T # views

self._subslice = False

if (self.axes and len(x) > 1000 and self._is_sorted(x) and

self.axes.name == 'rectilinear' and

self.axes.get_xscale() == 'linear' and

self._markevery is None and

self.get_clip_on()):

self._subslice = True

nanmask = np.isnan(x)

if nanmask.any():

self._x_filled = self._x.copy()

indices = np.arange(len(x))

self._x_filled[nanmask] = np.interp(indices[nanmask],

indices[~nanmask], self._x[~nanmask])

else:

self._x_filled = self._x

if self._path is not None:

interpolation_steps = self._path._interpolation_steps

else:

interpolation_steps = 1

xy = STEP_LOOKUP_MAP[self._drawstyle](*self._xy.T)

self._path = Path(np.asarray(xy).T,

_interpolation_steps=interpolation_steps)

self._transformed_path = None

self._invalidx = False

self._invalidy = False</div>

def _transform_path(self, subslice=None):

"""

Puts a TransformedPath instance at self._transformed_path;

all invalidation of the transform is then handled by the

TransformedPath instance.

"""

# Masked arrays are now handled by the Path class itself

if subslice is not None:

xy = STEP_LOOKUP_MAP[self._drawstyle](*self._xy[subslice, :].T)

_path = Path(np.asarray(xy).T,

_interpolation_steps=self._path._interpolation_steps)

else:

_path = self._path

self._transformed_path = TransformedPath(_path, self.get_transform())

def _get_transformed_path(self):

"""

Return the :class:`~matplotlib.transforms.TransformedPath` instance

of this line.

"""

if self._transformed_path is None:

self._transform_path()

return self._transformed_path

<div class="viewcode-block" id="Line2D.set_transform"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.set_transform">[docs]</a> def set_transform(self, t):

"""

Set the Transformation instance used by this artist.

Parameters

----------

t : `matplotlib.transforms.Transform`

"""

Artist.set_transform(self, t)

self._invalidx = True

self._invalidy = True

self.stale = True</div>

def _is_sorted(self, x):

"""Return whether x is sorted in ascending order."""

# We don't handle the monotonically decreasing case.

return _path.is_sorted(x)

<div class="viewcode-block" id="Line2D.draw"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.draw">[docs]</a> @allow_rasterization

def draw(self, renderer):

# docstring inherited from Artist.draw.

if not self.get_visible():

return

self.recache()

self.ind_offset = 0 # Needed for contains() method.

if self._subslice and self.axes:

x0, x1 = self.axes.get_xbound()

i0 = self._x_filled.searchsorted(x0, 'left')

i1 = self._x_filled.searchsorted(x1, 'right')

subslice = slice(max(i0 - 1, 0), i1 + 1)

self.ind_offset = subslice.start

self._transform_path(subslice)

else:

subslice = None

if self.get_path_effects():

from matplotlib.patheffects import PathEffectRenderer

renderer = PathEffectRenderer(self.get_path_effects(), renderer)

renderer.open_group('line2d', self.get_gid())

if self._lineStyles[self._linestyle] != '_draw_nothing':

tpath, affine = (self._get_transformed_path()

.get_transformed_path_and_affine())

if len(tpath.vertices):

gc = renderer.new_gc()

self._set_gc_clip(gc)

lc_rgba = mcolors.to_rgba(self._color, self._alpha)

gc.set_foreground(lc_rgba, isRGBA=True)

gc.set_antialiased(self._antialiased)

gc.set_linewidth(self._linewidth)

if self.is_dashed():

cap = self._dashcapstyle

join = self._dashjoinstyle

else:

cap = self._solidcapstyle

join = self._solidjoinstyle

gc.set_joinstyle(join)

gc.set_capstyle(cap)

gc.set_snap(self.get_snap())

if self.get_sketch_params() is not None:

gc.set_sketch_params(*self.get_sketch_params())

gc.set_dashes(self._dashOffset, self._dashSeq)

renderer.draw_path(gc, tpath, affine.frozen())

gc.restore()

if self._marker and self._markersize > 0:

gc = renderer.new_gc()

self._set_gc_clip(gc)

ec_rgba = mcolors.to_rgba(

self.get_markeredgecolor(), self._alpha)

fc_rgba = mcolors.to_rgba(

self._get_markerfacecolor(), self._alpha)

fcalt_rgba = mcolors.to_rgba(

self._get_markerfacecolor(alt=True), self._alpha)

# If the edgecolor is "auto", it is set according to the *line*

# color but inherits the alpha value of the *face* color, if any.

if (cbook._str_equal(self._markeredgecolor, "auto")

and not cbook._str_lower_equal(

self.get_markerfacecolor(), "none")):

ec_rgba = ec_rgba[:3] + (fc_rgba[3],)

gc.set_foreground(ec_rgba, isRGBA=True)

scale, length, randomness = self.get_sketch_params()

gc.set_sketch_params(scale/2, length/2, 2*randomness)

marker = self._marker

# Markers *must* be drawn ignoring the drawstyle (but don't pay the

# recaching if drawstyle is already "default").

if self.get_drawstyle() != "default":

with cbook._setattr_cm(

self, _drawstyle="default", _transformed_path=None):

self.recache()

self._transform_path(subslice)

.get_transformed_points_and_affine())

else:

.get_transformed_points_and_affine())

if len(tpath.vertices):

# subsample the markers if markevery is not None

markevery = self.get_markevery()

if markevery is not None:

subsampled = _mark_every_path(markevery, tpath,

affine, self.axes.transAxes)

else:

subsampled = tpath

snap = marker.get_snap_threshold()

if isinstance(snap, Real):

snap = renderer.points_to_pixels(self._markersize) >= snap

gc.set_snap(snap)

gc.set_joinstyle(marker.get_joinstyle())

gc.set_capstyle(marker.get_capstyle())

marker_path = marker.get_path()

marker_trans = marker.get_transform()

w = renderer.points_to_pixels(self._markersize)

if cbook._str_equal(marker.get_marker(), ","):

gc.set_linewidth(0)

else:

# Don't scale for pixels, and don't stroke them

marker_trans = marker_trans.scale(w)

renderer.draw_markers(gc, marker_path, marker_trans,

subsampled, affine.frozen(),

fc_rgba)

alt_marker_path = marker.get_alt_path()

if alt_marker_path:

alt_marker_trans = marker.get_alt_transform()

alt_marker_trans = alt_marker_trans.scale(w)

renderer.draw_markers(

gc, alt_marker_path, alt_marker_trans, subsampled,

affine.frozen(), fcalt_rgba)

gc.restore()

renderer.close_group('line2d')

self.stale = False</div>

<div class="viewcode-block" id="Line2D.get_antialiased"><a class="viewcode-back" href="../../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.get_antialiased">[docs]</a> def get_antialiased(self):

"""Return whether antialiased rendering is used."""

return self._antialiased</div>

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

lines.html

Latest commit

History

lines.html

File metadata and controls