lines

Shapes made up of lines.

class data_morph.shapes.lines.Diamond(dataset: Dataset)

Bases: LineCollection

Class for the diamond shape.

Parameters:

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

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

Calculate the minimum distance from the lines 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 lines of this shape to the point (x, y).

Return type:

float

Notes

Implementation based on this Stack Overflow answer.

classmethod get_name() → str

Get the name of the shape.

Returns:

The name of the shape.

Return type:

str

lines

An iterable of two (x, y) pairs representing the endpoints of a line.

Type:

Iterable[Iterable[numbers.Number]]

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

class data_morph.shapes.lines.HighLines(dataset: Dataset)

Bases: LineCollection

Class for the high lines 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 lines 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 lines of this shape to the point (x, y).

Return type:

float

Notes

Implementation based on this Stack Overflow answer.

classmethod get_name() → str

Get the name of the shape.

Returns:

The name of the shape.

Return type:

str

lines

An iterable of two (x, y) pairs representing the endpoints of a line.

Type:

Iterable[Iterable[numbers.Number]]

name: str | None = 'high_lines'

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

class data_morph.shapes.lines.HorizontalLines(dataset: Dataset)

Bases: LineCollection

Class for the horizontal lines 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 lines 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 lines of this shape to the point (x, y).

Return type:

float

Notes

Implementation based on this Stack Overflow answer.

classmethod get_name() → str

Get the name of the shape.

Returns:

The name of the shape.

Return type:

str

lines

An iterable of two (x, y) pairs representing the endpoints of a line.

Type:

Iterable[Iterable[numbers.Number]]

name: str | None = 'h_lines'

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

class data_morph.shapes.lines.Rectangle(dataset: Dataset)

Bases: LineCollection

Class for the rectangle shape.

Parameters:

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

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

Calculate the minimum distance from the lines 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 lines of this shape to the point (x, y).

Return type:

float

Notes

Implementation based on this Stack Overflow answer.

classmethod get_name() → str

Get the name of the shape.

Returns:

The name of the shape.

Return type:

str

lines

An iterable of two (x, y) pairs representing the endpoints of a line.

Type:

Iterable[Iterable[numbers.Number]]

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

class data_morph.shapes.lines.SlantDownLines(dataset: Dataset)

Bases: LineCollection

Class for the slant down lines 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 lines 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 lines of this shape to the point (x, y).

Return type:

float

Notes

Implementation based on this Stack Overflow answer.

classmethod get_name() → str

Get the name of the shape.

Returns:

The name of the shape.

Return type:

str

lines

An iterable of two (x, y) pairs representing the endpoints of a line.

Type:

Iterable[Iterable[numbers.Number]]

name: str | None = 'slant_down'

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

class data_morph.shapes.lines.SlantUpLines(dataset: Dataset)

Bases: LineCollection

Class for the slant up lines 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 lines 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 lines of this shape to the point (x, y).

Return type:

float

Notes

Implementation based on this Stack Overflow answer.

classmethod get_name() → str

Get the name of the shape.

Returns:

The name of the shape.

Return type:

str

lines

An iterable of two (x, y) pairs representing the endpoints of a line.

Type:

Iterable[Iterable[numbers.Number]]

name: str | None = 'slant_up'

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

class data_morph.shapes.lines.Star(dataset: Dataset)

Bases: LineCollection

Class for the star shape.

Parameters:

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

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

Calculate the minimum distance from the lines 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 lines of this shape to the point (x, y).

Return type:

float

Notes

Implementation based on this Stack Overflow answer.

classmethod get_name() → str

Get the name of the shape.

Returns:

The name of the shape.

Return type:

str

lines

An iterable of two (x, y) pairs representing the endpoints of a line.

Type:

Iterable[Iterable[numbers.Number]]

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

class data_morph.shapes.lines.VerticalLines(dataset: Dataset)

Bases: LineCollection

Class for the vertical lines 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 lines 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 lines of this shape to the point (x, y).

Return type:

float

Notes

Implementation based on this Stack Overflow answer.

classmethod get_name() → str

Get the name of the shape.

Returns:

The name of the shape.

Return type:

str

lines

An iterable of two (x, y) pairs representing the endpoints of a line.

Type:

Iterable[Iterable[numbers.Number]]

name: str | None = 'v_lines'

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

class data_morph.shapes.lines.WideLines(dataset: Dataset)

Bases: LineCollection

Class for the wide lines 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 lines 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 lines of this shape to the point (x, y).

Return type:

float

Notes

Implementation based on this Stack Overflow answer.

classmethod get_name() → str

Get the name of the shape.

Returns:

The name of the shape.

Return type:

str

lines

An iterable of two (x, y) pairs representing the endpoints of a line.

Type:

Iterable[Iterable[numbers.Number]]

name: str | None = 'wide_lines'

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

class data_morph.shapes.lines.XLines(dataset: Dataset)

Bases: LineCollection

Class for the X shape consisting of two crossing, perpendicular lines.

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 lines 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 lines of this shape to the point (x, y).

Return type:

float

Notes

Implementation based on this Stack Overflow answer.

classmethod get_name() → str

Get the name of the shape.

Returns:

The name of the shape.

Return type:

str

lines

An iterable of two (x, y) pairs representing the endpoints of a line.

Type:

Iterable[Iterable[numbers.Number]]

name: str | None = 'x'

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

Modules

diamond	Diamond shape.
high_lines	High lines shape.
horizontal_lines	Horizontal lines shape.
rectangle	Rectangle shape.
slant_down	Slant down lines shape.
slant_up	Slant up lines shape.
star	Star shape.
vertical_lines	Vertical lines shape.
wide_lines	Wide lines shape.
x_lines	X lines shape.