SimpleHeadphoneIR
Description
The SimpleHeadphoneIR
object stores SOFA data following the
SimpleHeadphoneIR convention. This convention stores impulse responses with a one-to-one
correspondence between emitter and receiver. The main application of this convention is to
store headphone impulse responses recorded for an emitter-ear pair. When measuring headphones,
two emitters (E1 and
E2) are typically placed on a listener's head,
and two microphones are placed in the listener's ears
(R1 and
R2). In the first measurement, two transfer
functions are measured: direct (E1 to
R1) and crosstalk
(E1 to
R2). In the second measurement, two further
transfer functions are measured (E2 to
R1 and
E2 to
R2). SimpleHeadphoneIR
is designed
to store this correspondence of direct impulse responses. In case it is required to store the
crosstalk impulse responses as well, use GeneralFIR
instead.
Use sofaread
and
sofawrite
to read
and write SOFA files with this convention.
Creation
Create a SimpleHeadphoneIR
object using sofaconvention
.
s = sofaconvention("SimpleHeadphoneIR");
Properties
Data
Numerator
— Impulse responses
[0 0]
(default) | M-by-R-by-N array
Impulse responses in FIR form, specified as a real-valued M-by-R-by-N array, where M is the number of measurements, R is the number of receivers, and N is the impulse response length. The number of receivers is typically equal to 2 in this convention.
Delay
— Impulse response delay
[0 0]
(default) | 1-by-R matrix | M-by-R matrix
Delay of each impulse response in samples, specified as a 1-by-R or M-by-R matrix, where M is the number of measurements and R is the number of receivers. The number of receivers is typically equal to 2 in this convention.
SamplingRate
— Sampling rate (Hz)
48000 (default) | positive scalar
Sampling rate of the data in hertz, specified as a positive scalar.
SamplingRateUnits
— Sampling rate units
"hertz"
This property is read-only.
Sampling rate units, returned as a string.
DataType
— Type of data
"FIR"
This property is read-only.
Type of data in the file, returned as a string.
Listener
ListenerPosition
— Listener position
[0 0 0]
(default) | 1-by-3 matrix | M-by-3 matrix
Listener position in Cartesian or spherical coordinates, specified as a 1-by-3 or M-by-3 matrix, where M is the number of measurements.
For more information, see Spatial Data Representations.
ListenerPositionType
— Listener position type
"cartesian"
(default) | "spherical"
Listener position type, specified as "cartesian"
or
"spherical"
.
ListenerPositionUnits
— Listener position units
"meter"
| "degree, degree, meter"
This property is read-only.
Listener position units, returned as "meter"
if
ListenerPositionType
is "cartesian"
or
"degree, degree, meter"
if
ListenerPositionType
is "spherical"
.
ListenerShortName
— Listener short name
""
(default) | string
Listener short name, specified as a string. This property defines the ID of the subject from the database.
ListenerDescription
— Listener description
""
(default) | string
Listener description, specified as a string.
Receiver
ReceiverPosition
— Receiver positions
[0 0.09 0; 0 -0.09 0]
(default) | 2-by-3 matrix | 2-by-3-by-M array
Receiver positions in Cartesian or spherical coordinates, specified as a 2-by-3 matrix or 2-by-3-by-M array, where M is the number of measurements and 2 represents the number of receivers. The default value assumes the head has a radius of 0.09 meters.
For more information, see Spatial Data Representations.
ReceiverPositionType
— Receiver position type
"cartesian"
(default) | "spherical"
Receiver position type, specified as "cartesian"
or
"spherical"
.
ReceiverPositionUnits
— Receiver position units
"meter"
| "degree, degree, meter"
This property is read-only.
Receiver position units, returned as "meter"
if
ReceiverPositionType
is "cartesian"
or
"degree, degree, meter"
if
ReceiverPositionType
is "spherical"
.
ReceiverDescription
— General receiver description
""
(default) | string
General receiver description, specified as a string.
ReceiverDescriptions
— Measurement-dependent receiver description
empty array (default) | M-by-1 string array | M-by-1 cell array of character strings
Measurement-dependent receiver description, specified as an M-by-1 string array or M-by-1 cell array of character strings. Each string describes the receiver for a specific measurement.
Source
SourcePosition
— Source position
[0 0 1]
(default) | 1-by-3 matrix | M-by-3 matrix
Source position in Cartesian or spherical coordinates, specified as a 1-by-3 or M-by-3 matrix, where M is the number of measurements.
For more information, see Spatial Data Representations.
SourcePositionType
— Source position type
"spherical"
(default) | "cartesian"
Source position type, specified as "cartesian"
or
"spherical"
.
SourcePositionUnits
— Source position units
"meter"
| "degree, degree, meter"
This property is read-only.
Receiver position units, returned as "meter"
if
SourcePositionType
is "cartesian"
or
"degree, degree, meter"
if SourcePositionType
is "spherical"
.
SourceDescription
— Source description
""
(default) | string
Source description, specified as a string.
SourceModel
— Source model
""
(default) | string
Source model, specified as a string. The source model must uniquely describe the headphones of the manufacturer.
SourceModels
— Measurement-dependent source model
empty array (default) | M-by-1 string array | M-by-1 cell array of character strings
Measurement-dependent source model, specified as an M-by-1 string array or M-by-1 cell array of character strings. Each string is the name of the headphone model for a specific measurement.
SourceManufacturer
— Source manufacturer
""
(default) | string
Source manufacturer, specified as a string.
SourceManufacturers
— Measurement-dependent source manufacturer
empty array (default) | M-by-1 string array | M-by-1 cell array of character strings
Measurement-dependent source manufacturer, specified as an M-by-1 string array or M-by-1 cell array of character strings. Each string is the name of the headphone manufacturer for a specific measurement.
SourceURI
— Source URI
""
(default) | string
Source URI, specified as a string.
Emitter
EmitterPosition
— Emitter position
[0 0.09 0; 0 -0.09 0]
(default) | 2-by-3 matrix | 2-by-3-by-M array
Emitter position in Cartesian or spherical coordinates, specified as a 2-by-3 matrix or 2-by-3-by-M array, where M is the number of measurements and 2 represents the number of emitters.
For more information, see Spatial Data Representations.
EmitterPositionType
— Emitter position type
"cartesian"
(default) | "spherical"
Emitter position type, specified as "cartesian"
or
"spherical"
.
EmitterPositionUnits
— Emitter position units
"meter"
| "degree, degree, meter"
This property is read-only.
Emitter position units, returned as "meter"
if
EmitterPositionType
is "cartesian"
or
"degree, degree, meter"
if EmitterPositionType
is "spherical"
.
EmitterDescription
— General emitter description
""
(default) | string
General emitter description, specified as a string.
EmitterDescriptions
— Measurement-dependent emitter description
empty array (default) | M-by-1 string array | M-by-1 cell array of character strings
Measurement-dependent emitter description, specified as an M-by-1 string array or M-by-1 cell array of character strings. Each string describes the emitter for a specific measurement.
Room
RoomType
— Room type
"free field"
(default) | string
Type of room used to perform the measurements, specified as a string.
Metadata
MeasurementDate
— Measurement date
0
(default) | vector of length M
Date and time of each measurement, specified as a vector of length
M, where M is the number of measurements. Each
element is a date value (for example, datetime("today")
).
SOFAConventions
— Name of SOFA convention
"SimpleHeadphoneIR"
This property is read-only.
Name of the SOFA convention, returned as a string.
DatabaseName
— Name of database
""
(default) | string
Name of the database that this data belongs to, specified as a string.
Version
— Version of specifications
"2.1"
(default) | string
This property is read-only.
Version of the SOFA AES69 specifications, returned as a string of the format
"x.y"
where x
is the version major and
y
is the version minor.
APIName
— Name of API
"Audio Toolbox"
(default) | string
This property is read-only.
Name of the API that created or edited the SOFA file, returned as a string.
APIVersion
— Version of API
"1.0"
(default) | string
This property is read-only.
Version of the API that created or edited the SOFA file, returned as a string of the
format "x.y"
or "x.y.z"
where x
is the version major and y
and z
are the version
minors.
SOFAConventionsVersion
— Version of convention set
"1.0"
(default) | string
This property is read-only.
Version of the SOFA AES69 convention set, returned as a string of the format
"x.y"
where x
is the version major and
y
is the version minor.
Title
— Title
""
(default) | string
Title containing a succinct description of the file contents, specified as a string.
AuthorContact
— Contact information of author
""
(default) | string
Contact information of the author (for example, an email address), specified as a string.
Organization
— Name of organization
""
(default) | string
Name of the organization of the author, specified as a string.
License
— Legal license
""
(default) | string
Legal license under which the data is provided, specified as a string.
ApplicationName
— Name of application
"Audio Toolbox"
(default) | string
Name of the application that created or edited the file, specified as a string.
ApplicationVersion
— Version of application
"3.0.0"
(default) | string
Version of the application that created or edited the file, specified as a string.
Comment
— Comment
""
(default) | string
Comment that can contain miscellaneous information about the data or methods used to produce the data, specified as a string.
History
— History
""
(default) | string
History defining the audio trail for modifications to the original data, specified as a string.
References
— References
""
(default) | string
Published or web-based references that describe the data or the methods used to produce the data, specified as a string.
Origin
— Origin
""
(default) | string
Origin, specified as a string representing the method used for creating the original data. In the case of model-generated data, the origin should name the model and its version. In the case of observed or measured data, the origin should characterize the data and, where possible, name the measurement method.
DateCreated
— Date created
string
This property is read-only.
Date and time of the creation of the file, returned as a string in ISO 8601 format
"YYYY-MM-DD hh:mm:ss"
. This property is set when a new file is
created.
DateModified
— Date modified
string
This property is read-only.
Date and time of the last file modification, returned as a string in ISO 8601 format
"YYYY-MM-DD hh:mm:ss"
. This property is updated when a file is
saved.
Examples
Create SimpleHeadphoneIR SOFA File
Create a SOFA template object following the SimpleHeadphoneIR convention.
s = sofaconvention("SimpleHeadphoneIR");
Generate mock impulse response data to store in the file. Set the number of measurements M
to two and set the impulse response length N
to 1024. The number of receivers R
is two, corresponding to two ears. Use the fir1
function to create arbitrary FIR filters for the impulse response measurements.
M = 2; N = 1024; R = 2; IR = zeros(M,R,N); IR(1,:,:) = [fir1(N-1,0.1);fir1(N-1,.2)]; IR(2,:,:) = [fir1(N-1,0.15);fir1(N-1,.25)];
Store the measurements in the SOFA object.
s.Numerator = IR;
Save the data to a SOFA file.
sofawrite("mockHeadphoneIRData.sofa",s);
More About
Spatial Data Representations
In this SOFA convention, you can represent spatial data using Cartesian or spherical coordinate systems with spatially discrete representations.
Each spatial representation stores the position data in numerical triplets (for example,
[0 0 0]
).
Cartesian coordinates contain three orthogonal linear values in the format
[x y z]
. The units of the values are meters.Spherical coordinates contain angular values for azimuth and elevation and a linear value for the radius in the format
[azimuth elevation radius]
. The azimuth angle, in degrees, must be in the range [0, 360). The elevation angle, in degrees, must be in the range [-90, 90]. The units of the linear radius are meters.
Version History
Introduced in R2023b
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: United States.
You can also select a web site from the following list
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)
Asia Pacific
- Australia (English)
- India (English)
- New Zealand (English)
- 中国
- 日本Japanese (日本語)
- 한국Korean (한국어)