Biologic

BioLogic

BioLogic(
    host: str = "192.109.209.128",
    timeout: int = 5,
    populate_info: bool = True,
    *,
    verbose: bool = False,
    **kwargs,
)

Bases: Measurer

Initialize Measurer class

PARAMETER	DESCRIPTION
verbose	verbosity of class. Defaults to False. TYPE: bool DEFAULT: False

connection_details property

connection_details: dict

Connection details for the device

host property writable

host: str

BioLogicDevice address

is_connected property

is_connected: bool

Whether the device is connected

timeout property writable

timeout: int

Device timeout

clearCache

clearCache()

Clear the cache

connect

connect()

Connect to the device

disconnect

disconnect()

Disconnect from the device

getDataframe

getDataframe(
    data_store: Iterable[tuple[NamedTuple, datetime]],
) -> DataFrame

Get dataframe of data collected

PARAMETER	DESCRIPTION
data_store	data store TYPE: Iterable[tuple[NamedTuple, datetime]]

RETURNS	DESCRIPTION
DataFrame	pd.DataFrame: dataframe of data collected

loadProgram

loadProgram(
    program: BiologicProgram,
    docstring_parser: Callable[[Any, bool], ProgramDetails]
    | None = None,
)

Load a program to the Measurer

PARAMETER	DESCRIPTION
program	program to load TYPE: BiologicProgram

measure

measure(
    *args,
    parameters: dict | None = None,
    blocking: bool = True,
    **kwargs,
) -> DataFrame | None

Run the measurement program

args: positional arguments parameters (dict, optional): dictionary of kwargs. Defaults to None. blocking (bool, optional): whether to block until completion. Defaults to True. *kwargs: keyword arguments

RETURNS	DESCRIPTION
DataFrame | None	pd.DataFrame|None: dataframe of data collected

saveData

saveData(filepath: str | Path)

Save data to file

PARAMETER	DESCRIPTION
filepath	path to save file TYPE: str | Path