matplotlib.github.com/_modules/matplotlib/patheffects.html at master · 2236zml/matplotlib.github.com · GitHub

History

522 lines (430 loc) · 57.8 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

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

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

<head>

<title>matplotlib.patheffects — Matplotlib 3.1.3 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.1.3 documentation"

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

</head>

<body>

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.1.3</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><a href="../index.html" >Module code</a> »</li>

<li><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.patheffects</h1><div class="highlight"><pre>

"""

Defines classes for path effects. The path effects are supported in

:class:`~matplotlib.text.Text`, :class:`~matplotlib.lines.Line2D`

and :class:`~matplotlib.patches.Patch`.

"""

from matplotlib.backend_bases import RendererBase

from matplotlib import colors as mcolors

from matplotlib import patches as mpatches

from matplotlib import transforms as mtransforms

<div class="viewcode-block" id="AbstractPathEffect"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.AbstractPathEffect">[docs]</a>class AbstractPathEffect(object):

"""

A base class for path effects.

Subclasses should override the ``draw_path`` method to add effect

functionality.

"""

def __init__(self, offset=(0., 0.)):

"""

Parameters

----------

offset : pair of floats

The offset to apply to the path, measured in points.

"""

self._offset = offset

self._offset_trans = mtransforms.Affine2D()

def _offset_transform(self, renderer, transform):

"""Apply the offset to the given transform."""

offset_x = renderer.points_to_pixels(self._offset[0])

offset_y = renderer.points_to_pixels(self._offset[1])

return transform + self._offset_trans.clear().translate(offset_x,

offset_y)

def _update_gc(self, gc, new_gc_dict):

"""

Update the given GraphicsCollection with the given

dictionary of properties. The keys in the dictionary are used to

identify the appropriate set_ method on the gc.

"""

new_gc_dict = new_gc_dict.copy()

dashes = new_gc_dict.pop("dashes", None)

if dashes:

gc.set_dashes(**dashes)

for k, v in new_gc_dict.items():

set_method = getattr(gc, 'set_' + k, None)

if not callable(set_method):

raise AttributeError('Unknown property {0}'.format(k))

set_method(v)

return gc

<div class="viewcode-block" id="AbstractPathEffect.draw_path"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.AbstractPathEffect.draw_path">[docs]</a> def draw_path(self, renderer, gc, tpath, affine, rgbFace=None):

"""

Derived should override this method. The arguments are the same

as :meth:`matplotlib.backend_bases.RendererBase.draw_path`

except the first argument is a renderer.

"""

# Get the real renderer, not a PathEffectRenderer.

if isinstance(renderer, PathEffectRenderer):

renderer = renderer._renderer

return renderer.draw_path(gc, tpath, affine, rgbFace)</div></div>

<div class="viewcode-block" id="PathEffectRenderer"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.PathEffectRenderer">[docs]</a>class PathEffectRenderer(RendererBase):

"""

Implements a Renderer which contains another renderer.

This proxy then intercepts draw calls, calling the appropriate

:class:`AbstractPathEffect` draw method.

.. note::

Not all methods have been overridden on this RendererBase subclass.

It may be necessary to add further methods to extend the PathEffects

capabilities further.

"""

def __init__(self, path_effects, renderer):

"""

Parameters

----------

path_effects : iterable of :class:`AbstractPathEffect`

The path effects which this renderer represents.

renderer : :class:`matplotlib.backend_bases.RendererBase` instance

"""

self._path_effects = path_effects

self._renderer = renderer

<div class="viewcode-block" id="PathEffectRenderer.new_gc"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.PathEffectRenderer.new_gc">[docs]</a> def new_gc(self):

# docstring inherited

return self._renderer.new_gc()</div>

<div class="viewcode-block" id="PathEffectRenderer.copy_with_path_effect"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.PathEffectRenderer.copy_with_path_effect">[docs]</a> def copy_with_path_effect(self, path_effects):

return self.__class__(path_effects, self._renderer)</div>

<div class="viewcode-block" id="PathEffectRenderer.draw_path"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.PathEffectRenderer.draw_path">[docs]</a> def draw_path(self, gc, tpath, affine, rgbFace=None):

for path_effect in self._path_effects:

path_effect.draw_path(self._renderer, gc, tpath, affine,

rgbFace)</div>

<div class="viewcode-block" id="PathEffectRenderer.draw_markers"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.PathEffectRenderer.draw_markers">[docs]</a> def draw_markers(

self, gc, marker_path, marker_trans, path, *args, **kwargs):

# We do a little shimmy so that all markers are drawn for each path

# effect in turn. Essentially, we induce recursion (depth 1) which is

# terminated once we have just a single path effect to work with.

if len(self._path_effects) == 1:

# Call the base path effect function - this uses the unoptimised

# approach of calling "draw_path" multiple times.

return RendererBase.draw_markers(self, gc, marker_path,

marker_trans, path, *args,

**kwargs)

renderer = self.copy_with_path_effect([path_effect])

# Recursively call this method, only next time we will only have

# one path effect.

renderer.draw_markers(gc, marker_path, marker_trans, path,

*args, **kwargs)</div>

<div class="viewcode-block" id="PathEffectRenderer.draw_path_collection"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.PathEffectRenderer.draw_path_collection">[docs]</a> def draw_path_collection(self, gc, master_transform, paths, *args,

**kwargs):

# We do a little shimmy so that all paths are drawn for each path

# effect in turn. Essentially, we induce recursion (depth 1) which is

# terminated once we have just a single path effect to work with.

# Call the base path effect function - this uses the unoptimised

# approach of calling "draw_path" multiple times.

return RendererBase.draw_path_collection(self, gc,

master_transform, paths,

*args, **kwargs)

# Recursively call this method, only next time we will only have

# one path effect.

renderer.draw_path_collection(gc, master_transform, paths,

*args, **kwargs)</div>

<div class="viewcode-block" id="PathEffectRenderer.points_to_pixels"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.PathEffectRenderer.points_to_pixels">[docs]</a> def points_to_pixels(self, points):

# docstring inherited

return self._renderer.points_to_pixels(points)</div>

def _draw_text_as_path(self, gc, x, y, s, prop, angle, ismath):

# Implements the naive text drawing as is found in RendererBase.

path, transform = self._get_text_path_transform(x, y, s, prop,

angle, ismath)

color = gc.get_rgb()

gc.set_linewidth(0.0)

self.draw_path(gc, path, transform, rgbFace=color)

def __getattribute__(self, name):

if name in ['_text2path', 'flipy', 'height', 'width']:

return getattr(self._renderer, name)

else:

return object.__getattribute__(self, name)</div>

<div class="viewcode-block" id="Normal"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.Normal">[docs]</a>class Normal(AbstractPathEffect):

"""

The "identity" PathEffect.

The Normal PathEffect's sole purpose is to draw the original artist with

no special path effect.

"""

pass</div>

<div class="viewcode-block" id="Stroke"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.Stroke">[docs]</a>class Stroke(AbstractPathEffect):

"""A line based PathEffect which re-draws a stroke."""

def __init__(self, offset=(0, 0), **kwargs):

"""

The path will be stroked with its gc updated with the given

keyword arguments, i.e., the keyword arguments should be valid

gc parameter values.

"""

super().__init__(offset)

self._gc = kwargs

<div class="viewcode-block" id="Stroke.draw_path"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.Stroke.draw_path">[docs]</a> def draw_path(self, renderer, gc, tpath, affine, rgbFace):

"""

draw the path with updated gc.

"""

# Do not modify the input! Use copy instead.

gc0 = renderer.new_gc()

gc0.copy_properties(gc)

gc0 = self._update_gc(gc0, self._gc)

trans = self._offset_transform(renderer, affine)

renderer.draw_path(gc0, tpath, trans, rgbFace)

gc0.restore()</div></div>

<div class="viewcode-block" id="withStroke"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.withStroke">[docs]</a>class withStroke(Stroke):

"""

Adds a simple :class:`Stroke` and then draws the

original Artist to avoid needing to call :class:`Normal`.

"""

<div class="viewcode-block" id="withStroke.draw_path"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.withStroke.draw_path">[docs]</a> def draw_path(self, renderer, gc, tpath, affine, rgbFace):

Stroke.draw_path(self, renderer, gc, tpath, affine, rgbFace)

renderer.draw_path(gc, tpath, affine, rgbFace)</div></div>

<div class="viewcode-block" id="SimplePatchShadow"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.SimplePatchShadow">[docs]</a>class SimplePatchShadow(AbstractPathEffect):

"""A simple shadow via a filled patch."""

def __init__(self, offset=(2, -2),

shadow_rgbFace=None, alpha=None,

rho=0.3, **kwargs):

"""

Parameters

----------

offset : pair of floats

The offset of the shadow in points.

shadow_rgbFace : color

The shadow color.

alpha : float

The alpha transparency of the created shadow patch.

Default is 0.3.

http://matplotlib.1069221.n5.nabble.com/path-effects-question-td27630.html

rho : float

A scale factor to apply to the rgbFace color if `shadow_rgbFace`

is not specified. Default is 0.3.

**kwargs

Extra keywords are stored and passed through to

:meth:`AbstractPathEffect._update_gc`.

"""

super().__init__(offset)

if shadow_rgbFace is None:

self._shadow_rgbFace = shadow_rgbFace

else:

self._shadow_rgbFace = mcolors.to_rgba(shadow_rgbFace)

if alpha is None:

alpha = 0.3

self._alpha = alpha

self._rho = rho

#: The dictionary of keywords to update the graphics collection with.

self._gc = kwargs

<div class="viewcode-block" id="SimplePatchShadow.draw_path"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.SimplePatchShadow.draw_path">[docs]</a> def draw_path(self, renderer, gc, tpath, affine, rgbFace):

"""

Overrides the standard draw_path to add the shadow offset and

necessary color changes for the shadow.

"""

# IMPORTANT: Do not modify the input - we copy everything instead.

affine0 = self._offset_transform(renderer, affine)

gc0 = renderer.new_gc()

gc0.copy_properties(gc)

if self._shadow_rgbFace is None:

r, g, b = (rgbFace or (1., 1., 1.))[:3]

# Scale the colors by a factor to improve the shadow effect.

shadow_rgbFace = (r * self._rho, g * self._rho, b * self._rho)

else:

shadow_rgbFace = self._shadow_rgbFace

gc0.set_foreground("none")

gc0.set_alpha(self._alpha)

gc0.set_linewidth(0)

renderer.draw_path(gc0, tpath, affine0, shadow_rgbFace)

gc0.restore()</div></div>

<div class="viewcode-block" id="withSimplePatchShadow"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.withSimplePatchShadow">[docs]</a>class withSimplePatchShadow(SimplePatchShadow):

"""

Adds a simple :class:`SimplePatchShadow` and then draws the

original Artist to avoid needing to call :class:`Normal`.

"""

<div class="viewcode-block" id="withSimplePatchShadow.draw_path"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.withSimplePatchShadow.draw_path">[docs]</a> def draw_path(self, renderer, gc, tpath, affine, rgbFace):

SimplePatchShadow.draw_path(self, renderer, gc, tpath, affine, rgbFace)

<div class="viewcode-block" id="SimpleLineShadow"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.SimpleLineShadow">[docs]</a>class SimpleLineShadow(AbstractPathEffect):

"""A simple shadow via a line."""

def __init__(self, offset=(2, -2),

shadow_color='k', alpha=0.3, rho=0.3, **kwargs):

"""

Parameters

----------

offset : pair of floats

The offset to apply to the path, in points.

shadow_color : color

The shadow color. Default is black.

A value of ``None`` takes the original artist's color

with a scale factor of `rho`.

alpha : float

The alpha transparency of the created shadow patch.

Default is 0.3.

rho : float

A scale factor to apply to the rgbFace color if `shadow_rgbFace`

is ``None``. Default is 0.3.

**kwargs

Extra keywords are stored and passed through to

:meth:`AbstractPathEffect._update_gc`.

"""

super().__init__(offset)

if shadow_color is None:

self._shadow_color = shadow_color

else:

self._shadow_color = mcolors.to_rgba(shadow_color)

self._alpha = alpha

self._rho = rho

#: The dictionary of keywords to update the graphics collection with.

self._gc = kwargs

<div class="viewcode-block" id="SimpleLineShadow.draw_path"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.SimpleLineShadow.draw_path">[docs]</a> def draw_path(self, renderer, gc, tpath, affine, rgbFace):

"""

Overrides the standard draw_path to add the shadow offset and

necessary color changes for the shadow.

"""

# IMPORTANT: Do not modify the input - we copy everything instead.

gc0 = renderer.new_gc()

gc0.copy_properties(gc)

if self._shadow_color is None:

r, g, b = (gc0.get_foreground() or (1., 1., 1.))[:3]

# Scale the colors by a factor to improve the shadow effect.

else:

shadow_rgbFace = self._shadow_color

fill_color = None

gc0.set_foreground(shadow_rgbFace)

renderer.draw_path(gc0, tpath, affine0, fill_color)

gc0.restore()</div></div>

<div class="viewcode-block" id="PathPatchEffect"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.PathPatchEffect">[docs]</a>class PathPatchEffect(AbstractPathEffect):

"""

Draws a :class:`~matplotlib.patches.PathPatch` instance whose Path

comes from the original PathEffect artist.

"""

def __init__(self, offset=(0, 0), **kwargs):

"""

Parameters

----------

offset : pair of floats

The offset to apply to the path, in points.

**kwargs

All keyword arguments are passed through to the

:class:`~matplotlib.patches.PathPatch` constructor. The

properties which cannot be overridden are "path", "clip_box"

"transform" and "clip_path".

"""

super().__init__(offset=offset)

self.patch = mpatches.PathPatch([], **kwargs)

<div class="viewcode-block" id="PathPatchEffect.draw_path"><a class="viewcode-back" href="../../api/patheffects_api.html#matplotlib.patheffects.PathPatchEffect.draw_path">[docs]</a> def draw_path(self, renderer, gc, tpath, affine, rgbFace):

affine = self._offset_transform(renderer, affine)

self.patch._path = tpath

self.patch.set_transform(affine)

self.patch.set_clip_box(gc.get_clip_rectangle())

clip_path = gc.get_clip_path()

if clip_path:

self.patch.set_clip_path(*clip_path)

self.patch.draw(renderer)</div></div>

</pre></div>

</div>

</div>

Last updated on Feb 09, 2020.

Created using

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

Doc version v3.1.3-2-g782f6ef56.

</div>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

</footer>

</html>

matplotlib.github.com/_modules/matplotlib/patheffects.html at master · 2236zml/matplotlib.github.com · GitHub

Navigation Menu

Expand file tree

Breadcrumbs

patheffects.html

Latest commit

History

Breadcrumbs

patheffects.html

File metadata and controls

Footer

Footer navigation