sound:xtract tonal detection
Last update: 31.07.2026Version: 0.0.0
Description
Tonal components detection and isolation, using the XTRACT algorithm.
Inputs
| Input | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 Required |
input_signal | fields_container, field |
Signal(s) from which we want to extract tonal components, as a field or fields_container. When inputting a fields_container, each signal (each field of the fields_container) is processed individually. |
| Pin 1 Required |
input_parameters | generic_data_container |
Structure that contains the parameters of the algorithm: * Nfft (int) in number of samples * Regularity setting between 0 (0%) and 1 (100%). For more information, refer to Ansys Sound SAS documentation. * Maximum slope (float) in dB/Hz * Minimum duration (float) in seconds * Intertonal gap (float) in Hz * Local smergence (float) in dB This structure is of type Xtract_tonal_parameters (see this class for more details). |
Outputs
| Output | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 | output_tonal_signals | fields_container, field |
Tonal signal: signal that contains the tonal components, as a field or fields_container (depending on the input). |
| Pin 1 | output_non_tonal_signals | fields_container, field |
Non-tonal signal: original signal minus tonal signal, as a field or fields_container (depending on the input). |
Configurations
| Name | Expected type(s) | Default value | Description |
|---|---|---|---|
| mutex | bool |
false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
Scripting
Category: sound
Plugin: sound
Scripting name: None
Full name: None
Internal name: xtract_tonal
License: avrxp_snd_level1
Changelog
- Version 0.0.0: Initial release.
