annotations.Activity package

Submodules

annotations.Activity.activity module

filename

sppas.src.annotations.Activity.activity.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

Activity automatic detection.

class annotations.Activity.activity.Activity

Bases: object

Create an activity tier from time-aligned tokens.

__init__()

Create a sppasActivity instance with the default symbols.

append_activity(token, activity)

Append a new activity.

Parameters

• token – (str) The token of the tier TokensAlign

• activity – (str) Name of the activity

fix_activity(annotation)

Return the activity name of an annotation.

get_tier(tokens_tier, tmin, tmax)

Create and return the activity tier.

Parameters

tokens_tier – (sppasTier) a tier with time-aligned tokens

Returns

sppasTier

set_activities(activities={'#': 'silence', '*': 'noise', '+': 'pause', '@': 'laugh', 'dummy': 'dummy', 'laugh': 'laugh', 'noise': 'noise', 'sil': 'silence', 'sp': 'pause'})

Fix the dictionary of possible non-speech activities.

Parameters

activities – (dict) A dictionary of activities.

The key is the token; the value is the name of the activity.

annotations.Activity.sppasactivity module

filename

sppas.src.annotations.Activity.sppasactivity.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

SPPAS integration of Activity automatic annotation

class annotations.Activity.sppasactivity.sppasActivity(log=None)

Bases: annotations.baseannot.sppasBaseAnnotation

SPPAS integration of the Activity generation.

__init__(log=None)

Create a new sppasActivity instance.

Parameters

log – (sppasLog) Human-readable logs.

convert(tier, tmin, tmax)

Create an Activity and ActivityDuration tier.

Parameters

• tier – (sppasTier)

• tmin – (sppasPoint)

• tmax – (sppasPoint)

Returns

(sppasTier, sppasTier)

fix_options(options)

Fix all options.

Available options are:

• duration

Parameters

options – (sppasOption)

get_input_patterns()

List of patterns this annotation expects for its input filenames.

get_inputs(input_files)

Return the the tier with aligned tokens.

Parameters

input_files – (list)

Raise

NoTierInputError

Returns

(sppasTier)

get_output_pattern()

Pattern this annotation uses in an output filename.

run(input_files, output=None)

Run the automatic annotation process on an input.

Important: options could be changed!

Parameters

• input_files – (list of str) Time-aligned tokens

• output – (str) the output name - either filename or basename

Returns

(sppasTranscription)

set_duration_tier(value)

Fix the activity duration option.

Parameters

value – (bool) Activity tier generation.

Module contents

filename

sppas.src.annotations.activity.__init__.py

author

Brigitte Bigi

contact

develop@sppas.org

summary

Activity automatic annotations of SPPAS.

An activity is defined by a type of audio production. Activities can be of types: speech, silence, laugh, noise, etc.

class annotations.Activity.Activity

Bases: object

Create an activity tier from time-aligned tokens.

__init__()

Create a sppasActivity instance with the default symbols.

append_activity(token, activity)

Append a new activity.

Parameters

• token – (str) The token of the tier TokensAlign

• activity – (str) Name of the activity

fix_activity(annotation)

Return the activity name of an annotation.

get_tier(tokens_tier, tmin, tmax)

Create and return the activity tier.

Parameters

tokens_tier – (sppasTier) a tier with time-aligned tokens

Returns

sppasTier

set_activities(activities={'#': 'silence', '*': 'noise', '+': 'pause', '@': 'laugh', 'dummy': 'dummy', 'laugh': 'laugh', 'noise': 'noise', 'sil': 'silence', 'sp': 'pause'})

Fix the dictionary of possible non-speech activities.

Parameters

activities – (dict) A dictionary of activities.

The key is the token; the value is the name of the activity.

class annotations.Activity.sppasActivity(log=None)

Bases: annotations.baseannot.sppasBaseAnnotation

SPPAS integration of the Activity generation.

__init__(log=None)

Create a new sppasActivity instance.

Parameters

log – (sppasLog) Human-readable logs.

convert(tier, tmin, tmax)

Create an Activity and ActivityDuration tier.

Parameters

• tier – (sppasTier)

• tmin – (sppasPoint)

• tmax – (sppasPoint)

Returns

(sppasTier, sppasTier)

fix_options(options)

Fix all options.

Available options are:

• duration

Parameters

options – (sppasOption)

get_input_patterns()

List of patterns this annotation expects for its input filenames.

get_inputs(input_files)

Return the the tier with aligned tokens.

Parameters

input_files – (list)

Raise

NoTierInputError

Returns

(sppasTier)

get_output_pattern()

Pattern this annotation uses in an output filename.

run(input_files, output=None)

Run the automatic annotation process on an input.

Important: options could be changed!

Parameters

• input_files – (list of str) Time-aligned tokens

• output – (str) the output name - either filename or basename

Returns

(sppasTranscription)

set_duration_tier(value)

Fix the activity duration option.

Parameters

value – (bool) Activity tier generation.