torchsig.transforms.dataset_transforms.PassbandRippleDatasetTransform

class torchsig.transforms.dataset_transforms.PassbandRippleDatasetTransform(passband_ripple_db: float = 1.0, cutoff: float = 0.25, order: int = 5, numtaps: int = 63, **kwargs)[source]

Bases: DatasetTransform

Applies a model of wideband analog filter passband ripple for DatasetSignals.

passband_ripple_db

Desired passband ripple in dB. Default 1.0 dB.

Type:

float

cutoff

Passband cutoff frequency relative to Fs=1.0 sample rate. Default 0.25.

Type:

float

order

Desired filter order, which drives number of ripples present within the passband. Default 5.

Type:

int

numtaps

Number of taps in filter. Default 63.

Type:

int

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__(passband_ripple_db: float = 1.0, cutoff: float = 0.25, order: int = 5, numtaps: int = 63, **kwargs)[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