XtractDenoiser

class ansys.sound.core.xtract.XtractDenoiser(input_signal=None, input_parameters=None)

Denoise a signal using the Xtract algorithm.

See also

Xtract, XtractDenoiserParameters

Examples

Denoise a signal and display the resulting denoised and noise signals.

>>> from ansys.sound.core.xtract import XtractDenoiser
>>> denoiser = XtractDenoiser(
...     input_signal=my_signal,
...     input_parameters=my_denoiser_parameters
... )
>>> denoiser.process()
>>> denoised_signal, noise_signal = denoiser.get_output()
>>> denoiser.plot()

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:

input_signalFieldsContainer | Field, default: None

One or more signals to denoise as a DPF fields container or field. When inputting a fields container, each signal (each field of the fields container) is processed individually.

input_parametersXtractDenoiserParametersm, default: None

Structure that contains the parameters of the algorithm:

• Noise PSD (Field): Power spectral density of the noise

This structure is of the XtractDenoiserParameters type. For more information, see this class.

Methods

XtractDenoiser.get_output()	Get the output of the denoising.
XtractDenoiser.get_output_as_nparray()	Get the output of the denoising as NumPy arrays.
XtractDenoiser.plot()	Plot signals.
XtractDenoiser.process()	Apply denoising.

Attributes

XtractDenoiser.input_parameters	Input parameters.
XtractDenoiser.input_signal	Input signal.
XtractDenoiser.output_denoised_signals	Output denoised signals.
XtractDenoiser.output_noise_signals	Output noise signals.