aspsim.diagnostics.diagnostics

Functions

power_of_all_signals(processor)

Must be called from processor.prepare(), not processor.__init__()

Classes

RecordFilter(prop_name, *args, **kwargs)

Remember to include .ir in the property name if the property is a filter object

RecordFilterDifference(state_name, ...)

save_at_idx is an iterable which gives all indices for which to save data.

RecordSignal(sig_name, *args[, ...])

save_at_idx is an iterable which gives all indices for which to save data.

RecordState(state_name, state_dim, *args[, ...])

If state_dim is 1, the state is a scalar calue If the number is higher, the state is a vector, and the value of each component will be plotted as each line by the default plot function

SignalPower(sig_name, sim_info[, export_at, ...])

save_at_idx is an iterable which gives all indices for which to save data.

SignalPowerRatio(numerator_name, denom_name, ...)

save_at_idx is an iterable which gives all indices for which to save data.

SoundfieldPower(sig_name, pos_mic, ...[, ...])

use_samples : tuple[int, int]

StateComparison(compare_func, name_state1, ...)

compare_func should take the two states as argument, and return a single value representing the comparison (distance or MSE for example)

StatePower(prop_name, sim_info[, export_at, ...])

save_at_idx is an iterable which gives all indices for which to save data.

StateSummary(summary_func, state_name, ...)

summary_func should take the state as argument and return a single scalar representing the state (norm or power for example)