matplotlib.patches.Annulus

class matplotlib.patches.Annulus(xy, r, width, angle=0.0, **kwargs)[source]

Bases: matplotlib.patches.Patch

An elliptical annulus.

Parameters
xy(float, float)

xy coordinates of annulus centre.

rfloat or (float, float)

The radius, or semi-axes:

  • If float: radius of the outer circle.

  • If two floats: semi-major and -minor axes of outer ellipse.

widthfloat

Width (thickness) of the annular ring. The width is measured inward from the outer ellipse so that for the inner ellipse the semi-axes are given by r - width. width must be less than or equal to the semi-minor axis.

anglefloat, default: 0

Rotation angle in degrees (anti-clockwise from the positive x-axis). Ignored for circular annuli (i.e., if r is a scalar).

**kwargs

Keyword arguments control the Patch properties:

Property

Description

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array

alpha

unknown

animated

bool

antialiased or aa

bool or None

capstyle

CapStyle or {'butt', 'projecting', 'round'}

clip_box

Bbox

clip_on

bool

clip_path

Patch or (Path, Transform) or None

color

color

edgecolor or ec

color or None

facecolor or fc

color or None

figure

Figure

fill

bool

gid

str

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle or {'miter', 'round', 'bevel'}

label

object

linestyle or ls

{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

linewidth or lw

float or None

mouseover

bool

path_effects

AbstractPathEffect

picker

None or bool or float or callable

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

transform

Transform

url

str

visible

bool

zorder

float

property angle

Return the angle of the annulus.

property center

Return the center of the annulus.

get_angle()[source]

Return the angle of the annulus.

get_center()[source]

Return the center of the annulus.

get_path()[source]

Return the path of this patch.

get_radii()[source]

Return the semi-major and semi-minor radii of the annulus.

get_width()[source]

Return the width (thickness) of the annulus ring.

property radii

Return the semi-major and semi-minor radii of the annulus.

set(*, agg_filter=<UNSET>, alpha=<UNSET>, angle=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, capstyle=<UNSET>, center=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, radii=<UNSET>, rasterized=<UNSET>, semimajor=<UNSET>, semiminor=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]

Set multiple properties at once.

Supported properties are

Property

Description

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array

alpha

scalar or None

angle

float

animated

bool

antialiased or aa

bool or None

capstyle

CapStyle or {'butt', 'projecting', 'round'}

center

(float, float)

clip_box

Bbox

clip_on

bool

clip_path

Patch or (Path, Transform) or None

color

color

edgecolor or ec

color or None

facecolor or fc

color or None

figure

Figure

fill

bool

gid

str

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle or {'miter', 'round', 'bevel'}

label

object

linestyle or ls

{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

linewidth or lw

float or None

mouseover

bool

path_effects

AbstractPathEffect

picker

None or bool or float or callable

radii

float or (float, float)

rasterized

bool

semimajor

float

semiminor

float

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

transform

Transform

url

str

visible

bool

width

float

zorder

float

set_angle(angle)[source]

Set the tilt angle of the annulus.

Parameters
anglefloat
set_center(xy)[source]

Set the center of the annulus.

Parameters
xy(float, float)
set_radii(r)[source]

Set the semi-major (a) and semi-minor radii (b) of the annulus.

Parameters
rfloat or (float, float)

The radius, or semi-axes:

  • If float: radius of the outer circle.

  • If two floats: semi-major and -minor axes of outer ellipse.

set_semimajor(a)[source]

Set the semi-major axis a of the annulus.

Parameters
afloat
set_semiminor(b)[source]

Set the semi-minor axis b of the annulus.

Parameters
bfloat
set_width(width)[source]

Set the width (thickness) of the annulus ring.

The width is measured inwards from the outer ellipse.

Parameters
widthfloat
property width

Return the width (thickness) of the annulus ring.