sigkit.core package

Submodules

sigkit.core.base module

Abstract base classes and common exceptions for SigKit.

exception sigkit.core.base.SigKitError[source]

Bases: Exception

Base exception for Sigkit-specific errors.

class sigkit.core.base.Signal(samples: ~numpy.ndarray = <factory>, sample_rate: float = 1.0, carrier_frequency: float = 0.0)[source]

Bases: object

A container for a complex waveform.

Parameters:

  • samples – ndarray of shape (N) containing complex64 values, defaults to 4096.

  • sample_rate – in Hz

  • carrier_frequency – in Hz.

carrier_frequency: float = 0.0
sample_rate: float = 1.0
samples: ndarray
to_baseband() → Signal[source]

Convert the Signal to baseband by removing the carrier frequency.

If the carrier frequency is 0, the method returns.

to_tensor() → Tensor[source]

Convert the samples parameter to a PyTorch Tensor.

Convert into a complex64 tensor of shape (N,), Note that for our training pipeline, N should be 4096.