Skip to content

sgnts.base.slice_tools

Utilities for working with intervals of time

TSSlice dataclass

A class to support operations on an ordered tuple of integers start, stop.

Parameters:

Name Type Description Default
start Union[int, float]

Union[int, float], The start of the TSSlice. Must be int unless units=SECONDS.

 TIME_MIN
stop Union[int, float]

Union[int, float], The stop of the TSSlice. Must be int unless units=SECONDS.

 TIME_MAX
units TimeUnits

TimeUnits, The unit of time for start and stop. Defaults to OFFSETS.

 OFFSETS
Source code in sgnts/base/slice_tools.py 
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
@dataclass
class TSSlice:
    """A class to support operations on an ordered tuple of integers start, stop.

    Args:
        start:
            Union[int, float], The start of the TSSlice. Must be int
            unless units=SECONDS.
        stop:
            Union[int, float], The stop of the TSSlice. Must be int
            unless units=SECONDS.
        units:
            TimeUnits, The unit of time for start and stop. Defaults to OFFSETS.
    """

    start: Union[int, float] = TIME_MIN
    stop: Union[int, float] = TIME_MAX
    units: TimeUnits = TimeUnits.OFFSETS

    def __post_init__(self):
        if (self.start is None and self.stop is not None) or (
            self.stop is None and self.start is not None
        ):
            raise ValueError("if one of start or stop is None, both must be")

        if self.start is not None:
            # 2. Validate Types based on Units
            if self.units == TimeUnits.SECONDS:
                # Allow floats, ints, or numpy numerics for SECONDS
                if not isinstance(
                    self.start, (int, float, numpy.number)
                ) or not isinstance(self.stop, (int, float, numpy.number)):
                    raise ValueError("start and stop must be numeric for SECONDS")
            else:
                # OFFSETS, NANOSECONDS, SAMPLES must be integers
                if not isinstance(self.start, (int, numpy.integer)) or not isinstance(
                    self.stop, (int, numpy.integer)
                ):
                    raise ValueError(
                        f"start and stop must be integers for unit {self.units}"
                    )

            # 3. Validate Order
            if not (self.stop >= self.start):
                raise ValueError("stop must be greater than or equal to start")

            # 4. Validate Bounds (Skip for seconds as float bounds/precision differ)
            if self.units != TimeUnits.SECONDS:
                if self.start < TIME_MIN:
                    raise ValueError(f"start must be greater than {TIME_MIN}")
                if self.stop > TIME_MAX:
                    raise ValueError(f"stop must be less than {TIME_MAX}")

    def convert(
        self,
        target_unit: TimeUnits,
        from_sample_rate: Optional[int] = None,
        to_sample_rate: Optional[int] = None,
    ) -> "TSSlice":
        """Convert this TSSlice to a new TSSlice with different units.

        Args:
            target_unit: The unit to convert to.
            from_sample_rate: Required if converting FROM samples.
            to_sample_rate: Required if converting TO samples.

        Returns:
            A new TSSlice instance in the target units.
        """
        # Handle infinite/empty slices simply
        if self.start is None:
            return TSSlice(None, None, units=target_unit)

        # Delegate the calculation strictly to Offset.convert
        # Offset.convert handles validation of whether rates are required/forbidden
        new_start = Offset.convert(
            self.start,
            from_unit=self.units,
            to_unit=target_unit,
            from_sample_rate=from_sample_rate,
            to_sample_rate=to_sample_rate,
        )

        new_stop = Offset.convert(
            self.stop,
            from_unit=self.units,
            to_unit=target_unit,
            from_sample_rate=from_sample_rate,
            to_sample_rate=to_sample_rate,
        )

        return TSSlice(new_start, new_stop, units=target_unit)

    @property
    def slice(self):
        """Convert to a python slice object with a stride of 1."""
        if self.units == TimeUnits.SECONDS:
            raise TypeError("Cannot create python slice from SECONDS units (float).")

        if self:
            return slice(self.start, self.stop, 1)
        else:
            return slice(-1, -1, 1)

    def _ensure_compatible(self, other: "TSSlice"):
        """Ensure two slices have compatible units before boolean operations."""
        if self.units != other.units:
            raise ValueError(
                f"Cannot operate on mixed units: {self.units} vs {other.units}. "
                "Convert one slice first."
            )

    def __getitem__(self, item):
        assert item in (0, 1)
        if item == 0:
            return self.start
        else:
            return self.stop

    def __and__(self, o):
        """Find the intersection of two TSSlices

        Examples:
            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=2, stop=5)
            >>> A&B
            TSSlice(start=2, stop=3)
            >>> B&A
            TSSlice(start=2, stop=3)

            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=4, stop=6)
            >>> A&B
            TSSlice(start=None, stop=None)
            >>> B&A
            TSSlice(start=None, stop=None)

            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=None, stop=None)
            >>> A&B
            TSSlice(start=None, stop=None)
            >>> B&A
            TSSlice(start=None, stop=None)
        """
        self._ensure_compatible(o)
        if self.start is None or self.stop is None or o.start is None or o.stop is None:
            return TSSlice(None, None)
        _start, _stop = max(self.start, o.start), min(self.stop, o.stop)
        if _start > _stop:
            return TSSlice(None, None)
        return TSSlice(_start, _stop)

    def __or__(self, o):
        """Find the TSSlice that spans both self and o.

        Examples:
            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=2, stop=5)
            >>> A|B
            TSSlice(start=0, stop=5)
            >>> B|A
            TSSlice(start=0, stop=5)

            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=4, stop=6)
            >>> A|B
            TSSlice(start=0, stop=6)
            >>> B|A
            TSSlice(start=0, stop=6)

            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=None, stop=None)
            >>> A|B
            TSSlice(start=None, stop=None)
            >>> B|A
            TSSlice(start=None, stop=None)
        """
        self._ensure_compatible(o)
        if self.start is None or self.stop is None or o.start is None or o.stop is None:
            return TSSlice(None, None)
        return TSSlice(min(self.start, o.start), max(self.stop, o.stop))

    def __bool__(self):
        """Check the truth value of this TSSlice.

        Examples:
            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=2, stop=5)
            >>> True if A else False
            True
            >>> True if B else False
            True

            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=4, stop=6)
            >>> True if A else False
            True
            >>> True if B else False
            True

            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=None, stop=None)
            >>> True if A else False
            True
            >>> True if B else False
            False
        """

        if self.start is None:
            assert self.stop is None
        if self.stop is None:
            assert self.start is None
        if self.start is None:
            return False
        else:
            return True

    def __add__(self, o):
        """Add two TSSlices together producing a single TSSlice if they intersect
        otherwise returning each in a list.

        Examples:
            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=2, stop=5)
            >>> A+B
            [TSSlice(start=0, stop=5)]
            >>> B+A
            [TSSlice(start=0, stop=5)]

            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=4, stop=6)
            >>> A+B
            [TSSlice(start=0, stop=3), TSSlice(start=4, stop=6)]
            >>> B+A
            [TSSlice(start=0, stop=3), TSSlice(start=4, stop=6)]

            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=None, stop=None)
            >>> A+B
            [TSSlice(start=0, stop=3), TSSlice(start=None, stop=None)]
            >>> B+A
            [TSSlice(start=None, stop=None), TSSlice(start=0, stop=3)]
        """
        self._ensure_compatible(o)
        if self & o:
            return [self | o]
        else:
            return sorted([self, o])

    def __gt__(self, o):
        """Check if a slice is greater than another slice.

        Examples:
            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=2, stop=5)
            >>> A>B
            False
            >>> B>A
            True

            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=4, stop=6)
            >>> A>B
            False
            >>> B>A
            True

            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=None, stop=None)
            >>> A>B
            False
            >>> B>A
            False
        """
        self._ensure_compatible(o)
        if self.start is None or self.stop is None or o.start is None or o.stop is None:
            return False
        return self.start > o.start and self.stop > o.stop

    def __lt__(self, o):
        self._ensure_compatible(o)
        if self.start is None or self.stop is None or o.start is None or o.stop is None:
            return False
        return self.start < o.start and self.stop < o.stop

    def __ge__(self, o):
        self._ensure_compatible(o)
        return self.start >= o.start and self.stop >= o.stop

    def __le__(self, o):
        self._ensure_compatible(o)
        return self.start <= o.start and self.stop <= o.stop

    def __sub__(self, o):
        """Find the difference of two overlapping slices, it not overlapping return an
        empty list.

        Examples:
            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=2, stop=5)
            >>> A-B
            [TSSlice(start=0, stop=2), TSSlice(start=3, stop=5)]
            >>> B-A
            [TSSlice(start=0, stop=2), TSSlice(start=3, stop=5)]

            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=4, stop=6)
            >>> A-B
            []
            >>> B-A
            []

            >>> A = TSSlice(start=0, stop=3)
            >>> B = TSSlice(start=None, stop=None)
            >>> A-B
            []
            >>> B-A
            []
        """
        self._ensure_compatible(o)
        b = self | o
        i = self & o
        if not b or not i:
            return []
        out = [TSSlice(b.start, i.start), TSSlice(i.stop, b.stop)]
        return sorted(o for o in out if o.isfinite())

    def __contains__(self, o):
        self._ensure_compatible(o)
        return o.start >= self.start and o.stop <= self.stop

    def split(self, o: int):
        """Split the slice with the given boundary value.

        Args:
            o:
                int, the boundary to split the tsslice
        """
        assert self.start <= o < self.stop
        return [
            TSSlice(self.start, o, units=self.units),
            TSSlice(o, self.stop, units=self.units),
        ]

    def isfinite(self):
        if not self:
            return False
        else:
            return self.stop > self.start

slice property

Convert to a python slice object with a stride of 1.

__add__(o)

Add two TSSlices together producing a single TSSlice if they intersect otherwise returning each in a list.

Examples:

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=2, stop=5)
>>> A+B
[TSSlice(start=0, stop=5)]
>>> B+A
[TSSlice(start=0, stop=5)]

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=4, stop=6)
>>> A+B
[TSSlice(start=0, stop=3), TSSlice(start=4, stop=6)]
>>> B+A
[TSSlice(start=0, stop=3), TSSlice(start=4, stop=6)]

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=None, stop=None)
>>> A+B
[TSSlice(start=0, stop=3), TSSlice(start=None, stop=None)]
>>> B+A
[TSSlice(start=None, stop=None), TSSlice(start=0, stop=3)]
Source code in sgnts/base/slice_tools.py 
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
def __add__(self, o):
    """Add two TSSlices together producing a single TSSlice if they intersect
    otherwise returning each in a list.

    Examples:
        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=2, stop=5)
        >>> A+B
        [TSSlice(start=0, stop=5)]
        >>> B+A
        [TSSlice(start=0, stop=5)]

        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=4, stop=6)
        >>> A+B
        [TSSlice(start=0, stop=3), TSSlice(start=4, stop=6)]
        >>> B+A
        [TSSlice(start=0, stop=3), TSSlice(start=4, stop=6)]

        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=None, stop=None)
        >>> A+B
        [TSSlice(start=0, stop=3), TSSlice(start=None, stop=None)]
        >>> B+A
        [TSSlice(start=None, stop=None), TSSlice(start=0, stop=3)]
    """
    self._ensure_compatible(o)
    if self & o:
        return [self | o]
    else:
        return sorted([self, o])

__and__(o)

Find the intersection of two TSSlices

Examples:

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=2, stop=5)
>>> A&B
TSSlice(start=2, stop=3)
>>> B&A
TSSlice(start=2, stop=3)

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=4, stop=6)
>>> A&B
TSSlice(start=None, stop=None)
>>> B&A
TSSlice(start=None, stop=None)

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=None, stop=None)
>>> A&B
TSSlice(start=None, stop=None)
>>> B&A
TSSlice(start=None, stop=None)
Source code in sgnts/base/slice_tools.py 
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
def __and__(self, o):
    """Find the intersection of two TSSlices

    Examples:
        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=2, stop=5)
        >>> A&B
        TSSlice(start=2, stop=3)
        >>> B&A
        TSSlice(start=2, stop=3)

        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=4, stop=6)
        >>> A&B
        TSSlice(start=None, stop=None)
        >>> B&A
        TSSlice(start=None, stop=None)

        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=None, stop=None)
        >>> A&B
        TSSlice(start=None, stop=None)
        >>> B&A
        TSSlice(start=None, stop=None)
    """
    self._ensure_compatible(o)
    if self.start is None or self.stop is None or o.start is None or o.stop is None:
        return TSSlice(None, None)
    _start, _stop = max(self.start, o.start), min(self.stop, o.stop)
    if _start > _stop:
        return TSSlice(None, None)
    return TSSlice(_start, _stop)

__bool__()

Check the truth value of this TSSlice.

Examples:

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=2, stop=5)
>>> True if A else False
True
>>> True if B else False
True

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=4, stop=6)
>>> True if A else False
True
>>> True if B else False
True

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=None, stop=None)
>>> True if A else False
True
>>> True if B else False
False
Source code in sgnts/base/slice_tools.py 
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
def __bool__(self):
    """Check the truth value of this TSSlice.

    Examples:
        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=2, stop=5)
        >>> True if A else False
        True
        >>> True if B else False
        True

        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=4, stop=6)
        >>> True if A else False
        True
        >>> True if B else False
        True

        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=None, stop=None)
        >>> True if A else False
        True
        >>> True if B else False
        False
    """

    if self.start is None:
        assert self.stop is None
    if self.stop is None:
        assert self.start is None
    if self.start is None:
        return False
    else:
        return True

__gt__(o)

Check if a slice is greater than another slice.

Examples:

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=2, stop=5)
>>> A>B
False
>>> B>A
True

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=4, stop=6)
>>> A>B
False
>>> B>A
True

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=None, stop=None)
>>> A>B
False
>>> B>A
False
Source code in sgnts/base/slice_tools.py 
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
def __gt__(self, o):
    """Check if a slice is greater than another slice.

    Examples:
        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=2, stop=5)
        >>> A>B
        False
        >>> B>A
        True

        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=4, stop=6)
        >>> A>B
        False
        >>> B>A
        True

        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=None, stop=None)
        >>> A>B
        False
        >>> B>A
        False
    """
    self._ensure_compatible(o)
    if self.start is None or self.stop is None or o.start is None or o.stop is None:
        return False
    return self.start > o.start and self.stop > o.stop

__or__(o)

Find the TSSlice that spans both self and o.

Examples:

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=2, stop=5)
>>> A|B
TSSlice(start=0, stop=5)
>>> B|A
TSSlice(start=0, stop=5)

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=4, stop=6)
>>> A|B
TSSlice(start=0, stop=6)
>>> B|A
TSSlice(start=0, stop=6)

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=None, stop=None)
>>> A|B
TSSlice(start=None, stop=None)
>>> B|A
TSSlice(start=None, stop=None)
Source code in sgnts/base/slice_tools.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
def __or__(self, o):
    """Find the TSSlice that spans both self and o.

    Examples:
        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=2, stop=5)
        >>> A|B
        TSSlice(start=0, stop=5)
        >>> B|A
        TSSlice(start=0, stop=5)

        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=4, stop=6)
        >>> A|B
        TSSlice(start=0, stop=6)
        >>> B|A
        TSSlice(start=0, stop=6)

        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=None, stop=None)
        >>> A|B
        TSSlice(start=None, stop=None)
        >>> B|A
        TSSlice(start=None, stop=None)
    """
    self._ensure_compatible(o)
    if self.start is None or self.stop is None or o.start is None or o.stop is None:
        return TSSlice(None, None)
    return TSSlice(min(self.start, o.start), max(self.stop, o.stop))

__sub__(o)

Find the difference of two overlapping slices, it not overlapping return an empty list.

Examples:

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=2, stop=5)
>>> A-B
[TSSlice(start=0, stop=2), TSSlice(start=3, stop=5)]
>>> B-A
[TSSlice(start=0, stop=2), TSSlice(start=3, stop=5)]

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=4, stop=6)
>>> A-B
[]
>>> B-A
[]

>>> A = TSSlice(start=0, stop=3)
>>> B = TSSlice(start=None, stop=None)
>>> A-B
[]
>>> B-A
[]
Source code in sgnts/base/slice_tools.py 
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
def __sub__(self, o):
    """Find the difference of two overlapping slices, it not overlapping return an
    empty list.

    Examples:
        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=2, stop=5)
        >>> A-B
        [TSSlice(start=0, stop=2), TSSlice(start=3, stop=5)]
        >>> B-A
        [TSSlice(start=0, stop=2), TSSlice(start=3, stop=5)]

        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=4, stop=6)
        >>> A-B
        []
        >>> B-A
        []

        >>> A = TSSlice(start=0, stop=3)
        >>> B = TSSlice(start=None, stop=None)
        >>> A-B
        []
        >>> B-A
        []
    """
    self._ensure_compatible(o)
    b = self | o
    i = self & o
    if not b or not i:
        return []
    out = [TSSlice(b.start, i.start), TSSlice(i.stop, b.stop)]
    return sorted(o for o in out if o.isfinite())

convert(target_unit, from_sample_rate=None, to_sample_rate=None)

Convert this TSSlice to a new TSSlice with different units.

Parameters:

Name Type Description Default
target_unit TimeUnits

The unit to convert to.

 required
from_sample_rate Optional[int]

Required if converting FROM samples.

 None
to_sample_rate Optional[int]

Required if converting TO samples.

 None

Returns:

Type Description
'TSSlice'

A new TSSlice instance in the target units.
Source code in sgnts/base/slice_tools.py 
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
def convert(
    self,
    target_unit: TimeUnits,
    from_sample_rate: Optional[int] = None,
    to_sample_rate: Optional[int] = None,
) -> "TSSlice":
    """Convert this TSSlice to a new TSSlice with different units.

    Args:
        target_unit: The unit to convert to.
        from_sample_rate: Required if converting FROM samples.
        to_sample_rate: Required if converting TO samples.

    Returns:
        A new TSSlice instance in the target units.
    """
    # Handle infinite/empty slices simply
    if self.start is None:
        return TSSlice(None, None, units=target_unit)

    # Delegate the calculation strictly to Offset.convert
    # Offset.convert handles validation of whether rates are required/forbidden
    new_start = Offset.convert(
        self.start,
        from_unit=self.units,
        to_unit=target_unit,
        from_sample_rate=from_sample_rate,
        to_sample_rate=to_sample_rate,
    )

    new_stop = Offset.convert(
        self.stop,
        from_unit=self.units,
        to_unit=target_unit,
        from_sample_rate=from_sample_rate,
        to_sample_rate=to_sample_rate,
    )

    return TSSlice(new_start, new_stop, units=target_unit)

split(o)

Split the slice with the given boundary value.

Parameters:

Name Type Description Default
o int

int, the boundary to split the tsslice

 required
Source code in sgnts/base/slice_tools.py 
350
351
352
353
354
355
356
357
358
359
360
361
def split(self, o: int):
    """Split the slice with the given boundary value.

    Args:
        o:
            int, the boundary to split the tsslice
    """
    assert self.start <= o < self.stop
    return [
        TSSlice(self.start, o, units=self.units),
        TSSlice(o, self.stop, units=self.units),
    ]

TSSlices dataclass

A class that holds a list of TSSlice objects and defines some operations on them.

Parameters:

Name Type Description Default
slices list

list, A list of TSSlice objects. These will be stored in a sorted order and are assumed to be immutable

 required
Source code in sgnts/base/slice_tools.py 
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
@dataclass
class TSSlices:
    """A class that holds a list of TSSlice objects and defines some operations on them.

    Args:
        slices:
            list, A list of TSSlice objects. These will be stored in a sorted order and
            are assumed to be immutable
    """

    slices: list

    def __post_init__(self):
        # Validate unit consistency
        if len(self.slices) > 0:
            base_unit = self.slices[0].units
            for s in self.slices[1:]:
                if s.units != base_unit:
                    raise ValueError("All slices in TSSlices must have the same units.")

        self.slices = sorted(self.slices)

    def __iadd__(self, other):
        """Inplace add (a new instance is made though)"""
        return TSSlices(self.slices + other.slices)

    def __iter__(self):
        return iter(self.slices)

    def convert(
        self,
        target_unit: TimeUnits,
        from_sample_rate: Optional[int] = None,
        to_sample_rate: Optional[int] = None,
    ) -> "TSSlices":
        """Convert all contained slices to a new unit."""
        new_slices = [
            s.convert(target_unit, from_sample_rate, to_sample_rate)
            for s in self.slices
        ]
        return TSSlices(new_slices)

    def simplify(self):
        """Merge overlapping slices and return a new instance of TSSlices.

        Examples:
            >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
            ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6)])
            >>> slices.simplify()
            TSSlices(slices=[TSSlice(start=0, stop=6)])

            >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
            ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6),
            ...     TSSlice(start=8, stop=10)])
            >>> slices.simplify()
            TSSlices(slices=[TSSlice(start=0, stop=6), TSSlice(start=8, stop=10)])
        """

        out = self.slices[0:1].copy()
        for s in self.slices[1:]:
            this = s + out[-1]
            if len(this) == 2:
                out.append(this[-1])
            else:
                out[-1] = this[0]
        return TSSlices(out)

    @property
    def slice(self):
        "Provide a slice that corresponds to the start and end offset"
        return TSSlice(
            self.slices[0].start,
            self.slices[-1].stop,
            units=self.slices[0].units,
        )

    def intersection(self):
        """Find the intersection of all slices. Might be empty.

        Examples:
            >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
            ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6)])
            >>> slices.intersection()
            TSSlice(start=2, stop=3)

            >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
            ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6),
            ...     TSSlice(start=8, stop=10)])
            >>> slices.intersection()
            TSSlice(start=None, stop=None)
        """
        s = TSSlice(self.slices[0].start, self.slices[0].stop)
        for s2 in self.slices[1:]:
            s = s & s2
        return s

    def search(self, tsslice: TSSlice, align: bool = True):
        """Search for the set of TSSlices that overlap wtih tsslice. If align=True the
        returned slices will be truncated to exactly fall within tsslice.

        Args:
            tsslice:
                TSSlice, the tsslice to search for overlap with
            align:
                bool, whether to align the tsslices

        Examples:
            >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
            ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6)])
            >>> slices.search(TSSlice(2,4), align=True)
            TSSlices(slices=[TSSlice(start=2, stop=4), TSSlice(start=2, stop=3),
                TSSlice(start=2, stop=4)])
            >>> slices.search(TSSlice(2,4), align=False)
            TSSlices(slices=[TSSlice(start=0, stop=4), TSSlice(start=1, stop=3),
                TSSlice(start=2, stop=6)])

            >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
            ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6),
            ...     TSSlice(start=8, stop=10)])
            >>> slices.search(TSSlice(2,4), align=True)
            TSSlices(slices=[TSSlice(start=2, stop=4), TSSlice(start=2, stop=3),
                TSSlice(start=2, stop=4)])
            >>> slices.search(TSSlice(2,4), align=False)
            TSSlices(slices=[TSSlice(start=0, stop=4), TSSlice(start=1, stop=3),
                TSSlice(start=2, stop=6)])
        """
        # Safety check: Search requires matching units
        if self.slices and tsslice.units != self.slices[0].units:
            raise ValueError(
                f"Search slice units ({tsslice.units}) do not match TSSlices "
                f"units ({self.slices[0].units}). "
                "Convert search slice manually."
            )

        startix = bisect.bisect_left(
            self.slices, TSSlice(tsslice.start, tsslice.start, units=tsslice.units)
        )
        stopix = bisect.bisect_right(
            self.slices, TSSlice(tsslice.stop, tsslice.stop, units=tsslice.units)
        )
        if not align:
            return TSSlices(self.slices[startix:stopix])
        else:
            out = []
            for s in self.slices[startix:stopix]:
                o = s & tsslice
                if o.isfinite():
                    out.append(o)
            return TSSlices(out)

    def invert(self, boundary_slice: TSSlice):
        """Within boundary_slice, return an inverted set of TSSlice's.

        Args:
            boundary_slice:
                TSSlice, the boundary to invert the TSSlices

        Examples:
            >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
            ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6)])
            >>> slices.invert(TSSlice(2,4))
            TSSlices(slices=[])

            >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
            ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6),
            ...     TSSlice(start=8, stop=10)])
            >>> slices.invert(TSSlice(2,4))
            TSSlices(slices=[TSSlice(start=6, stop=8)])
        """
        # Check units
        if self.slices and boundary_slice.units != self.slices[0].units:
            raise ValueError(
                f"Boundary slice units ({boundary_slice.units}) do not match "
                f"TSSlices units ({self.slices[0].units}). "
                "Convert boundary slice manually."
            )

        if len(self.slices) == 0:
            return TSSlices(
                [
                    TSSlice(
                        boundary_slice.start,
                        boundary_slice.stop,
                        units=boundary_slice.units,
                    )
                ]
            )
        _slices = self.simplify().slices
        out = []
        if boundary_slice.start < _slices[0].start:
            out.append(
                TSSlice(
                    boundary_slice.start, _slices[0].start, units=boundary_slice.units
                )
            )
        out.extend(
            [
                TSSlice(s1.stop, s2.start, units=boundary_slice.units)
                for (s1, s2) in zip(_slices[:-1], _slices[1:])
            ]
        )
        if boundary_slice.stop > _slices[-1].stop:
            out.append(
                TSSlice(
                    _slices[-1].stop, boundary_slice.stop, units=boundary_slice.units
                )
            )
        return TSSlices(out)

    @classmethod
    def intersection_of_multiple(cls, tsslices_list: list["TSSlices"]) -> "TSSlices":
        """Find the intersection of multiple TSSlices objects.

        This method computes regions that are present in ALL input TSSlices.
        It's useful for finding common valid data regions across multiple streams.

        Args:
            tsslices_list: List of TSSlices objects to intersect

        Returns:
            TSSlices containing only regions present in all inputs

        Examples:
            >>> slices1 = TSSlices([TSSlice(0, 10), TSSlice(20, 30)])
            >>> slices2 = TSSlices([TSSlice(5, 15), TSSlice(25, 35)])
            >>> slices3 = TSSlices([TSSlice(7, 12), TSSlice(22, 28)])
            >>> TSSlices.intersection_of_multiple([slices1, slices2, slices3])
            TSSlices(slices=[TSSlice(start=7, stop=10), TSSlice(start=25, stop=28)])

            >>> # Empty case
            >>> TSSlices.intersection_of_multiple([])
            TSSlices(slices=[])

            >>> # No overlap case
            >>> slices1 = TSSlices([TSSlice(0, 10)])
            >>> slices2 = TSSlices([TSSlice(20, 30)])
            >>> TSSlices.intersection_of_multiple([slices1, slices2])
            TSSlices(slices=[])
        """
        if not tsslices_list:
            return cls([])

        if len(tsslices_list) == 1:
            return tsslices_list[0]

        # Start with first set of slices
        intersection = tsslices_list[0]

        # Intersect with each subsequent set
        for slices in tsslices_list[1:]:
            new_intersection = []
            for int_slice in intersection.slices:
                for curr_slice in slices.slices:
                    overlap = int_slice & curr_slice
                    if overlap and overlap.isfinite():
                        new_intersection.append(overlap)
            intersection = cls(new_intersection)

            # Early exit if no intersection
            if not intersection.slices:
                return cls([])

        # Optionally simplify to merge overlapping slices
        return intersection.simplify() if intersection.slices else intersection

    def align_to_rate(self, target_rate: int) -> TSSlices:
        """Align TSSlices to integer sample boundaries at a target sample rate.
        Forces conversion to OFFSETS to perform alignment logic.
        """
        assert (
            target_rate in Offset.ALLOWED_RATES
        ), f"Target rate {target_rate} not in ALLOWED_RATES: {Offset.ALLOWED_RATES}"

        # 1. Determine the source slices in OFFSETS units
        if self.slices and self.slices[0].units != TimeUnits.OFFSETS:
            # We can't auto-convert SAMPLES because we don't know the source rate here
            if self.slices[0].units == TimeUnits.SAMPLES:
                raise ValueError(
                    "Cannot auto-align from SAMPLES units. Convert to OFFSETS first."
                )
            slices_to_process = self.convert(TimeUnits.OFFSETS).slices
        else:
            slices_to_process = self.slices

        # 2. Perform alignment logic
        offset_per_sample = Offset.MAX_RATE // target_rate
        aligned_slices = []

        for slc in slices_to_process:
            if not slc or not slc.isfinite():
                continue

            start_samples = slc.start / offset_per_sample
            stop_samples = slc.stop / offset_per_sample

            aligned_start_samples = math.ceil(start_samples)
            aligned_stop_samples = math.floor(stop_samples)

            if aligned_start_samples < aligned_stop_samples:
                aligned_start = aligned_start_samples * offset_per_sample
                aligned_stop = aligned_stop_samples * offset_per_sample
                aligned_slices.append(
                    TSSlice(aligned_start, aligned_stop, units=TimeUnits.OFFSETS)
                )

        return TSSlices(aligned_slices)

slice property

Provide a slice that corresponds to the start and end offset

__iadd__(other)

Inplace add (a new instance is made though)

Source code in sgnts/base/slice_tools.py 
392
393
394
def __iadd__(self, other):
    """Inplace add (a new instance is made though)"""
    return TSSlices(self.slices + other.slices)

align_to_rate(target_rate)

Align TSSlices to integer sample boundaries at a target sample rate. Forces conversion to OFFSETS to perform alignment logic.

Source code in sgnts/base/slice_tools.py 
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
def align_to_rate(self, target_rate: int) -> TSSlices:
    """Align TSSlices to integer sample boundaries at a target sample rate.
    Forces conversion to OFFSETS to perform alignment logic.
    """
    assert (
        target_rate in Offset.ALLOWED_RATES
    ), f"Target rate {target_rate} not in ALLOWED_RATES: {Offset.ALLOWED_RATES}"

    # 1. Determine the source slices in OFFSETS units
    if self.slices and self.slices[0].units != TimeUnits.OFFSETS:
        # We can't auto-convert SAMPLES because we don't know the source rate here
        if self.slices[0].units == TimeUnits.SAMPLES:
            raise ValueError(
                "Cannot auto-align from SAMPLES units. Convert to OFFSETS first."
            )
        slices_to_process = self.convert(TimeUnits.OFFSETS).slices
    else:
        slices_to_process = self.slices

    # 2. Perform alignment logic
    offset_per_sample = Offset.MAX_RATE // target_rate
    aligned_slices = []

    for slc in slices_to_process:
        if not slc or not slc.isfinite():
            continue

        start_samples = slc.start / offset_per_sample
        stop_samples = slc.stop / offset_per_sample

        aligned_start_samples = math.ceil(start_samples)
        aligned_stop_samples = math.floor(stop_samples)

        if aligned_start_samples < aligned_stop_samples:
            aligned_start = aligned_start_samples * offset_per_sample
            aligned_stop = aligned_stop_samples * offset_per_sample
            aligned_slices.append(
                TSSlice(aligned_start, aligned_stop, units=TimeUnits.OFFSETS)
            )

    return TSSlices(aligned_slices)

convert(target_unit, from_sample_rate=None, to_sample_rate=None)

Convert all contained slices to a new unit.

Source code in sgnts/base/slice_tools.py 
399
400
401
402
403
404
405
406
407
408
409
410
def convert(
    self,
    target_unit: TimeUnits,
    from_sample_rate: Optional[int] = None,
    to_sample_rate: Optional[int] = None,
) -> "TSSlices":
    """Convert all contained slices to a new unit."""
    new_slices = [
        s.convert(target_unit, from_sample_rate, to_sample_rate)
        for s in self.slices
    ]
    return TSSlices(new_slices)

intersection()

Find the intersection of all slices. Might be empty.

Examples:

>>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6)])
>>> slices.intersection()
TSSlice(start=2, stop=3)

>>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6),
...     TSSlice(start=8, stop=10)])
>>> slices.intersection()
TSSlice(start=None, stop=None)
Source code in sgnts/base/slice_tools.py 
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
def intersection(self):
    """Find the intersection of all slices. Might be empty.

    Examples:
        >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
        ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6)])
        >>> slices.intersection()
        TSSlice(start=2, stop=3)

        >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
        ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6),
        ...     TSSlice(start=8, stop=10)])
        >>> slices.intersection()
        TSSlice(start=None, stop=None)
    """
    s = TSSlice(self.slices[0].start, self.slices[0].stop)
    for s2 in self.slices[1:]:
        s = s & s2
    return s

intersection_of_multiple(tsslices_list) classmethod

Find the intersection of multiple TSSlices objects.

This method computes regions that are present in ALL input TSSlices. It's useful for finding common valid data regions across multiple streams.

Parameters:

Name Type Description Default
tsslices_list list['TSSlices']

List of TSSlices objects to intersect

 required

Returns:

Type Description
'TSSlices'

TSSlices containing only regions present in all inputs

Examples:

>>> slices1 = TSSlices([TSSlice(0, 10), TSSlice(20, 30)])
>>> slices2 = TSSlices([TSSlice(5, 15), TSSlice(25, 35)])
>>> slices3 = TSSlices([TSSlice(7, 12), TSSlice(22, 28)])
>>> TSSlices.intersection_of_multiple([slices1, slices2, slices3])
TSSlices(slices=[TSSlice(start=7, stop=10), TSSlice(start=25, stop=28)])

>>> # Empty case
>>> TSSlices.intersection_of_multiple([])
TSSlices(slices=[])

>>> # No overlap case
>>> slices1 = TSSlices([TSSlice(0, 10)])
>>> slices2 = TSSlices([TSSlice(20, 30)])
>>> TSSlices.intersection_of_multiple([slices1, slices2])
TSSlices(slices=[])
Source code in sgnts/base/slice_tools.py 
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
@classmethod
def intersection_of_multiple(cls, tsslices_list: list["TSSlices"]) -> "TSSlices":
    """Find the intersection of multiple TSSlices objects.

    This method computes regions that are present in ALL input TSSlices.
    It's useful for finding common valid data regions across multiple streams.

    Args:
        tsslices_list: List of TSSlices objects to intersect

    Returns:
        TSSlices containing only regions present in all inputs

    Examples:
        >>> slices1 = TSSlices([TSSlice(0, 10), TSSlice(20, 30)])
        >>> slices2 = TSSlices([TSSlice(5, 15), TSSlice(25, 35)])
        >>> slices3 = TSSlices([TSSlice(7, 12), TSSlice(22, 28)])
        >>> TSSlices.intersection_of_multiple([slices1, slices2, slices3])
        TSSlices(slices=[TSSlice(start=7, stop=10), TSSlice(start=25, stop=28)])

        >>> # Empty case
        >>> TSSlices.intersection_of_multiple([])
        TSSlices(slices=[])

        >>> # No overlap case
        >>> slices1 = TSSlices([TSSlice(0, 10)])
        >>> slices2 = TSSlices([TSSlice(20, 30)])
        >>> TSSlices.intersection_of_multiple([slices1, slices2])
        TSSlices(slices=[])
    """
    if not tsslices_list:
        return cls([])

    if len(tsslices_list) == 1:
        return tsslices_list[0]

    # Start with first set of slices
    intersection = tsslices_list[0]

    # Intersect with each subsequent set
    for slices in tsslices_list[1:]:
        new_intersection = []
        for int_slice in intersection.slices:
            for curr_slice in slices.slices:
                overlap = int_slice & curr_slice
                if overlap and overlap.isfinite():
                    new_intersection.append(overlap)
        intersection = cls(new_intersection)

        # Early exit if no intersection
        if not intersection.slices:
            return cls([])

    # Optionally simplify to merge overlapping slices
    return intersection.simplify() if intersection.slices else intersection

invert(boundary_slice)

Within boundary_slice, return an inverted set of TSSlice's.

Parameters:

Name Type Description Default
boundary_slice TSSlice

TSSlice, the boundary to invert the TSSlices

 required

Examples:

>>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6)])
>>> slices.invert(TSSlice(2,4))
TSSlices(slices=[])

>>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6),
...     TSSlice(start=8, stop=10)])
>>> slices.invert(TSSlice(2,4))
TSSlices(slices=[TSSlice(start=6, stop=8)])
Source code in sgnts/base/slice_tools.py 
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
def invert(self, boundary_slice: TSSlice):
    """Within boundary_slice, return an inverted set of TSSlice's.

    Args:
        boundary_slice:
            TSSlice, the boundary to invert the TSSlices

    Examples:
        >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
        ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6)])
        >>> slices.invert(TSSlice(2,4))
        TSSlices(slices=[])

        >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
        ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6),
        ...     TSSlice(start=8, stop=10)])
        >>> slices.invert(TSSlice(2,4))
        TSSlices(slices=[TSSlice(start=6, stop=8)])
    """
    # Check units
    if self.slices and boundary_slice.units != self.slices[0].units:
        raise ValueError(
            f"Boundary slice units ({boundary_slice.units}) do not match "
            f"TSSlices units ({self.slices[0].units}). "
            "Convert boundary slice manually."
        )

    if len(self.slices) == 0:
        return TSSlices(
            [
                TSSlice(
                    boundary_slice.start,
                    boundary_slice.stop,
                    units=boundary_slice.units,
                )
            ]
        )
    _slices = self.simplify().slices
    out = []
    if boundary_slice.start < _slices[0].start:
        out.append(
            TSSlice(
                boundary_slice.start, _slices[0].start, units=boundary_slice.units
            )
        )
    out.extend(
        [
            TSSlice(s1.stop, s2.start, units=boundary_slice.units)
            for (s1, s2) in zip(_slices[:-1], _slices[1:])
        ]
    )
    if boundary_slice.stop > _slices[-1].stop:
        out.append(
            TSSlice(
                _slices[-1].stop, boundary_slice.stop, units=boundary_slice.units
            )
        )
    return TSSlices(out)

search(tsslice, align=True)

Search for the set of TSSlices that overlap wtih tsslice. If align=True the returned slices will be truncated to exactly fall within tsslice.

Parameters:

Name Type Description Default
tsslice TSSlice

TSSlice, the tsslice to search for overlap with

 required
align bool

bool, whether to align the tsslices

 True

Examples:

>>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6)])
>>> slices.search(TSSlice(2,4), align=True)
TSSlices(slices=[TSSlice(start=2, stop=4), TSSlice(start=2, stop=3),
    TSSlice(start=2, stop=4)])
>>> slices.search(TSSlice(2,4), align=False)
TSSlices(slices=[TSSlice(start=0, stop=4), TSSlice(start=1, stop=3),
    TSSlice(start=2, stop=6)])

>>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6),
...     TSSlice(start=8, stop=10)])
>>> slices.search(TSSlice(2,4), align=True)
TSSlices(slices=[TSSlice(start=2, stop=4), TSSlice(start=2, stop=3),
    TSSlice(start=2, stop=4)])
>>> slices.search(TSSlice(2,4), align=False)
TSSlices(slices=[TSSlice(start=0, stop=4), TSSlice(start=1, stop=3),
    TSSlice(start=2, stop=6)])
Source code in sgnts/base/slice_tools.py 
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
def search(self, tsslice: TSSlice, align: bool = True):
    """Search for the set of TSSlices that overlap wtih tsslice. If align=True the
    returned slices will be truncated to exactly fall within tsslice.

    Args:
        tsslice:
            TSSlice, the tsslice to search for overlap with
        align:
            bool, whether to align the tsslices

    Examples:
        >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
        ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6)])
        >>> slices.search(TSSlice(2,4), align=True)
        TSSlices(slices=[TSSlice(start=2, stop=4), TSSlice(start=2, stop=3),
            TSSlice(start=2, stop=4)])
        >>> slices.search(TSSlice(2,4), align=False)
        TSSlices(slices=[TSSlice(start=0, stop=4), TSSlice(start=1, stop=3),
            TSSlice(start=2, stop=6)])

        >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
        ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6),
        ...     TSSlice(start=8, stop=10)])
        >>> slices.search(TSSlice(2,4), align=True)
        TSSlices(slices=[TSSlice(start=2, stop=4), TSSlice(start=2, stop=3),
            TSSlice(start=2, stop=4)])
        >>> slices.search(TSSlice(2,4), align=False)
        TSSlices(slices=[TSSlice(start=0, stop=4), TSSlice(start=1, stop=3),
            TSSlice(start=2, stop=6)])
    """
    # Safety check: Search requires matching units
    if self.slices and tsslice.units != self.slices[0].units:
        raise ValueError(
            f"Search slice units ({tsslice.units}) do not match TSSlices "
            f"units ({self.slices[0].units}). "
            "Convert search slice manually."
        )

    startix = bisect.bisect_left(
        self.slices, TSSlice(tsslice.start, tsslice.start, units=tsslice.units)
    )
    stopix = bisect.bisect_right(
        self.slices, TSSlice(tsslice.stop, tsslice.stop, units=tsslice.units)
    )
    if not align:
        return TSSlices(self.slices[startix:stopix])
    else:
        out = []
        for s in self.slices[startix:stopix]:
            o = s & tsslice
            if o.isfinite():
                out.append(o)
        return TSSlices(out)

simplify()

Merge overlapping slices and return a new instance of TSSlices.

Examples:

>>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6)])
>>> slices.simplify()
TSSlices(slices=[TSSlice(start=0, stop=6)])

>>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6),
...     TSSlice(start=8, stop=10)])
>>> slices.simplify()
TSSlices(slices=[TSSlice(start=0, stop=6), TSSlice(start=8, stop=10)])
Source code in sgnts/base/slice_tools.py 
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
def simplify(self):
    """Merge overlapping slices and return a new instance of TSSlices.

    Examples:
        >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
        ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6)])
        >>> slices.simplify()
        TSSlices(slices=[TSSlice(start=0, stop=6)])

        >>> slices = TSSlices(slices=[TSSlice(start=0, stop=4),
        ...     TSSlice(start=1, stop=3), TSSlice(start=2, stop=6),
        ...     TSSlice(start=8, stop=10)])
        >>> slices.simplify()
        TSSlices(slices=[TSSlice(start=0, stop=6), TSSlice(start=8, stop=10)])
    """

    out = self.slices[0:1].copy()
    for s in self.slices[1:]:
        this = s + out[-1]
        if len(this) == 2:
            out.append(this[-1])
        else:
            out[-1] = this[0]
    return TSSlices(out)