GeneralTF: Difference between revisions

From Sofaconventions
Jump to navigation Jump to search
← Older edit
Content deleted Content added
No edit summary
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__TOC__
==Description==

This conventions defines only that TF is the DataType. All other metadata follow the general SOFA specifications.
This conventions defines only that TF is the DataType. All other metadata follow the general SOFA specifications.


This conventions can be used to save data which are too general to store in more specific conventions, e.g., exact configuration of sources and receivers in a BEM simulation.
This conventions can be used to save data which are too general to store in more specific conventions, e.g., exact configuration of sources and receivers in a BEM simulation.


== Version 2.0 ==


{| border="1"
{| border="1"
!Name
!Name
!Default
!Default
![[SOFA_conventions#AnchorFlags|Flags]]
!Flags
!Dimensions
![[SOFA_conventions#AnchorDimensions|Dimensions]]
!Type
!Comment
|-
|GLOBAL:Conventions||<nowiki>SOFA</nowiki>||rm||||attribute||
|-
|GLOBAL:Version||<nowiki>2.1</nowiki>||rm||||attribute||
|-
|GLOBAL:SOFAConventions||<nowiki>GeneralTF</nowiki>||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||<nowiki>2.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||We store frequency-dependent data here
|-
|GLOBAL:History||<nowiki></nowiki>||||||attribute||
|-
|GLOBAL:License||<nowiki>No license provided, ask the author for permission</nowiki>||m||||attribute||
|-
|GLOBAL:Organization||<nowiki></nowiki>||m||||attribute||
|-
|GLOBAL:References||<nowiki></nowiki>||||||attribute||
|-
|GLOBAL:RoomType||<nowiki>free field</nowiki>||m||||attribute||The room information can be arbitrary
|-
|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 0]</nowiki>||m||IC, RC, 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||In order to store different directions/positions around the listener, SourcePosition is assumed to vary
|-
|SourcePosition:Type||<nowiki>spherical</nowiki>||m||||attribute||
|-
|SourcePosition:Units||<nowiki>degree, degree, metre</nowiki>||m||||attribute||
|-
|EmitterPosition||<nowiki>[0 0 0]</nowiki>||m||eC, eCM||double||
|-
|EmitterPosition:Type||<nowiki>cartesian</nowiki>||m||||attribute||
|-
|EmitterPosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|-
|Data.Real||<nowiki>0</nowiki>||m||mrn||double||The real part of the complex spectrum
|-
|Data.Imag||<nowiki>0</nowiki>||m||MRN||double||The imaginary part of the complex spectrum
|-
|N||<nowiki>0</nowiki>||m||N||double||Frequency values
|-
|N:LongName||<nowiki>frequency</nowiki>||m||||attribute||narrative name of N
|-
|N:Units||<nowiki>hertz</nowiki>||m||||attribute||Unit of the values given in N
|}

== Version 1.0 ==

Version 1.0 is deprecated. Please use Conventions version 2.0 instead.


{| border="1"
!Name
!Default
![[SOFA_conventions#AnchorFlags|Flags]]
![[SOFA_conventions#AnchorDimensions|Dimensions]]
!Type
!Type
!Comment
!Comment
Line 58: Line 150:
|ListenerPosition:Units||<nowiki>metre</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||<nowiki>[0 0 0]</nowiki>||m||rCI, rCM||double||
|-
|-
|ReceiverPosition:Type||<nowiki>cartesian</nowiki>||m||||attribute||
|ReceiverPosition:Type||<nowiki>cartesian</nowiki>||m||||attribute||
Line 76: Line 168:
|EmitterPosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|EmitterPosition:Units||<nowiki>metre</nowiki>||m||||attribute||
|-
|-
|Data.Real||<nowiki>[0 0]</nowiki>||m||mRn||double||The real part of the complex spectrum
|Data.Real||<nowiki>0</nowiki>||m||mRn||double||The real part of the complex spectrum
|-
|-
|Data.Imag||<nowiki>[0 0]</nowiki>||m||MRN||double||The imaginary part of the complex spectrum
|Data.Imag||<nowiki>0</nowiki>||m||MRN||double||The imaginary part of the complex spectrum
|-
|-
|N||<nowiki>0</nowiki>||m||N||double||Frequency values
|N||<nowiki>0</nowiki>||m||N||double||Frequency values
|-
|-
|N_LongName||<nowiki>frequency</nowiki>||||||attribute||
|N:LongName||<nowiki>frequency</nowiki>||m||||attribute||narrative name of N
|-
|-
|N_Units||<nowiki>hertz</nowiki>||m||||attribute||Unit of the values given in N
|N:Units||<nowiki>hertz</nowiki>||m||||attribute||Unit of the values given in N
|}
|}


Legend:
* '''Name''': the name of the metadata
** A colon: the metadata is an attribute
*** "GLOBAL:": the metadata is a global attribute
*** "X:Y": the metadata is an attribute Y of the variable X
** No colon: the metadata is a variable
** Data.X: the metadata is structured within the data
* '''Default''': default value for the metadata
** An asterisk (*): special handling required, mentioned in the column Comment
* '''Flags''':
** r: read-only, must be the default value
** m: mandatory, must be saved in the file
* '''Dimensions''': dimensions of the metadata (see [[SOFA specifications]] for more explanations)
** lower case: the variable size in that dimension determines the dimension size in the file
** upper case: variable must be of that dimension (or one of these dimensions)

Latest revision as of 12:23, 21 October 2022

Description

This conventions defines only that TF is the DataType. All other metadata follow the general SOFA specifications.

This conventions can be used to save data which are too general to store in more specific conventions, e.g., exact configuration of sources and receivers in a BEM simulation.

Version 2.0

Name Default Flags Dimensions Type Comment
GLOBAL:Conventions SOFA rm attribute
GLOBAL:Version 2.1 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 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 TF rm attribute We store frequency-dependent data 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 eC, eCM double
EmitterPosition:Type cartesian m attribute
EmitterPosition:Units metre m attribute
Data.Real 0 m mrn double The real part of the complex spectrum
Data.Imag 0 m MRN 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

Version 1.0

Version 1.0 is deprecated. Please use Conventions version 2.0 instead.


Name Default Flags Dimensions Type Comment
GLOBAL:Conventions SOFA rm attribute
GLOBAL:Version 1.0 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 1.0 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 We store frequency-dependent data 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 rCI, 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.Real 0 m mRn double The real part of the complex spectrum
Data.Imag 0 m MRN 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
Retrieved from "https://www.sofaconventions.org/mediawiki/index.php?title=GeneralTF&oldid=2477"