stack_patches

function of dascore.utils.patch source

stack_patches(
    patches ,
    dim_vary = None,
    check_behavior: Literal[‘warn’, ‘raise’, None] = warn,
)-> ‘PatchType’

Stack (add) all patches compatible with first patch together.

Parameters

Parameter Description
dim_vary The name of the dimension which can be different in values
(but not shape) and patches still added together.
If None, all dimension values must be equal.
check_behavior Indicates what to do when an incompatible patch is found in the
spool. None will silently skip any incompatible patches,
‘warn’ will issue a warning and then skip incompatible patches,
‘raise’ will raise an
IncompatiblePatchError
if any incompatible patches are found.

Examples

import dascore as dc
# add a spool with equal sized patches but progressing time dim
spool = dc.get_example_spool()
stacked_patch = spool.stack(dim_vary='time')