convert_from_indices about alphatims HOT 2 CLOSED

Dear @liquidcarbon, thanks for checking in again. Your second approach with "raw" slicing is the route I always take myself as well.

That said, I do understand the confusion with the first approach. From a technical perspective, it boils down to lines

Since return_tof_indices is True, AlphaTims will slice the tof_indices as requested. However, providing a None slice is the same as a full : or Ellipsis ... slice, hence all elements are returned.

The confusion probably lies more in the conceptual idea of the function. It is intended to convert raw_indices to their actual coordinates. The additional frame_indices and other index options are only intended for performance reasons and to avoid additional computation.

This is somewhat hinted at by the fact that raw_indices are the only accepted non-keyword argument. Probably it is a good idea to remove the default None option to show this is an essential keyword and to update some of the documentation. If you have any suggestions, feel free to make PR into the dev branch. If not, I'll probably get to this myself in the future at some point...

from alphatims.

I can get around it by asking

data.convert_from_indices(
    raw_indices=data[[1,2], "raw"],
    return_tof_indices=True,
)

Not a big deal - was just wondering if that's expected behaviour.

from alphatims.