SourceBroadbandNoise

class ansys.sound.core.sound_composer.SourceBroadbandNoise(file='', source_control=None)

Sound Composer’s broadband noise source class.

This class creates a broadband noise source for the Sound Composer. A broadband noise source is used to generate a sound signal from a given broadband noise and its source control. The broadband noise consists of a series of noise spectra, each corresponding to a control parameter value. The source control contains the control parameter values over time.

Class instantiation takes the following parameters.

Parameters:

filestr, default: “”

Path to the broadband noise file. Supported files are text files with the header AnsysSound_BBN. If left empty, the broadband noise source is not loaded.

source_controlSourceControlTime, default: None

Source control, consisting of the control parameter values over time, to use when generating the sound from this source.

Methods

SourceBroadbandNoise.convert_fields_container_to_np_array(fc)	Convert a DPF fields container to a NumPy array.
SourceBroadbandNoise.get_output()	Get the generated sound as a DPF field.
SourceBroadbandNoise.get_output_as_nparray()	Get the generated sound as a NumPy array.
SourceBroadbandNoise.is_source_control_valid()	Source control verification function.
SourceBroadbandNoise.load_source_bbn(file)	Load the broadband noise source data from a file.
SourceBroadbandNoise.plot()	Plot the resulting signal in a figure.
SourceBroadbandNoise.plot_control()	Plot the source control(s) in a figure.
SourceBroadbandNoise.process([...])	Generate the sound of the broadband noise source.

Attributes

SourceBroadbandNoise.source_bbn	Broadband noise source data, as a DPF fields container.
SourceBroadbandNoise.source_control	Broadband noise source control.