Plugins

Annotation Pro enables easy and efficient extensions of the built-in functionality by means of plugins. In this section we will publish some of the plugins. Further below you can also find some help on how to create a plugin of your own, and a link to Annotation Pro API.

In order to use any of the Annotation Pro plugins it is sufficient to save the plugin to the ‘Plugins’ folder in the ‘Annotation Pro’ folder on your disk (the plugins below are zipped, so after saving them you also need to unzip them). Then the plugin’s name becomes visible in the Plugins menu in your Annotation Pro programme (you might need to press ‘Refresh’ in order to update the display of the menu list). The plugins can be used for a single annotation file or for a number of files selected in the programme’s workspace (choose “Workspace Mode” for using a plugin with multiple files selected in your workspace).

Plugin name Description Details Download
Statistics – Annotation Pro + TGA Plugin based on the TGA idea and on-line tool solution by Dafydd Gibbon. Update: enables file collections processing (Workspace Mode) Read more... Download
Statistics – Segment Rate Moving Average (SRMA) Calculates segment rate using moving average method Read more... Download

 

Statistics – nPVI moving average (nPVIMA) Computes nPVI (Normalized Pairwise Variability Index) Read more... Download
Statistics – Segment Rate in a Layer Calculates the segments rate within an annotation layer (in segments per second) Read more... Download
Statistics – Duration Quadrants Calculates z-scored durations of consecutive segments within an annotation layer and plots results as proposed by Petra Wagner Read more... Download
Feature space analysis – Assign labels to polygon areas Assigns text labels to polygon areas in the picture used as the graphical representation of the feature space in perception-based annotation or tests Read more... Download
Export -Export selected layers to CSV Exports selected layers (specified by ‘layerNames’) from one file or file collection (Workspace Mode) to a CSV file. Download
Export – Export selected layers as TextGrids Exports selected layers (specified by ‘layerNames’) to TextGrid (Praat) format. Download
Edit – Remove pauses Removes segments (specified by ‘pausePattern’) from one or more files (Workspace Mode) Read more... Download
Edit – Find & Replace Replaces one string by another or removes a string from (a collection of) annotations. (Workspace Mode) Read more... Download
Edit – Remove empty segments Removes segments that do not include any label from (a collection of) annotations. (Workspace Mode) Read more... Download

 

How to write my own plugin

In order to create a plugin you do not need any expensive tools. Plugins should be created in C# programming language. To edit a plugin it is sufficient to use a simplest notepad software or any other programme supporting edition of C# files; e.g., Notepad or (preferably) Notepad 2 or Notepad ++ software which offer more options for displaying syntax in colours or line numbering. You can also download a freeware version of Visual Studio – Visual Studio Express that offers even more support for writing in C#. Visual Studio Website.

  1. Copy the file above and save it as: Examples#HelloWorld.cs
  2. Store it to the folder: Dokumenty\Annotation Pro\Plugins
  3. Run it in Annotation Pro here: Plugins -> Examples -> HelloWorld. If you cannot see plugin name in the menu, press: Plugins -> Refresh.
  4. Open file: Examples#HelloWorld.cs in Notepad or other editor and look at its content.

Grouping plugins

When the number of your plugins becomes too high and it is not comfortable to display them in one list you can group them in the Plugins . The character #  in the name of your plugin indicates dividing the name of the group from the name of the specific plugin. The part of the name to the left from # is the group name. The group will be automatically created in the menu when you start the programme.

Annotation Pro API

Application Pramming Interface is a detailed description of classes and functions available for the creators of plugins. You can check the detail parameters of functions or methods of clasess.

Annotation Pro API

More about plugins & other plugin scripts

More details about the API, Annotation Pro plugin architecture, example use cases, some programming guidelines, and sample plugin scripts can be found in: Klessa, K. (2016). Speech Annotation Mining with Annotation Pro plugins, Wydawnictwo Rys, Poznań. ISBN 978-83-65483-20-1 (download the plugin listings described in the book).

Sharing plugins & cooperation

In case if you wish to share your plugin by publishing it on this website, please contact Kasia Klessa at katarzyna@klessa.pl, we will add your plugin description to the list, cite your reference(s), and publish a download link. In case if you have an idea for a new plugin but you are not sure how to create  it – you are also welcome to get in touch at the same address, we’ll be happy to try and help!

Comments are closed.