flag_block

sofia_redux.scan.custom.hawc_plus.integration.hawc_integration_numba_functions.flag_block(from_frame, to_frame, frame_valid, sample_flags, jump_flag, channel)[source]

Flag all samples within a block for a given channel with a jump flag.

Parameters:
from_frameint

The starting frame from which to begin jump correction.

to_frameint

The end frame (non-inclusive) at which to conclude jump correction.

frame_validnumpy.ndarray (bool)

A boolean mask of shape (n_frames,) where False excludes a frame from any processing.

sample_flagsnumpy.ndarray (int)

The frame data sample flags. Typically non-zero samples will be excluded from processing. However, those samples not flagged with only exclude_sample_flag will be included.

jump_flagint

The integer flag identifier with which to flag samples if the jump block length to which they belong is less than min_jump_level_frames and cannot be levelled.

channelint

The channel to process.

Returns:
None