API Reference#

Core

core

Defines core objects of arim.

geometry

ray

Ray tracing module

_probes

Database of probes

Modelling

model

Core functions of the forward models.

models

Imaging and forward models

scat

Scattering functions and helpers

Imaging

im

Imaging module.

im.tfm

Main functions: contact_tfm(), tfm_for_view()

im.das

Delay-and-sum functions

Utils

datasets

Example datasets

io

Import/export tools

io.native

Load .arim file format

io.brain

I/O module for BRAIN files (Matlab NDT library of Universiy of Bristol).

io.scat

ut

Toolbox of functions for ultrasonic testing/acoustics.

plot

Plotting utilities based on matplotib.

signal

Module for signal processing.

measurement

Tools and methods based on ultrasonic data measurements

Nuts and bolts

config

Helper for configuring scripts

helpers

Helper functions

settings

Settings use in this library.

exceptions

Exceptions and warnings