Parameters

eitprocessing.parameters.eeli.EELI dataclass

EELI(
    method: Literal["breath_detection"] = "breath_detection",
    breath_detection_kwargs: dict = dict(),
)

Compute the end-expiratory lung impedance (EELI) per breath.

compute_parameter

compute_parameter(continuous_data: ContinuousData) -> ndarray

Compute the EELI for each breath in the impedance data.

Example:

>>> global_impedance = sequence.continuous_data["global_impedance_(raw)"]
>>> eeli_data = EELI().compute_parameter(global_impedance)

PARAMETER	DESCRIPTION
continuous_data	a ContinuousData object containing impedance data. TYPE: ContinuousData

RETURNS	DESCRIPTION
ndarray	np.ndarray: the end-expiratory values of all breaths in the impedance data.

eitprocessing.parameters.tidal_impedance_variation.TIV dataclass

TIV(
    method: Literal["extremes"] = "extremes",
    breath_detection_kwargs: dict = dict(),
)

Compute the tidal impedance variation (TIV) per breath.

compute_parameter

compute_parameter(data: ContinuousData | EITData) -> NoReturn

Compute the tidal impedance variation per breath on either ContinuousData or EITData, depending on the input.

PARAMETER	DESCRIPTION
data	either continuous_data or eit_data to compute TIV on. TYPE: ContinuousData | EITData

compute_continuous_parameter

compute_continuous_parameter(
    continuous_data: ContinuousData,
    tiv_method: Literal["inspiratory", "expiratory", "mean"] = "inspiratory",
    sequence: Sequence | None = None,
    store: bool | None = None,
    result_label: str = "continuous_tivs",
) -> SparseData

Compute the tidal impedance variation per breath.

PARAMETER	DESCRIPTION
continuous_data	The ContinuousData to compute the TIV on. TYPE: ContinuousData
tiv_method	The label of which part of the breath the TIV should be determined on (inspiratory, expiratory, or mean). Defaults to 'inspiratory'. TYPE: Literal['inspiratory', 'expiratory', 'mean'] DEFAULT: 'inspiratory'
sequence	optional, Sequence that contains the object to detect TIV on, TYPE: Sequence | None DEFAULT: None
store	whether to store the result in the sequence, defaults to True if a Sequence if provided. TYPE: bool | None DEFAULT: None
result_label	label of the returned SparseData object, defaults to 'continuous_tivs'. TYPE: str DEFAULT: 'continuous_tivs'

RETURNS	DESCRIPTION
SparseData	A list with the computed TIV values.

RAISES	DESCRIPTION
RuntimeError	If store is set to true but no sequence is provided.
ValueError	If the provided sequence is not an instance of the Sequence dataclass.
ValueError	If tiv_method is not one of 'inspiratory', 'expiratory', or 'mean'.

compute_pixel_parameter

compute_pixel_parameter(
    eit_data: EITData,
    continuous_data: ContinuousData,
    sequence: Sequence,
    tiv_method: Literal["inspiratory", "expiratory", "mean"] = "inspiratory",
    tiv_timing: Literal["pixel", "continuous"] = "pixel",
    store: bool | None = None,
    result_label: str = "pixel_tivs",
) -> SparseData

Compute the tidal impedance variation per breath on pixel level.

PARAMETER	DESCRIPTION
sequence	The sequence containing the data. TYPE: Sequence
eit_data	The eit pixel level data to determine the TIV of. TYPE: EITData
continuous_data	The continuous data to determine the continuous data breaths or pixel level breaths. TYPE: ContinuousData
tiv_method	The label of which part of the breath the TIV should be determined on (inspiratory, expiratory or mean). Defaults to 'inspiratory'. TYPE: Literal['inspiratory', 'expiratory', 'mean'] DEFAULT: 'inspiratory'
tiv_timing	The label of which timing should be used to compute the TIV, either based on breaths detected in continuous data ('continuous') or based on pixel breaths ('pixel'). Defaults to 'pixel'. TYPE: Literal['pixel', 'continuous'] DEFAULT: 'pixel'
result_label	label of the returned IntervalData object, defaults to 'pixel_tivs'. TYPE: str DEFAULT: 'pixel_tivs'
store	whether to store the result in the sequence, defaults to True if a Sequence if provided. TYPE: bool | None DEFAULT: None

RETURNS	DESCRIPTION
SparseData	An np.ndarray with the computed TIV values.

RAISES	DESCRIPTION
RuntimeError	If store is set to true but no sequence is provided.
ValueError	If the provided sequence is not an instance of the Sequence dataclass.
ValueError	If tiv_method is not one of 'inspiratory', 'expiratory', or 'mean'.
ValueError	If tiv_timing is not one of 'continuous' or 'pixel'.