get_tone_details#

TonalityDIN45681.get_tone_details(spectrum_index, tone_index)#

Get the tone data, for a specific spectrum.

Returns all the data associated with a specific detected tone, in a specific spectrum (that is, at a specific time step).

Parameters:
spectrum_index: int

Index of the spectrum where the tone was detected. The index is 0-based.

tone_index: int

Index of the tone whose details are requested. The index is 0-based.

Returns:
tuple

  • First element (float): decisive difference DLj in dB.

  • Second element (float): uncertainty, in dB.

  • Third element (float): decisive frequency, in Hz.

  • Fourth element (str): tone type (’’ for individual tones, or ‘FG’ for groups of tones).

  • Fifth element (float): critical band lower limit, in Hz.

  • Sixth element (float): critical band upper limit, in Hz.

  • Seventh element (float): mean narrow-band masking noise level Ls, in dBA.

  • Eighth element (float): tone level Lt, in dBA.

  • Ninth element (float): masking noise level Lg, in dBA.

  • Tenth element (float): masking index av, in dB.

Return type:

tuple