merge_masks

pypillometry.merge_masks()

Pipeline step for merge_masks() (d | pp.merge_masks(...)).

Merge masks of all variables into a single joint mask.

This function creates a joint mask by taking the logical OR of all individual masks (under the default mask policy, see get_mask()), then applies this joint mask to all variables (the newly masked samples get the "user" layer).

Parameters:

inplacebool or None, optional

if True, make change in-place and return the object; if False, make and return copy before making changes; if None, use the object-level setting (specified in the constructor)

Returns:

EyeData

the object with merged masks (self or a copy, depending on inplace)