register

Base classes for loading datakit sources.

class mesofield.datakit.sources.register.LoadContext

Bases: object

Context object passed to every DataSource.load call.

Carries identity (subject/session/task), the inventory row for that cell (so sources can locate sibling files via path_for()), and any upstream sources that were loaded for the same cell as declared on DataSource.requires.

For backward parity with previous releases, when "dataqueue" is present in dependencies, the convenience attributes dataqueue_frame, dataqueue_meta, master_timeline, and experiment_window are populated from it. New sources should prefer reading from dependencies directly.

path_for(tag)

Return the path stored in the inventory row for tag, or None.

Parameters:

tag (str)

Return type:

Path | None

require_path(tag)

Like path_for() but raises FileNotFoundError when missing.

Parameters:

tag (str)

Return type:

Path

get_dependency(tag)

Return a previously-loaded dependency stream, or None if unavailable.

Parameters:

tag (str)

Return type:

LoadedStream | None

require_dependency(tag)

Like get_dependency() but raises if the dependency is missing.

Parameters:

tag (str)

Return type:

LoadedStream

__init__(subject, session, task, inventory_row, dependencies=<factory>, master_timeline=None, experiment_window=None, dataqueue_frame=None, dataqueue_meta=None)

Parameters:

• subject (str)

• session (str)

• task (str | None)

• inventory_row (Mapping[str, Any])

• dependencies (Mapping[str, LoadedStream | None])

• master_timeline (ndarray | None)

• experiment_window (tuple[float, float] | None)

• dataqueue_frame (DataFrame | None)

• dataqueue_meta (Mapping[str, Any] | None)

Return type:

None

class mesofield.datakit.sources.register.DataSource

Bases: object

Base class for a file-backed data source.

requires: ClassVar[Tuple[str, ...]] = ()

Tag names of upstream sources whose loaded streams should be made available via LoadContext.dependencies. Soft contract: a missing or failed dependency yields None in dependencies[tag]; sources are responsible for either degrading gracefully or raising.

load(path, *, context=None)

Load data from the given path.

Parameters:

• path (Path)

• context (LoadContext | None)

Return type:

LoadedStream

class mesofield.datakit.sources.register.TimeseriesSource

Bases: DataSource

Base class for time-indexed sources.

build_timeseries(path, *, context=None)

Return (timeline, value, meta).

Parameters:

• path (Path)

• context (LoadContext | None)

Return type:

tuple[ndarray, Any, Dict[str, Any]]

load(path, *, context=None)

Load data from the given path.

Parameters:

• path (Path)

• context (LoadContext | None)

Return type:

LoadedStream

class mesofield.datakit.sources.register.TableSource

Bases: DataSource

Base class for static table sources.

build_table(path, *, context=None)

Return (timeline, value, meta).

Parameters:

• path (Path)

• context (LoadContext | None)

Return type:

tuple[ndarray, Any, Dict[str, Any]]

load(path, *, context=None)

Load data from the given path.

Parameters:

• path (Path)

• context (LoadContext | None)

Return type:

LoadedStream

class mesofield.datakit.sources.register.IntervalSeriesSource

Bases: DataSource

Base class for interval-based sources.

build_intervals(path, *, context=None)

Return an intervals table with start/stop columns and meta.

Parameters:

• path (Path)

• context (LoadContext | None)

Return type:

tuple[DataFrame, Dict[str, Any]]

load(path, *, context=None)

Load data from the given path.

Parameters:

• path (Path)

• context (LoadContext | None)

Return type:

LoadedStream