Skip to main content

Classes for defining sequential information from TextGrids

Project description

Aligned TextGrid

PyPI lint_and_test codecov Maintainability Build Docs DOI

The aligned-textgrid package provides a python interface for representing and operating on TextGrids produced by forced aligners like FAVE or the Montreal Forced Aligner. Classes provided by aligned-textgrid represent hierarchical and precedence relationships among data stored in TextGrid formats allowing for simplified and more accessible analysis of aligned speech data.

Example Use Cases

  • You want to quickly loop through the Phone tier of a Textgrid, and also access information about the word it is a part of.
  • You want to quickly loop over the Word tier of a Textgrid and quickly count how many phones it has.
  • You want to programmatically merge together adjacent Textgrid intervals.

For examples on how to use the pacakge, see the Usage pages.

Installation

To install aligned-textgrid using pip, run the following command in your terminal:

pip install aligned-textgrid

Not another TextGrid implementation

There are several other packages that parse Praat Textgrids, including

aligned-textgrid’s goal is to capture hierarchical and sequential relationships represented in many TextGrids, and to make them easilly accessible to users via an intuitive interface. The goal is that from any arbitrary location within a TextGrid, users can easilly access information with minimally defensive coding.

Example

As an example, we’ll read in a textgrid produced with forced alignment that contains a single speaker with a word and phone tier.

from aligned_textgrid import AlignedTextGrid, Word, Phone
tg = AlignedTextGrid(
    textgrid_path='doc_src/usage/resources/josef-fruehwald_speaker.TextGrid', 
    entry_classes=[Word, Phone]
    )

Then, we can access an arbitrary phone interval.

arbitrary_interval = tg[0].Phone[20]

From this aribitrary interval, we can access information about the intervals preceding and following with the .prev and .fol attributes.

print(arbitrary_interval.prev.label)
print(arbitrary_interval.label)
print(arbitrary_interval.fol.label)
R
EY1
N

We can also access information about the word this interval is nested within with the .inword attribute.

print(arbitrary_interval.inword.label)
raindrops

The object returned by .inword is just another interval, meaning we can access informaton about it’s context with the .prev and .fol attributes as well.

print(arbitrary_interval.inword.prev.label)
print(arbitrary_interval.inword.label)
print(arbitrary_interval.inword.fol.label)
strikes
raindrops
in

For more

You can also directly read up on the function and class references.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aligned_textgrid-0.6.2.tar.gz (36.4 kB view hashes)

Uploaded Source

Built Distribution

aligned_textgrid-0.6.2-py3-none-any.whl (40.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page