read_array

method of dascore.io.core.FiberIO source

read_array(
    self ,
    resource ,
    windows: collections.abc.Sequence[tuple[tuple[int | None[int, None], int | None[int, None]], <class ’slice, None]] = (),
    key: str = ““,
)-> ‘np.ndarray’

Read one logical patch’s array over half-open positional windows.

windows holds a (start, stop) sample range for each axis of the returned array, in order, as array[start:stop, ...] would; an entry of None, or an axis left off the end, is returned whole; the framework really does pass None, so an implementer must take it. The array has the axis order, shape, and dtype declared by get_metadata, including format-specific layout and scaling. key names the array: the logical patch of a multi-patch resource, or a path inside the resource. Readers which cannot slice storage decode and then slice.