TonalityISO1996_2_OverTime

class ansys.sound.core.psychoacoustics.TonalityISO1996_2_OverTime(signal=None, window_length=1000.0, overlap=75.0, noise_pause_threshold=1.0, effective_analysis_bandwidth=5.0, noise_bandwidth_ratio=0.75)

Computes the tonality according to the standard ISO 1996-2:2007, annex C, over time.

Note

The standard ISO 1996-2:2007, annex C, does not include a method for calculation over time. The computation of the present indicator is thus not entirely covered by the standard. The method used here splits the input signal into overlapping windows (segments), and then computes the tonality, for each window, according to the standard ISO 1996-2:2007, annex C.

Class instantiation takes the following parameters.

Parameters:

signalField, default: None

Input signal.

window_lengthfloat, default: 1000.0

Window length in ms.

overlapfloat, default: 75.0

Overlap between successive windows in %.

noise_pause_thresholdfloat, default: 1.0

Noise pause detection threshold (“level excess”) in dB.

effective_analysis_bandwidthfloat, default: 5.0

Effective analysis bandwidth in Hz.

noise_critical_bandwidth_ratiofloat, default: 0.75

Noise bandwidth, in proportion to the critical bandwidth, that is taken into account for the calculation of the masking noise level (the default value 0.75 means that the masking noise level is estimated in a band delimited by 75 % of the critical bandwidth on each side of the tone). Value must be between 0.75 and 2.

For more information about the parameters, please refer to the Ansys Sound SAS user guide.

Methods

TonalityISO1996_2_OverTime.convert_fields_container_to_np_array(fc)	Convert a DPF fields container to a NumPy array.
TonalityISO1996_2_OverTime.get_output()	Get the ISO 1996-2 tonality data.
TonalityISO1996_2_OverTime.get_output_as_nparray()	Get the ISO 1996-2 tonality data as NumPy arrays.
TonalityISO1996_2_OverTime.get_segment_count()	Get the number of segments.
TonalityISO1996_2_OverTime.get_segment_details(...)	Get the ISO 1996-2 tonality details in the specified segment of the input signal.
TonalityISO1996_2_OverTime.get_time_scale()	Get the time scale.
TonalityISO1996_2_OverTime.get_tonal_adjustment_over_time()	Get the ISO 1996-2 tonal adjustment over time.
TonalityISO1996_2_OverTime.get_tonal_audibility_over_time()	Get the ISO 1996-2 tonal audibility over time.
TonalityISO1996_2_OverTime.plot()	Plot the ISO 1996-2 tonal audibility and tonal adjustment over time.
TonalityISO1996_2_OverTime.process()	Compute the tonal audibility and tonal adjustment according to ISO1996-2 annex C.

Attributes

TonalityISO1996_2_OverTime.effective_analysis_bandwidth	Effective analysis bandwidth in Hz.
TonalityISO1996_2_OverTime.noise_bandwidth_ratio	Noise bandwidth in proportion to the critical bandwidth.
TonalityISO1996_2_OverTime.noise_pause_threshold	Noise pause detection threshold (level excess) in dB.
TonalityISO1996_2_OverTime.overlap	Overlap between successive windows in %.
TonalityISO1996_2_OverTime.signal	Input signal in Pa.
TonalityISO1996_2_OverTime.window_length	Length of the integration window in ms.