CreateSignalFieldsContainer#

class ansys.sound.core.signal_utilities.CreateSignalFieldsContainer(fields=None)#

Create a PyAnsys Sound fields container containing signals as DPF fields.

This class creates a DPF fields container from a list, tuple, or array of signal fields. To create signal fields from signal data, use the class CreateSignalField.

Class instantiation takes the following parameters.

Parameters:
fieldslist[Field] | tuple[Field] | np.ndarray[Field], default: None

Signal fields to include in the fields container.

Methods

CreateSignalFieldsContainer.get_output()

Get the signal fields container.

CreateSignalFieldsContainer.get_output_as_nparray()

Get output as a NumPy array.

CreateSignalFieldsContainer.plot()

Plot the resulting signals in a single figure.

CreateSignalFieldsContainer.process()

Create the signal fields container.

Attributes

CreateSignalFieldsContainer.fields

List, tuple, or NumPy array of signal fields to store.