torchsig.transforms.signal_transforms.CarrierPhaseOffsetSignalTransform¶

class torchsig.transforms.signal_transforms.CarrierPhaseOffsetSignalTransform(phase_offset_range: Tuple[float, float] = (0, 6.283185307179586), **kwargs)[source]¶

Bases: SignalTransform

SignalTransform that applies a randomized carrier phase offset to Signal IQ data.

The randomized phase offset is of the form exp(j * phi) where phi is in the range of 0 to 2pi radians. Real world effects such as time delays as a signal transits the air and others can cause such randomized phase offsets.

The transform does not usually require any arguments due to its simplicity. It is generally unrealistic to have a randomized phase offset of a range less than 0 to 2pi.

phase_offset_range¶

Range bounds for phase offset (radians).

Type:: Tuple[float, float]

phase_offset_distribution¶

Random draw from phase offset distribution.

Type:: Callable[[], float]

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 Signal's SignalMetadata and checks signal valididty.
`update_from_parent`	Update numpy and torch number generators with parent seed

__init__(phase_offset_range: Tuple[float, float] = (0, 6.283185307179586), **kwargs)[source]¶: Transform initialization as Seedable.

__call__(signal: Signal) → Signal[source]¶

Performs transforms.

Parameters:: signal (Signal) – Signal to be transformed.
Raises:: NotImplementedError – Inherited classes must override this method.
Returns:: Transformed Signal.
Return type:: Signal

__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) → None¶

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

Parameters:: signal (Signal) – Transformed signal.

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