Pytta

What's Changed

This is our second official version of the toolbox!

There are some improvements in the deconvolution methods inside the "ImpulsiveResponse" class.

Also, this version is compatible with more modern versions of python and scipy.

There is room for future improvements.

Check our examples folder

* Add shields.io metadata badges to README.md by jvcarli in https://github.com/PyTTaMaster/PyTTa/pull/30
* Fix setup.py so PyTTa is installed only with Python compatible versions. by jvcarli in https://github.com/PyTTaMaster/PyTTa/pull/34
* [FIX] Fix typos in pytta's package and in examples directory by jvcarli in https://github.com/PyTTaMaster/PyTTa/pull/36
* [FEATURE] RoomAnalysis class for monaural room impulse response parameters calculation. by Chum4k3r in https://github.com/PyTTaMaster/PyTTa/pull/35
* [FEATURE] Introduced plotly waterfall by rinaldipp in https://github.com/PyTTaMaster/PyTTa/pull/37
* Bugfix concerning DC-component of Signal by Juli-Sleeps-Well in https://github.com/PyTTaMaster/PyTTa/pull/42
* python 3.11 compatibility, some plot updates, and deconv with zero pa… by eric-brandao in https://github.com/PyTTaMaster/PyTTa/pull/47
* necessary changes in deconvolution with regularization, and other stuff by eric-brandao in https://github.com/PyTTaMaster/PyTTa/pull/48

New Contributors
* rinaldipp made their first contribution in https://github.com/PyTTaMaster/PyTTa/pull/37
* Juli-Sleeps-Well made their first contribution in https://github.com/PyTTaMaster/PyTTa/pull/42
* eric-brandao made their first contribution in https://github.com/PyTTaMaster/PyTTa/pull/47

**Full Changelog**: https://github.com/PyTTaMaster/PyTTa/compare/v0.1.0...v0.1.2

Finally our first official version of the toolbox! With several improvements and room for future improvements.
Now the most stable version is available through pip install.
Check our examples folder ;]

Introduced features:

[FEATURE] SignalObj numSamples as input arg for 'freq' signal
[FEATURE] Some more improvements to HDF5 saving
[FEATURE] Introduced version to HDF5. Prepared for future adaptors.
[FEATURE] SignalObj.play refactory
[FEATURE] Introduced SignalObj.split(...) and pytta.split(...)
[FEATURE] Measurement-based audio input and output with pytta.Streaming and pytta.Monitor support.
[FEATURE] Streaming and parallel Monitor working
[FEATURE] rooms.Analyse(bypassLundeby)
[FEATURE] Introduced roomir.MPP.RT and some minor bug fixes
[FEATURE] Introduced .plot_time/.plot_time_dB(timeUnit='s' or 'ms')
[FEATURE] plot_bars(xLim=[f1 f2])
[FEATURE] New function: get_device_from_user
[FEATURE] Added utility subpackage pytta.utils
[FEATURE] rooms.G_Lps Analysis output with .windowLimits property
[FEATURE] pytta.apps.roomir.D.calibrate_res MeasuredThing of sourcerecalibration type
[FEATURE] pytta/Analysis.plot_bars(overlapBars, color)
[FEATURE] adjustable Analysis bands' limits via .minBand and .maxBand
[FEATURE] Introduced Analysis.plot_bars(forceZeroCentering) argument.
[FEATURE] Introduced waterfall plot for impulsive response
[FEATURE] plots module fully implemented and documented for current plots
[FEATURE] introduced plot module + pytta.plot functions for multiple SignalObjs plotting.
[FEATURE] Introduced pytta.plot_time for multiple SigObj plots
[FEATURE] new fft transformation in SignalObj
[FEATURE] Introduced list save support to pytta.functions.h5_save
[FEATURE] Introduced dictionary save support to pytta.functions.h5_save
[FEATURE] introduced IRManualCut on G terms + some progress on G recalibration
[FEATURE] Introduced roomir.MeasurementPostProcess class for G calculation
[FEATURE] Introduced SignalObj.crop
[FEATURE] Introduced rooms.Analyse IRManualCut
[FEATURE] Introduced SignalObj.signalType and FFT Normalization
[FEATURE] ImpulsiveResponse zero padding
[FEATURE] Introduced Sm calculation to iso3741.Lp_ST
[FEATURE] Added Monitor base class
[FEATURE] Introduced Analysis.error and its plot for uncertainties visualization
[FEATURE] Introduced roomir output transducer compensation + MeasurementData.calibrate_res with input compensation
[FEATURE] Introduced Analysis.plot_bars(ylim)
[FEATURE] in pytta.rooms introduced automatic IR cut to RT calculation
[FEATURE] Introduced SignalObj.mul FFT convolution
[FEATURE] Roomir impulsive response calculation doing Kirkeby regularization
[FEATURE] Introduced Kirkeby regularization for IR calculation and some minor bug fixes
[FEATURE] Introduced roomir input and output transducer response compensation
[FEATURE] Introduced roomir channelcalibration measurement kind.

Fixes:
[FIX] SignalObj._ifft
[FIX] Removed warning of log10(0)
[FIX] SignalObj._ifft
[FIX] Change 'is' to '==' in 'varnames is ()' to fix SyntaxWarning.
[FIX] Spelling.
[FIX] removed plot
[FIX] Added print_devices() to print devices list returned by list_devices().
[FIX] Remove fft_degree references from imported functions.
[FIX] _ for not user-intended functions
[FIX] fft_degree moving
[FIX] default system messed because of wrong FIXME tags
[FIX] Fixed rooms.cumulative_integration freqRange argument.
[FIX] bug due to roomir.MeasurementChList new name
[FIX] Monitor string formatting
[FIX] Monitor colors
[FIX] Removed Recorder class
[FIX] plt spectrogram + SignalObj from freq array

[FIX] add _ on modules' name
[FIX] Filtered SignalObjs now holds channel information from former SignalObj
[FIX] Added utils reference.
[FIX] adding _ to some modules names
[FIX] generate.filter renamed to generate.octfilter
[FIX] fractional_octave_frequencies call on Analysis.data.setter
[FIX] pytta.iso3741 remove old code
[FIX] add fft after SignalObj.calib_p/v
[FIX] rooms.G input data types
[FIX] G calculation
[FIX] SignalObj spectrum magnitude
[FIX] .spl() method now uses .dBRefList() to perform proper SPL calulation
[FIX] generate.impulse SignalType
[FIX] SignalObj samples number calculation
[FIX] little bug in functions.plot_spectrogram
[FIX] SignalObj._ifft
[FIX] c-contiguous bug in rooms.py
[FIX] PyTTaObj.samplingRate data type
[FIX] frf_measurement and roomac_testing examples
[FIX] _base.ChannelObj.calib_volt
[FIX] roomir bugs related to measurements with arrays and some pytta.signal/_base minor bugs.
[FIX] SignalObj.truediv bug
[FIX] SignalObj.timeVector constructed with linspace
[FIX] Structural changes on multiprocessing call for monitor function
[FIX] Structural changes on multiprocessing call for monitor function
[FIX] Structural changes on multiprocessing call for monitor function
[FIX] measurement._print_max_level output mapping
[FIX] Analysis.add
[FIX] SignalObj.plot_time_dB()

Features:

[FEATURE] SignalObj.plot methods return fig
[FEATURE] Analysis.__rtruediv__ and plot improvements
[FEATURE] Introduced Analysis save support to plot labels
[FEATURE] introduced apps.iso3741
[FEATURE] introduced roomir.MeasurementData.calibrate_res(...)
[FEATURE] Introduced Level Analysis.__truediv__ support
[FEATURE] introduced Level pytta.Analysis type
[FEATURE] Introduced Analysis.__truediv__, __mul__, and __add__
[FEATURE] on pytta.roomir.TakeMeasure introduced OutputAmplification
[FEATURE] Introduced hdf5 save support to Analysis
[FEATURE] Introduced roomir.calculate_ir; changed roomir MS kind to roomres
[FEATURE] ImpulsiveResponse don't hold the excutation and recording signals anymore
[FEATURE] Modded Streaming class as superclass for Recorder, Player and PlaybackRecorder
[FEATURE] Introduced changeable MS properties in pytta.roomir
[FEATURE] ImpulsiveResponse doesn't hold the excitation and recording signals anymore.
[FEATURE] Introduced roomir.MeasurementData.get method
[FEATURE] Recorder: tested (test_streaming.py)
[FEATURE] Recorder added to module level
[FEATURE] Recorder improvements
[FEATURE] AntiAliasingFilter initial commit
[FEATURE] introduced Analysis.anName + plot adjustments
[FEATURE] pytta.rooms working + Lundeby plots + Analysis
[FEATURE] pytta.Analysis now working
[FEATURE] Improved imports and ChannelsList searching for items
[FEATURE] in roomir introduced: properties to MS + MD.__h5_update + MD.get
[FEATURE] introduced roomir.MeasurementSetup.__repr__
[FEATURE] introduced roomir.MeasurementSetup.__repr__
[FEATURE] introduced freqSignal test to SignalObj in test_h5io.py
[FEATURE] introduced measurement outputAmplification
[FEATURE] roomir.MeasuredThing.h5_save
[FEATURE] h5_save support for roomir.MeasurementSetup
[FEATURE] *.pytta and *.hdf5 both are saved/loaded through pytta.save/load
[FEATURE] on pytta.roomir.MeasurementSetup introduced pause option betwen averages
[FEATURE] test file for h5io
[FEATURE] Introduced SignalObj.__mul__ for gain applying"
[FEATURE] pytta.h5save/load: introduced support to pytta.classes.measurement.RecMeasure
[FEATURE] Introduced pytta.ImpulsiveResponse.__repr__ method
[FEATURE] pytta.h5save/load: introduced support to RecMeasure
[FEATURE] Introduced __repr__ magic method to pytta.measurement.Measurement/RecMeasure/PlayRecMeasure/FRFMeasure and pytta._base.PyTTaObj
[FEATURE] pytta.h5save/load: introduced support to FRFMeasure, PlayRecMeasure, and RecMeasure
[FEATURE] pytta.h5save/load: add support to ImpulsiveResponse
[FEATURE] pytta.h5save: rename objs with same creation_name
[FEATURE] OOP plot generation + rooms using generators
[FEATURE] Introduced hdf5 files i/o as pytta.functions.h5save/h5load
[FEATURE] _base.ChannelsList.__contains__ now checks into channels names, codes and numbers.
[FEATURE] Added .calib_pressure to measurement classes.
[FEATURE] Introduced 'in' comparison (__contains__ magic method) for pytta.classes._base.ChannelsList.
[FEATURE] Band's center frequencies now come with standardized nominal values.
[FEATURE] Introduced channel code, pytta._base.ChannelObj.code
[FEATURE] _to_dict for all. Commit 4866a61 left behind by a forgoten pull
[FEATURE] added (C)larity and (D)efinition functions
[FEATURE] Added respective C and D calculations.
[FEATURE] Reverberation Time calculation, pytta.rooms example and sample IRs
[FEATURE] Apply filters and cumulative integration

Fixes:

[FIX] Analysis.plot return fig
[FIX] rooms.RT numba related bugs
[FIX] pytta.h5_save support to Analysis
[FIX] pytta.roomir support to temperatura and RH acquisition through LabJack U3 + EI1050
[FIX] Analysis.plot_bars() yticks
[FIX] _base.ChannelObj.__truedive__' bug due to chNum vs chIndex
[FIX] print rate at ~125 ms
[FIX] missing attribute
[FIX] rec data ndarray shape
[FIX] Import base classes on pytta.functions for h5_load purposes
[FIX] pytta.roomir.TakeMeasure.__cfg_channels(): get outChSel only when kind is appropriated
[FIX] _base.ChannelsList.__getitem__: included get by code
[FIX] missing ',' in __all__ at pytta.__init__
[FIX] rooms._filter as OctFilter.filter() return is now a list
[FIX] .freq_to_band() base parameter
[FIX] Imports: optimized imports; ChannelsList: optimized item search
[FIX] Dependencies: added Numba
[FIX] README.md
[FIX] functions.__parse_load unclosed json file
[FIX] bug on pytta_save creation_name
[FIX] SignalObj.plot_freq ylim for -inf case
[FIX] roomir.__h5_unpack minor bug
[FIX] roomir minor bugs
[FIX] Measurement.__print_max__level__ bug
[FIX] added freqMin / freqMax input check in SignalObj
[FIX] code snipet for PlayRec and Rec.run() result creation name
[FIX] measurement clipping warning. Now considering the outputAmplification
[FIX] measurements.__repr__
[FIX] some syntax
[FIX] minor adjusts + added RIS resource
[FIX] ._filter() output
[FIX] heritaged attributes via SignalObj.__add__ to the new summed SignalObj.
[FIX] Plot bug fix
[FIX] _base.ChannelsList.__repr__ text
[FIX] pytta.h5load fileName bug
[FIX] little doc error in test_h5io.py
[FIX] input type for np.linspace
[FIX] pytta.generate.noise().numSamples wasnt correct because numerical error
[FIX] RecMeasure was trying to access ChannelsList.mapping while it was a property
[FIX] Fix all inChannel/outChannel names to inChannels/outChannels
[FIX] pyttta.classes.FRFMeasure.run(): added code snippet for IR's creation_name
[FIX] Fix _base.ChannelsList.__truediv__ because channels can't be reached by its list index anymore
[FIX] Fix SignalObj.plot_freq()'s min. value for axis limits
[FIX] Fix pytta.merge for loop in channels
[FIX] As a channel can only be reached by its number at _base.ChannelsList.__getitem__, introduced distinguishment betwen chIndex (refers to timeSignal array's index; starts in 0) and chNum (refers to the channel number in ChannelsList; starts in 1 and the next can be different from 2)
[FIX] Load parser and .calib_pressure from Measurement-like classes
[FIX] Changed relative to absolute import scheme
[FIX] Several bug fixes and syntax conformation
[FIX] __filter changed to _filter
[FIX] __print_max_level rename to _print_max_levl
[FIX] added classes subpack to setup.py and fixed install requirements.
[FIX] -load parser
[FIX] freq_to_band for both base 10 and 2, for any nthOct fraction.
[FIX] Default parameters
[FIX] Array dimensions, ChannelsList passing and typos
[FIX] freq_to_band, therefore filtering, now works for any nthOct
[FIX] Print on calculation
[FIX] RI file name

Introduced features:

[FEATURE] Introduced CoordinatesObj._to_dict and necessary adaptations
[FEATURE] Introduce CoordinateObj
[FEATURE] units dict in pytta.properties
[FEATURE] pytta.save() and pytta.load() functions for *.pytta files
[FEATURE] Streaming.calib_pressure method
[FEATURE] .save method for all PyTTaObj classes
[FEATURE] ChannelsList featuring on every PyTTaObj subclass
[FEATURE] Improving save methods
[FIX][FEATURE] Code improvement, added reset method to Streaming
[FEATURE] Added Streaming class and stream generator function
[FEATURE] Initial commit

Fixes:

[FIX] Array dimensions, ChannelsList passdown and typos
[FIX] freq_to_band, therefore filtering, now works for any nthOct
[FIX] Functions out of scope
[FIX] Number of colums
[FIX] Typos
[FIX] PEP8, Typos and FRFMeasure load
[FIX][EXAMPLE] Changed if statement to try-except block on exit() function
[FIX] Added stream.close() call to exit() method
[FIX] Audio player example works inside Spyder
[FIX] Typos and namings
[FIX] delete unwanted files
[FIX] .gitignore
[FIX] White spaces
[FIX] PyTTa version
[FIX][FEATURE] Code improvement, added reset method to Streaming
[FIX] classes.py fully compliant with PEP 8
[FIX] changes on imports to generate documentation
[FIX] docs and .DS file

Simple compatibility release.