CreateSignalField

class ansys.sound.core.signal_utilities.CreateSignalField(data=array([], dtype=float64), sampling_frequency=44100.0, unit='Pa')

Create a PyAnsys Sound field containing a time-domain signal.

This class creates a DPF field from a series of time-domain - typically acoustic - signal samples.

See also

CreateSignalFieldsContainer

Examples

Create a PyAnsys Sound field containing a time-domain signal from signal data.

>>> from ansys.sound.core.signal_utilities import CreateSignalField
>>> create_signal_field = CreateSignalField(
...     data=my_signal_data,
...     sampling_frequency=44100.0,
...     unit="Pa",
... )
>>> create_signal_field.process()
>>> signal_as_a_field = create_signal_field.get_output()

Class instantiation takes the following parameters.

Parameters:

datanumpy.ndarray, default: np.empty(0)

Time-domain signal data in the form of a 1D NumPy array.

sampling_frequencyfloat, default: 44100.0

Sampling frequency of the data, in Hz.

unitstr, default: “Pa”

Unit of the data.

Methods

CreateSignalField.get_output()	Get the created time-domain signal DPF field.
CreateSignalField.get_output_as_nparray()	Get the time-domain signal data as a NumPy array.
CreateSignalField.plot()	Plot the resulting signals in a single figure.
CreateSignalField.process()	Create the PyAnsys Sound signal field.

Attributes

CreateSignalField.data	Time-domain signal data in the form of a 1D NumPy array.
CreateSignalField.sampling_frequency	Sampling frequency in Hz of the data.
CreateSignalField.unit	Unit of the data to store.