sofar 1.2.1__py3-none-any.whl

sofar/sofa_conventions/conventions/GeneralFIR_1.0.json

@@ -0,0 +1,295 @@
+{
+    "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": "GeneralFIR",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "This conventions stores IRs for general purposes, i.e., only the mandatory, SOFA general metadata are pre-defined"
+    },
+    "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": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:DataType": {
+        "default": "FIR",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "We 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": "The room information can be arbitrary"
+    },
+    "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": ""
+    },
+    "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,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "IC, RC, 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,
+            1
+        ],
+        "flags": "m",
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": "In order to store different directions/positions around the listener, SourcePosition is assumed to vary"
+    },
+    "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,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "eCI, eCM",
+        "type": "double",
+        "comment": ""
+    },
+    "EmitterPosition:Type": {
+        "default": "cartesian",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "EmitterPosition:Units": {
+        "default": "metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ListenerView": {
+        "default": [
+            1,
+            0,
+            0
+        ],
+        "flags": null,
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": ""
+    },
+    "ListenerView:Type": {
+        "default": "cartesian",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ListenerView:Units": {
+        "default": "metre",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "Data.IR": {
+        "default": 0,
+        "flags": "m",
+        "dimensions": "mrn",
+        "type": "double",
+        "comment": "Impulse responses"
+    },
+    "Data.SamplingRate": {
+        "default": 48000,
+        "flags": "m",
+        "dimensions": "I, M",
+        "type": "double",
+        "comment": "Sampling rate of the samples in Data.IR and Data.Delay"
+    },
+    "Data.SamplingRate:Units": {
+        "default": "hertz",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Unit of the sampling rate"
+    },
+    "Data.Delay": {
+        "default": 0,
+        "flags": "m",
+        "dimensions": "IR, MR",
+        "type": "double",
+        "comment": "Additional delay of each IR (in samples)"
+    }
+}

sofar/sofa_conventions/conventions/GeneralSOS_1.0.csv

@@ -0,0 +1,40 @@
+Name	Default	Flags	Dimensions	Type	Comment
+GLOBAL:Conventions	SOFA	rm	  	attribute
+GLOBAL:Version	2.1	rm	 	attribute
+GLOBAL:SOFAConventions	GeneralSOS	rm	  	attribute	This conventions follows GeneralFIR but the data is stored as second-order section (SOS) coefficients.
+GLOBAL:SOFAConventionsVersion	1.0	rm	  	attribute
+GLOBAL:APIName		rm	  	attribute
+GLOBAL:APIVersion		rm	  	attribute
+GLOBAL:ApplicationName			  	attribute
+GLOBAL:ApplicationVersion			  	attribute
+GLOBAL:AuthorContact		m	  	attribute
+GLOBAL:Comment			 	attribute
+GLOBAL:DataType	SOS	rm		attribute	Filters described as second-order section (SOS) coefficients
+GLOBAL:History			 	attribute
+GLOBAL:License	No license provided, ask the author for permission	m	  	attribute
+GLOBAL:Organization		m	  	attribute
+GLOBAL:References				attribute
+GLOBAL:RoomType	free field	m	  	attribute	The room information can be arbitrary
+GLOBAL:Origin				attribute
+GLOBAL:DateCreated		m	 	attribute
+GLOBAL:DateModified		m	 	attribute
+GLOBAL:Title		m		attribute
+ListenerPosition	[0 0 0] 	m	IC, MC	double
+ListenerPosition:Type	cartesian	m	  	attribute
+ListenerPosition:Units	metre	m	  	attribute
+ListenerView	[1 0 0]		IC, MC	double
+ListenerView:Type	cartesian			attribute
+ListenerView:Units	metre			attribute
+ReceiverPosition	[0 0 0]	m	IC, RC, RCM	double
+ReceiverPosition:Type	cartesian	m	  	attribute
+ReceiverPosition:Units	metre	m	  	attribute
+SourcePosition	[0 0 1]	m	IC, MC	double	In order to store different directions/positions around the listener, SourcePosition is assumed to vary
+SourcePosition:Type	spherical	m	  	attribute
+SourcePosition:Units	degree, degree, metre	m	  	attribute
+EmitterPosition	[0 0 0]	m	eCI, eCM	double
+EmitterPosition:Type	cartesian	m	  	attribute
+EmitterPosition:Units	metre	m	  	attribute
+Data.SOS	permute([0 0 0 1 0 0], [3 1 2]);	m	mrn	double	Filter coefficients as SOS coefficients.
+Data.SamplingRate	48000	m	I, M	double	Sampling rate of the coefficients in Data.SOS and the delay in Data.Delay
+Data.SamplingRate:Units	hertz	m		attribute	Unit of the sampling rate
+Data.Delay	0	m	IR, MR	double	Broadband delay (in samples resulting from SamplingRate)

sofar/sofa_conventions/conventions/GeneralSOS_1.0.json

@@ -0,0 +1,306 @@
+{
+    "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": "GeneralSOS",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "This conventions follows GeneralFIR but the data is stored as second-order section (SOS) coefficients."
+    },
+    "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": "SOS",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Filters described as second-order section (SOS) coefficients"
+    },
+    "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": "The room information can be arbitrary"
+    },
+    "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": ""
+    },
+    "ListenerPosition:Type": {
+        "default": "cartesian",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ListenerPosition:Units": {
+        "default": "metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ListenerView": {
+        "default": [
+            1,
+            0,
+            0
+        ],
+        "flags": null,
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": ""
+    },
+    "ListenerView:Type": {
+        "default": "cartesian",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ListenerView:Units": {
+        "default": "metre",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ReceiverPosition": {
+        "default": [
+            0,
+            0,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "IC, RC, 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,
+            1
+        ],
+        "flags": "m",
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": "In order to store different directions/positions around the listener, SourcePosition is assumed to vary"
+    },
+    "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,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "eCI, eCM",
+        "type": "double",
+        "comment": ""
+    },
+    "EmitterPosition:Type": {
+        "default": "cartesian",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "EmitterPosition:Units": {
+        "default": "metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "Data.SOS": {
+        "default": [
+            [
+                [
+                    0,
+                    0,
+                    0,
+                    1,
+                    0,
+                    0
+                ]
+            ]
+        ],
+        "flags": "m",
+        "dimensions": "mrn",
+        "type": "double",
+        "comment": "Filter coefficients as SOS coefficients."
+    },
+    "Data.SamplingRate": {
+        "default": 48000,
+        "flags": "m",
+        "dimensions": "I, M",
+        "type": "double",
+        "comment": "Sampling rate of the coefficients in Data.SOS and the delay in Data.Delay"
+    },
+    "Data.SamplingRate:Units": {
+        "default": "hertz",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Unit of the sampling rate"
+    },
+    "Data.Delay": {
+        "default": 0,
+        "flags": "m",
+        "dimensions": "IR, MR",
+        "type": "double",
+        "comment": "Broadband delay (in samples resulting from SamplingRate)"
+    }
+}

sofar/sofa_conventions/conventions/GeneralTF-E_1.0.csv

@@ -0,0 +1,38 @@
+Name	Default	Flags	Dimensions	Type	Comment
+GLOBAL:Conventions	SOFA	rm	  	attribute
+GLOBAL:Version	2.1	rm	 	attribute
+GLOBAL:SOFAConventions	GeneralTF-E	rm	  	attribute	This conventions stores TFs depending in the Emiiter for general purposes, i.e., only the mandatory, SOFA general metadata are pre-defined. This convention is based on GeneralTF
+GLOBAL:SOFAConventionsVersion	1.0	rm	  	attribute
+GLOBAL:APIName		rm	  	attribute
+GLOBAL:APIVersion		rm	  	attribute
+GLOBAL:ApplicationName			  	attribute
+GLOBAL:ApplicationVersion			  	attribute
+GLOBAL:AuthorContact		m	  	attribute
+GLOBAL:Comment			 	attribute
+GLOBAL:DataType	TF-E	rm	  	attribute	We store frequency-dependent data depending on the emitter here
+GLOBAL:History			 	attribute
+GLOBAL:License	No license provided, ask the author for permission	m	  	attribute
+GLOBAL:Organization		m	  	attribute
+GLOBAL:References				attribute
+GLOBAL:RoomType	free field	m	  	attribute	The room information can be arbitrary
+GLOBAL:Origin				attribute
+GLOBAL:DateCreated		m	 	attribute
+GLOBAL:DateModified		m	 	attribute
+GLOBAL:Title		m		attribute
+ListenerPosition	[0 0 0] 	m	IC, MC	double
+ListenerPosition:Type	cartesian	m	  	attribute
+ListenerPosition:Units	metre	m	  	attribute
+ReceiverPosition	[0 0 0]	m	IC, RC, RCM	double
+ReceiverPosition:Type	cartesian	m	  	attribute
+ReceiverPosition:Units	metre	m	  	attribute
+SourcePosition	[0 0 1]	m	IC, MC	double	In order to store different directions/positions around the listener, SourcePosition is assumed to vary
+SourcePosition:Type	spherical	m	  	attribute
+SourcePosition:Units	degree, degree, metre	m	  	attribute
+EmitterPosition	[0 0 0]	m	IC, EC, ECM	double
+EmitterPosition:Type	cartesian	m	  	attribute
+EmitterPosition:Units	metre	m	  	attribute
+Data.Real	0	m	mrne	double	The real part of the complex spectrum
+Data.Imag	0	m	MRNE	double	The imaginary part of the complex spectrum
+N	0	m	N	double	Frequency values
+N:LongName	frequency	m		attribute	narrative name of N
+N:Units	hertz	m		attribute	Unit of the values given in N