Source code for data_morph.shapes.lines.diamond

"""Diamond shape."""

from ...data.dataset import Dataset
from ..bases.line_collection import LineCollection




class Diamond(LineCollection):
    """
    Class for the diamond shape.

    .. plot::
       :scale: 75
       :caption:
            This shape is generated using the panda dataset.

        from data_morph.data.loader import DataLoader
        from data_morph.plotting.diagnostics import plot_shape_on_dataset
        from data_morph.shapes.lines import Diamond

        dataset = DataLoader.load_dataset('panda')
        shape = Diamond(dataset)
        plot_shape_on_dataset(dataset, shape, show_bounds=False, alpha=0.25)

    Parameters
    ----------
    dataset : Dataset
        The starting dataset to morph into other shapes.
    """

    def __init__(self, dataset: Dataset) -> None:
        xmin, xmax = dataset.data.x.quantile([0.05, 0.95])
        ymin, ymax = dataset.data.y.quantile([0.05, 0.95])

        xmid = (xmax + xmin) / 2
        ymid = (ymax + ymin) / 2

        super().__init__(
            [[xmin, ymid], [xmid, ymax]],
            [[xmid, ymax], [xmax, ymid]],
            [[xmax, ymid], [xmid, ymin]],
            [[xmid, ymin], [xmin, ymid]],
        )