Proposal 0.4

From Sofaconventions
Jump to navigation Jump to search

Only changes compared to the last version are listed here!!!


Fix mandatory metadata

The metadata mandatory in all SOFA conventions have not been fixed yet. We propose to have the following metadata mandatory in all SOFA conventions:


Name Default Flags Dimensions Comment
GLOBAL_Conventions SOFA r
GLOBAL_Version * r Insert the actual SOFA version here
GLOBAL_SOFAConventions SimpleFreeFieldHRIR
GLOBAL_SOFAConventionsVersion * Insert the actual SOFA convention version here
GLOBAL_APIName * Insert the API Name here
GLOBAL_APIVersion * Insert the API Version here
GLOBAL_AuthorContact
GLOBAL_License No license provided, ask the author for permission
GLOBAL_Organization
GLOBAL_RoomType free field
GLOBAL_DataType FIR
GLOBAL_History
GLOBAL_Comment
GLOBAL_DatabaseTimeCreated * will be updated when saving and not existing or empty
GLOBAL_DatabaseTimeModified * will be updated each time when saving
I 1 r I
I_LongName singleton dimension r
R 2 R
R_LongName number of receivers r
E 1 E
E_LongName number of emitters r
N - N
N_LongName time
N_Units samples
M - M
M_LongName number of measurements r
C 3 r C
C_LongName coordinate triplet r
ListenerPosition [1 0 0] IC, MC
ListenerPosition_Type cartesian
ListenerPosition_Unitsmeter
ReceiverPosition [0 -0.09 0; 0 0.09 0] rCI, rCM
ReceiverPosition_Type cartesian
ReceiverPosition_Units meter
SourcePosition [0 0 0] IC, MC
SourcePosition_Type cartesian
SourcePosition_Units meter
EmitterPosition [0 0 0] eCI, eCM
EmitterPosition_Type cartesian
EmitterPosition_Units meter
Data.FIR [1 1] mRn Only mandatory when DatyType is FIR
Data.SamplingRate 48000 I Only mandatory when DatyType is FIR
Data.SamplingRate_Units hertz Only mandatory when DatyType is FIR

Fix versioning of SOFA and conventions

Fix if datatypes can change within conventions