sofar 0.3.1__py2.py3-none-any.whl → 1.1.0__py2.py3-none-any.whl

sofar/sofa_conventions/conventions/SimpleHeadphoneIR_1.0.json

@@ -0,0 +1,396 @@
+{
+    "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": "SimpleHeadphoneIR",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Conventions for IRs with a 1-to-1 correspondence between emitter and receiver. The main application for this convention is to store headphone IRs recorded for each emitter and each ear."
+    },
+    "GLOBAL:SOFAConventionsVersion": {
+        "default": "1.0",
+        "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": "We will store IRs here"
+    },
+    "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": "Room type is not relevant here"
+    },
+    "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": ""
+    },
+    "GLOBAL:DatabaseName": {
+        "default": "",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Correspondence to a database"
+    },
+    "GLOBAL:ListenerShortName": {
+        "default": "",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Correspondence to a subject from the database"
+    },
+    "GLOBAL:ListenerDescription": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Narrative description of the listener (or mannequin)"
+    },
+    "GLOBAL:SourceDescription": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Narrative description of the headphones"
+    },
+    "GLOBAL:SourceManufacturer": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Name of the headphones manufacturer"
+    },
+    "GLOBAL:SourceModel": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Name of the headphone model. Must uniquely describe the headphones of the manufacturer"
+    },
+    "GLOBAL:SourceURI": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "URI of the headphone specifications"
+    },
+    "GLOBAL:ReceiverDescription": {
+        "default": "",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Narrative description of the microphones"
+    },
+    "GLOBAL:EmitterDescription": {
+        "default": "",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Narrative description of the headphone drivers"
+    },
+    "ListenerPosition": {
+        "default": [
+            0,
+            0,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": ""
+    },
+    "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": "rCI, rCM",
+        "type": "double",
+        "comment": ""
+    },
+    "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": "Default: Headphones are located at the position of the listener"
+    },
+    "SourcePosition:Type": {
+        "default": "spherical",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "SourcePosition:Units": {
+        "default": "degree, degree, metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "EmitterPosition": {
+        "default": [
+            [
+                0,
+                0.09,
+                0
+            ],
+            [
+                0,
+                -0.09,
+                0
+            ]
+        ],
+        "flags": "m",
+        "dimensions": "eCI, eCM",
+        "type": "double",
+        "comment": "Default: Reflects the correspondence of each emitter to each receiver"
+    },
+    "EmitterPosition:Type": {
+        "default": "cartesian",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "EmitterPosition:Units": {
+        "default": "metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "SourceManufacturer": {
+        "default": [
+            ""
+        ],
+        "flags": null,
+        "dimensions": "MS",
+        "type": "string",
+        "comment": "Optional M-dependent version of the attribute SourceManufucturer"
+    },
+    "SourceModel": {
+        "default": [
+            ""
+        ],
+        "flags": null,
+        "dimensions": "MS",
+        "type": "string",
+        "comment": "Optional M-dependent version of the attribute SourceModel"
+    },
+    "ReceiverDescriptions": {
+        "default": [
+            ""
+        ],
+        "flags": null,
+        "dimensions": "MS",
+        "type": "string",
+        "comment": "R-dependent version of the attribute ReceiverDescription"
+    },
+    "EmitterDescriptions": {
+        "default": [
+            ""
+        ],
+        "flags": null,
+        "dimensions": "MS",
+        "type": "string",
+        "comment": "E-dependent version of the attribute EmitterDescription"
+    },
+    "MeasurementDate": {
+        "default": 0,
+        "flags": null,
+        "dimensions": "M",
+        "type": "double",
+        "comment": "Optional M-dependent date and time of the measurement"
+    },
+    "Data.IR": {
+        "default": [
+            0,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "mRn",
+        "type": "double",
+        "comment": ""
+    },
+    "Data.SamplingRate": {
+        "default": 48000,
+        "flags": "m",
+        "dimensions": "I, M",
+        "type": "double",
+        "comment": ""
+    },
+    "Data.SamplingRate:Units": {
+        "default": "hertz",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "Data.Delay": {
+        "default": [
+            0,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "IR, MR",
+        "type": "double",
+        "comment": ""
+    }
+}

sofar/{conventions/source → sofa_conventions/conventions}/SingleRoomMIMOSRIR_1.0.csv

@@ -1,6 +1,6 @@
 Name	Default	Flags	Dimensions	Type	Comment
 GLOBAL:Conventions	SOFA	rm	  	attribute
-GLOBAL:Version	2.0	rm	 	attribute
+GLOBAL:Version	2.1	rm	 	attribute
 GLOBAL:SOFAConventions	SingleRoomMIMOSRIR	rm	  	attribute	Single-room multiple-input multiple-output spatial room impulse responses, depending on Emitters
 GLOBAL:SOFAConventionsVersion	1.0	rm	  	attribute
 GLOBAL:DataType	FIR-E	rm	  	attribute	Shall be FIR-E
@@ -16,10 +16,23 @@ GLOBAL:License	No license provided, ask the author for permission	m	  	attribute
 GLOBAL:ApplicationName			  	attribute
 GLOBAL:ApplicationVersion			  	attribute
 GLOBAL:Comment			 	attribute
-GLOBAL:RoomDescription				attribute	narrative description of the room
 GLOBAL:History			 	attribute
 GLOBAL:References				attribute
 GLOBAL:Origin				attribute
+GLOBAL:DatabaseName		m		attribute	Name of the database. Used for classification of the data.
+GLOBAL:RoomShortName				attribute	Short name of the Room
+GLOBAL:RoomDescription				attribute	Informal verbal description of the room
+GLOBAL:RoomLocation				attribute	Location of the room
+GLOBAL:RoomGeometry				attribute	URI to a file describing the room geometry.
+RoomTemperature	0		I, M	double	Temperature during measurements, given in Kelvin.
+RoomTemperature:Units	kelvin			attribute	Units of the room temperature
+RoomVolume	0		I, MI	double	Volume of the room
+RoomVolume:Units	cubic metre			attribute	Units of the room volume
+RoomCornerA	[0 0 0]		IC, MC	double
+RoomCornerB	[1 2 3]		IC, MC	double
+RoomCorners	0		II	double	The value of this attribute is to be ignored. It only exist to for RoomCorners:Type and RoomCorners:Units
+RoomCorners:Type	cartesian			attribute
+RoomCorners:Units	metre			attribute
 GLOBAL:ListenerShortName				attribute
 GLOBAL:ListenerDescription				attribute
 ListenerPosition	[0 0 0] 	m	MC	double
@@ -31,6 +44,7 @@ ListenerView:Type	cartesian	m		attribute
 ListenerView:Units	metre	m		attribute
 GLOBAL:ReceiverShortName				attribute
 GLOBAL:ReceiverDescription				attribute
+ReceiverDescriptions	{''}		RS, RSM	string	R-dependent version of the attribute ReceiverDescription
 ReceiverPosition	[0 0 0]	m	IC, RCI, RCM	double
 ReceiverPosition:Type	spherical	m	  	attribute	Can be of any type enabling both spatially discrete and spatially continuous representations.
 ReceiverPosition:Units	degree, degree, metre	m	  	attribute
@@ -49,6 +63,7 @@ SourceView:Type	cartesian	m		attribute
 SourceView:Units	metre	m		attribute
 GLOBAL:EmitterShortName				attribute
 GLOBAL:EmitterDescription				attribute
+EmitterDescriptions	{''}		ES, ESM	string	E-dependent version of the attribute EmitterDescription
 EmitterPosition	[0 0 0]	m	IC, ECI, ECM	double	Can be of any type enabling both spatially discrete and spatially continuous representations.
 EmitterPosition:Type	spherical	m	  	attribute
 EmitterPosition:Units	degree, degree, metre	m	  	attribute
@@ -60,9 +75,4 @@ Data.IR	0	m	mrne	double	Impulse responses
 Data.SamplingRate	48000	m	I, M	double	Sampling rate of the samples in Data.IR and Data.Delay
 Data.SamplingRate:Units	hertz	m		attribute	Unit of the sampling rate
 Data.Delay	0	m	IRI, MRI, MRE	double	Additional delay of each IR (in samples)
-RoomCornerA	[0 0 0]	m	IC, MC	double
-RoomCornerB	[1 2 3]	m	IC, MC	double
-RoomCorners	0		II	double	The value of this attribute is to be ignored. It only exist to for RoomCorners:Type and RoomCorners:Units
-RoomCorners:Type	cartesian	m		attribute
-RoomCorners:Units	metre	m		attribute
-GLOBAL:DatabaseName		m		attribute	Name of the database. Used for classification of the data.
+MeasurementDate	0		M	double	Optional M-dependent date and time of the measurement.

sofar/{conventions → sofa_conventions/conventions}/SingleRoomMIMOSRIR_1.0.json

@@ -7,7 +7,7 @@
         "comment": ""
     },
     "GLOBAL:Version": {
-        "default": "2.0",
+        "default": "2.1",
         "flags": "rm",
         "dimensions": null,
         "type": "attribute",
@@ -118,33 +118,61 @@
         "type": "attribute",
         "comment": ""
     },
-    "GLOBAL:RoomDescription": {
+    "GLOBAL:History": {
         "default": "",
         "flags": null,
         "dimensions": null,
         "type": "attribute",
-        "comment": "narrative description of the room"
+        "comment": ""
     },
-    "GLOBAL:History": {
+    "GLOBAL:References": {
         "default": "",
         "flags": null,
         "dimensions": null,
         "type": "attribute",
         "comment": ""
     },
-    "GLOBAL:References": {
+    "GLOBAL:Origin": {
         "default": "",
         "flags": null,
         "dimensions": null,
         "type": "attribute",
         "comment": ""
     },
-    "GLOBAL:Origin": {
+    "GLOBAL:DatabaseName": {
+        "default": "",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Name of the database. Used for classification of the data."
+    },
+    "GLOBAL:RoomShortName": {
         "default": "",
         "flags": null,
         "dimensions": null,
         "type": "attribute",
-        "comment": ""
+        "comment": "Short name of the Room"
+    },
+    "GLOBAL:RoomDescription": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Informal verbal description of the room"
+    },
+    "GLOBAL:RoomLocation": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Location of the room"
+    },
+    "GLOBAL:RoomGeometry": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "URI to a file describing the room geometry."
     },
     "GLOBAL:ListenerShortName": {
         "default": "",
@@ -202,12 +230,76 @@
         "type": "attribute",
         "comment": ""
     },
-    "GLOBAL:DatabaseName": {
-        "default": "",
-        "flags": "m",
+    "RoomTemperature": {
+        "default": 0,
+        "flags": null,
+        "dimensions": "I, M",
+        "type": "double",
+        "comment": "Temperature during measurements, given in Kelvin."
+    },
+    "RoomTemperature:Units": {
+        "default": "kelvin",
+        "flags": null,
         "dimensions": null,
         "type": "attribute",
-        "comment": "Name of the database. Used for classification of the data."
+        "comment": "Units of the room temperature"
+    },
+    "RoomVolume": {
+        "default": 0,
+        "flags": null,
+        "dimensions": "I, MI",
+        "type": "double",
+        "comment": "Volume of the room"
+    },
+    "RoomVolume:Units": {
+        "default": "cubic metre",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Units of the room volume"
+    },
+    "RoomCornerA": {
+        "default": [
+            0,
+            0,
+            0
+        ],
+        "flags": null,
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": ""
+    },
+    "RoomCornerB": {
+        "default": [
+            1,
+            2,
+            3
+        ],
+        "flags": null,
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": ""
+    },
+    "RoomCorners": {
+        "default": 0,
+        "flags": null,
+        "dimensions": "II",
+        "type": "double",
+        "comment": "The value of this attribute is to be ignored. It only exist to for RoomCorners:Type and RoomCorners:Units"
+    },
+    "RoomCorners:Type": {
+        "default": "cartesian",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "RoomCorners:Units": {
+        "default": "metre",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
     },
     "ListenerPosition": {
         "default": [
@@ -270,6 +362,15 @@
         "type": "attribute",
         "comment": ""
     },
+    "ReceiverDescriptions": {
+        "default": [
+            ""
+        ],
+        "flags": null,
+        "dimensions": "RS, RSM",
+        "type": "string",
+        "comment": "R-dependent version of the attribute ReceiverDescription"
+    },
     "ReceiverPosition": {
         "default": [
             0,
@@ -392,6 +493,15 @@
         "type": "attribute",
         "comment": ""
     },
+    "EmitterDescriptions": {
+        "default": [
+            ""
+        ],
+        "flags": null,
+        "dimensions": "ES, ESM",
+        "type": "string",
+        "comment": "E-dependent version of the attribute EmitterDescription"
+    },
     "EmitterPosition": {
         "default": [
             0,
@@ -453,48 +563,12 @@
         "type": "attribute",
         "comment": ""
     },
-    "RoomCornerA": {
-        "default": [
-            0,
-            0,
-            0
-        ],
-        "flags": "m",
-        "dimensions": "IC, MC",
-        "type": "double",
-        "comment": ""
-    },
-    "RoomCornerB": {
-        "default": [
-            1,
-            2,
-            3
-        ],
-        "flags": "m",
-        "dimensions": "IC, MC",
-        "type": "double",
-        "comment": ""
-    },
-    "RoomCorners": {
+    "MeasurementDate": {
         "default": 0,
         "flags": null,
-        "dimensions": "II",
+        "dimensions": "M",
         "type": "double",
-        "comment": "The value of this attribute is to be ignored. It only exist to for RoomCorners:Type and RoomCorners:Units"
-    },
-    "RoomCorners:Type": {
-        "default": "cartesian",
-        "flags": "m",
-        "dimensions": null,
-        "type": "attribute",
-        "comment": ""
-    },
-    "RoomCorners:Units": {
-        "default": "metre",
-        "flags": "m",
-        "dimensions": null,
-        "type": "attribute",
-        "comment": ""
+        "comment": "Optional M-dependent date and time of the measurement."
     },
     "Data.IR": {
         "default": 0,