mdreg.ants.coreg_series#

mdreg.ants.coreg_series(moving: ndarray | Array, fixed: ndarray | Array, parallel=True, progress_bar=False, path=None, name='coreg', return_transfo=True, **kwargs)[source]#

Coregister two series of 2D images or 3D volumes.

Parameters:
  • moving (numpy.ndarray | zarr.Array) – The moving image or volume, with dimensions (x,y,t) or (x,y,z,t).

  • fixed (numpy.ndarray) – The fixed target image or volume, in the same dimensions as the moving image.

  • parallel (bool) – Set to True to parallelize the computations. Defaults to True.

  • progress_bar (bool) – Show a progress bar during the computation. This keyword is ignored if parallel = True. Defaults to False.

  • path (str, optional) – Path on disk where to save the results. If no path is provided, the results are not saved to disk. Defaults to None.

  • name (str, optional) – For data that are saved on disk, provide an optional filename. This argument is ignored if no path is provided.

  • (bool) (return_transfo) – to files on disk. If this is set to False, only the coregistered image is returned and the transformations are deleted on disk. Defaults to True.

  • kwargs (dict) – Any keyword argument accepted by ants.registration. Array arguments need to be provided as numpy arrays rather than ants’s own data type.

Returns:

  • cor (numpy.ndarray | zarr.Array) – Coregistered series with the same dimensions as the moving image.

  • transfo (list) – List of paths to files containing the transformation parameters.