SourceHarmonics

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

Sound Composer’s harmonics source class.

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

The harmonics source data consists of a series of orders whose levels depend on RPM.

The source control contains the RPM values over time.

Class instantiation takes the following parameters.

Parameters:

filestr, default: “”

Path to the harmonics source data file. Supported files are the same XML and text (with the header AnsysSound_Orders) formats as supported by Ansys Sound SAS.

source_controlSourceControlTime, default: None

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

Methods

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

Attributes

SourceHarmonics.source_control	Source control for the harmonics source.
SourceHarmonics.source_harmonics	Source data for the harmonics source.