Skip to content

zencontrol_short#

zen_api_utils.zencontrol_short #

Classes:

ZenExperiment #

ZenExperiment(experiment: str = 'test.czexp', savefolder: str = 'c:\\zen_output', cziname: str = 'myimage.czi')

Initialize a ZenExperiment object with default values to be used via the TCP-IP connection between Python and ZEN.

:param experiment: name of the experiment, defaults to 'test.czexp' :type experiment: str, optional :param savefolder: folder to save the resulting CZI image, defaults to c:\zen_output :type savefolder: str, optional :param cziname: name of the CZI to be saved, defaults to 'myimage.czi' :type cziname: str, optional

Methods:

  • startexperiment –

    Start the actual ZEN experiment. It will open a TCP-IP

startexperiment #

startexperiment(timeout: int = 200, port: int = 52757) -> str | None

Start the actual ZEN experiment. It will open a TCP-IP connection to ZEN and then send the list of commands

:param timeout: [description], defaults to 200 :type timeout: int, optional :param port: [description], defaults to 52757 :type port: int, optional :return: full path of the saved CZI file :rtype: str

ZenDocuments #

ZenDocuments()

Methods:

  • getfilenames –

    Get lists of all ZEN related files using a certain pattern.

getfilenames #

getfilenames(folder: str = 'c:\\temp', pattern: str = '*.czexp') -> tuple[list[str], list[str]]

Get lists of all ZEN related files using a certain pattern.

:param folder: file extension pattern, defaults to r"c: emp" :type pattern: str, optional :param pattern: file extension pattern, defaults to "*.czexp" :type pattern: str, optional :return: list with full path and short names of files :rtype: list