gw.transforms.waveform_transforms.create_mask_based_on_frequency_update

gw.transforms.waveform_transforms.create_mask_based_on_frequency_update(
    sample_frequencies,
    detectors,
    minimum_frequency=None,
    maximum_frequency=None,
)

Creates a mask for each detector containing True for sample_frequencies not affected by the frequency updates for minimum and maximum frequencies.

Parameters

Name	Type	Description	Default
sample_frequencies	np.array	Frequency values for which we want to create a mask. Assumed to be the same for all detectors.	required
detectors	list[str]	List of detector names.	required
minimum_frequency	Optional[float | dict[str, float]]	Update of f_min. If a float, the same value will be used for all detectors.	None
maximum_frequency	Optional[float | dict[str, float]]	Update of f_max. If a float, the same value will be used for all detectors.	None

Returns

Name	Type	Description
frequency_masks	dict	Dictionary providing a boolean mask for the sample frequencies of each detector based on provided frequency updates. True for values to keep, False for values to mask.