treble_tsdk.results.results_naming_enums

Results naming conventions and enumerations.

Defines enums and utilities for result types, IR types, file naming conventions and acoustic parameter identifiers.

Classes

AxisDefinition	Axis definitions
FrequencyPlotType	Frequency plot types
IrSuffix	IR suffixes for simulation types.
IrType	Available types for IR
PointType	Point types
ResultParameter	Result parameters

class treble_tsdk.results.results_naming_enums.IrType

Available types for IR

mono = 'mono'

spatial = 'spatial'

device = 'device'

class treble_tsdk.results.results_naming_enums.IrSuffix

IR suffixes for simulation types.

hybrid_mono = 'hybrid_IR.wav'

hybrid_spatial = 'hybrid_Spatial_IR.wav'

hybrid_device = 'Hybrid_device.wav'

dg_mono = 'DG_IR_SC.wav'

dg_spatial = 'DG_IR_Spatial.wav'

dg_device = 'DG_device.wav'

ga_mono = 'GA_IR.wav'

ga_spatial = 'GA_spatial_IR.wav'

ga_device = 'GA_device.wav'

class treble_tsdk.results.results_naming_enums.PointType

Point types

source = 'sources'

receiver = 'receivers'

get_singular()

Get the singular form of the point type.

Returns str:

Singular form (e.g., ‘source’ from ‘sources’).

class treble_tsdk.results.results_naming_enums.FrequencyPlotType

Frequency plot types

mag = 'spl_mag'

dB = 'spl_db'

complex = 'complex'

class treble_tsdk.results.results_naming_enums.AxisDefinition

Axis definitions

frequency = 'Frequency band [Hz]'

sti = 'Noise criterion (NC) curve [dB]'

mtf = 'mtf'

class treble_tsdk.results.results_naming_enums.ResultParameter

Result parameters

EDT = 'edt'

T20 = 't20'

T30 = 't30'

C50 = 'c50'

C80 = 'c80'

D50 = 'd50'

TS = 'ts'

G = 'g'

SPL = 'spl'

STI = 'sti'

MTF = 'mtf'

classmethod print()

Print all available result parameters.

get_yaxis() → str

Get the y-axis label with appropriate units for the parameter.

Returns str:

Y-axis label string with units.