SourceBroadbandNoiseTwoParameters

class ansys.sound.core.sound_composer.SourceBroadbandNoiseTwoParameters(file='', source_control1=None, source_control2=None)

Sound Composer’s broadband noise source with two parameters class.

This class creates a broadband noise source with two parameters for the Sound Composer. A broadband noise source with two parameters is used to generate a sound signal from broadband noise source data and two source controls.

The broadband noise source data consists of a series of noise spectra, each corresponding to a pair of control parameter values.

Each of the two source controls contains one control parameter’s values over time.

Class instantiation takes the following parameters.

Parameters:

filestr, default: “”

Path to the broadband noise with two parameters file. Supported files are text files with the header AnsysSound_BBN_MultipleParameters and should be created using Ansys Sound SAS.

source_control1SourceControlTime, default: None

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

source_control2SourceControlTime, default: None

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

Methods

SourceBroadbandNoiseTwoParameters.convert_fields_container_to_np_array(fc)	Convert a DPF fields container to a NumPy array.
SourceBroadbandNoiseTwoParameters.get_as_generic_data_containers()	Get the source and source control data as generic data containers.
SourceBroadbandNoiseTwoParameters.get_output()	Get the generated sound as a DPF field.
SourceBroadbandNoiseTwoParameters.get_output_as_nparray()	Get the generated sound as a NumPy array.
SourceBroadbandNoiseTwoParameters.is_source_control_valid()	Source control verification function.
SourceBroadbandNoiseTwoParameters.load_source_bbn_two_parameters(file)	Load the broadband noise source with two parameters data from a file.
SourceBroadbandNoiseTwoParameters.plot()	Plot the resulting signal.
SourceBroadbandNoiseTwoParameters.plot_control()	Plot the source controls.
SourceBroadbandNoiseTwoParameters.process([...])	Generate the sound of the broadband noise source with two parameters.
SourceBroadbandNoiseTwoParameters.set_from_generic_data_containers(...)	Set the source and source control data from generic data containers.

Attributes

SourceBroadbandNoiseTwoParameters.source_bbn_two_parameters	Source data for the broadband noise source with two parameters.
SourceBroadbandNoiseTwoParameters.source_control1	First source control for the broadband noise source with two parameters.
SourceBroadbandNoiseTwoParameters.source_control2	Second source control for the broadband noise source with two parameters.