SimpleFreeFieldTF: Difference between revisions

From Sofaconventions
Jump to navigation Jump to search
Content deleted Content added
Created page with "This SOFA Conventions is similar to SimpleFreeFieldHRIR. The most apparent difference is the DataType, which is ComplexSpectrum. This Conventions was requested to cover th..."
 
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Description ==
This SOFA Conventions is similar to [[SimpleFreeFieldHRIR]]. The most apparent difference is the DataType, which is ComplexSpectrum. This Conventions was requested to cover the needs coming from HRTF simulations where results are given as complex values in the frequency domain for some discrete frequencies.


This SOFA convention set is similar to [[SimpleFreeFieldHRIR]]. The only difference is the DataType, which is TF, not FIR. SimpleFreeFieldTF was requested to cover the needs coming from HRTF simulations where results are given as complex values in the frequency domain for some discrete frequencies.
==Proposed for SOFA 0.4==

== Version 1.0 ==

This version follows the conventions SimpleFreeFieldHRIR (version 1.0) standardized in AES69-2015. Note that SimpleFreeFieldTF 1.0, in contrast to SimpleFreeFieldHRIR 1.0, has not been included in the standard, thus it is declared as stable.


{| border="1"
!Name
!Default
!Flags
!Dimensions
!Type
!Comment
|-
|GLOBAL:Conventions||<nowiki>SOFA</nowiki>||rm||||attribute||
|-
|GLOBAL:Version||<nowiki>1.0</nowiki>||rm||||attribute||
|-
|GLOBAL:SOFAConventions||<nowiki>SimpleFreeFieldTF</nowiki>||rm||||attribute||This conventions is for TFs created under conditions where room information is irrelevant
|-
|GLOBAL:SOFAConventionsVersion||<nowiki>1.0</nowiki>||rm||||attribute||
|-
|GLOBAL:APIName||<nowiki></nowiki>||rm||||attribute||
|-
|GLOBAL:APIVersion||<nowiki></nowiki>||rm||||attribute||
|-
|GLOBAL:ApplicationName||<nowiki></nowiki>||||||attribute||
|-
|GLOBAL:ApplicationVersion||<nowiki></nowiki>||||||attribute||
|-
|GLOBAL:AuthorContact||<nowiki></nowiki>||m||||attribute||
|-
|GLOBAL:Comment||<nowiki></nowiki>||||||attribute||
|-
|GLOBAL:DataType||<nowiki>TF</nowiki>||rm||||attribute||
|-
|GLOBAL:History||<nowiki></nowiki>||||||attribute||
|-
|GLOBAL:License||<nowiki>No license provided, ask the author for permission</nowiki>||m||||attribute||
|-
|GLOBAL:ListenerShortName||<nowiki></nowiki>||m||||attribute||ID of the subject from the database
|-
|GLOBAL:Organization||<nowiki></nowiki>||m||||attribute||
|-
|GLOBAL:References||<nowiki></nowiki>||||||attribute||
|-
|GLOBAL:RoomType||<nowiki>free field</nowiki>||m||||attribute||
|-
|GLOBAL:Origin||<nowiki></nowiki>||||||attribute||
|-
|GLOBAL:DateCreated||<nowiki></nowiki>||m||||attribute||
|-
|GLOBAL:DateModified||<nowiki></nowiki>||m||||attribute||
|-
|GLOBAL:Title||<nowiki></nowiki>||m||||attribute||
|-
|ListenerPosition||<nowiki>[0 0 0] </nowiki>||m||IC, MC||double||
|-
|ListenerPosition:Type||<nowiki>cartesian</nowiki>||m||||attribute||
|-
|ListenerPosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|-
|ReceiverPosition||<nowiki>[0 0.09 0; 0 -0.09 0]</nowiki>||m||rCI, rCM||double||
|-
|ReceiverPosition:Type||<nowiki>cartesian</nowiki>||m||||attribute||
|-
|ReceiverPosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|-
|SourcePosition||<nowiki>[0 0 1]</nowiki>||m||IC, MC||double||Source position is assumed to vary for different directions/positions around the listener
|-
|SourcePosition:Type||<nowiki>spherical</nowiki>||m||||attribute||
|-
|SourcePosition:Units||<nowiki>degree, degree, metre</nowiki>||m||||attribute||
|-
|EmitterPosition||<nowiki>[0 0 0]</nowiki>||m||eCI, eCM||double||
|-
|EmitterPosition:Type||<nowiki>cartesian</nowiki>||m||||attribute||
|-
|EmitterPosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|-
|GLOBAL:DatabaseName||<nowiki></nowiki>||m||||attribute||name of the database to which these data belong
|-
|ListenerUp||<nowiki>[0 0 1]</nowiki>||m||IC, MC||double||
|-
|ListenerView||<nowiki>[1 0 0]</nowiki>||m||IC, MC||double||
|-
|ListenerView:Type||<nowiki>cartesian</nowiki>||m||||attribute||
|-
|ListenerView:Units||<nowiki>metre</nowiki>||m||||attribute||
|-
|Data.Real||<nowiki>[0 0]</nowiki>||m||mRn||double||
|-
|Data.Imag||<nowiki>[0 0]</nowiki>||m||MRN||double||
|-
|N||<nowiki>0</nowiki>||m||N||double||
|-
|N_LongName||<nowiki>frequency</nowiki>||||||attribute||
|-
|N_Units||<nowiki>hertz</nowiki>||||||attribute||
|}

== Old deprecated versions ==

For historical reasons the older versions of the SimpleFreeFieldTF conventions are listed below.

=== Version 0.4 ===


{| border="1"
!Name
!Default
!Flags
!Dimensions
!Type
!Comment
|-
|GLOBAL:Conventions||SOFA||rm||||attribute||
|-
|GLOBAL:Version||0.6||rm||||attribute||
|-
|GLOBAL:SOFAConventions||SimpleFreeFieldTF||rm||||attribute||This conventions is for TFs 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||||m||||attribute||
|-
|GLOBAL:DataType||TF||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:SubjectID||||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||
|-
|Data.Real||[1 1]||m||mRn||double||
|-
|Data.Imag||[0 0]||m||MRN||double||
|-
|N||0||m||N||double||
|-
|N_LongName||frequency||||||attribute||
|-
|N_Units||hertz||||||attribute||
|}


=== Version 0.3 ===


{| border="1"
{| border="1"
Line 10: Line 211:
!Type
!Type
!Comment
!Comment
|----
|-
|GLOBAL:Conventions||SOFA||rm||||attribute||
|GLOBAL_Conventions
|-
|SOFA
|GLOBAL:Version||0.5||rm||||attribute||
|rm
|
|-
|GLOBAL:SOFAConventions||GeneralTF||rm||||attribute||This conventions stores TFs for general purposes, i.e., only the mandatory, SOFA general metadata are pre-defined. This convention is based on GeneralFIR.
|
|
|-
|GLOBAL:SOFAConventionsVersion||0.1||rm||||attribute||
|----
|-
|GLOBAL_Version
|GLOBAL:APIName||||rm||||attribute||
|0.4
|rm
|-
|GLOBAL:APIVersion||||rm||||attribute||
|
|
|-
|GLOBAL:ApplicationName||||m||||attribute||
|
|----
|-
|GLOBAL:ApplicationVersion||||m||||attribute||
|GLOBAL_SOFAConventions
|-
|SimpleFreeFieldTF
|GLOBAL:AuthorContact||||m||||attribute||
|rm
|
|-
|GLOBAL:Comment||||m||||attribute||
|
|
|-
|GLOBAL:DataType||FIR||rm||||attribute||We store frequency-dependent data here
|----
|-
|GLOBAL_SOFAConventionsVersion
|GLOBAL:History||||m||||attribute||
|0.1
|m
|-
|GLOBAL:License||No license provided, ask the author for permission||m||||attribute||
|
|
|-
|GLOBAL:Organization||||m||||attribute||
|
|----
|-
|GLOBAL:References||||m||||attribute||
|GLOBAL_APIName
|
|-
|GLOBAL:RoomType||free field||m||||attribute||The room information can be arbitrary
|rm
|
|-
|GLOBAL:Source||||m||||attribute||
|
|-
|Insert the API Name here
|GLOBAL:TimeCreated||||m||||attribute||
|----
|-
|GLOBAL_APIVersion
|GLOBAL:TimeModified||||m||||attribute||
|
|rm
|-
|GLOBAL:Title||||m||||attribute||
|
|
|-
|ListenerPosition||[0 0 0] ||m||IC, MC||double||
|Insert the API Version here
|----
|-
|ListenerPosition:Type||cartesian||m||||attribute||
|GLOBAL_ApplicationName
|
|-
|ListenerPosition:Units||meter||m||||attribute||
|m
|
|-
|ReceiverPosition||[0 -0.09 0; 0 0.09 0]||m||rCI, rCM||double||
|
|
|-
|ReceiverPosition:Type||cartesian||m||||attribute||
|----
|-
|GLOBAL_ApplicationVersion
|ReceiverPosition:Units||meter||m||||attribute||
|
|m
|-
|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, meter||m||||attribute||
|GLOBAL_AuthorContact
|
|-
|EmitterPosition||[0 0 0]||m||eCI, eCM||double||
|m
|
|-
|EmitterPosition:Type||cartesian||m||||attribute||
|
|
|-
|EmitterPosition:Units||meter||m||||attribute||
|----
|-
|GLOBAL_License
|Data.Real||[1 1]||m||mRn||double||
|No license provided, ask the author for permission
|m
|-
|Data.Imag||[0 0]||m||MRN||double||
|
|
|-
|N||0||m||N||double||
|
|----
|-
|N_LongName||frequency||||||attribute||
|GLOBAL_Organization
|
|-
|N_Units||hertz||||||attribute||
|m
|
|
|
|----
|GLOBAL_DatabaseName
|
|m
|
|
|
|----
|GLOBAL_SubjectID
|
|m
|
|
|
|----
|GLOBAL_RoomType
|free field
|m
|
|
|
|----
|GLOBAL_DataType
|ComplexSpectrum
|m
|
|
|
|----
|GLOBAL_History
|
|
|
|
|
|----
|GLOBAL_Comment
|
|
|
|
|
|----
|GLOBAL_DatabaseTimeCreated
|
|m
|
|
|will be updated when saving and not existing or empty
|----
|GLOBAL_DatabaseTimeModified
|
|m
|
|
|will be updated each time when saving
|----
|ListenerPosition
| [1 0 0]
|m
|IC, MC
|double
|
|----
|ListenerPosition_Type
|cartesian
|m
|
|
|
|----
|ListenerPosition_Units
|meter
|m
|
|
|
|----
|ListenerUp
|[1.2 0 1]
|m
|IC, MC
|double
|
|----
|ListenerUp_Type
|cartesian
|m
|
|
|
|----
|ListenerUp_Units
|meter
|m
|
|
|
|----
|ListenerView
|[0 0 0]
|m
|IC, MC
|double
|
|----
|ListenerView_Type
|cartesian
|m
|
|
|
|----
|ListenerView_Units
|meter
|m
|
|
|
|----
|ListenerRotation
|[0 0 0]
|m
|IC, MC
|double
|
|----
|ListenerRotation_Type
|din9300
|m
|
|
|
|----
|ListenerRotation_Units
|degrees
|m
|
|
|
|----
|ReceiverPosition
|[0 -0.09 0; 0 0.09 0]
|m
|rCI, rCM
|double
|
|----
|ReceiverPosition_Type
|cartesian
|m
|
|
|
|----
|ReceiverPosition_Units
|meter
|m
|
|
|
|----
|SourcePosition
|[0 0 0]
|m
|IC, MC
|double
|
|----
|SourcePosition_Type
|cartesian
|m
|
|
|
|----
|SourcePosition_Units
|meter
|m
|
|
|
|----
|SourceUp
|[0 0 1]
|m
|IC, MC
|double
|
|----
|SourceUp_Type
|cartesian
|m
|
|
|
|----
|SourceUp_Units
|meter
|m
|
|
|
|----
|SourceView
|[1 0 0]
|m
|IC, MC
|double
|
|----
|SourceView_Type
|cartesian
|m
|
|
|
|----
|SourceView_Units
|meter
|m
|
|
|
|----
|EmitterPosition
|[0 0 0]
|m
|eCI, eCM
|double
|
|----
|EmitterPosition_Type
|cartesian
|m
|
|
|
|----
|EmitterPosition_Units
|meter
|m
|
|
|
|----
|Data.Real
|[1 1]
|m
|mRn
|double
|
|----
|Data.Imag
|[0 0]
|m
|MRN
|double
|
|----
|N
|0
|m
|N
|double
|
|----
|N_LongName
|frequency
|
|
|
|
|----
|N_Units
|hertz
|
|
|
|
|----
|}
|}

Latest revision as of 13:07, 13 May 2015

Description

This SOFA convention set is similar to SimpleFreeFieldHRIR. The only difference is the DataType, which is TF, not FIR. SimpleFreeFieldTF was requested to cover the needs coming from HRTF simulations where results are given as complex values in the frequency domain for some discrete frequencies.

Version 1.0

This version follows the conventions SimpleFreeFieldHRIR (version 1.0) standardized in AES69-2015. Note that SimpleFreeFieldTF 1.0, in contrast to SimpleFreeFieldHRIR 1.0, has not been included in the standard, thus it is declared as stable.


Name Default Flags Dimensions Type Comment
GLOBAL:Conventions SOFA rm attribute
GLOBAL:Version 1.0 rm attribute
GLOBAL:SOFAConventions SimpleFreeFieldTF rm attribute This conventions is for TFs created under conditions where room information is irrelevant
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 rm attribute
GLOBAL:History attribute
GLOBAL:License No license provided, ask the author for permission m attribute
GLOBAL:ListenerShortName m attribute ID of the subject from the database
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 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 Source position is assumed to vary for different directions/positions around the listener
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
GLOBAL:DatabaseName m attribute name of the database to which these data belong
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
Data.Real [0 0] m mRn double
Data.Imag [0 0] m MRN double
N 0 m N double
N_LongName frequency attribute
N_Units hertz attribute

Old deprecated versions

For historical reasons the older versions of the SimpleFreeFieldTF conventions are listed below.

Version 0.4

Name Default Flags Dimensions Type Comment
GLOBAL:Conventions SOFA rm attribute
GLOBAL:Version 0.6 rm attribute
GLOBAL:SOFAConventions SimpleFreeFieldTF rm attribute This conventions is for TFs 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 m attribute
GLOBAL:DataType TF 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:SubjectID 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
Data.Real [1 1] m mRn double
Data.Imag [0 0] m MRN double
N 0 m N double
N_LongName frequency attribute
N_Units hertz attribute


Version 0.3

Name Default Flags Dimensions Type Comment
GLOBAL:Conventions SOFA rm attribute
GLOBAL:Version 0.5 rm attribute
GLOBAL:SOFAConventions GeneralTF rm attribute This conventions stores TFs for general purposes, i.e., only the mandatory, SOFA general metadata are pre-defined. This convention is based on GeneralFIR.
GLOBAL:SOFAConventionsVersion 0.1 rm attribute
GLOBAL:APIName rm attribute
GLOBAL:APIVersion rm attribute
GLOBAL:ApplicationName m attribute
GLOBAL:ApplicationVersion m attribute
GLOBAL:AuthorContact m attribute
GLOBAL:Comment m attribute
GLOBAL:DataType FIR rm attribute We store frequency-dependent data here
GLOBAL:History m attribute
GLOBAL:License No license provided, ask the author for permission m attribute
GLOBAL:Organization m attribute
GLOBAL:References m attribute
GLOBAL:RoomType free field m attribute The room information can be arbitrary
GLOBAL:Source m attribute
GLOBAL:TimeCreated m attribute
GLOBAL:TimeModified 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 In order to store different directions/positions around the listener, SourcePosition is assumed to vary
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
Data.Real [1 1] m mRn double
Data.Imag [0 0] m MRN double
N 0 m N double
N_LongName frequency attribute
N_Units hertz attribute
Retrieved from "https://www.sofaconventions.org/mediawiki/index.php?title=SimpleFreeFieldTF&oldid=1969"