aind_ephys_utils.ops.normalize module

Normalization operations.

aind_ephys_utils.ops.normalize.normalize(data: DataArray | ndarray | Sequence[object] | Sequence[Sequence[object]], *, dim: str | Tuple[str, ...], method: str = 'zscore', dims: Sequence[str] | None = None, coords: Dict[str, object] | None = None, return_type: str = 'auto') → DataArray | object

Normalize data across one or more dimensions.

Parameters:

  • data – Input DataArray or NumPy-like data.

  • dim – Dimension(s) to normalize across.

  • method – Normalization method (e.g. “zscore”, “minmax”, “robust”).

  • dims – Optional dimension names used when data is a dense NumPy array.

  • coords – Optional coordinate mapping used when constructing a DataArray from dense NumPy input.

  • return_type – Output type policy: "auto", "xarray", or "numpy". "auto" mirrors the input style.

Returns:

Normalized data in the selected output representation.

Return type:

xr.DataArray or object