anndict.AdataDict.index_bool

anndict.AdataDict.index_bool#

AdataDict.index_bool(index_dict, inplace=True)[source]#

Index the AdataDict by a dictionary of indices.

Parameters:
index_dict dict

A dict with the same structure as the AdataDict, but values are boolean.

inplace bool (default: True)

If True, modifies the AdataDict in-place. Otherwise, returns a new AdataDict.

Return type:

None | AdataDict

Returns:

  • None and modifies the AdataDict in-place if inplace=True.

  • New AdataDict object with the specified indices if inplace=False.