graphicle.data.MaskGroup.recursive_drop(key: str = 'latent', inplace: bool = False) MaskGroup[source]

Removes masks indexed by key at all levels of nesting.

New in version 0.2.8.

Parameters:
key : str

String key to be dropped from the MaskGroup. Default is "latent".

inplace : bool

If True, will mutate the MaskGroup instance inplace. If False, will first copy the instance, leaving the original object unchanged. Default is False.

Returns:

MaskGroup object with key recursively removed.

Return type:

MaskGroup


Last update: Jun 27, 2025