## On this page

  

 

 # sound:xtract tonal detection

 Last update: 31.07.2026 

**Version: 0.0.0**

## Description

Tonal components detection and isolation, using the XTRACT algorithm.

## Inputs

InputNameExpected type(s)Description**Pin 0**   
Requiredinput\_signal[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#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**   
Requiredinput\_parameters[`generic_data_container`](../../core-concepts/dpf-types.md#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

OutputNameExpected type(s)Description**Pin 0**output\_tonal\_signals[`fields_container`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#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`](../../core-concepts/dpf-types.md#fields-container), [`field`](../../core-concepts/dpf-types.md#field)Non-tonal signal: original signal minus tonal signal, as a field or fields\_container (depending on the input).## Configurations

NameExpected type(s)Default valueDescription**mutex**[`bool`](../../core-concepts/dpf-types.md#standard-types)falseIf 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.