SAF
Loading...
Searching...
No Matches
Data Fields
saf_sofa_container Struct Reference
saf_sofa_reader

SOFA container struct comprising all possible data that can be extracted from SOFA 1.0 files; as laid down in the GeneralFIR and SimpleFreeFieldHRIR specifications: https://www.sofaconventions.org/mediawiki/index.php/GeneralFIR https://www.sofaconventions.org/mediawiki/index.php/SimpleFreeFieldHRIR. More...

#include <saf_sofa_reader.h>

Data Fields

int nSources
 Number of source/measurement positions.
 
int nReceivers
 Number of ears/number of mics etc.
 
int DataLengthIR
 Length of the IRs, in samples.
 
float * DataIR
 The impulse response (IR) Data; FLAT:nSources x nReceivers x DataLengthIR.
 
float DataSamplingRate
 Sampling rate used to measure the IRs.
 
float * DataDelay
 Delay in samples; nReceivers x 1.
 
float * SourcePosition
 Source positions (refer to SourcePositionType & SourcePositionUnits for the convention and units); FLAT: nSources x 3.
 
float * ReceiverPosition
 Receiver positions (refer to ReceiverPositionType & ReceiverPositionUnits for the convention and units); FLAT: nReceivers x 3.
 
int nListeners
 Number of listener positions.
 
int nEmitters
 Number of emitter positions.
 
float * ListenerPosition
 Listener position (The object incorporating all receivers; refer to ListenerPositionType & ListenerPositionUnits for the convention and units); FLAT: nListeners x 3.
 
float * ListenerUp
 Vector pointing upwards from the listener position (Cartesian); 1 x 3 or FLAT: nListeners x 3.
 
float * ListenerView
 Vector pointing forwards from the listener position (Cartesian); 3 x 1.
 
float * EmitterPosition
 Positions of acoustic excitation used for the measurement (refer to EmitterPositionType & EmitterPositionUnits for the convention and units); FLAT: nEmitters x 3.
 
char * ListenerPositionType
 {'cartesian'|'spherical'}
 
char * ListenerPositionUnits
 {'degree, degree, metre'|'metre'}
 
char * ListenerViewType
 {'cartesian'|'spherical'}
 
char * ListenerViewUnits
 {'degree, degree, metre'|'metre'}
 
char * ReceiverPositionType
 {'cartesian'|'spherical'}
 
char * ReceiverPositionUnits
 {'degree, degree, metre'|'metre'}
 
char * SourcePositionType
 {'cartesian'|'spherical'}
 
char * SourcePositionUnits
 {'degree, degree, metre'|'metre'}
 
char * EmitterPositionType
 {'cartesian'|'spherical'}
 
char * EmitterPositionUnits
 {'degree, degree, metre'|'metre'}
 
char * DataSamplingRateUnits
 {'hertz'}
 
char * Conventions
 {'SOFA'}
 
char * Version
 Version number.
 
char * SOFAConventions
 {'GeneralFIR'|'GeneralTF'| 'SimpleFreeFieldHRIR'}
 
char * SOFAConventionsVersion
 SOFA convention number.
 
char * APIName
 API name.
 
char * APIVersion
 API version.
 
char * ApplicationName
 Name of Application that created file.
 
char * ApplicationVersion
 Ver.
 
char * AuthorContact
 Contact information.
 
char * Comment
 File comments.
 
char * DataType
 {'FIR'|'TF'}
 
char * History
 History information.
 
char * License
 License under which file is provided.
 
char * Organisation
 Organisation reponsible for the file.
 
char * References
 References.
 
char * RoomType
 Room type (free field etc.)
 
char * Origin
 Where this file came from.
 
char * DateCreated
 Date file was created.
 
char * DateModified
 Date file was modified.
 
char * Title
 Title of file.
 
char * DatabaseName
 Name of database this file belongs to.
 
char * ListenerShortName
 Name of the listener/dummyhead/mic etc.
 
void * hLMSOFA
 libmysofa handle
 

Detailed Description

SOFA container struct comprising all possible data that can be extracted from SOFA 1.0 files; as laid down in the GeneralFIR and SimpleFreeFieldHRIR specifications: https://www.sofaconventions.org/mediawiki/index.php/GeneralFIR https://www.sofaconventions.org/mediawiki/index.php/SimpleFreeFieldHRIR.

Definition at line 86 of file saf_sofa_reader.h.

Field Documentation

◆ APIName

char* saf_sofa_container::APIName

API name.

Definition at line 140 of file saf_sofa_reader.h.

◆ APIVersion

char* saf_sofa_container::APIVersion

API version.

Definition at line 141 of file saf_sofa_reader.h.

◆ ApplicationName

char* saf_sofa_container::ApplicationName

Name of Application that created file.

Definition at line 142 of file saf_sofa_reader.h.

◆ ApplicationVersion

char* saf_sofa_container::ApplicationVersion

Ver.

of Application that created file

Definition at line 143 of file saf_sofa_reader.h.

◆ AuthorContact

char* saf_sofa_container::AuthorContact

Contact information.

Definition at line 144 of file saf_sofa_reader.h.

◆ Comment

char* saf_sofa_container::Comment

File comments.

Definition at line 145 of file saf_sofa_reader.h.

◆ Conventions

char* saf_sofa_container::Conventions

{'SOFA'}

Definition at line 135 of file saf_sofa_reader.h.

◆ DatabaseName

char* saf_sofa_container::DatabaseName

Name of database this file belongs to.

Definition at line 156 of file saf_sofa_reader.h.

◆ DataDelay

float* saf_sofa_container::DataDelay

Delay in samples; nReceivers x 1.

Definition at line 94 of file saf_sofa_reader.h.

◆ DataIR

float* saf_sofa_container::DataIR

The impulse response (IR) Data; FLAT:nSources x nReceivers x DataLengthIR.

Definition at line 91 of file saf_sofa_reader.h.

◆ DataLengthIR

int saf_sofa_container::DataLengthIR

Length of the IRs, in samples.

Definition at line 90 of file saf_sofa_reader.h.

◆ DataSamplingRate

float saf_sofa_container::DataSamplingRate

Sampling rate used to measure the IRs.

Definition at line 93 of file saf_sofa_reader.h.

◆ DataSamplingRateUnits

char* saf_sofa_container::DataSamplingRateUnits

{'hertz'}

Definition at line 132 of file saf_sofa_reader.h.

◆ DataType

char* saf_sofa_container::DataType

{'FIR'|'TF'}

Definition at line 146 of file saf_sofa_reader.h.

◆ DateCreated

char* saf_sofa_container::DateCreated

Date file was created.

Definition at line 153 of file saf_sofa_reader.h.

◆ DateModified

char* saf_sofa_container::DateModified

Date file was modified.

Definition at line 154 of file saf_sofa_reader.h.

◆ EmitterPosition

float* saf_sofa_container::EmitterPosition

Positions of acoustic excitation used for the measurement (refer to EmitterPositionType & EmitterPositionUnits for the convention and units); FLAT: nEmitters x 3.

Definition at line 115 of file saf_sofa_reader.h.

◆ EmitterPositionType

char* saf_sofa_container::EmitterPositionType

{'cartesian'|'spherical'}

Definition at line 130 of file saf_sofa_reader.h.

◆ EmitterPositionUnits

char* saf_sofa_container::EmitterPositionUnits

{'degree, degree, metre'|'metre'}

Definition at line 131 of file saf_sofa_reader.h.

◆ History

char* saf_sofa_container::History

History information.

Definition at line 147 of file saf_sofa_reader.h.

◆ hLMSOFA

void* saf_sofa_container::hLMSOFA

libmysofa handle

Definition at line 160 of file saf_sofa_reader.h.

◆ License

char* saf_sofa_container::License

License under which file is provided.

Definition at line 148 of file saf_sofa_reader.h.

◆ ListenerPosition

float* saf_sofa_container::ListenerPosition

Listener position (The object incorporating all receivers; refer to ListenerPositionType & ListenerPositionUnits for the convention and units); FLAT: nListeners x 3.

Definition at line 106 of file saf_sofa_reader.h.

◆ ListenerPositionType

char* saf_sofa_container::ListenerPositionType

{'cartesian'|'spherical'}

Definition at line 122 of file saf_sofa_reader.h.

◆ ListenerPositionUnits

char* saf_sofa_container::ListenerPositionUnits

{'degree, degree, metre'|'metre'}

Definition at line 123 of file saf_sofa_reader.h.

◆ ListenerShortName

char* saf_sofa_container::ListenerShortName

Name of the listener/dummyhead/mic etc.

Definition at line 157 of file saf_sofa_reader.h.

◆ ListenerUp

float* saf_sofa_container::ListenerUp

Vector pointing upwards from the listener position (Cartesian); 1 x 3 or FLAT: nListeners x 3.

Definition at line 111 of file saf_sofa_reader.h.

◆ ListenerView

float* saf_sofa_container::ListenerView

Vector pointing forwards from the listener position (Cartesian); 3 x 1.

Definition at line 113 of file saf_sofa_reader.h.

◆ ListenerViewType

char* saf_sofa_container::ListenerViewType

{'cartesian'|'spherical'}

Definition at line 124 of file saf_sofa_reader.h.

◆ ListenerViewUnits

char* saf_sofa_container::ListenerViewUnits

{'degree, degree, metre'|'metre'}

Definition at line 125 of file saf_sofa_reader.h.

◆ nEmitters

int saf_sofa_container::nEmitters

Number of emitter positions.

Definition at line 105 of file saf_sofa_reader.h.

◆ nListeners

int saf_sofa_container::nListeners

Number of listener positions.

Definition at line 104 of file saf_sofa_reader.h.

◆ nReceivers

int saf_sofa_container::nReceivers

Number of ears/number of mics etc.

Definition at line 89 of file saf_sofa_reader.h.

◆ nSources

int saf_sofa_container::nSources

Number of source/measurement positions.

Definition at line 88 of file saf_sofa_reader.h.

◆ Organisation

char* saf_sofa_container::Organisation

Organisation reponsible for the file.

Definition at line 149 of file saf_sofa_reader.h.

◆ Origin

char* saf_sofa_container::Origin

Where this file came from.

Definition at line 152 of file saf_sofa_reader.h.

◆ ReceiverPosition

float* saf_sofa_container::ReceiverPosition

Receiver positions (refer to ReceiverPositionType & ReceiverPositionUnits for the convention and units); FLAT: nReceivers x 3.

Definition at line 99 of file saf_sofa_reader.h.

◆ ReceiverPositionType

char* saf_sofa_container::ReceiverPositionType

{'cartesian'|'spherical'}

Definition at line 126 of file saf_sofa_reader.h.

◆ ReceiverPositionUnits

char* saf_sofa_container::ReceiverPositionUnits

{'degree, degree, metre'|'metre'}

Definition at line 127 of file saf_sofa_reader.h.

◆ References

char* saf_sofa_container::References

References.

Definition at line 150 of file saf_sofa_reader.h.

◆ RoomType

char* saf_sofa_container::RoomType

Room type (free field etc.)

Definition at line 151 of file saf_sofa_reader.h.

◆ SOFAConventions

char* saf_sofa_container::SOFAConventions

{'GeneralFIR'|'GeneralTF'| 'SimpleFreeFieldHRIR'}

Definition at line 137 of file saf_sofa_reader.h.

◆ SOFAConventionsVersion

char* saf_sofa_container::SOFAConventionsVersion

SOFA convention number.

Definition at line 139 of file saf_sofa_reader.h.

◆ SourcePosition

float* saf_sofa_container::SourcePosition

Source positions (refer to SourcePositionType & SourcePositionUnits for the convention and units); FLAT: nSources x 3.

Definition at line 95 of file saf_sofa_reader.h.

◆ SourcePositionType

char* saf_sofa_container::SourcePositionType

{'cartesian'|'spherical'}

Definition at line 128 of file saf_sofa_reader.h.

◆ SourcePositionUnits

char* saf_sofa_container::SourcePositionUnits

{'degree, degree, metre'|'metre'}

Definition at line 129 of file saf_sofa_reader.h.

◆ Title

char* saf_sofa_container::Title

Title of file.

Definition at line 155 of file saf_sofa_reader.h.

◆ Version

char* saf_sofa_container::Version

Version number.

Definition at line 136 of file saf_sofa_reader.h.

The documentation for this struct was generated from the following file: