Loading functions¶

eitprocessing.datahandling.loading.load_eit_data ¶

load_eit_data(
    path: str | Path | list[str | Path],
    vendor: Vendor | str,
    label: str | None = None,
    name: str | None = None,
    description: str = "",
    sample_frequency: float | None = None,
    first_frame: int = 0,
    max_frames: int | None = None,
) -> Sequence

Load EIT data from path(s).

PARAMETER	DESCRIPTION
`path`	relative or absolute path(s) to data file. TYPE: `str \| Path \| list[str \| Path]`
`vendor`	vendor indicating the device used. Note: for load functions of specific vendors (e.g. `load_draeger_data`), this argument is defaulted to the correct vendor. TYPE: `Vendor \| str`
`label`	short description of sequence for computer interpretation. Defaults to "Sequence_". TYPE: `str \| None` DEFAULT: `None`
`name`	short description of sequence for human interpretation. Defaults to the same value as label. TYPE: `str \| None` DEFAULT: `None`
`description`	long description of sequence for human interpretation. TYPE: `str` DEFAULT: `''`
`sample_frequency`	sample frequency at which the data was recorded. Default for Draeger: 20 Default for Timpel: 50 Default for Sentec: 50.2 TYPE: `float \| None` DEFAULT: `None`
`first_frame`	index of first frame to load. Defaults to 0. TYPE: `int` DEFAULT: `0`
`max_frames`	maximum number of frames to load. The actual number of frames can be lower than this if this would surpass the final frame. TYPE: `int \| None` DEFAULT: `None`

RAISES	DESCRIPTION
`NotImplementedError`	is raised when there is no loading method for

RETURNS	DESCRIPTION
`Sequence`	a Sequence with the given label, name and description, containing the loaded data. TYPE: `Sequence`

Example:

>>> sequence = load_eit_data(
...     ["path/to/file1", "path/to/file2"],
...     vendor="sentec",
...     label="initial_measurement"
... )
>>> pixel_impedance = sequence.eit_data["raw"].pixel_impedance