GeneralFIR-E: Difference between revisions

From Sofaconventions
Jump to navigation Jump to search
Content deleted Content added
No edit summary
mNo edit summary
Tag: Manual revert
 
(3 intermediate revisions by the same user not shown)
Line 3: Line 3:
GeneralFIR-E is the standardized version of the previously proposed [[GeneralFIR]] convention. It extends GeneralFIR by having Emitter as an explicit dimension in the data.
GeneralFIR-E is the standardized version of the previously proposed [[GeneralFIR]] convention. It extends GeneralFIR by having Emitter as an explicit dimension in the data.


The conventions is defined in AES69-2020 (SOFA 2.0).
The conventions is defined in AES69-2022 (SOFA 2.1).




Line 16: Line 16:
|GLOBAL:Conventions||<nowiki>SOFA</nowiki>||rm||||attribute||
|GLOBAL:Conventions||<nowiki>SOFA</nowiki>||rm||||attribute||
|-
|-
|GLOBAL:Version||<nowiki>2.0</nowiki>||rm||||attribute||
|GLOBAL:Version||<nowiki>2.1</nowiki>||rm||||attribute||
|-
|-
|GLOBAL:SOFAConventions||<nowiki>GeneralFIR-E</nowiki>||rm||||attribute||This conventions stores IRs for general purposes, i.e., only the mandatory, SOFA general metadata are pre-defined
|GLOBAL:SOFAConventions||<nowiki>GeneralFIR-E</nowiki>||rm||||attribute||This conventions stores IRs for general purposes, i.e., only the SOFA general metadata are predefined.
|-
|-
|GLOBAL:SOFAConventionsVersion||<nowiki>2.0</nowiki>||rm||||attribute||
|GLOBAL:SOFAConventionsVersion||<nowiki>2.0</nowiki>||rm||||attribute||
Line 32: Line 32:
|GLOBAL:AuthorContact||<nowiki></nowiki>||m||||attribute||
|GLOBAL:AuthorContact||<nowiki></nowiki>||m||||attribute||
|-
|-
|GLOBAL:Comment||<nowiki></nowiki>||m||||attribute||
|GLOBAL:Comment||<nowiki></nowiki>||||||attribute||
|-
|-
|GLOBAL:DataType||<nowiki>FIR-E</nowiki>||rm||||attribute||We use FIR datatype which in addition depends on Emitters (E)
|GLOBAL:DataType||<nowiki>FIR-E</nowiki>||rm||||attribute||We use FIR datatype which in addition depends on Emitters (E).
|-
|-
|GLOBAL:History||<nowiki></nowiki>||||||attribute||
|GLOBAL:History||<nowiki></nowiki>||||||attribute||
Line 44: Line 44:
|GLOBAL:References||<nowiki></nowiki>||||||attribute||
|GLOBAL:References||<nowiki></nowiki>||||||attribute||
|-
|-
|GLOBAL:RoomType||<nowiki>free field</nowiki>||m||||attribute||The room information can be arbitrary
|GLOBAL:RoomType||<nowiki>free field</nowiki>||m||||attribute||It can be free field, reverberant, shoebox or dae.
|-
|-
|GLOBAL:Origin||<nowiki></nowiki>||||||attribute||
|GLOBAL:Origin||<nowiki></nowiki>||||||attribute||
Line 60: Line 60:
|ListenerPosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|ListenerPosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|-
|-
|ReceiverPosition||<nowiki>[0 0 0]</nowiki>||m||IC, RC, RCM||double||
|ReceiverPosition||<nowiki>[0 0 0]</nowiki>||m||ICI, RCI, RCM||double||
|-
|-
|ReceiverPosition:Type||<nowiki>cartesian</nowiki>||m||||attribute||
|ReceiverPosition:Type||<nowiki>cartesian</nowiki>||m||||attribute||
Line 66: Line 66:
|ReceiverPosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|ReceiverPosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|-
|-
|SourcePosition||<nowiki>[0 0 1]</nowiki>||m||IC, MC||double||
|SourcePosition||<nowiki>[0 0 0]</nowiki>||m||IC, MC||double||
|-
|-
|SourcePosition:Type||<nowiki>spherical</nowiki>||m||||attribute||
|SourcePosition:Type||<nowiki>cartesian</nowiki>||m||||attribute||
|-
|-
|SourcePosition:Units||<nowiki>degree, degree, metre</nowiki>||m||||attribute||
|SourcePosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|-
|-
|EmitterPosition||<nowiki>[0 0 0]</nowiki>||m||IC, EC, 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||<nowiki>[0 0 0]</nowiki>||m||ICI, ECI, ECM||double||Each speaker is represented as an Emitter.
|-
|-
|EmitterPosition:Type||<nowiki>cartesian</nowiki>||m||||attribute||
|EmitterPosition:Type||<nowiki>cartesian</nowiki>||m||||attribute||
Line 78: Line 78:
|EmitterPosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|EmitterPosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|-
|-
|Data.IR||<nowiki>0</nowiki>||m||mrne||double||Impulse responses
|Data.IR||<nowiki>0</nowiki>||m||mrne||double||Impulse responses.
|-
|-
|Data.SamplingRate||<nowiki>48000</nowiki>||m||I, M||double||Sampling rate of the samples in Data.IR and Data.Delay
|Data.SamplingRate||<nowiki>48000</nowiki>||m||I, M||double||Sampling rate of the samples in Data.IR and Data.Delay.
|-
|-
|Data.SamplingRate:Units||<nowiki>hertz</nowiki>||m||||attribute||Unit of the sampling rate
|Data.SamplingRate:Units||<nowiki>hertz</nowiki>||m||||attribute||Unit of the sampling rate.
|-
|-
|Data.Delay||<nowiki>0</nowiki>||m||IRE, MRE||double||Additional delay of each IR (in samples)
|Data.Delay||<nowiki>0</nowiki>||m||IRI, MRI, MRE||double||Additional delay of each IR (in samples, with the time interval as described by SamplingRate).
|}
|}

Latest revision as of 10:30, 17 July 2025

This conventions defines a general convention with FIR-E as DataType (no restrictions but DataType).

GeneralFIR-E is the standardized version of the previously proposed GeneralFIR convention. It extends GeneralFIR by having Emitter as an explicit dimension in the data.

The conventions is defined in AES69-2022 (SOFA 2.1).


Name Default Flags Dimensions Type Comment
GLOBAL:Conventions SOFA rm attribute
GLOBAL:Version 2.1 rm attribute
GLOBAL:SOFAConventions GeneralFIR-E rm attribute This conventions stores IRs for general purposes, i.e., only the SOFA general metadata are predefined.
GLOBAL:SOFAConventionsVersion 2.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 FIR-E 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 free field m attribute It can be free field, reverberant, shoebox or dae.
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 ICI, RCI, RCM double
ReceiverPosition:Type cartesian m attribute
ReceiverPosition:Units metre m attribute
SourcePosition [0 0 0] m IC, MC double
SourcePosition:Type cartesian m attribute
SourcePosition:Units metre m attribute
EmitterPosition [0 0 0] m ICI, ECI, ECM double Each speaker is represented as an Emitter.
EmitterPosition:Type cartesian m attribute
EmitterPosition:Units metre m attribute
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, with the time interval as described by SamplingRate).