Source code for abm_initialization_collection.sample.exclude_selected_ids

import pandas as pd


def exclude_selected_ids(samples: pd.DataFrame, exclude: list[int]) -> pd.DataFrame:
    """
    Filters samples to exclude given ids.

    Parameters
    ----------
    samples
        Sample cell ids and coordinates.
    exclude
        List of ids to exclude.

    Returns
    -------
    :
        Samples without excluded ids.
    """

    samples = samples[~samples.id.isin(exclude)]
    return samples.reset_index(drop=True)