Residuals#

Returned by cnmf.get_residuals() extension.

class mesmerize_core.arrays.LazyArrayResiduals(raw_movie, rcm, rcb, timeout=10)#

Lazy array for residuals, i.e. Y - (A ⊗ C) - (b ⊗ f)

Create a LazyArray of the residuals, Y - (A C) - (b f)

Parameters:
  • raw_movie (np.memmap) – numpy memmap of the raw movie

  • rcm (LazyArrayRCM) – reconstructed movie lazy array

  • rcb (LazyArrayRCB) – reconstructed background lazy array

  • timeout (int, default 10) – timeout for min-max calculation, not implemented yet

property dtype: str#

str data type

property shape: Tuple[int, int, int]#

Tuple[int] (n_frames, dims_x, dims_y)

property n_frames: int#

int number of frames

property min: float#

float min value of the array if it were fully computed

as_numpy()#

NOT RECOMMENDED, THIS COULD BE EXTREMELY LARGE. Converts to a standard numpy array in RAM.

Return type:

np.ndarray

property max: float#

float max value of the array if it were fully computed

property nbytes: int#

int number of bytes for the array if it were fully computed

property nbytes_gb: float#

float number of gigabytes for the array if it were fully computed

property ndim: int#

int Number of dimensions