torchsig.transforms.target_transforms.FamilyIndex¶

class torchsig.transforms.target_transforms.FamilyIndex(class_family_dict: Dict[str, str] | None = {'1024qam': 'qam', '128qam_cross': 'qam', '16ask': 'ask', '16fsk': 'fsk', '16gfsk': 'fsk', '16gmsk': 'fsk', '16msk': 'fsk', '16psk': 'psk', '16qam': 'qam', '256qam': 'qam', '2fsk': 'fsk', '2gfsk': 'fsk', '2gmsk': 'fsk', '2msk': 'fsk', '32ask': 'ask', '32psk': 'psk', '32qam': 'qam', '32qam_cross': 'qam', '4ask': 'ask', '4fsk': 'fsk', '4gfsk': 'fsk', '4gmsk': 'fsk', '4msk': 'fsk', '512qam_cross': 'qam', '64ask': 'ask', '64psk': 'psk', '64qam': 'qam', '8ask': 'ask', '8fsk': 'fsk', '8gfsk': 'fsk', '8gmsk': 'fsk', '8msk': 'fsk', '8psk': 'psk', 'am-dsb': 'am', 'am-dsb-sc': 'am', 'am-lsb': 'am', 'am-usb': 'am', 'bpsk': 'psk', 'chirpss': 'chirp', 'fm': 'fm', 'lfm_data': 'chirp', 'lfm_radar': 'chirp', 'ofdm-1024': 'ofdm', 'ofdm-1200': 'ofdm', 'ofdm-128': 'ofdm', 'ofdm-180': 'ofdm', 'ofdm-2048': 'ofdm', 'ofdm-256': 'ofdm', 'ofdm-300': 'ofdm', 'ofdm-512': 'ofdm', 'ofdm-600': 'ofdm', 'ofdm-64': 'ofdm', 'ofdm-72': 'ofdm', 'ofdm-900': 'ofdm', 'ook': 'ook', 'qpsk': 'psk', 'tone': 'tone'}, family_list: List[str] | None = None, **kwargs)[source]¶

Bases: TargetTransform

Adds a family_index to a signal’s metadata based on it’s class_name

class_family_dict¶

Class name to Family name dict (keys=class name, values= family name). Defaults to TorchSigSignalLists.family_dict.

Type:: Optional[Dict[str, str]], optional

family_list¶

Family list to index by. Defaults to alphabetical list of class_family_dict family names.

Type:: Optional[List[str]], optional

Methods

`add_parent`	Add parent Seedable object and set up RNGs accordingly
`get_distribution`
`get_second_seed`	Gets second seed, usually used to seed both torch and numpy generators with slightly different seeds
`seed`	Seed number generators with given seed.
`setup_rngs`	Initialize torch and numpy number generators, and update its children.
`update`	Update bookeeping for signals
`update_from_parent`	Update numpy and torch number generators with parent seed

__init__(class_family_dict: Dict[str, str] | None = {'1024qam': 'qam', '128qam_cross': 'qam', '16ask': 'ask', '16fsk': 'fsk', '16gfsk': 'fsk', '16gmsk': 'fsk', '16msk': 'fsk', '16psk': 'psk', '16qam': 'qam', '256qam': 'qam', '2fsk': 'fsk', '2gfsk': 'fsk', '2gmsk': 'fsk', '2msk': 'fsk', '32ask': 'ask', '32psk': 'psk', '32qam': 'qam', '32qam_cross': 'qam', '4ask': 'ask', '4fsk': 'fsk', '4gfsk': 'fsk', '4gmsk': 'fsk', '4msk': 'fsk', '512qam_cross': 'qam', '64ask': 'ask', '64psk': 'psk', '64qam': 'qam', '8ask': 'ask', '8fsk': 'fsk', '8gfsk': 'fsk', '8gmsk': 'fsk', '8msk': 'fsk', '8psk': 'psk', 'am-dsb': 'am', 'am-dsb-sc': 'am', 'am-lsb': 'am', 'am-usb': 'am', 'bpsk': 'psk', 'chirpss': 'chirp', 'fm': 'fm', 'lfm_data': 'chirp', 'lfm_radar': 'chirp', 'ofdm-1024': 'ofdm', 'ofdm-1200': 'ofdm', 'ofdm-128': 'ofdm', 'ofdm-180': 'ofdm', 'ofdm-2048': 'ofdm', 'ofdm-256': 'ofdm', 'ofdm-300': 'ofdm', 'ofdm-512': 'ofdm', 'ofdm-600': 'ofdm', 'ofdm-64': 'ofdm', 'ofdm-72': 'ofdm', 'ofdm-900': 'ofdm', 'ook': 'ook', 'qpsk': 'psk', 'tone': 'tone'}, family_list: List[str] | None = None, **kwargs)[source]¶: Transform initialization as Seedable.

__call__(metadatas: List[Dict[str, Any]], enable_verify=True) → List[Any] | Dict[str, Any]¶

Applies the target transform to a list of signal metadata.

Parameters:

metadatas (List[Dict[str, Any]]) – The list of metadata dictionaries to transform.
enable_verify (bool, optional) – Whether to verify metadata before transforming. Defaults to True.

Returns:

The transformed list of metadata dictionaries.

Return type:

List[Dict[str, Any]]

__repr__() → str¶

Transform string representation. Should be able to recreate class from this string.

Returns:: Transform representation.
Return type:: str

__str__() → str¶: Return str(self).

add_parent(parent) → None¶: Add parent Seedable object and set up RNGs accordingly

get_second_seed(seed: int) → int¶

Gets second seed, usually used to seed both torch and numpy generators with slightly different seeds

Parameters:: seed (int) – Seed to use.
Returns:: New seed.
Return type:: int

seed(seed: int) → None¶

Seed number generators with given seed.

Parameters:: seed (int) – Seed to use.

setup_rngs() → None¶: Initialize torch and numpy number generators, and update its children.

update(signal: Signal | DatasetSignal) → None¶

Update bookeeping for signals

Parameters:: signal (Signal | DatasetSignal) – signal to update metadata.
Raises:: NotImplementedError – Inherited classes must override this method.

update_from_parent() → None¶: Update numpy and torch number generators with parent seed