Source code for abm_initialization_collection.sample.include_selected_ids

import pandas as pd


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

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

    Returns
    -------
    :
        Samples with included ids.
    """

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