Skip to content

API Reference

Auto-generated from the NumPy-style docstrings. Each page renders the main classes and methods with their full signature, a typed parameter table, and cross-links — search a name and read everything you need without opening the source.

  • Transducers

    Array, mono-element, custom, and Field II-imported geometries. Delays, apodization, transform, show.

  • Emission

    Emission — monochromatic, transient, and attenuated pressure fields.

  • Reception

    Reception — pulse-echo RF, PSF, phantoms, FMC, sequences.

  • Beamforming

    DAS volume / RCA / focused-line beamformers and envelope detection.

  • I/O

    RFDataset checkpoint store and HDF5/UFF export.

  • Plotting

    2-D Matplotlib and 3-D PyVista visualization helpers.

  • Brain Atlas

    BrainGlobe atlas integration.