parse_array_slices_Nd

parse_array_slices_Nd(key: Union[tuple, slice], extent: Box, dims: int = 3, h_dim: int = -3, w_dim: int = -2) → Tuple[Box, List[Optional[Any]]]

Parse multi-dim array-indexing inputs into a Box and slices.

Parameters

• key (Union[tuple, slice]) – Input to __getitem__.

• extent (Box) – Extent of the raster/label source being indexed.

• dims (int) – Total available indexable dims. Defaults to 3.

• h_dim (int) – Index of height dim. Defaults to -3.

• w_dim (int) – Index of width dim. Defaults to -2.

Raises

• NotImplementedError – If not (1 <= dims <= 3).

• TypeError – If key is not a slice or tuple.

• IndexError – if not (1 <= len(key) <= dims).

• TypeError – If the index for any of the dims is None.

• ValueError – If more than one Ellipsis (“…”) in the input.

• ValueError – If h and w indices (first 2 dims) are not slices.

• NotImplementedError – If input contains negative values.

Returns

A Box representing the h and w slices and a list

containing slices/index-values for all the dims.

Return type

Tuple[Box, list]