arlmet.DirectoryIndex#

class arlmet.DirectoryIndex(directory, table, *, cache=None)[source]#

The ARL files in a directory, by the times their headers say they hold.

Made by arlmet.index().

Parameters:
  • directory (Path) – The indexed folder.

  • table (DataFrame) – One row per file (see table).

  • cache (Path | None) – The cache file the table was saved to.

Attributes

cache

The cache file the table was saved to, or None.

directory

The indexed folder.

step

The time between the valid times of the directory, or None for fewer than two.

table

One row per file, sorted by start, then name.

Methods

covering(start, end)

Return the files that cover a window, in time order.

missing(start, end)

Return the valid times a window needs that no usable file holds.