Reorder samples in irregular rate streams - Worthwhile feature?

[cboulay]

The latest version of the pupil labs LSL plugin forces Pupil capture service to use the LSL clock (great!). When frames are acquired from the video they get timestamped with an LSL timestamp. Sometimes frames get processed out of order and a recent sample can get pushed before an older sample. This is OK because they're timestamped with their LSL times from when they were acquired, and the stream is marked as irregular rate so there is no automatic dejittering.

Should streams with irregular rate be sorted by their timestamp on import? Is there a use case where this might be undesirable? e.g., "I want to know the order the samples were pushed; I don't care about their timestamps!" That seems pretty unlikely. I also think we don't have to worry about people using the timestamps for anything other than timestamps because they would have encountered problems from clock offset adjustment.

Are there technical reasons why we wouldn't want to support this in pyxdf? I'm guessing these streams would have to be eagerly loaded and couldn't be lazily loaded if lazy loading ever becomes a feature.

[cbrnr]

I'd make this optional so even if there is a use case you haven't thought about we have that covered.

[cbrnr]

@cboulay do you want to implement this (e.g. with a new parameter sort_irregular=False)?