deltametrics.mobility.check_inputs

deltametrics.mobility.check_inputs(chmap, basevalues=None, basevalues_idx=None, window=None, window_idx=None, landmap=None)

Check the input variable values.

Ensures compatibility with mobility functions. Tries to convert from some potential input types (xarray data arrays, deltametrics masks) if possible.

Parameters:

• chmap (list, xarray.DataArray, numpy.ndarray) – Either a list of 2-D deltametrics.mask, xarray.DataArray, or numpy.ndarray objects, or a t-x-y 3-D xarray.DataArray or numpy.ndarray with channel mask values.

• basevalues (list, int, float, optional) – List of time values to use as the base channel map. (or single value)

• basevalues_idx (list, optional) – List of time indices to use as the base channel map. (or single value)

• window (int, float, optional) – Duration of time to use as the time lag (aka how far from the basemap will be analyzed).

• window_idx (int, float, optional) – Duration of time in terms of indices (# of save states) to use as the time lag.

• landmap (list, xarray.DataArray, numpy.ndarray, optional) – Either a list of 2-D deltametrics.mask, xarray.DataArray, or numpy.ndarray objects, or a t-x-y 3-D xarray.DataArray or numpy.ndarray with land mask values.

Return type:

Same as input, but with some type sanitization.