PyPI - sofar - Versions diffs - 1.2.1__py3-none-any.whl - Mend

sofar 1.2.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (105) hide show

docs/Makefile +20 -0
docs/api_reference.rst +20 -0
docs/conf.py +167 -0
docs/contributing.rst +1 -0
docs/history.rst +1 -0
docs/index.rst +4 -0
docs/make.bat +36 -0
docs/readme.rst +1 -0
docs/resources/conventions.py +162 -0
docs/resources/working_with_sofa_HRIR_lateral.png +0 -0
docs/resources/working_with_sofa_source_horizontal.png +0 -0
docs/resources/working_with_sofa_source_lateral.png +0 -0
docs/sofar.rst +82 -0
sofar/__init__.py +28 -0
sofar/io.py +427 -0
sofar/sofa.py +1835 -0
sofar/sofa_conventions/VERSION +1 -0
sofar/sofa_conventions/conventions/AnnotatedEmitterAudio_0.2.csv +46 -0
sofar/sofa_conventions/conventions/AnnotatedEmitterAudio_0.2.json +353 -0
sofar/sofa_conventions/conventions/AnnotatedReceiverAudio_0.2.csv +46 -0
sofar/sofa_conventions/conventions/AnnotatedReceiverAudio_0.2.json +353 -0
sofar/sofa_conventions/conventions/FreeFieldDirectivityTF_1.1.csv +59 -0
sofar/sofa_conventions/conventions/FreeFieldDirectivityTF_1.1.json +444 -0
sofar/sofa_conventions/conventions/FreeFieldHRIR_1.0.csv +43 -0
sofar/sofa_conventions/conventions/FreeFieldHRIR_1.0.json +333 -0
sofar/sofa_conventions/conventions/FreeFieldHRTF_1.0.csv +44 -0
sofar/sofa_conventions/conventions/FreeFieldHRTF_1.0.json +340 -0
sofar/sofa_conventions/conventions/GeneralFIR-E_2.0.csv +37 -0
sofar/sofa_conventions/conventions/GeneralFIR-E_2.0.json +270 -0
sofar/sofa_conventions/conventions/GeneralFIR_1.0.csv +40 -0
sofar/sofa_conventions/conventions/GeneralFIR_1.0.json +295 -0
sofar/sofa_conventions/conventions/GeneralSOS_1.0.csv +40 -0
sofar/sofa_conventions/conventions/GeneralSOS_1.0.json +306 -0
sofar/sofa_conventions/conventions/GeneralTF-E_1.0.csv +38 -0
sofar/sofa_conventions/conventions/GeneralTF-E_1.0.json +277 -0
sofar/sofa_conventions/conventions/GeneralTF_1.0.csv +38 -0
sofar/sofa_conventions/conventions/GeneralTF_1.0.json +277 -0
sofar/sofa_conventions/conventions/GeneralTF_2.0.csv +38 -0
sofar/sofa_conventions/conventions/GeneralTF_2.0.json +277 -0
sofar/sofa_conventions/conventions/SimpleFreeFieldHRIR_1.0.csv +47 -0
sofar/sofa_conventions/conventions/SimpleFreeFieldHRIR_1.0.json +369 -0
sofar/sofa_conventions/conventions/SimpleFreeFieldHRSOS_1.0.csv +43 -0
sofar/sofa_conventions/conventions/SimpleFreeFieldHRSOS_1.0.json +349 -0
sofar/sofa_conventions/conventions/SimpleFreeFieldHRTF_1.0.csv +44 -0
sofar/sofa_conventions/conventions/SimpleFreeFieldHRTF_1.0.json +340 -0
sofar/sofa_conventions/conventions/SimpleFreeFieldSOS_1.0.csv +43 -0
sofar/sofa_conventions/conventions/SimpleFreeFieldSOS_1.0.json +349 -0
sofar/sofa_conventions/conventions/SimpleHeadphoneIR_1.0.csv +51 -0
sofar/sofa_conventions/conventions/SimpleHeadphoneIR_1.0.json +396 -0
sofar/sofa_conventions/conventions/SingleRoomMIMOSRIR_1.0.csv +78 -0
sofar/sofa_conventions/conventions/SingleRoomMIMOSRIR_1.0.json +601 -0
sofar/sofa_conventions/conventions/SingleRoomSRIR_1.0.csv +78 -0
sofar/sofa_conventions/conventions/SingleRoomSRIR_1.0.json +601 -0
sofar/sofa_conventions/conventions/deprecated/AnnotatedEmitterAudio_0.1.csv +46 -0
sofar/sofa_conventions/conventions/deprecated/AnnotatedEmitterAudio_0.1.json +351 -0
sofar/sofa_conventions/conventions/deprecated/AnnotatedReceiverAudio_0.1.csv +46 -0
sofar/sofa_conventions/conventions/deprecated/AnnotatedReceiverAudio_0.1.json +351 -0
sofar/sofa_conventions/conventions/deprecated/FreeFieldDirectivityTF_1.0.csv +58 -0
sofar/sofa_conventions/conventions/deprecated/FreeFieldDirectivityTF_1.0.json +437 -0
sofar/sofa_conventions/conventions/deprecated/GeneralFIRE_1.0.csv +37 -0
sofar/sofa_conventions/conventions/deprecated/GeneralFIRE_1.0.json +270 -0
sofar/sofa_conventions/conventions/deprecated/MultiSpeakerBRIR_0.3.csv +48 -0
sofar/sofa_conventions/conventions/deprecated/MultiSpeakerBRIR_0.3.json +376 -0
sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldHRIR_0.4.csv +43 -0
sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldHRIR_0.4.json +333 -0
sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldTF_0.4.csv +44 -0
sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldTF_0.4.json +340 -0
sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldTF_1.0.csv +44 -0
sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldTF_1.0.json +340 -0
sofar/sofa_conventions/conventions/deprecated/SimpleHeadphoneIR_0.1.csv +51 -0
sofar/sofa_conventions/conventions/deprecated/SimpleHeadphoneIR_0.1.json +396 -0
sofar/sofa_conventions/conventions/deprecated/SimpleHeadphoneIR_0.2.csv +51 -0
sofar/sofa_conventions/conventions/deprecated/SimpleHeadphoneIR_0.2.json +396 -0
sofar/sofa_conventions/conventions/deprecated/SingleRoomDRIR_0.2.csv +47 -0
sofar/sofa_conventions/conventions/deprecated/SingleRoomDRIR_0.2.json +360 -0
sofar/sofa_conventions/conventions/deprecated/SingleRoomDRIR_0.3.csv +47 -0
sofar/sofa_conventions/conventions/deprecated/SingleRoomDRIR_0.3.json +360 -0
sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.1.csv +47 -0
sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.1.json +366 -0
sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.2.csv +51 -0
sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.2.json +397 -0
sofar/sofa_conventions/rules/deprecations.json +13 -0
sofar/sofa_conventions/rules/rules.json +819 -0
sofar/sofa_conventions/rules/unit_aliases.json +11 -0
sofar/sofa_conventions/rules/upgrade.json +226 -0
sofar/sofa_conventions/write_upgrade_rules.py +139 -0
sofar/sofa_conventions/write_verification_data.py +313 -0
sofar/sofa_conventions/write_verification_rules.py +356 -0
sofar/sofastream.py +301 -0
sofar/update_conventions.py +449 -0
sofar/utils.py +316 -0
sofar-1.2.1.dist-info/LICENSE +22 -0
sofar-1.2.1.dist-info/METADATA +136 -0
sofar-1.2.1.dist-info/RECORD +105 -0
sofar-1.2.1.dist-info/WHEEL +5 -0
sofar-1.2.1.dist-info/top_level.txt +3 -0
tests/__init__.py +0 -0
tests/conftest.py +27 -0
tests/test_deprecations.py +19 -0
tests/test_io.py +349 -0
tests/test_sofa.py +353 -0
tests/test_sofa_upgrade_conventions.py +111 -0
tests/test_sofa_verify.py +480 -0
tests/test_sofastream.py +127 -0
tests/test_utils.py +250 -0

sofar/sofa_conventions/conventions/deprecated/SingleTrackedAudio_0.2.json ADDED Viewed

@@ -0,0 +1,397 @@
+{
+    "GLOBAL:Conventions": {
+        "default": "SOFA",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:Version": {
+        "default": "2.1",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:SOFAConventions": {
+        "default": "SingleTrackedAudio",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:SOFAConventionsVersion": {
+        "default": "0.2",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:APIName": {
+        "default": "",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:APIVersion": {
+        "default": "",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:ApplicationName": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:ApplicationVersion": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:AuthorContact": {
+        "default": "",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:Comment": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:DataType": {
+        "default": "FIR",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:History": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:License": {
+        "default": "No license provided, ask the author for permission",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:Organization": {
+        "default": "",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:References": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:RoomType": {
+        "default": "free field",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:Origin": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:DateCreated": {
+        "default": "",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:DateModified": {
+        "default": "",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:Title": {
+        "default": "",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ListenerPosition": {
+        "default": [
+            0,
+            0,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": "Position of the head. IC if not tracked, MC if tracked."
+    },
+    "ListenerPosition:Type": {
+        "default": "cartesian",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ListenerPosition:Units": {
+        "default": "metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ReceiverPosition": {
+        "default": [
+            [
+                0,
+                0.09,
+                0
+            ],
+            [
+                0,
+                -0.09,
+                0
+            ]
+        ],
+        "flags": "m",
+        "dimensions": "IC, RC, RCM",
+        "type": "double",
+        "comment": "Position of the ears. RC if not tracked, RCM if tracked."
+    },
+    "ReceiverPosition:Type": {
+        "default": "cartesian",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ReceiverPosition:Units": {
+        "default": "metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "SourcePosition": {
+        "default": [
+            0,
+            0,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": "Position of the virtual ensemble. IC if not tracked, MC if tracked."
+    },
+    "SourcePosition:Type": {
+        "default": "cartesian",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "SourcePosition:Units": {
+        "default": "metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "EmitterPosition": {
+        "default": [
+            0,
+            0,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "eC, eCM",
+        "type": "double",
+        "comment": "Position of the virtual source(s). eC if not tracked, eCM if tracked."
+    },
+    "EmitterPosition:Type": {
+        "default": "cartesian",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "EmitterPosition:Units": {
+        "default": "metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ListenerUp": {
+        "default": [
+            0,
+            0,
+            1
+        ],
+        "flags": "m",
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": "Must be of the same dimensionality as ListenerView."
+    },
+    "ListenerView": {
+        "default": [
+            1,
+            0,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": "Orientation of the head. IC if not tracked, MC if tracked."
+    },
+    "ListenerView:Type": {
+        "default": "cartesian",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ListenerView:Units": {
+        "default": "metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "EmitterUp": {
+        "default": [
+            0,
+            0,
+            0
+        ],
+        "flags": null,
+        "dimensions": "EC, ECM",
+        "type": "double",
+        "comment": "Must be of the same dimensionality as EmitterView."
+    },
+    "EmitterView": {
+        "default": [
+            0,
+            0,
+            0
+        ],
+        "flags": null,
+        "dimensions": "EC, ECM",
+        "type": "double",
+        "comment": "Orientation of the virtual source(s). EC if not tracked, ECM if tracked."
+    },
+    "EmitterView:Type": {
+        "default": "cartesian",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "EmitterView:Units": {
+        "default": "metre",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "M": {
+        "default": 0,
+        "flags": "m",
+        "dimensions": "m",
+        "type": "double",
+        "comment": "Time stamp of the measurements in M,defines the size of M."
+    },
+    "M:LongName": {
+        "default": "time",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Narrative name for M"
+    },
+    "M:Units": {
+        "default": "second",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Units used for M"
+    },
+    "Response": {
+        "default": "",
+        "flags": null,
+        "dimensions": "S, C, I",
+        "type": "attribute",
+        "comment": "the subject\u00e2\u20ac\u2122s response"
+    },
+    "Response:Type": {
+        "default": "",
+        "flags": null,
+        "dimensions": "S, C, I",
+        "type": "attribute",
+        "comment": "type depends on the dimension"
+    },
+    "Response:LongName": {
+        "default": "Date",
+        "flags": null,
+        "dimensions": "S",
+        "type": "attribute",
+        "comment": "narrative description of the response type"
+    },
+    "Data.Receiver": {
+        "default": [
+            0,
+            0
+        ],
+        "flags": null,
+        "dimensions": "nR",
+        "type": "double",
+        "comment": "(binaural) audio data at the receivers; n=number of audio samples"
+    },
+    "Data.Emitter": {
+        "default": [
+            0,
+            0
+        ],
+        "flags": null,
+        "dimensions": "nE",
+        "type": "double",
+        "comment": "(source) audio data at the emitters; n=number of audio samples"
+    },
+    "Data.SamplingRate": {
+        "default": 44100,
+        "flags": "m",
+        "dimensions": "I",
+        "type": "double",
+        "comment": ""
+    },
+    "Data.SamplingRate:Units": {
+        "default": "hertz",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    }
+}

sofar/sofa_conventions/rules/deprecations.json ADDED Viewed

@@ -0,0 +1,13 @@
+{
+    "GLOBAL:SOFAConventions": {
+        "GeneralFIRE": "GenerelFIR-E",
+        "MultiSpeakerBRIR": "SingleRoomMIMOSRIR",
+        "MusicalInstrumentDirectivityTF": "FreeFieldDirectivityTF",
+        "SimpleBRIR": "SingleRoomSRIR",
+        "SingleRoomDRIR": "SingleRoomSRIR",
+        "SimpleFreeFieldDirectivityTF": "FreeFieldDirectivityTF",
+        "SimpleFreeFieldSOS": "SimpleFreeFieldHRSOS",
+        "SimpleFreeFieldTF": "SimpleFreeFieldHRTF",
+        "SingleTrackedAudio": "AnnotatedEmitterAudio or AnnotatedReceiverAudio"
+    }
+}