visbrain.objects.RoiObj.where_is

RoiObj.where_is(patterns, df=None, union=True, columns=None, exact=False)[source][source]

Find a list of string patterns in a DataFrame.

Parameters:
patterns : list

List of string patterns to search.

df : pd.DataFrame | None

The DataFrame to use. If None, the DataFrame of the ROI are going to be used by default.

union : bool | True

Take either the union of matching patterns (True) or the intersection (False).

columns : list | None

List of specific column names to search in. If None, this method inspect every columns in the DataFrame.

exact : bool | False

Specify if the pattern to search have to be exact matching.

Returns:
idx : list

List of index that match with the list of patterns.