LevelOverTime

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

Compute the level over time.

This class computes the level over time 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”.

time_weightingstr, default: “Fast”

The time weighting to use when computing the level over time. Available options are “Fast”, “Slow”, “Impulse”, and “Custom”. When “Custom” is selected, the user can provide custom parameters using the method set_custom_parameters().

Methods

LevelOverTime.convert_fields_container_to_np_array(fc)	Convert a DPF fields container to a NumPy array.
LevelOverTime.get_level_max()	Return the maximum level.
LevelOverTime.get_level_over_time()	Return the level over time.
LevelOverTime.get_output()	Return the maximum level and level over time.
LevelOverTime.get_output_as_nparray()	Return the maximum level, level over time, and time scale.
LevelOverTime.get_time_scale()	Return the time scale.
LevelOverTime.plot()	Plot the level over time.
LevelOverTime.process()	Compute the overall level.
LevelOverTime.set_custom_parameters([...])	Set the custom parameters for the time weighting.

Attributes

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