OverallLevel

class ansys.sound.core.standard_levels.OverallLevel(signal=None, scale='dB', reference_value=1.0, frequency_weighting='')

Compute the overall level.

This class computes the overall level of a signal.

Class instantiation takes the following parameters.

Parameters:

signalField, default: None

The signal to process.

scalestr, default: “dB”

The scale type of the output level. Available options are “dB” and “RMS”.

reference_valuefloat, default: 1.0

The reference value for the level computation. If the overall level is computed with a signal in Pa, the reference value should be 2e-5.

frequency_weightingstr, default: “”

The frequency weighting to apply to the signal before computing the level. Available options are “”, “A”, “B”, and “C”, respectively to get level in dBSPL, dB(A), dB(B), and dB(C). Note that the frequency weighting is only applied if the attribute scale is set to “dB”.

Methods

OverallLevel.convert_fields_container_to_np_array(fc)	Convert a DPF fields container to a NumPy array.
OverallLevel.get_level()	Return the overall level.
OverallLevel.get_output()	Return the overall level.
OverallLevel.get_output_as_nparray()	Return the overall level as a numpy array.
OverallLevel.plot()	Plot the output.
OverallLevel.process()	Compute the overall level.

Attributes

OverallLevel.frequency_weighting	Frequency weighting of the computed level.
OverallLevel.reference_value	Reference value for the level computation.
OverallLevel.scale	Scale type of the output level.
OverallLevel.signal	Input signal.