Creates an instance of the CantoneseIPAOperator.

By default no tone marks will be shown.

Parameters:

• options - extra options
• dbConnectInst - instance of a DatabaseConnector, if none is given, default settings will be assumed.
• toneMarkType - type of tone marks, one out of 'Numbers', 'ChaoDigits', 'IPAToneBar', 'Diacritics', 'None'
• 1stToneName - tone for mark 1 under tone mark type 'Numbers', either 'HighLevel' or 'HighFalling'.
• stopTones - if set to 'none' the basic 6 (7) tones will be used and stop tones will be reported as one of them, if set to 'general' the three stop tones will be included, if set to 'explicit' the short and long forms will be explicitly supported.

Overrides: object.__init__

Returns the reading operator's default options.

The default implementation returns an empty dictionary. The keyword 'dbConnectInst' is not regarded a configuration option of the operator and is thus not included in the dict returned.

Returns: dict

the reading operator's default options.

Overrides: ReadingOperator.getDefaultOptions

(inherited documentation)

Returns a set of tones supported by the reading. These tones don't necessarily reflect the tones of the underlying language but may defer to reflect notational or other features.

The default implementation will raise a NotImplementedError.

Returns: list

list of supported tone marks.

Overrides: TonalFixedEntityOperator.getTones

(inherited documentation)

Gets the list of plain entities supported by this reading. Different to getReadingEntities() the entities will carry no tone mark.

The default implementation will raise a NotImplementedError.

Returns: set of str

set of supported syllables

Overrides: TonalFixedEntityOperator.getPlainReadingEntities

(inherited documentation)

Splits the given plain syllable into onset (initial) and rhyme (final).

Parameters:

• plainSyllable (str) - syllable in IPA without tone marks

Returns: tuple of str

tuple of syllable onset and rhyme

Raises:

• InvalidEntityError - if the entity is invalid (e.g. syllable nucleus or tone invalid).

Gets the entity with tone mark for the given plain entity and tone.

The plain entity returned will always be in Unicode's Normalization Form C (NFC, see http://www.unicode.org/reports/tr15/).

Parameters:

• plainEntity - entity without tonal information
• tone - tone

Returns: str

entity with appropriate tone

Raises:

• InvalidEntityError - if the entity is invalid.

Overrides: TonalFixedEntityOperator.getTonalEntity

(inherited documentation)

Splits the entity into an entity without tone mark and the name of the entity's tone.

The plain entity returned will always be in Unicode's Normalization Form C (NFC, see http://www.unicode.org/reports/tr15/).

Parameters:

• entity - entity with tonal information

Returns: tuple

plain entity without tone mark and additionally the tone

Raises:

• InvalidEntityError - if the entity is invalid.

Overrides: TonalFixedEntityOperator.splitEntityTone

(inherited documentation)

Gets the explicit tone for the given plain syllable and base tone.

In case the 6 (7) base tones are used, the stop tone value can be deduced from the given syllable. The stop tone returned will be even more precise in denoting the vowel length that influences the tone contour.

Parameters:

• plainSyllable (str) - syllable without tonal information
• baseTone (str) - tone

Returns: str

explicit tone

Raises:

• InvalidEntityError - if the entity is invalid.

Gets the base tone (one of the 6/7 general tones) for the given tone mark.

Parameters:

• toneMark (str) - tone mark representation of the tone

Returns: str

base tone

Raises:

• InvalidEntityError - if the toneMark does not exist.

TONES

List of tone names. Needs to be implemented in child class.

Value:

['HighLevel', 'MidLevel', 'MidLowLevel', 'HighRising', 'MidLowRising', 'MidLowFalling', 'HighFalling']

STOP_TONES

Cantonese stop tone mapping to general level tones.

Value:

{'HighStopped': 'HighLevel', 'MidLowStopped': 'MidLowLevel', 'MidStopped': 'MidLevel'}

STOP_TONES_EXPLICIT

Cantonese stop tone mapping to general level tones with stop tones realised for explicit marking short/long pronunciation.

Value:

{'HighStopped_Long': ('HighLevel', 'L'), 'HighStopped_Short': ('HighLevel', 'S'), 'MidLowStopped_Long': ('MidLowLevel', 'L'), 'MidLowStopped_Short': ('MidLowLevel', 'S'), 'MidStopped_Long': ('MidLevel', 'L'), 'MidStopped_Short': ('MidLevel', 'S')}

TONE_MARK_PREFER

Mapping of tone marks to tone name which will be preferred on ambiguous mappings. Needs to be implemented in child classes.

Value:

{'ChaoDigits': {}, 'Diacritics': {}, 'IPAToneBar': {}, 'Numbers': {'1': 'HighLevel'}}

TONE_MARK_MAPPING

Mapping of tone names to tone mark for each tone mark type. Needs to be implemented in child classes.

Value:

{'ChaoDigits': {'HighFalling': '52', 'HighLevel': '55', 'HighRising': '25', 'HighStopped_Long': '55', 'HighStopped_Short': '5', 'MidLevel': '33', 'MidLowFalling': '21', 'MidLowLevel': '22', ...