Mesh2HRTF_API

Functions for processing input for Mesh2HRTF and output from Mesh2HRTF are contained in the Mesh2HRTF API. It is currently available for Python and Matlab/Octave. The functions have identical names in both cases.

The Python functions are documented here. They currently contain more functionality and offer a better modularization. The Matlab functions are documented through their headers. Here is a brief overview of the API (x: not available)

Function	Purpose	Python	Matlab	Comment
compute_dtfs	Compute directional transfer functions (DTFs) from HRIRs	x		For Matlab use SOFAhrtf2dtf from the SOFAtoolbox
compute_hrirs	Compute HRIRs from HRTFs	x		part of output2hrtf in Matlab API
export_vtk	Export pressure on 3D mesh for visualization in ParaView	x	x
inspect_sofa_files	Plot final HRTFs/HRIRs	x		For Matlab use SOFAplotHRTF from the SOFAtoolbox
manage_numcalc	Automatic close to optimal parallelization of NumCalc calculations	x
manage_numcalc_script	Script version of manage_numcalc that can be run from the command line	x
merge_sofa_files	Merge SOFA files from multiple projects	x	x
ncdata2vtk	Export pressure on the evaluation grid for visualization in ParaView		x	Partly doubles functionality of export_vtk
output2hrtf	compute HRTFs/HRIRs from NumCalc output	x	x
process_multiple_outputs2hrtf	as output2hrtf, but can handle multiple projects	x	x
read_evaluation_grid	Read evaluation grid	x	x
read_ram_estimates	Read estimated RAM consumption from Memory.txt	x
reference_hrtfs	Reference HRTF to sound pressure at center of head	x		part of output2hrtf in Matlab API
remove_outputs	Delete NumCalc output (can be large)	x		Part of process_multiple_outputs2hrtf in the Matlab API
resample_sofa_file	Resample HRIRs to a different sampling rate	x		For Matlab use SOFAresample from the SOFAtoolbox
write_evaluation_grid	Write evaluation grid	x	x
write_material	Write acoustic boundary condition to material file	x	x
write_output_report	Check and report computation time and errors in the NumCalc output	x	x