Skip to content

cpran/plugin_vieweach

Repository files navigation

vieweach build badge

See the wiki for the complete documentation

Description

This plugin provides features for iterating through an arbitrarily complex sets of objects. They are provided both as procedures, to make it easier to write scripts that use those iterative features, and as scripts, to encapsulate the most commonly needed applications.

The procedures are written in such a way that their behaviour can be almost completely redefined by means of procedure redefinition, which is a way to implement something akin to code hooks in Praat.

In simple terms, this means that the code that gets executed at specific times during the iteration are designed to be modified. This makes the procedures incredibly versatile.

Procedures

The first set of procedures (for_each.proc) defines the core iterative features, which uses Table and Strings objects to represent sets of objects to iterate over. This makes it possible to seamlessly iterate over objects that reside in the Object list, on disk, or in a combination of both.

The second set of procedures (view_each.proc) demonstrates one possible application of for_each to allow for easy navigation both back and forth over the specified (sets of) objects, opening the appropriate editor window for each when available.

Scripts

These two set of procedures are further packaged into two corresponding scripts: for_each.praat and view_each.praat.

The first one will execute a specified script during each iteration, and select all the objects created over those iterations at the end. The script also makes it possible to specify whether the iteration should be done directly over the selected objects, by selecting one object per type for each iteration, or by using the selected objects (either Table or Strings objects) as sets of objects.

As an example, if told to iterate over the selected objects, and given a script with the instructions

name$ = extractWord$(selected$(), " ")
Copy: name$

then the resulting selection after completion would be a copy of all the initially selected objects.

The second comes in two flavours, and will iterate over either objects in the Object list or on disk and provide an editor for each, if applicable. If the selection includes only Sound and TextGrid objects, then the script will automatically pair these for each iteration. The navigation over the objects is robust enough to support the deletion of objects with no ill effects.

Customization

The provided scripts and the tests provide a good example of the versatility made possible thanks to procedure redefinition. Take a look at the code for ideas, or visit the wiki for the full documentation of the available hooks and start writing your own scripts!

Requirements

About

Iterate through arbitrary sets of Praat objects (Mirror)

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published