Rings#

class data_morph.shapes.circles.Rings(dataset: Dataset, num_rings: int = 4)[source]#

Bases: Shape

Class representing rings comprising multiple concentric circles.

../_images/data_morph-shapes-circles-Rings-1.png

This shape is generated using the panda dataset.#

Parameters:
  • dataset (Dataset) – The starting dataset to morph into other shapes.

  • num_rings (int, default 4) – The number of rings to include. Must be greater than 1.

See also

Circle

The individual rings are represented as circles.

circles: list[Circle]#

The individual rings represented by Circle objects.

Type:

list[Circle]

distance(x: Number, y: Number) float[source]#

Calculate the minimum absolute distance between any of this shape’s circles’ edges and a point (x, y).

Parameters:
Returns:

The minimum absolute distance between any of this shape’s circles’ edges and the point (x, y).

Return type:

float

See also

Circle.distance

Rings consists of multiple circles, so we use the minimum distance to one of the circles.

plot(ax: Axes = None) Axes[source]#

Plot the shape.

Parameters:

ax (matplotlib.axes.Axes, optional) – An optional Axes object to plot on.

Returns:

The Axes object containing the plot.

Return type:

matplotlib.axes.Axes