XtractTransientParameters

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

Contains transient parameters for use in Xtract processing or signal denoising.

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.convert_fields_container_to_np_array(fc)	Convert a DPF fields container to a NumPy array.
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.