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

sofar/{conventions/source → sofa_conventions/conventions}/SingleRoomSRIR_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	SingleRoomSRIR	rm	  	attribute	For measuring SRIRs in a single room with a single excitation source (e.g., a loudspeaker) and a listener containing an arbitrary number of omnidirectional receivers (e.g., a microphone array).
 GLOBAL:SOFAConventionsVersion	1.0	rm	  	attribute
 GLOBAL:DataType	FIR	rm	  	attribute	Shall be FIR
@@ -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, M	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	eCI, eCM	double
 EmitterPosition:Type	spherical	m	  	attribute	Shall be 'cartesian' or 'spherical', restricting to spatially discrete emitters.
 EmitterPosition:Units	degree, degree, metre	m	  	attribute
@@ -60,9 +75,4 @@ Data.IR	0	m	mrn	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	IR, MR	double	Additional delay of each IR (in samples)
-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	Type of coordinate system for RoomCornerA and RoomCornerB
-RoomCorners:Units	metre			attribute	Unit of coordinate system for RoomCornerA and RoomCornerB
-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}/SingleRoomSRIR_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, M",
+        "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": null,
-        "dimensions": "IC, MC",
-        "type": "double",
-        "comment": ""
-    },
-    "RoomCornerB": {
-        "default": [
-            1,
-            2,
-            3
-        ],
-        "flags": null,
-        "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": null,
-        "dimensions": null,
-        "type": "attribute",
-        "comment": "Type of coordinate system for RoomCornerA and RoomCornerB"
-    },
-    "RoomCorners:Units": {
-        "default": "metre",
-        "flags": null,
-        "dimensions": null,
-        "type": "attribute",
-        "comment": "Unit of coordinate system for RoomCornerA and RoomCornerB"
+        "comment": "Optional M-dependent date and time of the measurement"
     },
     "Data.IR": {
         "default": 0,

sofar/{conventions/source → sofa_conventions/conventions/deprecated}/FreeFieldDirectivityTF_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	FreeFieldDirectivityTF	rm		attribute	This conventions stores directivities of acoustic sources (instruments, loudspeakers, singers, talkers, etc) in the frequency domain for multiple musical notes in free field.
 GLOBAL:SOFAConventionsVersion	1.0	rm		attribute
 GLOBAL:DataType	TF	rm		attribute	We store frequency-dependent data here
@@ -50,7 +50,7 @@ EmitterPosition:Units	metre	m		attribute
 EmitterDescription	{''}		IS, MS	string	A more detailed structure of the source. In a simple setting, a single Emitter is considered that is collocated with the source. In a more complicated setting, this may be the strings of a violin or the units of a loudspeaker.
 MIDINote	0		I, M	double	Defines the note played by the source during the measurement. The note is specified a MIDI note by the [https://www.midi.org/specifications-old/item/the-midi-1-0-specification MIDI specifications, version 1.0]. Not mandatory, but recommended for tonal instruments.
 Description	{''}		MS	string	This variable is used when the description varies with M.
-SourceTuningFrequency	440		I, M	double	Frequency (in Hertz) to which a musical instrument is tuned to corresponding to the note A4 (MIDINote=69). Recommended for tonal instruments.
+SourceTuningFrequency	440		I, M	double	Frequency (in hertz) to which a musical instrument is tuned to corresponding to the note A4 (MIDINote=69). Recommended for tonal instruments.
 Data.Real	0	m	mrn	double	Real part of the complex spectrum. The default value 0 indicates that all data fields are initialized with zero values.
 Data.Imag	0	m	MRN	double	Imaginary part of the complex spectrum
 N	0	m	N	double	Frequency values

sofar/{conventions → sofa_conventions/conventions/deprecated}/FreeFieldDirectivityTF_1.0.json

@@ -7,7 +7,7 @@
         "comment": ""
     },
     "GLOBAL:Version": {
-        "default": "2.0",
+        "default": "2.1",
         "flags": "rm",
         "dimensions": null,
         "type": "attribute",
@@ -397,7 +397,7 @@
         "flags": null,
         "dimensions": "I, M",
         "type": "double",
-        "comment": "Frequency (in Hertz) to which a musical instrument is tuned to corresponding to the note A4 (MIDINote=69). Recommended for tonal instruments."
+        "comment": "Frequency (in hertz) to which a musical instrument is tuned to corresponding to the note A4 (MIDINote=69). Recommended for tonal instruments."
     },
     "N": {
         "default": 0,

sofar/sofa_conventions/conventions/deprecated/MultiSpeakerBRIR_0.3.csv

@@ -0,0 +1,48 @@
+Name	Default	Flags	Dimensions	Type	Comment
+GLOBAL:Conventions	SOFA	rm	  	attribute	
+GLOBAL:Version	1.0	rm	 	attribute	
+GLOBAL:SOFAConventions	MultiSpeakerBRIR	rm	  	attribute	This convention is for BRIRs recorded in reverberant conditions from multiple loudspeaker sources at a number of listener orientations.
+GLOBAL:SOFAConventionsVersion	0.3	rm	  	attribute	
+GLOBAL:APIName		rm	  	attribute	
+GLOBAL:APIVersion		rm	  	attribute	
+GLOBAL:ApplicationName			  	attribute	
+GLOBAL:ApplicationVersion			  	attribute	
+GLOBAL:AuthorContact		m	  	attribute	
+GLOBAL:Comment		m	 	attribute	
+GLOBAL:DataType	FIRE	rm	  	attribute	We use FIR datatype which in addition depends on Emitters (E)
+GLOBAL:History			 	attribute	
+GLOBAL:License	No license provided, ask the author for permission	m	  	attribute	
+GLOBAL:Organization		m	  	attribute	
+GLOBAL:References				attribute	
+GLOBAL:RoomType	reverberant	m	  	attribute	
+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.09 0; 0 -0.09 0]	m	rCI, rCM	double	
+ReceiverPosition:Type	cartesian	m	  	attribute	
+ReceiverPosition:Units	metre	m	  	attribute	
+SourcePosition	[0 0 1]	m	IC, MC	double	
+SourcePosition:Type	spherical	m	  	attribute	
+SourcePosition:Units	degree, degree, metre	m	  	attribute	
+EmitterPosition	[0 0 0]	m	eCI, eCM	double	Each speaker is represented as an emitter. Use EmitterPosition to represent the position of a particular speaker. Size of EmitterPosition determines E
+EmitterPosition:Type	cartesian	m	  	attribute	
+EmitterPosition:Units	metre	m	  	attribute	
+GLOBAL:DatabaseName		m	  	attribute	name of the database to which these data belong
+GLOBAL:ListenerShortName		m	  	attribute	ID of the subject from the database
+GLOBAL:RoomDescription				attribute	narrative description of the room
+ListenerUp	[0 0 1]	m	IC, MC	double	
+ListenerView	[1 0 0]	m	IC, MC	double	
+ListenerView:Type	cartesian	m	  	attribute	
+ListenerView:Units	metre	m	  	attribute	
+EmitterUp	[0 0 1]		ECI, ECM	double	When EmitterUp provided, EmitterView must be provided as well
+EmitterView	[1 0 0]		ECI, ECM	double	When EmitterView provided, EmitterUp must be provided as well
+EmitterView:Type	cartesian		  	attribute	
+EmitterView:Units	metre		  	attribute	
+Data.IR	[1 1]	m	mREn	double	
+Data.SamplingRate	48000	m	I	double	
+Data.SamplingRate:Units	hertz	m		attribute	
+Data.Delay	[0 0]	m	IRE, MRE	double	

sofar/sofa_conventions/conventions/deprecated/SimpleFreeFieldHRIR_0.4.csv

@@ -0,0 +1,43 @@
+Name	Default	Flags	Dimensions	Type	Comment
+GLOBAL:Conventions	SOFA	rm	  	attribute	
+GLOBAL:Version	1.0	rm	 	attribute	
+GLOBAL:SOFAConventions	SimpleFreeFieldHRIR	rm	  	attribute	This convention set is for HRIRs recorded under free-field conditions or other IRs created under conditions where room information is irrelevant
+GLOBAL:SOFAConventionsVersion	0.4	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	FIR	rm	  	attribute	
+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	
+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	meter	m	  	attribute	
+ReceiverPosition	[0 0.09 0; 0 -0.09 0]	m	rCI, rCM	double	
+ReceiverPosition:Type	cartesian	m	  	attribute	
+ReceiverPosition:Units	meter	m	  	attribute	
+SourcePosition	[0 0 1]	m	IC, MC	double	Source position is assumed to vary for different directions/positions around the listener
+SourcePosition:Type	spherical	m	  	attribute	
+SourcePosition:Units	degree, degree, meter	m	  	attribute	
+EmitterPosition	[0 0 0]	m	eCI, eCM	double	
+EmitterPosition:Type	cartesian	m	  	attribute	
+EmitterPosition:Units	meter	m	  	attribute	
+GLOBAL:DatabaseName		m	  	attribute	name of the database to which these data belong
+GLOBAL:ListenerShortName		m	  	attribute	ID of the subject from the database
+ListenerUp	[0 0 1]	m	IC, MC	double	
+ListenerView	[1 0 0]	m	IC, MC	double	
+ListenerView:Type	cartesian	m		attribute	
+ListenerView:Units	meter	m		attribute	
+Data.IR	[1 1]	m	mRn	double	
+Data.SamplingRate	48000	m	I	double	
+Data.SamplingRate:Units	hertz	m		attribute	
+Data.Delay	[0 0]	m	IR, MR	double