outRange

utilipy.data_utils.outRange(*args: Union[numpy.array, Sequence], rng: Optional[Sequence] = None, lbi: bool = True, ubi: bool = False, as_ind: bool = False) numpy.array[source]

Multidimensional box exclusion.

equivelent to ~inRange

Parameters
argslist

either list of values along each dimension or list of values & bounds the input type depends on rng

rngNone or list

(default None) if rng is not None:

args = [[x1], [x2], ...]
rng =   [1st [lower, upper],
         2nd [lower, upper],
         ...]

else, args are the list of (x, [lower bound, upper. bound])

lbibool

(default False) Lower Bound Inclusive, whether to be inclusive on the lower bound

ubibool

(default True) Upper Bound Inclusive, whether to be inclusive on the upper bound

as_indbool

(default False) whether to return bool array or the indices (where(bool array == True)) sets the default behavior for the wrapped fnction func

Returns
outrangendarray of bool or ndarray of int

boolean array to select values outside box selection if as_ind, then index array of same

Other Parameters
as_indbool or “flatten”, optional

(default False) whether to return a boolean array, or array of indices.