bioio.Dimensions

class bioio.Dimensions(dims: Collection[str], shape: Tuple[int, ...])[source]

A general object for managing the pairing of dimension name and dimension size.

Parameters:
dims: Collection[str]

An ordered string or collection of the dimensions to pair with their sizes.

shape: Tuple[int, …]

An ordered tuple of the dimensions sizes to pair with their names.

Examples

>>> dims = Dimensions("TCZYX", (1, 4, 75, 624, 924))
... dims.X
... dims['T', 'X']
__init__(dims: Collection[str], shape: Tuple[int, ...])[source]

A general object for managing the pairing of dimension name and dimension size.

Parameters:
dims: Collection[str]

An ordered string or collection of the dimensions to pair with their sizes.

shape: Tuple[int, …]

An ordered tuple of the dimensions sizes to pair with their names.

Examples

>>> dims = Dimensions("TCZYX", (1, 4, 75, 624, 924))
... dims.X
... dims['T', 'X']

Methods

__init__(dims, shape)

A general object for managing the pairing of dimension name and dimension size.

items()

Attributes