sofar 1.2.1__py3-none-any.whl

sofar/utils.py

@@ -0,0 +1,316 @@
+"""Contains util functions to work with sofar and Sofa objects."""
+import os
+import glob
+import numpy as np
+import numpy.testing as npt
+import warnings
+import sofar as sf
+
+
+def version():
+    """Return version of sofar and SOFA conventions."""
+
+    sofa_conventions = os.path.join(
+        os.path.dirname(__file__), "sofa_conventions", 'VERSION')
+    with open(sofa_conventions) as file:
+        sofa_conventions = file.readline().strip()
+
+    return (f"sofar v{sf.__version__} implementing "
+            f"SOFA standard {sofa_conventions}")
+
+
+def _verify_convention_and_version(version, convention):
+    """
+    Verify if convention and version exist. Raise a Value error if it does not.
+
+    Parameters
+    ----------
+    version : str
+        The version to be checked
+    convention : str
+        The name of the convention to be checked
+    """
+
+    # check if the convention exists
+    if convention not in _get_conventions("name"):
+        raise ValueError(
+            f"Convention '{convention}' does not exist")
+
+    name_version = _get_conventions("name_version")
+
+    # check which version is wanted
+    version_exists = False
+    for versions in name_version:
+        # check if convention and version match
+        if versions[0] == convention \
+                and str(float(versions[1])) == version:
+            version_exists = True
+
+    if not version_exists:
+        raise ValueError((
+            f"{convention} v{version} is not a valid SOFA Convention."
+            "If you are trying to read the data use "
+            "sofar.read_sofa_as_netcdf(). Call sofar.list_conventions() for a "
+            "list of valid Conventions"))
+
+
+def list_conventions():
+    """
+    List available SOFA conventions by printing to the console.
+    """
+    print(_get_conventions("string"))
+
+
+def _get_conventions(return_type, conventions_path=None):
+    """
+    Get available SOFA conventions.
+
+    Parameters
+    ----------
+    return_type : string, optional
+        ``'path'``
+            Return a list with the full paths and filenames of the convention
+            files (json files)
+        ``'path_source'``
+            Return a list with the full paths and filenames of the source
+            convention files from API_MO (csv files)
+        ``'name'``
+            Return a list of the convention names without version
+        ``'name_version'``
+            Return a list of tuples containing the convention name and version.
+        ``'string'``
+            Returns a string that lists the names and versions of all
+            conventions.
+    conventions_path : str, optional
+        The path to the the `conventions` folder containing the csv and json
+        files.
+
+    Returns
+    -------
+    See parameter `return_type`.
+    """
+    # directory containing the SOFA conventions
+    if conventions_path is None:
+        conventions_path = os.path.join(
+            os.path.dirname(__file__), "sofa_conventions", 'conventions')
+
+    reg_str = "*.csv" if return_type == "path_source" else "*.json"
+
+    # SOFA convention files
+    standardized = list(glob.glob(os.path.join(conventions_path, reg_str)))
+    deprecated = list(
+        glob.glob(os.path.join(conventions_path, "deprecated", reg_str)))
+    paths = standardized + deprecated
+
+    conventions_str = "Available SOFA conventions:\n"
+
+    conventions = []
+    versions = []
+    for path in paths:
+        fileparts = os.path.basename(path).split(sep="_")
+        conventions += [fileparts[0]]
+        versions += [fileparts[1][:-5]]
+        conventions_str += f"{conventions[-1]} (Version {versions[-1]})\n"
+
+    if return_type is None:
+        return
+    elif return_type.startswith("path"):
+        return paths
+    elif return_type == "name":
+        return conventions
+    elif return_type == "name_version":
+        return list(zip(conventions, versions))
+    elif return_type == "string":
+        return conventions_str
+    else:
+        raise ValueError(f"return_type {return_type} is invalid")
+
+
+def equals(sofa_a, sofa_b, verbose=True, exclude=None):
+    """
+    Compare two SOFA objects against each other.
+
+    Parameters
+    ----------
+    sofa_a : Sofa
+        SOFA object
+    sofa_b : Sofa
+        SOFA object
+    verbose : bool, optional
+        Print differences to the console. The default is True.
+    exclude : str, optional
+        Specify what fields should be excluded from the comparison
+
+        ``'GLOBAL'``
+            Exclude all global attributes, i.e., fields starting with 'GLOBAL:'
+        ``'DATE'``
+            Exclude date attributes, i.e., fields that contain 'Date'
+        ``'ATTR'``
+            Exclude all attributes, i.e., fields that contain ':'
+
+        The default is None, which does not exclude anything.
+
+    Returns
+    -------
+    is_identical : bool
+        ``True`` if sofa_a and sofa_b are identical, ``False`` otherwise.
+    """
+
+    is_identical = True
+
+    # get and filter keys
+    # ('_*' are SOFA object private variables, '__' are netCDF attributes)
+    keys_a = [k for k in sofa_a.__dict__.keys() if not k.startswith("_")]
+    keys_b = [k for k in sofa_b.__dict__.keys() if not k.startswith("_")]
+
+    if exclude is not None:
+        if exclude.upper() == "GLOBAL":
+            keys_a = [k for k in keys_a if not k.startswith("GLOBAL_")]
+            keys_b = [k for k in keys_b if not k.startswith("GLOBAL_")]
+        elif exclude.upper() == "ATTR":
+            keys_a = [k for k in keys_a if
+                      sofa_a._convention[k]["type"] != "attribute"]
+            keys_b = [k for k in keys_b if
+                      sofa_b._convention[k]["type"] != "attribute"]
+        elif exclude.upper() == "DATE":
+            keys_a = [k for k in keys_a if "Date" not in k]
+            keys_b = [k for k in keys_b if "Date" not in k]
+        else:
+            raise ValueError(
+                f"exclude is {exclude} but must be GLOBAL, DATE, or ATTR")
+
+    # check for equal length
+    if len(keys_a) != len(keys_b):
+        return _equals_raise_warning((
+            f"not identical: sofa_a has {len(keys_a)} attributes for "
+            f"comparison and sofa_b has {len(keys_b)}."), verbose)
+
+    # check if the keys match
+    if set(keys_a) != set(keys_b):
+        return _equals_raise_warning(
+            "not identical: sofa_a and sofa_b do not have the ame attributes",
+            verbose)
+
+    # compare the data inside the SOFA object
+    for key in keys_a:
+
+        # get data and types
+        a = getattr(sofa_a, key)
+        b = getattr(sofa_b, key)
+        type_a = sofa_a._convention[key]["type"]
+        type_b = sofa_b._convention[key]["type"]
+
+        # compare attributes
+        if type_a == "attribute" and type_b == "attribute":
+
+            # compare
+            if a != b:
+                is_identical = _equals_raise_warning(
+                    f"not identical: different values for {key}", verbose)
+
+        # compare double variables
+        elif type_a == "double" and type_b == "double":
+
+            try:
+                npt.assert_allclose(np.squeeze(a), np.squeeze(b))
+            except AssertionError:
+                is_identical = _equals_raise_warning(
+                    "not identical: different values for {key}", verbose)
+
+        # compare string variables
+        elif type_a == "string" and type_b == "string":
+            try:
+                assert np.all(
+                    np.squeeze(a).astype("S") == np.squeeze(b).astype("S"))
+            except AssertionError:
+                is_identical = _equals_raise_warning(
+                    "not identical: different values for {key}", verbose)
+        else:
+            is_identical = _equals_raise_warning(
+                (f"not identical: {key} has different data types "
+                 f"({type_a}, {type_b})"), verbose)
+
+    return is_identical
+
+
+def _equals_raise_warning(message, verbose):
+    if verbose:
+        warnings.warn(message, stacklevel=2)
+    return False
+
+
+def _atleast_nd(array, ndim):
+    """
+    Get numpy array with specified number of dimensions. Dimensions are
+    appended at the end if ndim > 3.
+    """
+    try:
+        array = array.copy()
+    except AttributeError:
+        array = array
+
+    if ndim == 1:
+        array = np.atleast_1d(array)
+    if ndim == 2:
+        array = np.atleast_2d(array)
+    if ndim >= 3:
+        array = np.atleast_3d(array)
+    for _ in range(ndim - array.ndim):
+        array = array[..., np.newaxis]
+    return array
+
+
+def _nd_newaxis(array, ndim):
+    """Append dimensions to the end of an array until array.ndim == ndim."""
+    array = np.array(array)
+
+    for _ in range(ndim - array.ndim):
+        array = array[..., np.newaxis]
+    return array
+
+
+def _complete_sofa(convention="GeneralTF"):
+    """
+    Generate SOFA file with all required data for testing verification rules.
+    """
+
+    sofa = sf.Sofa(convention)
+    # Listener meta data
+    sofa.add_variable("ListenerView", [1, 0, 0], "double", "IC")
+    sofa.add_attribute("ListenerView_Type", "cartesian")
+    sofa.add_attribute("ListenerView_Units", "metre")
+    sofa.add_variable("ListenerUp", [0, 0, 1], "double", "IC")
+    # Receiver meta data
+    sofa.add_variable("ReceiverView", [1, 0, 0], "double", "IC")
+    sofa.add_attribute("ReceiverView_Type", "cartesian")
+    sofa.add_attribute("ReceiverView_Units", "metre")
+    sofa.add_variable("ReceiverUp", [0, 0, 1], "double", "IC")
+    # Source meta data
+    sofa.add_variable("SourceView", [1, 0, 0], "double", "IC")
+    sofa.add_attribute("SourceView_Type", "cartesian")
+    sofa.add_attribute("SourceView_Units", "metre")
+    sofa.add_variable("SourceUp", [0, 0, 1], "double", "IC")
+    # Emitter meta data
+    sofa.add_variable("EmitterView", [1, 0, 0], "double", "IC")
+    sofa.add_attribute("EmitterView_Type", "cartesian")
+    sofa.add_attribute("EmitterView_Units", "metre")
+    sofa.add_variable("EmitterUp", [0, 0, 1], "double", "IC")
+    sofa.add_attribute("GLOBAL_EmitterDescription", "what an emitter")
+    sofa.add_variable("EmitterDescriptions", ["emitter array"], "string", "MS")
+    # Room meta data
+    sofa.add_attribute("GLOBAL_RoomShortName", "Hall")
+    sofa.add_attribute("GLOBAL_RoomDescription", "Wooden floor")
+    sofa.add_attribute("GLOBAL_RoomLocation", "some where nice")
+    sofa.add_variable("RoomTemperature", 0, "double", "I")
+    sofa.add_attribute("RoomTemperature_Units", "kelvin")
+    sofa.add_attribute("GLOBAL_RoomGeometry", "some/file")
+    sofa.add_variable("RoomVolume", 200, "double", "I")
+    sofa.add_attribute("RoomVolume_Units", "cubic metre")
+    sofa.add_variable("RoomCornerA", [0, 0, 0], "double", "IC")
+    sofa.add_variable("RoomCornerB", [1, 1, 1], "double", "IC")
+    sofa.add_variable("RoomCorners", 0, "double", "I")
+    sofa.add_attribute("RoomCorners_Type", "cartesian")
+    sofa.add_attribute("RoomCorners_Units", "metre")
+
+    sofa.verify()
+    return sofa

sofar-1.2.1.dist-info/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021, The pyfar developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

sofar-1.2.1.dist-info/METADATA

@@ -0,0 +1,136 @@
+Metadata-Version: 2.1
+Name: sofar
+Version: 1.2.1
+Summary: Maybe the most complete python package for SOFA files so far.
+Author-email: The pyfar developers <info@pyfar.org>
+License: MIT License
+        
+        Copyright (c) 2021, The pyfar developers
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+        
+Project-URL: Tracker, https://github.com/pyfar/sofar/issues
+Project-URL: Documentation, https://sofar.readthedocs.io/
+Project-URL: Download, https://pypi.org/project/sofar/
+Project-URL: Homepage, https://pyfar.org/
+Project-URL: Source, https://github.com/pyfar/sofar
+Project-URL: Changelog, https://github.com/pyfar/sofar/blob/main/HISTORY.rst
+Keywords: acoustics,pyfar
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: netCDF4
+Requires-Dist: numpy>=1.14.0
+Requires-Dist: beautifulsoup4
+Requires-Dist: requests
+Provides-Extra: deploy
+Requires-Dist: twine; extra == "deploy"
+Requires-Dist: wheel; extra == "deploy"
+Requires-Dist: build; extra == "deploy"
+Requires-Dist: setuptools; extra == "deploy"
+Requires-Dist: bump-my-version; extra == "deploy"
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: watchdog; extra == "tests"
+Requires-Dist: ruff==0.8.2; extra == "tests"
+Requires-Dist: coverage; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: autodocsumm>=0.2.14; extra == "docs"
+Requires-Dist: pydata-sphinx-theme; extra == "docs"
+Requires-Dist: sphinx_mdinclude; extra == "docs"
+Requires-Dist: sphinx-design; extra == "docs"
+Requires-Dist: sphinx-favicon; extra == "docs"
+Requires-Dist: sphinx-reredirects; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: sofar[deploy,docs,tests]; extra == "dev"
+
+<h1 align="center">
+<img src="https://github.com/pyfar/gallery/raw/main/docs/resources/logos/pyfar_logos_fixed_size_sofar.png" width="300">
+</h1><br>
+
+[![PyPI version](https://badge.fury.io/py/sofar.svg)](https://badge.fury.io/py/sofar)
+[![Documentation Status](https://readthedocs.org/projects/sofar/badge/?version=latest)](https://sofar.readthedocs.io/en/latest/?badge=latest)
+[![CircleCI](https://circleci.com/gh/pyfar/sofar.svg?style=shield)](https://circleci.com/gh/pyfar/sofar)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/sofar_introduction.ipynb)
+
+Sofar is maybe the most complete Python package for the SOFA file format so
+far. SOFA files store spatially distributed acoustic data such as impulse
+responses or transfer functions. They are defined by the AES69-2022 standard
+(see references). These are the key features of sofar
+
+- Read, edit, and write SOFA files
+- Add custom attributes to SOFA files
+- Full Verification of the content of a SOFA files against AES69-2022
+- Upgrade data that uses outdated SOFA conventions
+- Open license allows unrestricted use
+- sofar is tested using continuous integration on
+- Uses a complete definition of the AES69-2022 standard (see references) maintained at [sofa_conventions](https://github.com/pyfar/sofa_conventions)
+
+Getting Started
+===============
+
+The [sofar and SOFA notebook](https://pyfar-gallery.readthedocs.io/en/latest/gallery/interactive/sofar_introduction.html)
+gives an overview of the most important sofar functionality and is a good starting point. For processing and visualizing data
+inside SOFA files, we recommend the [pyfar package](https://pyfar.readthedocs.io) that can read SOFA files through
+`pyfar.io.read_sofa` and the in-depth examples contained in the
+[pyfar example gallery](https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html). Check out
+[read the docs](https://sofar.readthedocs.io) for a complete documentation of sofar. A more detailed introduction to the SOFA
+file format is given by Majdak et. al. 2022 (see references below). All information is also bundled at [pyfar.org](https://pyfar.org).
+
+Installation
+============
+
+Use pip to install sofar
+
+    pip install sofar
+
+
+(Requires Python >= 3.8)
+
+If the installation fails, please check out the [help section](https://pyfar-gallery.readthedocs.io/en/latest/help).
+
+Contributing
+============
+
+Refer to the [contribution guidelines](https://sofar.readthedocs.io/en/stable/contributing.html) for more information.
+
+References
+==========
+
+AES69-2022: *AES standard for file exchange - Spatial acoustic data file
+format*, Audio Engineering Society, Inc., New York, NY, USA.
+(https://www.aes.org/publications/standards/search.cfm?docID=99)
+
+P. Majdak, F. Zotter, F. Brinkmann, J. De Muynke, M. Mihocic, and M.
+Noisternig, "Spatially Oriented Format for Acoustics 2.1: Introduction and
+Recent Advances", *J. Audio Eng. Soc.*, vol. 70, no. 7/8, pp. 565-584,
+Jul. 2022. DOI: https://doi.org/10.17743/jaes.2022.0026

sofar-1.2.1.dist-info/RECORD

@@ -0,0 +1,105 @@
+docs/Makefile,sha256=OYY1k1pc-qybE8cc8J65Uumpst0kiq55ct3gjLaWeJU,606
+docs/api_reference.rst,sha256=s3tvYCr2vktN05sSyIhzt1BNktV13SnfU-Cz4fDmf5o,705
+docs/conf.py,sha256=JLiZhmxpMXTnK3KPposuhV96J5smR5xzgONt-aTCn_M,5299
+docs/contributing.rst,sha256=h9XHQ0lx_ySKgXQmwqhJQLPD7VElHdyu1ruKfYWvrYA,33
+docs/history.rst,sha256=6GtKybnFdujxXakMcb0LHcrFsWwqRh8JJ_xhO_Qxqdg,28
+docs/index.rst,sha256=TNHSWTiFrI_R7vn1E2XM2RTx3YEg8KuSzwAY9ttDdWc,37
+docs/make.bat,sha256=wLZX2GGllVCJQSJ93BGGGHkLEsy6JC_I7u6xRKG3CtA,803
+docs/readme.rst,sha256=ctYl-VOckbYAd-QhoWKIKS2C1kErl9plJWaPraZkfjY,28
+docs/sofar.rst,sha256=uJ_NCeXUJKFURnuQCZbKON7JwbbTdAFSlrb--symugo,1479
+docs/resources/conventions.py,sha256=4ewEa-AGBkem-VWbfUbXWMy6UUv3DFu2cGETPo89GCc,6052
+docs/resources/working_with_sofa_HRIR_lateral.png,sha256=VpNNtT52Jsl6ymrY9bs1mbNWyCg9S0Ewi1I0CSHB4aE,42425
+docs/resources/working_with_sofa_source_horizontal.png,sha256=rKvTCt4j_JtR1JGHPSu1pIySNTAH-PRog0hMOjBQXLM,125698
+docs/resources/working_with_sofa_source_lateral.png,sha256=H1VhLtBOjJV6m62fN2vrMzoq6NTOYLmLUfIQLHqL49I,140443
+sofar/__init__.py,sha256=ADa6pEg3ehw9Zy6ExRztvtCjrcwDkU4DUBrlQ3v12jE,688
+sofar/io.py,sha256=kN8BcofSYb2Ew5NfBEN-C72wxep9Qw9s5Dmpypprnp8,16053
+sofar/sofa.py,sha256=yIl00ekMthqJPmpiujfM-Hlb4IuqOpcGPQcIRJA8DW0,69887
+sofar/sofastream.py,sha256=OAHC4nzzR7a4uksUeMawYGMzCNBQQg2gk7PK20Rn6xo,9988
+sofar/update_conventions.py,sha256=XKylP9n7vRiJUOg4HBZXmDut_MbgNZ9-HZUs52xACtc,18137
+sofar/utils.py,sha256=_3dH_fUBLmVlD6DD4Zc7akXk-lTY0DAPJzS4DnX0iyo,10838
+sofar/sofa_conventions/VERSION,sha256=IuQRql5P3qfPUQuJwuh-RX5TvI_Wd4bDdSm8VLNQqds,34
+sofar/sofa_conventions/write_upgrade_rules.py,sha256=7I2UlOwtuYfpV3L14zehZH0TZ2Kz9cxYz1fxgfg124w,4805
+sofar/sofa_conventions/write_verification_data.py,sha256=vIE7UQRGlUziCeNv3kwV5CtELXh9h-_AWFsbEsn-g1M,10767
+sofar/sofa_conventions/write_verification_rules.py,sha256=oOrgDA7tOgnymtXmDih7s7XiRj28Xkj--A8ihaOFRM0,13871
+sofar/sofa_conventions/conventions/AnnotatedEmitterAudio_0.2.csv,sha256=q1fOy9QqskNjsV2b-rn9GDTThOo-AUKGORMmXSgp83w,2348
+sofar/sofa_conventions/conventions/AnnotatedEmitterAudio_0.2.json,sha256=lznoLbG6HYvPAZ-alVoWgfBXHFDeMb0PNnyOWoag3-Y,8420
+sofar/sofa_conventions/conventions/AnnotatedReceiverAudio_0.2.csv,sha256=MHBEkaSfiHm-d-8EAqL40M-0wt8couJfO2Q-Ff4SoEs,2360
+sofar/sofa_conventions/conventions/AnnotatedReceiverAudio_0.2.json,sha256=2Wf1XgP4BNhI1lNlgnFabX6mUC2pT0IGLW92mjY82hY,8432
+sofar/sofa_conventions/conventions/FreeFieldDirectivityTF_1.1.csv,sha256=Wait37FTh6ROKgpX7-JsVM-ohtKfsdHjxVL5vN7uTTs,5510
+sofar/sofa_conventions/conventions/FreeFieldDirectivityTF_1.1.json,sha256=sm8Pj_Z1n1tW2jYlu00eikR3yCcANEm_Kw5Eq9jrbw4,13138
+sofar/sofa_conventions/conventions/FreeFieldHRIR_1.0.csv,sha256=C_fc7wHjBLc2krPja33sQaDSZDvlr80GSsgOj904GBY,2479
+sofar/sofa_conventions/conventions/FreeFieldHRIR_1.0.json,sha256=-777Wo-fgKq844AwxIlompmIF9rHLRXWIAJjgaqADdU,8127
+sofar/sofa_conventions/conventions/FreeFieldHRTF_1.0.csv,sha256=BbE417cDQ6eQ8UFl3MVWv9SatQ2OHZ7UF7u_ZCfCoBk,2222
+sofar/sofa_conventions/conventions/FreeFieldHRTF_1.0.json,sha256=aN7x7UU-HkT5a-cVmJ29IXP1h_8DFsyInsbWFm65oVk,7996
+sofar/sofa_conventions/conventions/GeneralFIR-E_2.0.csv,sha256=daSPbImANSYn5rIHQkn6fdD3kE0Z-wq9iyCGfMEroGY,1998
+sofar/sofa_conventions/conventions/GeneralFIR-E_2.0.json,sha256=ERs0oQrZL2JLQOcFE7umPIOIMqm2pQy_lOA8UPtLg18,6615
+sofar/sofa_conventions/conventions/GeneralFIR_1.0.csv,sha256=HInvJ980U9wtu2QUT9JZ3rUlR7Qfi2yzgZb4j3q6n58,2011
+sofar/sofa_conventions/conventions/GeneralFIR_1.0.json,sha256=dmVz1aTMv-9EKO9NwzTbWq-QU-uOa9d-zhS4ScKhDLU,7054
+sofar/sofa_conventions/conventions/GeneralSOS_1.0.csv,sha256=3JzYYRULpd8WmCC0Mze6wTzr7PluwEjy6lxt74VDsow,2130
+sofar/sofa_conventions/conventions/GeneralSOS_1.0.json,sha256=3FYXzhcb2jJFjlKFlF60Uv_82boZUNbfSVlS54It8xM,7357
+sofar/sofa_conventions/conventions/GeneralTF-E_1.0.csv,sha256=lztME1Skiac-Bj1OctWuQ05_THozrPzil6a01F9PufI,2015
+sofar/sofa_conventions/conventions/GeneralTF-E_1.0.json,sha256=bQZn8O67anSvZJgo7PkIP9TaPprBlhqPmzpp6dy8LQY,6757
+sofar/sofa_conventions/conventions/GeneralTF_1.0.csv,sha256=RD1aXHuRIECKkHDZm0cLyRp-m32-hg_hRxNegdJnttc,1956
+sofar/sofa_conventions/conventions/GeneralTF_1.0.json,sha256=mPbpQcfEeJt2lKJODGgEgusDOzLU3HbmD3Fr6LbXnt0,6696
+sofar/sofa_conventions/conventions/GeneralTF_2.0.csv,sha256=8fpM1wnY4YL9DbIwstrU5UCokh9rheiookSJYSMqKR8,1957
+sofar/sofa_conventions/conventions/GeneralTF_2.0.json,sha256=pn6V2AVJum8y0L0cpn3Kt5ostsmErjcF41_XeiPdk88,6699
+sofar/sofa_conventions/conventions/SimpleFreeFieldHRIR_1.0.csv,sha256=gZ_jA2hAdetCxgV3P-I9T3QTG7hNwogon0r1pKpv8iM,2239
+sofar/sofa_conventions/conventions/SimpleFreeFieldHRIR_1.0.json,sha256=ScZn_Jf9AI1o6gyFcdl5xFzdnvSfuMcdyG9GH5eOdDc,8446
+sofar/sofa_conventions/conventions/SimpleFreeFieldHRSOS_1.0.csv,sha256=YXI6K_HiGH6wVTr3QIUhhtKQRKD3uUaj56D6xzCYUzE,2303
+sofar/sofa_conventions/conventions/SimpleFreeFieldHRSOS_1.0.json,sha256=dG_O9QiWYrB8IkZD-z3W1GUJw8E_c7NT5CN4xOmhhwk,8254
+sofar/sofa_conventions/conventions/SimpleFreeFieldHRTF_1.0.csv,sha256=x7fyeLrub2clGMszUtv6v9lg2cF8hI-FzeAqJEimXyc,2015
+sofar/sofa_conventions/conventions/SimpleFreeFieldHRTF_1.0.json,sha256=HFNW4_1A3t1M6geUTUVLZrf7sAmhy59T47d__YXdylM,7791
+sofar/sofa_conventions/conventions/SimpleFreeFieldSOS_1.0.csv,sha256=YphFfFEwTSosaYOTbUv2gz-Pb5yrQv7AFVZuXh-WUjM,2298
+sofar/sofa_conventions/conventions/SimpleFreeFieldSOS_1.0.json,sha256=SILNWPWs3JFVtnDvKDpyZ3RBGboD8SWaqmaT83EUb7w,8249
+sofar/sofa_conventions/conventions/SimpleHeadphoneIR_1.0.csv,sha256=7B_ijKN7AVftugYTvCCM8n76ofs8gCWkBvFc_9D-STk,3103
+sofar/sofa_conventions/conventions/SimpleHeadphoneIR_1.0.json,sha256=pUUme-CuoipR06Yi26yfntWwMMWs7wrriqseg6NPK2M,9863
+sofar/sofa_conventions/conventions/SingleRoomMIMOSRIR_1.0.csv,sha256=2OzG5t9rYzDrywP__99ylHmyAM9Mjx758jO5dudv0Jc,4053
+sofar/sofa_conventions/conventions/SingleRoomMIMOSRIR_1.0.json,sha256=5tjPriXZk8WEIr15i41L7hQRwAxzw_gA0nxWkZfe_7g,14346
+sofar/sofa_conventions/conventions/SingleRoomSRIR_1.0.csv,sha256=l7aeLNxbOyXgfQIjCo3QzpRpBonMp9ssfhps4fejHxc,4199
+sofar/sofa_conventions/conventions/SingleRoomSRIR_1.0.json,sha256=gVwyzGni9e3w5wehnxe6Oe5knO2Np5doHYLzRsfrlfc,14491
+sofar/sofa_conventions/conventions/deprecated/AnnotatedEmitterAudio_0.1.csv,sha256=pHwICgmCtMNdGBHPItuydYuX32myAEqCWtGSKBJR8_s,2355
+sofar/sofa_conventions/conventions/deprecated/AnnotatedEmitterAudio_0.1.json,sha256=p-WppnTuOaEFj0WlKxiM47H92pmHkIFZ9jX6TV0iLQE,8403
+sofar/sofa_conventions/conventions/deprecated/AnnotatedReceiverAudio_0.1.csv,sha256=A8doF2goKhvf1QumQOx-k_MsZKVJRHZiRbYCAXjxrTI,2367
+sofar/sofa_conventions/conventions/deprecated/AnnotatedReceiverAudio_0.1.json,sha256=dzSUPEqXT0BG0TeTa7r4zZJS01le1dJTdftBOgUXV18,8415
+sofar/sofa_conventions/conventions/deprecated/FreeFieldDirectivityTF_1.0.csv,sha256=Ha6178_LxRod-L2UcI7SX3o6Cf1YRFs1zgIpn0kd0rA,5125
+sofar/sofa_conventions/conventions/deprecated/FreeFieldDirectivityTF_1.0.json,sha256=GcOb3cbv63C7S4cJ7IVvU7NAAd1h8mA7RHaAFQ_jqz8,12627
+sofar/sofa_conventions/conventions/deprecated/GeneralFIRE_1.0.csv,sha256=2_ed7Y0CGJmCx9V3X7L4gipJ94nLzH7Jl9fXXtI7rLQ,1988
+sofar/sofa_conventions/conventions/deprecated/GeneralFIRE_1.0.json,sha256=y3A1fhyS4XUAIbEGv92pwrYp01HutgIKajI4WmJYYKQ,6603
+sofar/sofa_conventions/conventions/deprecated/MultiSpeakerBRIR_0.3.csv,sha256=E_jW15CNWUsp5W9Uw2EbNNyvDxDMFvs-CAELDmYtp0I,2560
+sofar/sofa_conventions/conventions/deprecated/MultiSpeakerBRIR_0.3.json,sha256=PBC2SOliEORqJpuSweO77_tePFBVVoJ6zZ_COUNrZME,8884
+sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldHRIR_0.4.csv,sha256=WQRiDw51jZK9yGyfCtUVGpKbi0FMl-BtG2yn-5s5AME,2093
+sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldHRIR_0.4.json,sha256=sGWA33puXRpPmoMOZfBT0SgbLGIJIACNcxsJdACmKKY,7704
+sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldTF_0.4.csv,sha256=lHINbpcuvHBNsAOL6KGWPy3SMEHorFcovgafXivBt0w,1989
+sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldTF_0.4.json,sha256=RIAUjtb5QvLn3dny_b4uxdsHXD0nkxbK49w4RiJslJI,7770
+sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldTF_1.0.csv,sha256=nzm1DDWj3blCljLFQZ1K2OU_GKgkW9x0Ow638aL_cys,2028
+sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldTF_1.0.json,sha256=aXc5prNxJslNt6ESYACRHhzUxMWa80rDhvChRxGSoDM,7770
+sofar/sofa_conventions/conventions/deprecated/SimpleHeadphoneIR_0.1.csv,sha256=eADQZ2qv5odeUMQsgc8YZQQA5sRN-2M3Ym5LnGrbI_E,3153
+sofar/sofa_conventions/conventions/deprecated/SimpleHeadphoneIR_0.1.json,sha256=5AUrkT4s-FMFkqbVEiak7YKugtzwb0iU7o3XuYbNtYs,9870
+sofar/sofa_conventions/conventions/deprecated/SimpleHeadphoneIR_0.2.csv,sha256=sBlw9J3Clix0b7aPRo-uQntM43pqBlqSG00OHJ_i7OM,3153
+sofar/sofa_conventions/conventions/deprecated/SimpleHeadphoneIR_0.2.json,sha256=fHK0c3DUTvAUxOAKC1LuJZlxSyKoSjF0HpJkkpUYCyA,9870
+sofar/sofa_conventions/conventions/deprecated/SingleRoomDRIR_0.2.csv,sha256=JsPEm-KgQ_b_2nGzVys4jnJTSedSQtcoOk1x31ycqLE,2045
+sofar/sofa_conventions/conventions/deprecated/SingleRoomDRIR_0.2.json,sha256=oR-qubagKs28ICI7243Ep2zX0AFn_8lvYPNPseg16O8,8097
+sofar/sofa_conventions/conventions/deprecated/SingleRoomDRIR_0.3.csv,sha256=l6PAKjsNuaFHVUlT4rVdZY9Pj7nh_jF8d82i5YSbkss,1999
+sofar/sofa_conventions/conventions/deprecated/SingleRoomDRIR_0.3.json,sha256=ccCvFNWYwATIRCPxQke73ckogc2Y3hBP97_JOtPusns,8097
+sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.1.csv,sha256=Vjx7u0MaYsUFbzKPKgAWxeT9iqqNC5gF_P6RqG-dd78,2397
+sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.1.json,sha256=XE2ai8ybHxzrWKDUooE7LpBoiFS3pf-5RiG17Jy08E0,8650
+sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.2.csv,sha256=svRCzuJl_wR8Y1LUS7O_N1KkWtxTB8lrhQXBi7uif60,2727
+sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.2.json,sha256=g64b-uuzPlm_nXvoRgMxcydDTq5LSsX3mmeFN-tl6-w,9531
+sofar/sofa_conventions/rules/deprecations.json,sha256=adYMivYOicwuAUFAsoiDcGHdhre5ZqNOhIe9BX2mM7M,534
+sofar/sofa_conventions/rules/rules.json,sha256=45fbAzUczWYSpZZj7A15psx2Rh77xz56eT2CagKrwts,23096
+sofar/sofa_conventions/rules/unit_aliases.json,sha256=QXgOfpe8bnmUybVhSSj3nIUYw50CAVehh7sdFNPFl0k,212
+sofar/sofa_conventions/rules/upgrade.json,sha256=0o9sTQELnEUXl_teZLjO1Azx7yqrTHmYzT8_7VB9LtM,6025
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/conftest.py,sha256=3J_BsyJ-_L5145UY_17pb56AptLZr62QFt-zhzE0OE8,738
+tests/test_deprecations.py,sha256=mIlI1utzIiisKrerd9gZjxVLy2N5l2Jtg9dpWuJ0o7M,610
+tests/test_io.py,sha256=Xpg9Or9z-91lm6n9-fZXVoyx5CZpgWZ7unJ0wtN3-0Q,12112
+tests/test_sofa.py,sha256=YcG1BlA2_6IrE9RvcHcUh2k_XtoRP8nWjLiMbgkqUK0,11450
+tests/test_sofa_upgrade_conventions.py,sha256=bZbatBojTSRkJDFK-VCohkZqvVV7j8cOBC2qVzNFYU4,3726
+tests/test_sofa_verify.py,sha256=D0_mcv5h-4OE198URWWOuFrp4bpqrLWQZ7wOP80PbYI,16074
+tests/test_sofastream.py,sha256=tdTX6qxaUY3bX5pVcHpJxASuLj2k2aqtL1Qyu7hPc24,3905
+tests/test_utils.py,sha256=edpDH6AqwlBp3l8hw_4THLN4yhHfp8Ih61pVyIAiAVU,8825
+sofar-1.2.1.dist-info/LICENSE,sha256=OOdX8H69BDppTN8KCBp8l2_yDbH6sW-YuSEKDgZPuL4,1079
+sofar-1.2.1.dist-info/METADATA,sha256=WXrHLyWVmwqHGsDP-wVZFcAsSa6o_bHUey9GkQzx4kQ,6433
+sofar-1.2.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+sofar-1.2.1.dist-info/top_level.txt,sha256=5YyQsRMOJOaaykMzffbmmHklMAiAw8g1BWOcLxiN110,17
+sofar-1.2.1.dist-info/RECORD,,

sofar-1.2.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.6.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sofar-1.2.1.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+docs
+sofar
+tests

tests/conftest.py

@@ -0,0 +1,27 @@
+import pytest
+import numpy as np
+import sofar as sf
+
+
+# Temporary SOFA-file
+@pytest.fixture
+def temp_sofa_file(tmp_path_factory):
+    """
+    Temporary small SOFA file.
+    To be used when data needs to be read from a SOFA file for testing.
+    Contains custom data for "Data_IR", "GLOBAL_RoomType" and
+    "Data_SamplingRate_Units".
+
+    Returns
+    -------
+    filename : SOFA file
+        Filename of temporary SOFA file
+    """
+
+    filename = tmp_path_factory.mktemp("data") / "test_sofastream.sofa"
+    sofa = sf.Sofa("SimpleFreeFieldHRIR")
+    sofa.Data_IR = np.array([[0, 1], [2, 3], [4, 5]])
+    sofa.GLOBAL_RoomType = "free field"
+    sofa.Data_SamplingRate_Units = "hertz"
+    sf.write_sofa(filename, sofa)
+    return filename

tests/test_deprecations.py

@@ -0,0 +1,19 @@
+import pytest
+from packaging import version
+import re
+import sofar as sf
+
+
+# deprecate in 1.3.0 ----------------------------------------------------------
+def test_pad_zero_modi():
+    with pytest.warns(
+            UserWarning,
+            match=re.escape('Sofa.info() will be deprecated in sofar 1.3.0')):
+        sofa = sf.Sofa('GeneralTF')
+        sofa.info()
+
+    if version.parse(sf.__version__) >= version.parse('1.3.0'):
+        sofa = sf.Sofa('GeneralTF')
+        with pytest.raises(AttributeError, match='has no attribute'):
+            # remove Sofa.info() from pyfar 1.3.0!
+            sofa.info()