ArticulatoryConsonantExtractor

Defined in: voxatlas.features.phonology.articulatory.consonant

class voxatlas.features.phonology.articulatory.consonant.ArticulatoryConsonantExtractor

Bases: BaseExtractor

Extract the phonology.articulatory.consonant feature within the VoxAtlas pipeline.

This public extractor defines the reusable API for computing phonology.articulatory.consonant from VoxAtlas structured inputs. It consumes phoneme units and produces values aligned to phoneme units, making the extractor a stable pipeline node that can be cited independently of the surrounding execution machinery.

Algorithm

The extractor maps phoneme labels to articulatory classes using the phonology resource tables bundled with VoxAtlas.

1. Resource lookup Each aligned phoneme label is normalized to IPA-like form and matched against the articulatory feature inventory.

2. Class projection The output is a binary or categorical indicator, typically representable as \(x_i = \mathbf{1}[\mathrm{phoneme}_i \in C]\) for a class \(C\) such as vowels, nasals, or plosives.

3. Packaging The resulting phoneme-aligned values can then be aggregated into rhythm or segmental summaries.

Notes

This extractor declares the upstream dependencies [‘phonology.articulatory.features’] and is executed only after those features are available in the pipeline feature store.

Examples

>>> import pandas as pd
>>> from voxatlas.features.feature_input import FeatureInput
>>> from voxatlas.features.feature_output import TableFeatureOutput
>>> from voxatlas.features.phonology.articulatory.consonant import ArticulatoryConsonantExtractor
>>> from voxatlas.pipeline.feature_store import FeatureStore
>>> table = pd.DataFrame({"id": [1, 2], "consonant": [1, 0]})
>>> store = FeatureStore()
>>> store.add(
...     "phonology.articulatory.features",
...     TableFeatureOutput(feature="phonology.articulatory.features", unit="phoneme", values=table),
... )
>>> feature_input = FeatureInput(audio=None, units=None, context={"feature_store": store})
>>> out = ArticulatoryConsonantExtractor().compute(feature_input, {})
>>> float(out.values.loc[1])
1.0

name: str = 'phonology.articulatory.consonant'

input_units: str | None = 'phoneme'

output_units: str | None = 'phoneme'

dependencies: list[str] = ['phonology.articulatory.features']

default_config: dict = {}

compute(feature_input, params)

Compute the extractor output for a single pipeline invocation.

This method is the reusable execution entry point for the extractor. It receives the standard FeatureInput bundle, applies the configured algorithm, and returns feature values aligned to the extractor output units for storage in the pipeline feature store.

Parameters:

• feature_input (object) – Structured extractor input bundling audio, hierarchical units, and execution context for this feature computation.

• params (object) – Resolved feature configuration for this invocation. Keys are feature-specific and merged from defaults and pipeline settings.

Returns:

Structured output aligned to the phoneme unit level when applicable.

Return type:

FeatureOutput

Examples

>>> import pandas as pd
>>> from voxatlas.features.feature_input import FeatureInput
>>> from voxatlas.features.feature_output import TableFeatureOutput
>>> from voxatlas.features.phonology.articulatory.consonant import ArticulatoryConsonantExtractor
>>> from voxatlas.pipeline.feature_store import FeatureStore
>>> table = pd.DataFrame({"id": [1], "consonant": [1]})
>>> store = FeatureStore()
>>> store.add(
...     "phonology.articulatory.features",
...     TableFeatureOutput(feature="phonology.articulatory.features", unit="phoneme", values=table),
... )
>>> feature_input = FeatureInput(audio=None, units=None, context={"feature_store": store})
>>> result = ArticulatoryConsonantExtractor().compute(feature_input, {})
>>> result.unit
'phoneme'