UT3Frame.from_t3frame

static t3toolbox.uniform_frame_variations_format.UT3Frame.from_t3frame(frame, N=None, nU=None, nD=None, rL=None, rR=None)

def from_t3frame(
        frame: bvf.T3Frame,
        N:  typ.Optional[int] = None,   # padded mode dim   (default max(shape))
        nU: typ.Optional[int] = None,   # padded up rank    (default max(up_ranks))
        nD: typ.Optional[int] = None,   # padded down rank  (default max(down_ranks))
        rL: typ.Optional[int] = None,   # padded left rank  (default max(left_ranks))
        rR: typ.Optional[int] = None,   # padded right rank (default max(right_ranks))
) -> 'UT3Frame':

Pack a ragged T3Frame into a uniform frame.

A single ragged frame has ranks shared across its C stack, so the masks come out uniform across the stack (varying-rank uniform batches arise only by stack-ing a heterogeneous tree).

Parameters:

• frame (T3Frame)

• N (t3toolbox.backend.common.typ.Optional[int])

• nU (t3toolbox.backend.common.typ.Optional[int])

• nD (t3toolbox.backend.common.typ.Optional[int])

• rL (t3toolbox.backend.common.typ.Optional[int])

• rR (t3toolbox.backend.common.typ.Optional[int])

Return type:

UT3Frame