torchsig.signals.signal_types.DatasetSignal

class torchsig.signals.signal_types.DatasetSignal(data: np.ndarray = array([], dtype=float64), signals: List[Signal] | Signal | List[SignalMetadata] | SignalMetadata | List[Dict[str, Any]] = None, dataset_metadata: DatasetMetadata = None)[source]

Bases: object

DatasetSignal class. Represents a signal within a dataset with metadata.

data

The IQ data of the signal.

Type:

np.ndarray

metadata

The metadata associated with the signal.

Type:

List[SignalMetadata]

Parameters:

  • data (np.ndarray, optional) – The IQ data for the signal. Defaults to np.array([]).

  • signals (List[Signal] | Signal | List[SignalMetadata] | SignalMetadata | List[Dict[str, Any]], optional) – The list of signals or metadata objects associated with the dataset signal.

  • dataset_metadata (DatasetMetadata, optional) – The dataset metadata. Defaults to None.

Methods

verify

Verifies data and metadata are valid.
__init__(data: np.ndarray = array([], dtype=float64), signals: List[Signal] | Signal | List[SignalMetadata] | SignalMetadata | List[Dict[str, Any]] = None, dataset_metadata: DatasetMetadata = None)[source]
verify()[source]

Verifies data and metadata are valid.

Raises:

ValueError – Data or metadata is invalid.

__repr__()[source]

Return repr(self).