torchsig.transforms.dataset_transforms.RandomMagRescale

class torchsig.transforms.dataset_transforms.RandomMagRescale(start=(0.0, 0.9), scale=(-4.0, 4.0), **kwargs)[source]

Bases: DatasetTransform

Randomly apply a magnitude rescaling, emulating a change in a receiver’s gain control.

start

start sets the time when the rescaling kicks in * If int or float, start is fixed at the value provided. * If list, start is any element in the list. * If tuple, start is in range of (tuple[0], tuple[1]).

Type:

int, float, list, tuple

start_distribution (Callable[[], float]): Random draw from start distribution. scale (int, float, list, tuple):

scale sets the magnitude of the rescale * If int or float, scale is fixed at the value provided. * If list, scale is any element in the list. * If tuple, scale is in range of (tuple[0], tuple[1]).

scale_distribution (Callable[[], float]): Random draw from scale distribution.

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

Updates bookkeeping to transforms in DatasetSignal's SignalMetadata and checks signal valididty.

update_from_parent

Update numpy and torch number generators with parent seed

__init__(start=(0.0, 0.9), scale=(-4.0, 4.0), **kwargs) None[source]

Transform initialization as Seedable.

__call__(signal: DatasetSignal) DatasetSignal[source]

Performs transforms.

Parameters:

signal (DatasetSignal) – DatasetSignal to be transformed.

Raises:

NotImplementedError – Inherited classes must override this method.

Returns:

Transformed DatasetSignal.

Return type:

DatasetSignal

__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: DatasetSignal) None

Updates bookkeeping to transforms in DatasetSignal’s SignalMetadata and checks signal valididty. Inherited classes should always call self.update() after performing transform operation (inside __call__).

Parameters:

signal (DatasetSignal) – transformed DatasetSignal.

update_from_parent() None

Update numpy and torch number generators with parent seed