index_generator

lsst.ts.utils.index_generator(imin: int = 1, imax: int = 2147483647, i0: int | None = None) → Generator[int, None, None]

Sequential index generator.

Returns values i0, i0+1, i0+2, …, max, min, min+1, …

Parameters:

iminint, optional

Minimum index (inclusive).

imaxint, optional

Maximum index (inclusive).

i0int, optional

Initial index; if None then use imin.

Raises:

ValueError

If imin >= imax

Notes

The default min and max values are the allowed range of positive SAL indices. The index 0 has special meaning, and, by convention, we avoid negative SAL indices.