UT3Variations.unit

static t3toolbox.uniform_frame_variations_format.UT3Variations.unit(uniform_variation_shapes, shape, index, stack_shape=(), masks=None, use_jax=False)

def unit(
        uniform_variation_shapes,
        shape:       typ.Sequence[int],
        index:       typ.Tuple[bool, int, typ.Sequence[int]],  # (use_tt_coordinate, i, within_index)
        stack_shape: typ.Tuple[int, ...] = (),
        masks:       typ.Optional['UT3VariationsMasks'] = None,
        use_jax:     bool = False,
) -> 'UT3Variations':

Canonical unit variation: zero supercores except a single entry set to 1 (broadcast over the stack). index = (use_tt_coordinate, i, within_index) selects the family, the mode i, and the within-core entry. (For a meaningful unit the entry must land in a real slot – automatic under the all-True default.)

Parameters:

• shape (t3toolbox.backend.common.typ.Sequence[int])

• index (t3toolbox.backend.common.typ.Tuple[bool, int, t3toolbox.backend.common.typ.Sequence[int]])

• stack_shape (t3toolbox.backend.common.typ.Tuple[int, Ellipsis])

• masks (t3toolbox.backend.common.typ.Optional[UT3VariationsMasks])

• use_jax (bool)

Return type:

UT3Variations