sofar 1.2.1__py3-none-any.whl

sofar/sofa_conventions/conventions/SingleRoomSRIR_1.0.json

@@ -0,0 +1,601 @@
+{
+    "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": "SingleRoomSRIR",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "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": {
+        "default": "1.0",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:DataType": {
+        "default": "FIR",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Shall be FIR"
+    },
+    "GLOBAL:RoomType": {
+        "default": "shoebox",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Shall be 'shoebox' or 'dae'"
+    },
+    "GLOBAL:Title": {
+        "default": "",
+        "flags": "m",
+        "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:APIName": {
+        "default": "",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:APIVersion": {
+        "default": "",
+        "flags": "rm",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:AuthorContact": {
+        "default": "",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:Organization": {
+        "default": "",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:License": {
+        "default": "No license provided, ask the author for permission",
+        "flags": "m",
+        "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:Comment": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:History": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:References": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:Origin": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "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": "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": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:ListenerDescription": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:ReceiverShortName": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:ReceiverDescription": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:SourceShortName": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:SourceDescription": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:EmitterShortName": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "GLOBAL:EmitterDescription": {
+        "default": "",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "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": "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": [
+            0,
+            0,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "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": "m",
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": ""
+    },
+    "ListenerUp": {
+        "default": [
+            0,
+            0,
+            1
+        ],
+        "flags": "m",
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": ""
+    },
+    "ListenerView:Type": {
+        "default": "cartesian",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ListenerView:Units": {
+        "default": "metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ReceiverDescriptions": {
+        "default": [
+            ""
+        ],
+        "flags": null,
+        "dimensions": "RS, RSM",
+        "type": "string",
+        "comment": "R-dependent version of the attribute ReceiverDescription"
+    },
+    "ReceiverPosition": {
+        "default": [
+            0,
+            0,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "IC, RCI, RCM",
+        "type": "double",
+        "comment": ""
+    },
+    "ReceiverPosition:Type": {
+        "default": "spherical",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Can be of any type enabling both spatially discrete and spatially continuous representations."
+    },
+    "ReceiverPosition:Units": {
+        "default": "degree, degree, metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ReceiverView": {
+        "default": [
+            1,
+            0,
+            0
+        ],
+        "flags": null,
+        "dimensions": "RCI, RCM",
+        "type": "double",
+        "comment": ""
+    },
+    "ReceiverUp": {
+        "default": [
+            0,
+            0,
+            1
+        ],
+        "flags": null,
+        "dimensions": "RCI, RCM",
+        "type": "double",
+        "comment": ""
+    },
+    "ReceiverView:Type": {
+        "default": "cartesian",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "ReceiverView:Units": {
+        "default": "metre",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "SourcePosition": {
+        "default": [
+            0,
+            0,
+            1
+        ],
+        "flags": "m",
+        "dimensions": "MC",
+        "type": "double",
+        "comment": ""
+    },
+    "SourcePosition:Type": {
+        "default": "cartesian",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "SourcePosition:Units": {
+        "default": "metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "SourceView": {
+        "default": [
+            1,
+            0,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": ""
+    },
+    "SourceUp": {
+        "default": [
+            0,
+            0,
+            1
+        ],
+        "flags": "m",
+        "dimensions": "IC, MC",
+        "type": "double",
+        "comment": ""
+    },
+    "SourceView:Type": {
+        "default": "cartesian",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "SourceView:Units": {
+        "default": "metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "EmitterDescriptions": {
+        "default": [
+            ""
+        ],
+        "flags": null,
+        "dimensions": "ES, ESM",
+        "type": "string",
+        "comment": "E-dependent version of the attribute EmitterDescription"
+    },
+    "EmitterPosition": {
+        "default": [
+            0,
+            0,
+            0
+        ],
+        "flags": "m",
+        "dimensions": "eCI, eCM",
+        "type": "double",
+        "comment": ""
+    },
+    "EmitterPosition:Type": {
+        "default": "spherical",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Shall be 'cartesian' or 'spherical', restricting to spatially discrete emitters."
+    },
+    "EmitterPosition:Units": {
+        "default": "degree, degree, metre",
+        "flags": "m",
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "EmitterView": {
+        "default": [
+            1,
+            0,
+            0
+        ],
+        "flags": null,
+        "dimensions": "ECI, ECM",
+        "type": "double",
+        "comment": ""
+    },
+    "EmitterUp": {
+        "default": [
+            0,
+            0,
+            1
+        ],
+        "flags": null,
+        "dimensions": "ECI, ECM",
+        "type": "double",
+        "comment": ""
+    },
+    "EmitterView:Type": {
+        "default": "cartesian",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": "Shall be 'cartesian' or 'spherical', restricting to spatially discrete emitters."
+    },
+    "EmitterView:Units": {
+        "default": "metre",
+        "flags": null,
+        "dimensions": null,
+        "type": "attribute",
+        "comment": ""
+    },
+    "MeasurementDate": {
+        "default": 0,
+        "flags": null,
+        "dimensions": "M",
+        "type": "double",
+        "comment": "Optional M-dependent date and time of the measurement"
+    },
+    "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/deprecated/AnnotatedEmitterAudio_0.1.csv

@@ -0,0 +1,46 @@
+Name	Default	Flags	Dimensions	Type	Comment
+GLOBAL:Conventions	SOFA	rm		attribute
+GLOBAL:Version	2.1	rm		attribute
+GLOBAL:SOFAConventions	AnnotatedEmitterAudio	rm		attribute
+GLOBAL:SOFAConventionsVersion	0.1	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	Audio	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	Position of the head. IC if not tracked, MC if tracked.
+ListenerPosition:Type	cartesian	m		attribute
+ListenerPosition:Units	metre	m		attribute
+ReceiverPosition	[0 0.09 0; 0 -0.09 0]	m	rC, rCM	double	Position of the ears. RC if not tracked, RCM if tracked.
+ReceiverPosition:Type	cartesian	m		attribute
+ReceiverPosition:Units	metre	m		attribute
+SourcePosition	[0 0 0]	m	IC, MC	double	Position of the virtual ensemble. IC if not tracked, MC if tracked.
+SourcePosition:Type	cartesian	m		attribute
+SourcePosition:Units	metre	m		attribute
+EmitterPosition	[0 0 0]	m	eC, eCM	double	Position of the virtual source(s). eC if not tracked, eCM if tracked.
+EmitterPosition:Type	cartesian	m		attribute
+EmitterPosition:Units	metre	m		attribute
+ListenerUp	[0 0 1]	m	IC, MC	double	Must be of the same dimensionality as ListenerView.
+ListenerView	[1 0 0]	m	IC, MC	double	Orientation of the head. IC if not tracked, MC if tracked.
+ListenerView:Type	cartesian	m		attribute
+ListenerView:Units	metre	m		attribute
+Data.Emitter	[0 0]	m	In, En	double	audio data at the emitter(s); n=number of audio samples
+Data.SamplingRate	44100	m	I	double
+Data.SamplingRate:Units	hertz	m		attribute
+M	0	m	m	double	Time stamp of the measurements in M, defines the size of M.
+M:LongName	time	m		attribute	Narrative name for M
+M:Units	second	m		attribute	Units used for M
+Response			I, C, S	attribute	the subject’s response
+Response:Type			I, C, S	attribute	type depends on the dimension
+Response:LongName			S	attribute	narrative description of the response type