Selecting the Insert Text menu opens a text entry at the mouse cursor position.
Clicking outside the text entry or pressing the Del key closes the text entry.
Afterwards, the text can be moved using Drag and Drop.
Right clicking on the text shos a menu that enables to Delete it,
Edit it or changes its Font And Color.
The Export Image menu opens a file chooser dialog for selecting the file
in which the plot view will be saved. Supported file extensions are
png, bmp and jpg.
Selecting the Print Coordinates or pressing the C key toggles the printing
of the mouse cursor coordinates when moving the mouse.
⚠ This works only if the axis are shown.
i.e Show Axis is checked in the Plot Settings dialog.
The Plot Settings menu opens the next dialog box.
Plot Settings example (Up) and corresponding view (Down).
The Show Axis checkbox toggles if the axis are shown or not.
If Grid Lines is checked, grid lines are drawn across the plot if
Show Axis is also checked.
If Log(x) is checked, the x scale is logarithmic.
The X Left, X Right, Y Down and Y Up entries
set the plot boundaries.
The X Tick and Y Tick entries set the target number of tick
on the X and Y axis.
⚠ This number may not be fully
respected in order to reduce the number of digits required for plotting
values beside the ticks.
The X Border and Y Border entries set the space between
the axis and the plot.
The X Label and Y Label entries set the label of both axis.
Global Settings
The Settings dialog opens when you press the
button
in the top toolbar of the application.
If you click on the General tab, you can set some global parameters.
The Font button opens a dialog box that sets font and text color for
all the plot view axis and labels.
If Apply On Text Lines is checked, the font settings also apply to the
text lines created using the Plot > Insert Text menu and also
becomes the default when creating new text lines.
If Execute Macro At Startup is checked, the .py file selected using the
button
beside is executed when launching the software.
if Record macro is checked, All actions perfomed through the graphical
user interface are recorded and can be saved as Python scripts
(see Python section) .
If Compare Image is checked, each time an image is exported by a macro,
the exported image file is saved with its name modified with a _macro
suffix and compared to the file created previsously. If the files differ,
a dialog pops up asking if the image file has to be replaced or not.
Pressing the buttton
at the bottom left of the dialog loads previously saved
preferences file.
Pressing the buttton
saves the curent defaults to the file selected with the file chooser that pops up.
if Auto Save is checked, the current defaults are saved to
the Preferences file in your User Settings
folder when you close the application.
⚠ If you have previously saved your settings to another file,
it will be saved in that file instead but the default file
loaded by the application at startup remains unchanged.
⚠ When you uncheck Auto Save, you have to
save your preferences using the
buttton.
if Updates is checked, the application contacts our server at startup
and proposes you to install a new version if it is available.
The Acoustic / Speech checkbox toggles the corresponding setup option.
Directories
After first lauch, the following directories are created:
After installation, it contains the following subdirectories:
Acoustic Graphs for storing acoustic graph files.
Initially, this folder contains the acoustic graph files required
for executing the macro files described below.
Macros for storing python scripts.
Initially, this folder contains the following macro files.
import_acwato.py: Imports the acwato module from any Python interpreter compatible with
Python
3.10.
glottis_from_a.py: This script extracts glottal waveform from oral vowel
as explained in the DSP section.
story.py: This script synthesizes english vowels from vocal tract area
functions obtain from magnetic resonance imaging by Story and all.
acoustic_graph.py: This macro reproduces all the figures of the
acoustic graph article.
Pictures for storing images generated by the software
(see see here ).
article: Initially, this folder contains the audio files required for executing the
acoustic_graph.py script
described above. It will be filled with the image files generated by this macro
after execution.
Python
Here are the functions that can be called from Python scripts.
AddTextLine(string viewName, float x, float y)
# Add a text line in the view viewName
at position x, y
SetTextLine(string viewName, int index, string text)
# Set the text content of the text line index (creation order)
# in the view viewName.
MoveTextLine(string viewName, int index, float x, float y)
# Move the text line to the position x, y
RemoveTextLine(string viewName, int index)
# Remove the text line.
SetTextLineFont(string viewName, int index, .....)
# Set the text line font and color.
# ⚠ the arguments following index are OS dependent
# (Windows, Linux, macOS).
# You will have to use
Save Macro
and copy
# the resulting line in order to
get the font characteristics.
# Some font are not supported on all OS but the size and color
# should be correct when you execute a python script on a
# different OS than the one on which it was recorded.
##############################################
ExportImage(string viewName, string fileName)
# Export the view viewName to the file fileName.
# Returns returns 1 if image has changed and 0 otherwise.
FileCompare(string fileName1, string fileName2)
# Returns 1 if files differ, 0 if identical and -1 if
# one of the files cannot be opened.
SetPlotSettings(string viewName, float xLeft, float xRight, float yDown, float yUp,
int xBorder, int yBorder, int showAxis, int numOfTickX, int numOfTickY, int logX, int showGridLines,
string xLabel, string yLabel)
# Set the Plot Settings of the view viewName.
# showAxis, logX and showGridLines are false if 0, true otherwise.
SetDefaultNotebookPage(int tabIndex)
# Set the Global Settings tab.
# In the example here, it is 0 (General) or 1 (Audio) because
# Acoustic Speech is unchecked, otherwise,
# it can also be 2 (Acoustic Model) or 3 (Numerical Model).
SetAllPlotBackgroundColour(int red, int green, int blue)
# Set the Background Colour of all grapics views.
# red, green and blue ∈ [0,255]
SetAllPlotFont(.......)
# Set default font for all views as well as for axis labels
# and coordinates.
# See SetTextLineFont comments for arguments.
# If ApplyFontOnTextLines(int b)
# is called before, it also applies on existing text lines if b !=0.
LoadDefaults(string fileName)
# Loads the settings from the file fileName.
SaveDefaults (string fileName)
# Saves the settings to the file fileName.
LoadMacro(string fileName)
# Loads and executes the python script fileName (.py)
AutoSavePreferences(int b) # checks the Auto Save checkbox
# if b != 0, unchecks it otherwise.
SetSpeechModule(int b) # activates the Acoustic / Speech module
# if b != 0, deactivates it otherwise.
SetViewSize(string viewName, in width, int height)
# Set width and hight of the view viewName.
#### View Names (Basic) ####
"Signal:0" # left audio signal chanel.
"Signal:1" # right audio signal chanel "SoundFFT" # spectral analysis (FFT) "DSPFilter:mod" # DSP filter module |H| "DSPFilter:arg" # DSP filter phase arg(H) #### View Names (Acoustic / Speech) ####
"AcousticGraph" # Graph View "AcousticGraphResultPlot" # Transfer Function View "AreaFunction[graphIngex][edgeIndex]"
# Area Function # It is not easy to know the graph index
# (if there are several disconnected graph in the view)
# and egde index, but you can Save Macro after
# editing an area function to know its indexes.
"AcousticGraphCheck[column:line]" # Solution View # colum is the colum index (start from 0)
# line is the line index (start from 0)
button
in the top toolbar of the application.
If you click on the General tab, you can set some global parameters.
button
beside is executed when launching the software.
buttton
saves the curent defaults to the file selected with the file chooser that pops up.