Applying renaming of Matlab convenience class from itaVA to VA

parent f8e6bc41
......@@ -794,7 +794,7 @@ Build: C:/dev/VA/build_win32-x64.vc14</code></pre>
<h5>VAMatlab</h5>
<p>
To build a <code>Matlab</code> executable (mex), you need a Matlab installation ad the corresponding headers and libraries. You can compile the Matlab extension directly out of your development environment, however currently only Visual Studio has been tested.<br />
To generate the <code>itaVA</code> class to easy using the VAMatlab executable, currently a manual step is required because auto-generation calling Matlab out of the development environment is still under construction. To create the class, run the <code>itaVA_build.m</code> script in Matlab once. The class will be included into the deployment and can be found in the <code>matlab</code> folder (along with some examples).
To generate the <code>VA</code> class to easy using the VAMatlab executable, currently a manual step is required because auto-generation calling Matlab out of the development environment is still under construction. To create the class, run the <code>VA_build.m</code> script in Matlab once. The class will be included into the deployment and can be found in the <code>matlab</code> folder (along with some examples).
</p>
......
......@@ -306,7 +306,7 @@ hearingboth_pc_my_data = D:/experiments/BA/student54/3AFCTest/InputData</code></
<h5>Matlab</h5>
<p>
<pre><code>va = itaVA;
<pre><code>va = VA;
va.connect;
va.reset;
......@@ -315,14 +315,14 @@ X = va.create_signal_source_buffer_from_file( '$(DemoSound)' );
va.set_signal_source_buffer_playback_action( X, 'play' );
va.set_signal_source_buffer_looping( X, true );
S = va.create_sound_source( 'itaVA_Example_Source' );
S = va.create_sound_source( 'VA example sound source' );
va.set_sound_source_pose( S, [ -2 1.7 -2 ], [ 0 0 0 1 ] );
va.set_sound_source_signal_source( S, X );
H = va.create_directivity_from_file( '$(DefaultHRIR)' );
L = va.create_sound_receiver( 'itaVA_Example_Sound_Receiver' );
L = va.create_sound_receiver( 'VA example listener' );
va.set_sound_receiver_pose( L, [ 0 1.7 0 ], [ 0 0 0 1 ] );
va.set_sound_receiver_directivity( L, H );
......
......@@ -775,11 +775,11 @@ HRIRFilterLength = 128</pre></code></p>
<h4>Control VA using Matlab</h4>
<p>
The most common way to control VA for prototyping, testing, and in the scope of listening experiments is by using <b>MathWorks' Matlab</b>. VA provides a Matlab binding and a convenience class called <code>itaVA</code>. Once initialized, the class object can be connected to the VA server application over a TCP/IP network connection (or the local network port), as already described in the <a href="overview.html">overview section on controlling VA</a>.<br />
You can find the <code>itaVA.m</code> Matlab class along with the required files for communication with VA in the <a href="download.html">VA package under the <code>matlab</code> folder</a>. In case you are building and deploying <code>VAMatlab</code> on your own (for your platform), or if it is missing, look out for <code>build_itaVA*.m</code> scripts that will generate the convenience class around the <code>VAMatlab</code> executable. Adding this folder to the Matlab path list, will enable permanent access from the console, independently of the current working directory.
The most common way to control VA for prototyping, testing, and in the scope of listening experiments is by using <b>MathWorks' Matlab</b>. VA provides a Matlab binding and a convenience class called <code>VA</code>. Once initialized, the class object can be connected to the VA server application over a TCP/IP network connection (or the local network port), as already described in the <a href="overview.html">overview section on controlling VA</a>.<br />
You can find the <code>VA.m</code> Matlab class along with the required files for communication with VA in the <a href="download.html">VA package under the <code>matlab</code> folder</a>. In case you are building and deploying <code>VAMatlab</code> on your own (for your platform), or if it is missing, look out for <code>VA_build*.m</code> scripts that will generate the convenience class around the <code>VAMatlab</code> executable. Adding this folder to the Matlab path list, will enable permanent access from the console, independently of the current working directory.
<br />
To get started, inspect the example files and use Matlab's bash completion on an instance of the <code>itaVA</code> class to receive self explanatory functions, i.e., when executing
<pre><code>va = itaVA</code></pre>
To get started, inspect the example files and use Matlab's bash completion on an instance of the <code>VA</code> class to receive self explanatory functions, i.e., when executing
<pre><code>va = VA</code></pre>
The list of available methods is sorted by getter and setter nomenclature (<code>va.get_*</code> and <code>va.set_*</code>), followed by the entity (<code>sound_receiver</code>, <code>sound_source</code>, <code>sound_portal</code>), and the actual action. To create an entity, directivities and more, use the <code>va.create_*</code> methods.
<br />
<br />
......@@ -1059,7 +1059,7 @@ tts_in.prepare_text = 'welcome to virtual acoustics';
tts_in.direct_playback = true;
va.set_signal_source_parameters( tts_signal_source, tts_in )
</code></pre>
Do not forget that a signal source can only be auralized in combination with a sound source. For more information, refer to the <a href="https://git.rwth-aachen.de/ita/toolbox/blob/master/applications/VirtualAcoustics/VA/itaVA_example_text_to_speech.m">text-to-speech example</a> in the <a href="http://www.ita-toolbox.org" target="_blank">ITA-Toolbox for Matlab</a>.
Do not forget that a signal source can only be auralized in combination with a sound source. For more information, refer to the <a href="https://git.rwth-aachen.de/ita/toolbox/blob/master/applications/VirtualAcoustics/VA/VA_example_text_to_speech.m">text-to-speech example</a> in the <a href="http://www.ita-toolbox.org" target="_blank">ITA-Toolbox for Matlab</a>.
</p>
<h5>Other signal sources</h5>
......@@ -1415,7 +1415,7 @@ A virtual sound device can be activated that suspends the timeout-driven block p
<h5>Virtual sound card audio driver configuration</h5>
<p>
To enable the emulated sound card and set it up for the Matlab example script <code>itaVA_example_offline_simulation.m</code> (<a target="_blank" href="https://git.rwth-aachen.de/ita/VAMatlab/blob/master/matlab/itaVA_example_offline_simulation.m">open in git</a>) and <code>itaVA_example_offline_simulation_ir.m</code> (<a href="https://git.rwth-aachen.de/ita/VAMatlab/blob/master/matlab/itaVA_example_offline_simulation_ir.m" target="_blank">open in git</a>), modify your configuration as follows
To enable the emulated sound card and set it up for the Matlab example script <code>VA_example_offline_simulation.m</code> (<a target="_blank" href="https://git.rwth-aachen.de/ita/VAMatlab/blob/master/matlab/VA_example_offline_simulation.m">open in git</a>) and <code>VA_example_offline_simulation_ir.m</code> (<a href="https://git.rwth-aachen.de/ita/VAMatlab/blob/master/matlab/VA_example_offline_simulation_ir.m" target="_blank">open in git</a>), modify your configuration as follows
<pre><code>[Audio driver]
Driver = Virtual
Device = Trigger
......@@ -1447,12 +1447,12 @@ When recording offline simulations, it is often helpful to store the recorded au
<pre><code>% Single-line calls
va.set_rendering_module_parameters( 'MyRenderer', struct( 'RecordOutputFileName', 'modified_reproduction_out.wav' ) );
va.set_rendering_module_parameters( 'MyRenderer', struct( 'RecordOutputBaseFolder', ...
fullfile( 'recordings/MyRenderer', datestr( datetime( 'now' ) ) ) ) ); % with date and time folder
fullfile( 'recordings/MyRenderer', datestr( datetime( now, 'yyyy-mm-dd_HH-MM-SS' ) ) ) ) ); % with date and time folder
% Struct call
mStruct = struct();
mStruct.RecordOutputFileName = 'modified_rendering_out.wav';
mStruct.RecordOutputBaseFolder = fullfile( 'recordings/MyRenderer', datestr( datetime( 'now' ) ) ); % with date and time folder
mStruct.RecordOutputBaseFolder = fullfile( 'recordings/MyRenderer', datestr( datetime( now, 'yyyy-mm-dd_HH-MM-SS' ) ) ); % with date and time folder
va.set_rendering_module_parameters( 'MyRenderer', mStruct );
</code></pre>
<br />
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment