peyk.platforms.telegram.types.mask_position

Classes

MaskPosition(point, x_shift, y_shift, scale)

This object describes the position on faces where a mask should be placed by default.
class peyk.platforms.telegram.types.mask_position.MaskPosition(point: str, x_shift: float, y_shift: float, scale: float)[source]

Bases: object

This object describes the position on faces where a mask should be placed by default.

Variables:

  • point (str) – The part of the face relative to which the mask should be placed. One of ‘forehead’, ‘eyes’, ‘mouth’, or ‘chin’.

  • x_shift (float) – Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.

  • y_shift (float) – Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.

  • scale (float) – Mask scaling coefficient. For example, 2.0 means double size.

point: str
x_shift: float
y_shift: float
scale: float
classmethod from_dict(data: dict | None) → MaskPosition | None[source]

Provides the from dict operation for the Telegram integration.

Parameters:

data – Value used by this operation.

Returns:

Result produced by the operation.

to_dict() → Dict[str, object][source]

Provides the to dict operation for the Telegram integration.

Returns:

Result produced by the operation.