pymovements.datasets.base.Dataset.__init__

Dataset.__init__(root: str | Path, experiment: Experiment | None = None, filename_regex: str = '.*', filename_regex_dtypes: dict[str, type] | None = None, custom_read_kwargs: dict[str, Any] | None = None)[source]

Initialize the dataset object.

Parameters:

  • root (str, Path) – Path to the root directory of the dataset.

  • experiment (Experiment) – The experiment definition.

  • filename_regex (str) – Regular expression which needs to be matched before trying to read the file. Named groups will appear in the fileinfo dataframe.

  • filename_regex_dtypes (dict[str, type], optional) – If named groups are present in the filename_regex, this makes it possible to cast specific named groups to a particular datatype.

  • custom_read_kwargs (dict[str, Any], optional) – If specified, these keyword arguments will be passed to the file reading function.