torchsig.signals.signal_utils.check_signal_class

torchsig.signals.signal_utils.check_signal_class(name: str, possible_names: list[str]) → bool[source]

Check if the provided signal name matches any of the possible signal names.

This function performs a substring match against each possible name.

Parameters:

  • name – The signal name to check.

  • possible_names – A list of possible signal names to compare against.

Returns:

True if the signal name matches any of the possible names, otherwise False.

Return type:

bool

Examples

>>> check_signal_class("4fsk", ["fsk", "msk"])
True
>>> check_signal_class("am-dsb", ["am-"])
True
>>> check_signal_class("ofdm-64", ["ofdm"])
True