Base class to predict the angle of the hand.
Currently, 5 vowel positions are possible, and they are associated to only one angle value. For English langage, this will have to be changed because some vowels have a movement effect: side-forward, side-down.
Angle value is given relatively to the horizontal axis, like in the following unit circle:
90° | | 180° ------- + ------- 0° | | 270° -90°
Instantiate a hand angle's predictor.
def __init__(self):
"""Instantiate a hand angle's predictor.
"""
self._description = MSG_DESCRIPTION_BASE
self._vowels = dict()
self._radius = 10
self.__vowel_mapping = {'b': self._calculate_angle_b, 'c': self._calculate_angle_c, 'm': self._calculate_angle_m, 's': self._calculate_angle_s, 't': self._calculate_angle_t, 'n': self._calculate_angle_n}
Return the list of vowel codes the class can calculate hand angles for.
def vowel_codes(self) -> tuple:
"""Return the list of vowel codes the class can calculate hand angles for."""
return tuple(self.__vowel_mapping.keys())
Vagueness of angle value.
def get_radius(self) -> int:
"""Vagueness of angle value."""
return self._radius
Fix a new radius value.
def set_radius(self, r: int):
"""Fix a new radius value.
:param r: (int) The new radius value between 0 and MAX_RADIUS.
:raises: ValueError: Invalid given radius value.
"""
r = int(r)
if r < 0 or r > self.MAX_RADIUS:
raise IntervalRangeException(r, 0, BaseWhereAnglePredictor.MAX_RADIUS)
self._radius = r
Return the angle at a given position.
def get_angle(self, vowel: str='n') -> tuple:
"""Return the angle at a given position.
:param vowel: (char) Vowel position name. If unknown, 'n' is used instead.
:return: (int)
:raises: sppasKeyError: Invalid given vowel code.
"""
if vowel in self._vowels:
return self._vowels[vowel]
raise sppasKeyError(vowel, 'Predicted Angles')
Estimate the angle of the hand for all the given positions.
It uses predefined angles and stores them in a dictionary.
def predict_angle_values(self, vowels=('n',)) -> None:
"""Estimate the angle of the hand for all the given positions.
It uses predefined angles and stores them in a dictionary.
:param vowels: (tuple) List of vowel position names. If unknown, 'n' is used instead.
:raises: sppasKeyError: Invalid given vowel code.
"""
self.check(vowels)
self._vowels = dict()
codes = self.vowel_codes()
for vowel in vowels:
if vowel not in codes:
raise sppasKeyError(vowel, 'Position Code')
self._vowels[vowel] = self.__vowel_mapping[vowel]()
Check if the given vowel codes are valid.
def check(self, vowels: list):
"""Check if the given vowel codes are valid.
:param vowels: (list of characters)
:raises: sppasKeyError: Invalid given vowel code.
"""
codes = self.vowel_codes()
for vowel in vowels:
if vowel not in codes:
raise sppasKeyError(vowel, 'Position Code')
To be overridden. Calculate the angle at the neutral position.
def _calculate_angle_n(self) -> int:
"""To be overridden. Calculate the angle at the neutral position.
:return: (int) angle in degrees
"""
return 60
To be overridden. Calculate the angle at the cheek bone position.
def _calculate_angle_b(self) -> int:
"""To be overridden. Calculate the angle at the cheek bone position.
:return: (int) angle in degrees
"""
return 60
To be overridden. Calculate the angle at the chin position.
def _calculate_angle_c(self) -> int:
"""To be overridden. Calculate the angle at the chin position.
:return: (int) angle in degrees
"""
return 60
To be overridden. Calculate the angle at the mouse position.
def _calculate_angle_m(self) -> int:
"""To be overridden. Calculate the angle at the mouse position.
:return: (int) angle in degrees
"""
return 60
To be overridden. Calculate the angle at the side position.
def _calculate_angle_s(self) -> int:
"""To be overridden. Calculate the angle at the side position.
:return: (int) angle in degrees
"""
return 60
To be overridden. Calculate the angle at the throat position.
def _calculate_angle_t(self) -> int:
"""To be overridden. Calculate the angle at the throat position.
:return: (int) angle in degrees
"""
return 60