TonalityAures#

class ansys.sound.core.psychoacoustics.TonalityAures(signal=None, overlap=90.0, account_for_w1=False, w1_threshold=3.0)#

Computes the tonality of the signal according to Aures model.

References

W. Aures, “Procedure for calculating the sensory pleasantness of various sounds”, Acustica 59(2), pp. 130-141, December 1985.
E. Terhardt, G. Stoll, M. Seewann, “Algorithm for extraction of pitch and pitch salience from complex tonal signals”, J. Acoust. Soc. Am. 71(3), pp. 679-688, March 1982.

Class instantiation takes the following parameters.

Parameters:

signalField, default: None: Signal in Pa on which to compute Aures tonality.
overlapfloat, default: 90.0: Overlap in % between two successive windows.
account_for_w1bool, default: False: Specifies whether bandwidth weighting w1 should be taken into account or not.
w1_thresholdfloat, default: 3.0: Threshold for bandwidth weighting. Ignored when account_for_w1 is set to False.
For more information about the parameters, please refer to the Ansys Sound SAS user guide.

Methods

`TonalityAures.convert_fields_container_to_np_array`(fc)	Convert a DPF fields container to a NumPy array.
`TonalityAures.get_loudness_weighting_over_time`()	Get the relative loudness weighting wGr over time.
`TonalityAures.get_output`()	Get Aures' tonality data.
`TonalityAures.get_output_as_nparray`()	Get the Aures tonality data as NumPy arrays.
`TonalityAures.get_time_scale`()	Get the time scale.
`TonalityAures.get_tonal_weighting_over_time`()	Get the tonal component weighting wT over time.
`TonalityAures.get_tonality`()	Get the overall Aures tonality in tu.
`TonalityAures.get_tonality_over_time`()	Get the Aures tonality over time.
`TonalityAures.plot`()	Plot the tonality over time.
`TonalityAures.process`()	Compute the Aures tonality.

Attributes

`TonalityAures.account_for_w1`	Specifies whether bandwidth weighting w1 should be taken into account or not.
`TonalityAures.overlap`	Overlap in % between two successive windows.
`TonalityAures.signal`	Input signal in Pa.
`TonalityAures.w1_threshold`	Threshold in dB for the bandwidth weighting w1.