make_scan_payload

function of dascore.io.core

source

make_scan_payload(
    attrs: dascore.core.attrs.PatchAttrs | collections.abc.Mapping[PatchAttrs, collections.abc.Mapping[str, Any], None] ,
    coords: CoordManager ,
    dims: collections.abc.Sequence[collections.abc.Sequence[str], None] = None,
    shape: collections.abc.Sequence[collections.abc.Sequence[int], None] = None,
    dtype: str = ““,
    source_patch_id: str =”“,
)-> ‘ScanPayload’

Build one normalized FiberIO scan payload.

Parameters

Parameter	Description
attrs	The patch attributes, or anything convertible to them.
coords	The coordinates of the patch, usually a CoordManager.
dims	The dimension names. If None, use those of coords.
shape	The shape of the patch data. If None, use that of coords.
dtype	The string representation of the data’s dtype.
source_patch_id	Identifies which logical patch of a multi-patch resource this is.