Welcome to SPPAS’s API documentation

http://www.sppas.org

SPPAS - the automatic annotation and analyses of speech, is a scientific computer software package written and maintained by Brigitte Bigi of the Laboratoire Parole et Langage, in Aix-en-Provence, France.

Access the modules

Quick overview of the modules

Package dependencies:

Configuration of the application, global data structures and utilities

filename

sppas.src.config.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

Package for the configuration of SPPAS.

config: configuration & globals of SPPAS

This package includes classes to fix all global parameters. It does not requires any other package but all other packages of SPPAS are requiring it!

All classes of this package are compatible with any version of python.

filename

sppas.src.utils.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

Utilities for SPPAS.

utils: utility classes.

This package includes any utility class to extend python features. Currently, it implements a class to manage identically unicode data with all versions of python. It also includes a comparator of data which is very powerful for lists and dictionaries, a bidirectional dictionary, a representation of time, etc.

Requires the following other packages:

  • config

filename

sppas.src.calculus.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

Package for the calculus of SPPAS.

calculus: proposes some math on data.

This package includes mathematical functions to estimate descriptive statistics, for the scoring or in the domain of the information theory.

No required other package. This package is compatible with all versions of Python (from 2.7 to 3.9).

filename

sppas.src.structs.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

Package for the data structures of SPPAS.

structs: access and manage data structures.

This package includes classes to manage data like un-typed options, a language, a dag…

Requires the following other packages:

  • config

  • utils

Data structures to manage files to work with and data knowledge files

filename

sppas.src.wkps.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

The application workspace manager.

wkps: management of files into workspaces

Description:

This package includes classes to manage a bunch of files organized into workspaces. A workspace is made of data related to the file names and a list of references to make relations between file roots.

Requires the following other packages:

  • config

  • structs

and globals: paths, sppasIndexError.

Contributors:

  • Barthélémy Drabczuk

  • Laurent Vouriot

filename

sppas.src.resources.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

Resource models of SPPAS.

resources: access and manage linguistic resources

This package includes classes to manage the data of linguistic types like lexicons, pronunciation dictionaries, patterns, etc.

Requires the following other packages:

  • config

Data structure to represent annotated data and recordings

filename

sppas.src.anndata.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

Package to manage annotated data.

anndata: management of transcribed data.

anndata is a free and open source Python library to access and search data from annotated data. It can convert file formats like Elan’s EAF, Praat’s TextGrid and others into a sppasTranscription() object and convert into any of these formats. Those objects allow unified access to linguistic data from a wide range sources.

It requires the following other packages:

  • config

  • utils

filename

sppas.src.audiodata.__init__.py

author

Nicolas Chazeau, Brigitte Bigi

contact

develop@sppas.org

summary

audio file manager.

audiodata: management of digital audio data.

Requires the following other packages:

  • config

filename

sppas.src.imgdata.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

Package for the management of image files

imgdata: management of image files

Requires the following other packages:

  • config

Requires the following other external libraries:

  • opencv

  • numpy

If the video feature is not enabled, the sppasEnableFeatureError() is raised when a class is instantiated.

filename

sppas.src.videodata.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

Package for the management of video files.

videodata: management of video files

Requires the following other internal packages:

  • config

  • utils

  • imgdata

Requires the following other external libraries:

  • opencv

  • numpy

If the video feature is not enabled, the sppasEnableFeatureError() is raised when a class is instantiated.

The features of SPPAS

filename

sppas.src.annotations.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

The automatic annotations of SPPAS.

annotations: automatic annotations.

This package includes all the automatic annotations, each one in a package and the classes to manage the data to be annotated and the resulting annotated data.

Requires the following other packages:

  • config

  • utils

  • exc

  • structs

  • wkps

  • resources

  • anndata

  • audiodata

  • imgdata – if “video” feature enabled

  • videodata – if “video” feature enabled

filename

sppas.src.config.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

Package for the automatic data analysis of SPPAS.

analysis: automatic data analysis

This package includes all the automatic analysis of annotated data. It requires the following other packages:

  • config

  • structs

  • anndata

  • calculus

filename

sppas.src.plugins.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

Package for plugins of SPPAS.

plugins: access and manage external programs.

This package includes classes to manage external program to plug into SPPAS.

Example

>>> # Create a plugin manager (it will explore the installed plugins).
>>> manager = sppasPluginsManager()
>>> # Install a plugin
>>> plugin_id = manager.install(plugin_zip_filename,
>>>                             plugin_destination_folder_name)
>>> # Get a plugin
>>> p = manager.get_plugin(plugin_id)
>>> # Apply a plugin on a list of files
>>> message = manager.run_plugin(plugin_id, [some_filename1, some_filename2])
>>> print(message)
>>> # Delete an installed plugin
>>> manager.delete(plugin_id)

Requires the following other packages:

  • config

  • utils

  • structs