Skip to content

API Reference

Complete reference documentation for the ConfUSIus API. Please refer to the user guide for more detailed explanations and usage examples.

Core Modules

  • Input/Output


    Loading and saving fUSI data in various formats, including those from AUTC and EchoFrame systems, as well as general-purpose formats like Zarr and NIfTI.

  • fUSI-BIDS


    fUSI-BIDS metadata validation, conversion utilities, and coordinate handling for BIDS-compliant fUSI data.

  • Data Validation


    Validation of fUSI data compatibility with expected formats in ConfUSIus.

  • Multi-Pose


    Multi-pose consolidation tools for combining fUSI data across acquisition poses.

  • Beamformed IQ


    Processing of beamformed IQ signals, clutter filtering, and computation of derived measures such as power Doppler and axial velocity.

  • Plotting


    Rich visualization utilities for fUSI data including static plots and interactive napari viewers.

  • Quality Control


    Quality control metrics for assessing fUSI data quality.

  • Registration


    Motion correction and spatial alignment tools for aligning fUSI data across time points or with anatomical references.

  • Atlases


    Brain atlas integration for anatomical labeling and region-of-interest extraction.

  • Temporal Resampling


    Timing utilities for resampling fUSI time series onto uniform time grids.

  • Spatial Processing


    Spatial processing tools for fUSI volumetric data, including Gaussian smoothing.

  • Signal Extraction


    Extract and reconstruct signals from fUSI data using spatial masks.

  • Signal Processing


    Signal processing tools for fUSI time series including denoising and motion artifact correction.

  • Decomposition


    Matrix decomposition algorithms for fUSI time series (e.g. PCA, NMF, ICA).

  • Functional Connectivity


    Functional connectivity analysis for fUSI data.

  • General Linear Model


    Voxel-wise GLM for first- and second-level analysis of fUSI data, including design matrix construction and contrast computation.

  • Xarray Integration


    Xarray integration providing DataArray accessors for fUSI data.

  • Datasets


    Fetchers for publicly available fUSI datasets with automatic caching and offline support.