club

Club shape.

Classes

Club(dataset)

Class for the club shape.

class data_morph.shapes.points.club.Club(dataset: Dataset)

Bases: PointCollection

Class for the club shape.

This shape is generated using the panda dataset.

Parameters:

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

distance(x: Number, y: Number) → float

Calculate the minimum distance from the points of this shape to a point (x, y).

Parameters:

• x (numbers.Number) – Coordinates of a point in 2D space.

• y (numbers.Number) – Coordinates of a point in 2D space.

Returns:

The minimum distance from the points of this shape to the point (x, y).

Return type:

float

classmethod get_name() → str

Get the name of the shape.

Returns:

The name of the shape.

Return type:

str

name: str | None = None

The display name for the shape, if the lowercased class name is not desired.

plot(ax: Axes | None = None) → Axes

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

points

An array of (x, y) values representing an arrangement of points.

Type:

numpy.ndarray