torchsig.transforms.base_transforms.Transform

class torchsig.transforms.base_transforms.Transform(required_metadata: list[str] = [], **kwargs)

Bases: ABC, Seedable

Transform abstract class.

This is the base class for all transforms in TorchSig. All transforms should inherit from this class and implement the required methods.

Methods

add_parent	Add parent Seedable object and set up RNGs accordingly.
get_distribution	Create distribution function with proper seeding.
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_from_parent	Update numpy and torch number generators with parent seed.

__init__(required_metadata: list[str] = [], **kwargs)

Transform initialization as Seedable.

Parameters:

• required_metadata – List of metadata fields required for the transform to be applied.

• **kwargs – Additional keyword arguments passed to the parent class.

__call__(signal)

Validate signal, performs transform, update bookeeping.

Parameters:

signal – Signal to be transformed.

Raises:

NotImplementedError – Inherited classes must override this method.

Returns:

Transformed Signal.

__str__() → str

String representation of the transform.

Returns:

String representation of the transform.

__repr__() → str

Transform string representation.

Should be able to recreate class from this string.

Returns:

Transform representation.

add_parent(parent: Seedable, register: bool = True) → None

Add parent Seedable object and set up RNGs accordingly.

Parameters:

• parent – Parent Seedable object to add.

• register – If True (default), add self to parent.children so that future seed propagation reaches this object. Pass False for transient objects (e.g. per-sample Signal instances) that only need the parent link for metadata/RNG access during their lifetime but must not accumulate in the parent’s child list, which would otherwise cause unbounded memory growth.

get_distribution(params: list | tuple | float, scaling: str = 'linear') → Distribution

Create distribution function with proper seeding.

Parameters:

• params – Parameters for distribution.

• scaling – Scaling param for distribution. Defaults to ‘linear’.

Returns:

Distribution function, seeded.

Return type:

Distribution

get_second_seed(seed: int) → int

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

Parameters:

seed – Seed to use.

Returns:

New seed.

seed(seed: int) → None

Seed number generators with given seed.

Parameters:

seed – Seed to use.

setup_rngs() → None

Initialize torch and numpy number generators, and update its children.

update_from_parent() → None

Update numpy and torch number generators with parent seed.