SourceSpectrum

class ansys.sound.core.sound_composer.SourceSpectrum(file_source='', source_control=None)

Sound Composer’s spectrum source class.

This class creates a spectrum source for the Sound Composer. A spectrum source is used to generate a sound signal from a spectrum and a source control.

The source’s spectrum data consists of a power spectral density (PSD), where levels are specified in unit^2/Hz (for example Pa^2/Hz).

The source control contains the duration of the sound and the generation method to use.

Class instantiation takes the following parameters.

Parameters:

file_sourcestr, default: “”

Path to the file that contains the spectrum data. Supported files are the same XML and text (with the AnsysSound_Spectrum header) formats as supported by Ansys Sound SAS.

source_controlSourceControlSpectrum, default: None

Source control, consisting of the sound duration and sound generation method to use when generating the sound from this source.

Methods

SourceSpectrum.convert_fields_container_to_np_array(fc)	Convert a DPF fields container to a NumPy array.
SourceSpectrum.get_as_generic_data_containers()	Get the source and source control data as generic data containers.
SourceSpectrum.get_output()	Get the generated sound as a DPF field.
SourceSpectrum.get_output_as_nparray()	Get the generated sound as a NumPy array.
SourceSpectrum.is_source_control_valid()	Source control verification function.
SourceSpectrum.load_source_spectrum(file_source)	Load the spectrum source data from a spectrum file.
SourceSpectrum.plot()	Plot the resulting signal.
SourceSpectrum.plot_control()	Plot the source control(s) in a figure.
SourceSpectrum.process([sampling_frequency])	Generate the sound of the spectrum source.
SourceSpectrum.set_from_generic_data_containers(...)	Set the source and source control data from generic data containers.

Attributes

SourceSpectrum.source_control	Source control of the spectrum source.
SourceSpectrum.source_spectrum_data	Source data for the spectrum source.