XtractDenoiserParameters

class ansys.sound.core.xtract.XtractDenoiserParameters(noise_psd=None)

Store denoiser parameters for Xtract signal denoising.

See also

Xtract, XtractDenoiser

Examples

Create a set of Xtract denoiser parameters from a PSD.

>>> from ansys.sound.core.xtract import XtractDenoiserParameters
>>> denoiser_parameters = XtractDenoiserParameters(noise_psd=my_noise_psd)

Create a set of Xtract denoiser parameters from a white noise level.

>>> from ansys.sound.core.xtract import XtractDenoiserParameters
>>> denoiser_parameters = XtractDenoiserParameters()
>>> noise_psd = denoiser_parameters.create_noise_psd_from_white_noise_level(
...     white_noise_level=30.0,
...     sampling_frequency=48000.0,
...     window_length=50,
... )
>>> denoiser_parameters.noise_psd = noise_psd

Create a set of Xtract denoiser parameters from noise samples.

>>> from ansys.sound.core.xtract import XtractDenoiserParameters
>>> denoiser_parameters = XtractDenoiserParameters()
>>> noise_psd = denoiser_parameters.create_noise_psd_from_noise_samples(
...     signal=my_noise_signal,
...     sampling_frequency=48000.0,
...     window_length=50,
... )
>>> denoiser_parameters.noise_psd = noise_psd

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:

noise_psdField, optional

Power spectral density of the noise in unit^2/Hz (Pa^2/Hz for example). This parameter can be produced using one of the following methods:

• XtractDenoiserParameters.create_noise_psd_from_white_noise_level()

• XtractDenoiserParameters.create_noise_psd_from_noise_samples()

• XtractDenoiserParameters.create_noise_psd_from_automatic_estimation()

Methods

XtractDenoiserParameters.create_noise_psd_from_automatic_estimation(signal)	Create a power spectral density (PSD) of noise using an automatic estimation.
XtractDenoiserParameters.create_noise_psd_from_noise_samples(...)	Create a power spectral density (PSD) of noise from specific noise samples.
XtractDenoiserParameters.create_noise_psd_from_white_noise_level(...)	Create a power spectral density (PSD) of noise from the white noise level.
XtractDenoiserParameters.get_output()	Get output.
XtractDenoiserParameters.get_output_as_nparray()	Get output as a NumPy array.
XtractDenoiserParameters.get_parameters_as_generic_data_container()	Get the parameters as a generic data container.
XtractDenoiserParameters.plot()	Plot the output.
XtractDenoiserParameters.process()	Process inputs.

Attributes

XtractDenoiserParameters.noise_psd

Power spectral density (PSD) of the noise in unit^2/Hz (Pa^2/Hz for example).