User Guide: Difference between revisions
No edit summary |
|||
| (46 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
{{User Guide}} | |||
==Organise your sound files== | |||
{{STX}} can play, analyse, annotate and modify wave files. The main application - the [[User_Guide/Workspace|Workspace]] - is where you load your sound files and start your analysis from. Your sound files are organised in a [[User_Guide/Project|project]] file. You can use the [[User_Guide/FindFile|FindFile]] application to search for wave files on disk and import them into {{STX}}. | |||
==Analyse a Signal== | |||
There are a number of applications for analysing signals in {{STX}}. | |||
* [[User_Guide/Real_Time_Analyser|Real-Time Analyser]] - analyse the current sound input as a spectrum, wave or spectrogram graph | |||
* [[User Guide/Waveform and Segmentation Viewer|Waveform and Segmentation Viewer]] - useful for segmenting signals | |||
* [[User Guide/Spectrogram and Parameter Viewer|Spectrogram and Parameter Viewer]] - calculate, edit and extract parameters from the signal. Segmentation is also easy here. | |||
* [[User Guide/Spectrum Viewer|Spectrum Viewer]] - average the spectra of a signal segment. | |||
* [[User Guide/Transcription Script|Transcription]] - an application specifically designed for segmentation and transcription. | |||
==Record a Signal== | |||
The [[User Guide/Recorder|Recorder]] can be used to save an input stream to disk and whilst segmenting it on the fly. | |||
==Command-Line Parameters== | |||
There is a minimal set of [[User Guide/Command-Line Parameters|command line parameters]] which can be passed to {{STX}}. | |||
==Concepts and Terminology== | |||
{{STX}} uses some concepts and terminology which might benefit from some explanation. See [[User Guide/Concepts and Terminology|Concepts and Terminology]]. | |||
==Tutorials== | |||
There are a few [[User Guide/Tutorials|tutorials available]]. | |||
* [[User_Guide/Tutorials/Analysing_a_sound_file|Analysing a sound file]] | |||
* [[User_Guide/Tutorials/Opening_the_samples.stxpr_project|Opening the sample project]] | |||
* [[User_Guide/Tutorials/Playing_a_sound_file|Play a sound file]] | |||
* [[User_Guide/Tutorials/Running_an_application|Running an application]] | |||
* [[User_Guide/Tutorials/Setting_the_default_application|Setting the default application]] | |||
* [[User_Guide/Tutorials/Zooming_in_a_Viewer|Zooming in a viewer]] | |||
There is also the introductory video about [https://kfsmail.kfs.oeaw.ac.at/owncloud/index.php/s/cbMjVjgQLZGjYk8 the compact workspace]. | |||
==Scripts, Toolboxes, Development, and Extending {{STX}}== | |||
{{STX}} comes with a number of [[User Guide/Pre-installed scripts|pre-installed scripts]] - applications written in the {{STX}} scripting language, and loaded and run from a text file. You can write your own {{STX}} scripts, [[User Guide/Toolbox|toolboxes]] and applications. All the functionality that you find in {{STX}} is available to you in the script language. The [[User Guide/The_Script_Controller|script controller]] dialog, the [[User Guide/STX_Console|command line console]], the integrated [[User Guide/Debugger|debugger]] and the [[Programmer Guide]] will help you. | |||
==The Log Window== | |||
The little window up on the left hand corner of the screen is the {{STX}} [[/Log Window/]]. You can start a number of applications from here, change some general {{STX}} settings, and view the log messages. | |||
Latest revision as of 12:08, 4 October 2019
Contents
Organise your sound files
STx can play, analyse, annotate and modify wave files. The main application - the Workspace - is where you load your sound files and start your analysis from. Your sound files are organised in a project file. You can use the FindFile application to search for wave files on disk and import them into STx.
Analyse a Signal
There are a number of applications for analysing signals in STx.
- Real-Time Analyser - analyse the current sound input as a spectrum, wave or spectrogram graph
- Waveform and Segmentation Viewer - useful for segmenting signals
- Spectrogram and Parameter Viewer - calculate, edit and extract parameters from the signal. Segmentation is also easy here.
- Spectrum Viewer - average the spectra of a signal segment.
- Transcription - an application specifically designed for segmentation and transcription.
Record a Signal
The Recorder can be used to save an input stream to disk and whilst segmenting it on the fly.
Command-Line Parameters
There is a minimal set of command line parameters which can be passed to STx.
Concepts and Terminology
STx uses some concepts and terminology which might benefit from some explanation. See Concepts and Terminology.
Tutorials
There are a few tutorials available.
- Analysing a sound file
- Opening the sample project
- Play a sound file
- Running an application
- Setting the default application
- Zooming in a viewer
There is also the introductory video about the compact workspace.
Scripts, Toolboxes, Development, and Extending STx
STx comes with a number of pre-installed scripts - applications written in the STx scripting language, and loaded and run from a text file. You can write your own STx scripts, toolboxes and applications. All the functionality that you find in STx is available to you in the script language. The script controller dialog, the command line console, the integrated debugger and the Programmer Guide will help you.
The Log Window
The little window up on the left hand corner of the screen is the STx Log Window. You can start a number of applications from here, change some general STx settings, and view the log messages.
