AcquisitionParams.get_index

AcquisitionParams.get_index(sort_by=None, **parameters)[source]

Indexes the volumes based on the parameters

Parameters

  • parameters –

    mapping of parameters to how different they are allowed to be, e.g.

    • xps.get_index(b=100) groups to data into shells with b-values within 100

    • xps.get_index(b=100, te=0) ensures that only volumes with the same TE will be assigned to a given shell

    • NaNs are in the same shell, but in a different shell from everything else

  • sort_by – name of the parameter to sort the indices by

Returns

(n, ) integer array with the indices (0-based)