Skip to content

API Reference

Complete reference documentation for the EffUSIve API.

MATLAB API

  • Sequences

    Verasonics sequence configuration for power Doppler plane wave imaging.

  • Vantage

    Verasonics Vantage hardware helpers: project activation and RF time tagging.

  • Probes

    Transducer connector mappings for Cortexlab probes.

  • RF

    RF data processing: beamforming and power Doppler computation.

  • Utilities

    Logging helpers and z-stack NIfTI export.

  • Motor Control

    Zaber motor control interface and GUI.

  • GUI

    Acquisition GUI figures for B-mode, power Doppler, and Y-stack imaging.

Python API

  • Configuration

    Dataclasses and loading functions for the two-file config system.

  • Shared Memory

    Session-scoped Python shared-memory segments, layout constants, and the IPC protocol.

  • CLI

    Command-line entry point for the napari viewer.

  • MATLAB Worker

    Subprocess that runs the MATLAB engine and drives the VSX acquisition loop.

  • UDP Control

    Python-side UDP server for mpep-compatible experiment control.

  • Motor Controller

    Python-side serial controller for manual z-stack motor jogging.