mask_reduced_intensity#

ReducedIntensityGenerator1D.mask_reduced_intensity(mask_pattern, inplace=True, *args, **kwargs)[source]#

Masks the reduced intensity signal by multiplying it with a pattern consisting of only zeroes and ones. This can be used to mask the central beam.

Parameters:

mask_pattern (np.array of 0s and 1s) – A numpy array line profile of the same resolution as the radial profile. Must consist only of zeroes and ones. Ones are kept while zeroes are set to zero.
mask_threshold (int or float) – An integer or float threshold. Any pixel in the mask_pattern with lower intensity is kept, any with higher or equal is set to zero.
inplace (bool) – If True (default), this signal is overwritten. Otherwise, returns a new signal.
*args – Arguments to be passed to map().
**kwargs – Keyword arguments to be passed to map().