Xtract#

class ansys.sound.core.xtract.Xtract(input_signal=None, parameters_denoiser=None, parameters_tonal=None, parameters_transient=None)#

Provides Xtract processing.

PyAnsys Sound performs Xtract processing in the same way as Ansys Sound Analysis and Specification (SAS). This operator chains a denoising step, followed by a tonal extraction step and then a transient extraction step. It returns the individual signals processed at each step, as well as the remainder.

Methods

Xtract.convert_fields_container_to_np_array(fc)

Convert a DPF fields container to a NumPy array.

Xtract.get_output()

Get the output of the Xtract algorithm in a tuple as DPF fields containers or fields.

Xtract.get_output_as_nparray()

Get the output of the Xtract algorithm in a tuple as NumPy arrays.

Xtract.plot()

Plot the Xtract algorithm results.

Xtract.process()

Process the Xtract algorithm.

Attributes

Xtract.input_signal

Input signal.

Xtract.output_noise_signal

Noise signal.

Xtract.output_remainder_signal

Remainder signal.

Xtract.output_tonal_signal

Tonal signal.

Xtract.output_transient_signal

Transient signal.

Xtract.parameters_denoiser

Parameters of the denoiser step.

Xtract.parameters_tonal

Parameters of the tonal extraction step.

Xtract.parameters_transient

Parameters of the transient extraction step.