XtractTonalParameters

class ansys.sound.core.xtract.XtractTonalParameters(regularity=1.0, maximum_slope=750.0, minimum_duration=1.0, intertonal_gap=20.0, local_emergence=15.0, fft_size=8192)

Store tonal parameters for Xtract tonal extraction.

See also

Xtract, XtractTonal

Examples

Create a set of Xtract tonal extraction parameters.

>>> from ansys.sound.core.xtract import XtractTonalParameters
>>> tonal_parameters = XtractTonalParameters(
...     regularity=0.8,
...     maximum_slope=500.0,
...     minimum_duration=0.5,
...     intertonal_gap=30.0,
...     local_emergence=2.0,
...     fft_size=4096,
... )

See also

Extract tonal, transient, and noise components (Xtract)

Example demonstrating how to use Xtract to extract the various components of a signal.

Class instantiation takes the following parameters.

Parameters:

regularityfloat, default: 1.0

Regularity parameter. Values are between 0 and 1. This parameter is designed to reject tonal components with too much frequency variation. You should start with the default value (1.0) and then lower it to remove detected tonals whose frequency evolutions are too erratic.

maximum_slopefloat, default: 750.0

Maximum slope in Hz/s for each tonal component. Values are between 0 and 15000 Hz/s. A higher value enables finding tonal components with a greater frequency slope over time.

minimum_durationfloat, default: 1.0

Minimum duration in seconds for each tonal component. Values are between 0 and 5.

intertonal_gapfloat, default: 20.0

Minimum gap in Hz between two tonal components. Values are between 10 and 200.

local_emergencefloat, default: 15.0

Emergence of the tonal components compared to the background noise in dB. Values are between 0 and 100.

fft_sizeint, default: 8192

Number of samples for the FFT computation. The value must be greater than 0.

Methods

XtractTonalParameters.get_output()	Get output.
XtractTonalParameters.get_output_as_nparray()	Get output as a NumPy array.
XtractTonalParameters.get_parameters_as_generic_data_container()	Get the parameters as a generic data container.
XtractTonalParameters.plot()	Plot the output.
XtractTonalParameters.process()	Process inputs.

Attributes

XtractTonalParameters.fft_size	Number of FFT points.
XtractTonalParameters.intertonal_gap	Intertonal gap in Hz.
XtractTonalParameters.local_emergence	Local emergence in dB.
XtractTonalParameters.maximum_slope	Maximum slope in Hz/s.
XtractTonalParameters.minimum_duration	Minimum duration in s.
XtractTonalParameters.regularity	Regularity parameter.