XtractTransientParameters

class ansys.sound.core.xtract.XtractTransientParameters(lower_threshold=0.0, upper_threshold=100.0)

Store transient parameters for Xtract transient extraction.

See also

Xtract, XtractTransient

Examples

Create a set of Xtract transient extraction parameters.

>>> from ansys.sound.core.xtract import XtractTransientParameters
>>> transient_parameters = XtractTransientParameters(lower_threshold=20.0, upper_threshold=80.0)

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:

lower_thresholdfloat, default: 0.0

Minimum threshold, which is related to the minimum energy of transient components. Values are between 0 and 100. You should set this parameter as high as possible provided that no transient element remains in the remainder (non-transient signal).

upper_thresholdfloat, default: 100.0

Maximum threshold, which is related to the maximum energy of transient components. Values are between 0 and 100. You should set this parameter as low as possible provided that no transient element remains in the remainder (non-transient signal).

Methods

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

Attributes

XtractTransientParameters.lower_threshold	Lower threshold.
XtractTransientParameters.upper_threshold	Upper threshold.