flag_outside

sofia_redux.scan.source_models.source_numba_functions.flag_outside(sample_coordinates, valid_frames, channel_indices, sample_flags, skip_flag, map_range)[source]

Flag samples outside of the allowed mapping range.

Frames with no channels inside the allowable range will be flagged as invalid.

Parameters:
sample_coordinatesnumpy.ndarray (float)

An array of shape (2, n_frames, n_channels) containing the (x, y) coordinates of each sample measurement.

valid_framesnumpy.ndarray (bool)

A boolean mask of shape (n_frames,). Frames flagged as False will not be included in any calculations.

channel_indicesnumpy.ndarray (int)

The indices mapping n_channels onto all_channels.

sample_flagsnumpy.ndarray (int)

The sample flags to update. An array of shape (n_frames, all_channels).

skip_flagint

The integer flag to mark a sample as SKIP (outside mapping range).

map_rangenumpy.ndarray (float)

An array of shape (2, 2) containing the [[min(x), max(x)], [min(y), max(y)]] allowable map range.

Returns:
None