matplotlib.patheffects#

Définit des classes pour les effets de chemin. Les effets de chemin sont pris en charge dans Text, Line2Det Patch.

Voir également

Guide des effets de chemin

classe matplotlib.patheffects. AbstractPathEffect ( offset = (0.0, 0.0) ) [source] #

Socles :object

Une classe de base pour les effets de chemin.

Les sous-classes doivent remplacer la draw_pathméthode pour ajouter des fonctionnalités d'effet.

Paramètres :
décalage (float, float), par défaut : (0, 0)

Le décalage (x, y) à appliquer au chemin, mesuré en points.

draw_path ( moteur de rendu , gc , tpath , affine , rgbFace = None ) [source] #

Derived doit remplacer cette méthode. Les arguments sont les mêmes que matplotlib.backend_bases.RendererBase.draw_path() sauf que le premier argument est un moteur de rendu.

classe matplotlib.patheffects. Normal ( décalage = (0.0, 0.0) ) [source] #

Socles :AbstractPathEffect

L'"identité" PathEffect.

Le seul but de Normal PathEffect est de dessiner l'artiste original sans effet de chemin spécial.

Paramètres :
décalage (float, float), par défaut : (0, 0)

Le décalage (x, y) à appliquer au chemin, mesuré en points.

classe matplotlib.patheffects. PathEffectRenderer ( path_effects , renderer ) [source] #

Socles :RendererBase

Implémente un rendu qui contient un autre rendu.

Ce proxy intercepte ensuite les appels draw, en appelant la AbstractPathEffectméthode draw appropriée.

Noter

Toutes les méthodes n'ont pas été remplacées sur cette sous-classe RendererBase. Il peut être nécessaire d'ajouter d'autres méthodes pour étendre davantage les capacités de PathEffects.

Paramètres :
path_effects itérable deAbstractPathEffect

Les effets de chemin représentés par ce moteur de rendu.

sous-classe de moteur de rendumatplotlib.backend_bases.RendererBase
copy_with_path_effect ( path_effects ) [source] #
draw_markers ( gc , marker_path , marker_trans , path , * args , ** kwargs ) [source] #

Dessinez un marqueur à chacun des sommets du chemin (à l'exclusion des points de contrôle).

L'implémentation de base (de secours) effectue plusieurs appels à draw_path. Les backends peuvent souhaiter remplacer cette méthode afin de dessiner le marqueur une seule fois et de le réutiliser plusieurs fois.

Paramètres :
gcGraphicsContextBase

Le contexte graphique.

marqueur_transmatplotlib.transforms.Transform

Une transformation affine appliquée au marqueur.

transmatplotlib.transforms.Transform

Une transformation affine appliquée au chemin.

draw_path ( gc , tpath , affine , rgbFace = None ) [source] #

Dessinez une Pathinstance à l'aide de la transformation affine donnée.

draw_path_collection ( gc , master_transform , paths , * args , ** kwargs ) [source] #

Dessinez une collection de chemins .

Chaque chemin est d'abord transformé par l'entrée correspondante dans all_transforms (une liste de matrices (3, 3)) puis par master_transform . Ils sont ensuite traduits par l'entrée correspondante dans offsets , qui a d'abord été transformée par offset_trans .

facecolors , edgecolors , linewidths , linestyles et antialiased sont des listes qui définissent les propriétés correspondantes.

offset_position n'est plus utilisé maintenant, mais l'argument est conservé pour la compatibilité descendante.

L'implémentation de base (de secours) effectue plusieurs appels à draw_path. Les backends peuvent vouloir remplacer cela afin de rendre chaque ensemble de données de chemin une seule fois, puis référencer ce chemin plusieurs fois avec les différents décalages, couleurs, styles, etc. Les méthodes du générateur _iter_collection_raw_pathset _iter_collectionsont fournies pour aider (et normaliser) la mise en œuvre à travers les back-ends. Il est fortement recommandé d'utiliser ces générateurs, afin que les changements de comportement de draw_path_collectionpuissent être effectués globalement.

classe matplotlib.patheffects. PathPatchEffect ( décalage = (0, 0) , ** kwargs ) [source] #

Socles :AbstractPathEffect

Dessine une PathPatchinstance dont Path provient de l'artiste PathEffect d'origine.

Paramètres :
décalage (float, float), par défaut : (0, 0)

Le décalage (x, y) à appliquer au chemin, en points.

**kwargs

Tous les arguments de mots clés sont transmis au PathPatchconstructeur. Les propriétés qui ne peuvent pas être remplacées sont "path", "clip_box" "transform" et "clip_path".

draw_path ( moteur de rendu , gc , tpath , affine , rgbFace ) [source] #

Derived doit remplacer cette méthode. Les arguments sont les mêmes que matplotlib.backend_bases.RendererBase.draw_path() sauf que le premier argument est un moteur de rendu.

classe matplotlib.patheffects. SimpleLineShadow ( offset = (2, -2) , shadow_color = 'k' , alpha = 0.3 , rho = 0.3 , ** kwargs ) [source] #

Socles :AbstractPathEffect

Une simple ombre via une ligne.

Paramètres :
décalage (float, float), par défaut : (2, -2)

Le décalage (x, y) à appliquer au chemin, en points.

couleur shadow_color , par défaut : 'noir'

La couleur de l'ombre. Une valeur de Noneprend la couleur originale de l'artiste avec un facteur d'échelle de rho .

flottant alpha , par défaut : 0,3

Transparence alpha du patch d'ombre créé.

rho flottant, par défaut : 0,3

Un facteur d'échelle à appliquer à la couleur rgbFace si shadow_color vaut None.

**kwargs

Les mots-clés supplémentaires sont stockés et transmis à AbstractPathEffect._update_gc().

draw_path ( moteur de rendu , gc , tpath , affine , rgbFace ) [source] #

Remplace le draw_path standard pour ajouter le décalage de l'ombre et les changements de couleur nécessaires pour l'ombre.

classe matplotlib.patheffects. SimplePatchShadow ( offset = (2, -2) , shadow_rgbFace = None , alpha = None , rho = 0.3 , ** kwargs ) [source] #

Socles :AbstractPathEffect

Une simple ombre via un patch rempli.

Paramètres :
décalage (float, float), par défaut : (2, -2)

Le décalage (x, y) de l'ombre en points.

shadow_rgbCouleur du visage

La couleur de l'ombre.

flottant alpha , par défaut : 0,3

Transparence alpha du patch d'ombre créé.

rho flottant, par défaut : 0,3

Un facteur d'échelle à appliquer à la couleur rgbFace si shadow_rgbFace n'est pas spécifié.

**kwargs

Les mots-clés supplémentaires sont stockés et transmis à AbstractPathEffect._update_gc().

draw_path ( moteur de rendu , gc , tpath , affine , rgbFace ) [source] #

Remplace le draw_path standard pour ajouter le décalage de l'ombre et les changements de couleur nécessaires pour l'ombre.

classe matplotlib.patheffects. Course ( offset = (0, 0) , ** kwargs ) [source] #

Socles :AbstractPathEffect

Un PathEffect basé sur une ligne qui redessine un trait.

Le chemin sera barré avec son gc mis à jour avec les arguments de mot-clé donnés, c'est-à-dire que les arguments de mot-clé doivent être des valeurs de paramètre gc valides.

draw_path ( moteur de rendu , gc , tpath , affine , rgbFace ) [source] #

Dessinez le chemin avec le gc mis à jour.

classe matplotlib.patheffects. TickedStroke ( offset = (0, 0) , spacing = 10.0 , angle = 45.0 , length = 1.4142135623730951 , ** kwargs ) [source] #

Socles :AbstractPathEffect

Un PathEffect basé sur des lignes qui dessine un chemin avec un style coché.

Ce style de ligne est fréquemment utilisé pour représenter les contraintes d'optimisation. Les coches peuvent être utilisées pour indiquer qu'un côté de la ligne est invalide ou pour représenter une frontière fermée d'un domaine (c'est-à-dire un mur ou le bord d'un tuyau).

L'espacement, la longueur et l'angle des graduations peuvent être contrôlés.

Ce style de ligne est parfois appelé ligne hachurée.

Voir aussi l' exemple de démonstration de contour .

Voir aussi les contours dans l'exemple d'optimisation .

Paramètres :
décalage (float, float), par défaut : (0, 0)

Le décalage (x, y) à appliquer au chemin, en points.

espacement flottant, par défaut : 10,0

L'espacement entre les graduations en points.

angle flottant, par défaut : 45,0

L'angle entre le chemin et la coche en degrés. L'angle est mesuré comme si vous étiez une fourmi marchant le long de la courbe, avec zéro degré pointant directement devant vous, 90 à votre gauche, -90 à votre droite et 180 derrière vous.

longueur flottante, par défaut : 1,414

La longueur de la tique par rapport à l'espacement. Longueur recommandée = 1,414 (sqrt(2)) lorsque angle=45, longueur=1,0 lorsque angle=90 et longueur=2,0 lorsque angle=60.

**kwargs

Les mots-clés supplémentaires sont stockés et transmis à AbstractPathEffect._update_gc().

Exemples

Voir effet de chemin TickedStroke .

draw_path ( moteur de rendu , gc , tpath , affine , rgbFace ) [source] #

Dessinez le chemin avec le gc mis à jour.

classe matplotlib.patheffects. withSimplePatchShadow ( offset = (2, -2) , shadow_rgbFace = None , alpha = None , rho = 0.3 , ** kwargs ) [source] #

Socles :SimplePatchShadow

Un raccourci PathEffect pour appliquer SimplePatchShadowpuis dessiner l'artiste d'origine.

Avec cette classe, vous pouvez utiliser

artist.set_path_effects([path_effects.withSimplePatchShadow()])

comme raccourci pour

artist.set_path_effects([path_effects.SimplePatchShadow(),
                         path_effects.Normal()])
Paramètres :
décalage (float, float), par défaut : (2, -2)

Le décalage (x, y) de l'ombre en points.

shadow_rgbCouleur du visage

La couleur de l'ombre.

flottant alpha , par défaut : 0,3

Transparence alpha du patch d'ombre créé.

rho flottant, par défaut : 0,3

Un facteur d'échelle à appliquer à la couleur rgbFace si shadow_rgbFace n'est pas spécifié.

**kwargs

Les mots-clés supplémentaires sont stockés et transmis à AbstractPathEffect._update_gc().

draw_path ( moteur de rendu , gc , tpath , affine , rgbFace ) [source] #

Remplace le draw_path standard pour ajouter le décalage de l'ombre et les changements de couleur nécessaires pour l'ombre.

classe matplotlib.patheffects. withStroke ( offset = (0, 0) , ** kwargs ) [source] #

Socles :Stroke

Un raccourci PathEffect pour appliquer Strokepuis dessiner l'artiste d'origine.

Avec cette classe, vous pouvez utiliser

artist.set_path_effects([path_effects.withStroke()])

comme raccourci pour

artist.set_path_effects([path_effects.Stroke(),
                         path_effects.Normal()])

Le chemin sera barré avec son gc mis à jour avec les arguments de mot-clé donnés, c'est-à-dire que les arguments de mot-clé doivent être des valeurs de paramètre gc valides.

draw_path ( moteur de rendu , gc , tpath , affine , rgbFace ) [source] #

Dessinez le chemin avec le gc mis à jour.

classe matplotlib.patheffects. withTickedStroke ( offset = (0, 0) , spacing = 10.0 , angle = 45.0 , length = 1.4142135623730951 , ** kwargs ) [source] #

Socles :TickedStroke

Un raccourci PathEffect pour appliquer TickedStrokepuis dessiner l'artiste d'origine.

Avec cette classe, vous pouvez utiliser

artist.set_path_effects([path_effects.withTickedStroke()])

comme raccourci pour

artist.set_path_effects([path_effects.TickedStroke(),
                         path_effects.Normal()])
Paramètres :
décalage (float, float), par défaut : (0, 0)

Le décalage (x, y) à appliquer au chemin, en points.

espacement flottant, par défaut : 10,0

L'espacement entre les graduations en points.

angle flottant, par défaut : 45,0

L'angle entre le chemin et la coche en degrés. L'angle est mesuré comme si vous étiez une fourmi marchant le long de la courbe, avec zéro degré pointant directement devant vous, 90 à votre gauche, -90 à votre droite et 180 derrière vous.

longueur flottante, par défaut : 1,414

La longueur de la tique par rapport à l'espacement. Longueur recommandée = 1,414 (sqrt(2)) lorsque angle=45, longueur=1,0 lorsque angle=90 et longueur=2,0 lorsque angle=60.

**kwargs

Les mots-clés supplémentaires sont stockés et transmis à AbstractPathEffect._update_gc().

Exemples

Voir effet de chemin TickedStroke .

draw_path ( moteur de rendu , gc , tpath , affine , rgbFace ) [source] #

Dessinez le chemin avec le gc mis à jour.