funcs ¶

Bases: Flag

Defines alignment flags for positioning elements vertically and horizontally.

Attributes:

• BOTTOM –

  Align to the bottom.

• BOTTOM_CENTER –

  Align to the bottom-center.

• BOTTOM_LEFT –

  Align to the bottom-left corner.

• BOTTOM_RIGHT –

  Align to the bottom-right corner.

• CENTER –

  Align to the horizontal center.

• LEFT –

  Align to the left.

• MIDDLE –

  Align to the vertical center.

• MIDDLE_CENTER –

  Align to the center (both vertically and horizontally).

• MIDDLE_LEFT –

  Align to the middle-left.

• MIDDLE_RIGHT –

  Align to the middle-right.

• RIGHT –

  Align to the right.

• TOP –

  Align to the top.

• TOP_CENTER –

  Align to the top-center.

• TOP_LEFT –

  Align to the top-left corner.

• TOP_RIGHT –

  Align to the top-right corner.

BOTTOM = auto()

BOTTOM_CENTER = BOTTOM | CENTER

BOTTOM_LEFT = BOTTOM | LEFT

BOTTOM_RIGHT = BOTTOM | RIGHT

CENTER = auto()

LEFT = auto()

MIDDLE = auto()

MIDDLE_CENTER = MIDDLE | CENTER

MIDDLE_LEFT = MIDDLE | LEFT

MIDDLE_RIGHT = MIDDLE | RIGHT

RIGHT = auto()

TOP = auto()

TOP_CENTER = TOP | CENTER

TOP_LEFT = TOP | LEFT

TOP_RIGHT = TOP | RIGHT

Bases: CustomStrEnum

Convolution mode for .std.Convolution or std.AverageFrames

Methods:

• from_param –

  Return the enum value from a parameter.

• value –

Attributes:

• H –

  Alias for ConvMode.HORIZONTAL

• HORIZONTAL –

  Horizontal-only convolution.

• HV –

  Horizontal and Vertical convolution

• S –

  Alias for ConvMode.SQUARE

• SQUARE –

  Square horizontal/vertical convolution.

• T –

  Alias for ConvMode.TEMPORAL

• TEMPORAL –

  Temporal convolution

• V –

  Alias for ConvMode.VERTICAL

• VERTICAL –

  Vertical-only convolution.

• is_one_dim (bool) –
• is_spatial (bool) –
• is_temporal (bool) –
• is_two_dim (bool) –

H = HORIZONTAL

HORIZONTAL = 'h'

HV = 'hv'

S = SQUARE

SQUARE = 's'

T = TEMPORAL

TEMPORAL = 't'

V = VERTICAL

VERTICAL = 'v'

is_one_dim: bool

is_spatial: bool

is_temporal: bool

is_two_dim: bool

from_param(value: Any, func_except: FuncExcept | None = None) -> Self

40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

@classmethod
def from_param(cls, value: Any, func_except: FuncExcept | None = None) -> Self:
    """
    Return the enum value from a parameter.

    Args:
        value: Value to instantiate the enum class.
        func_except: Exception function.

    Returns:
        Enum value.

    Raises:
        NotFoundEnumValue: Variable not found in the given enum.
    """
    func_except = func_except or cls.from_param

    try:
        return cls(value)
    except (ValueError, TypeError):
        pass

    if isinstance(func_except, tuple):
        func_name, var_name = func_except
    else:
        func_name, var_name = func_except, repr(cls)

    raise NotFoundEnumValueError(
        'The given value for "{var_name}" argument must be a valid {enum_name}, not "{value}"!\n'
        "Valid values are: [{readable_enum}].",
        func_name,
        var_name=var_name,
        enum_name=cls,
        value=value,
        readable_enum=(f"{name} ({value!r})" for name, value in cls.__members__.items()),
        reason=value,
    ) from None

value() -> str

97
98

@enum_property
def value(self) -> str: ...