arim.model

Core functions of the forward models.

See also

arim.models arim.scat arim.ut

ModelAmplitudes()	Class for on-the-fly calculation of model amplitudes.
RayWeights(tx_ray_weights_dict, ...)	Data container for ray weights.
beamspread_2d_for_path(ray_geometry)	Compute the 2D beamspread for a path.
directivity_2d_rectangular_in_fluid(theta, ...)	Returns the directivity of an element based on the integration of uniformally radiating sources along a straight line in 2D.
directivity_2d_rectangular_in_fluid_for_path(...)	Wrapper for directivity_2d_rectangular_in_fluid() that uses a RayGeometry object.
directivity_2d_rectangular_on_solid_l(theta, ...)	L-wave directivity of rectangular element on solid
directivity_2d_rectangular_on_solid_t(theta, ...)	T-wave directivity of rectangular element on solid
fluid_solid(alpha_fluid, rho_fluid, ...[, ...])	Returns the transmission and reflection coefficients for an incident wave at a fluid-to-solid interface.
make_toneburst(num_cycles, centre_freq, dt)	Returns a toneburst defined by centre frequency and a number of cycles.
make_toneburst2(num_cycles, centre_freq, dt)	Returns a toneburst defined by centre frequency and a number of cycles.
material_attenuation_for_path(path, ...)	Return material attenuation for each ray (between 0 and 1)
model_amplitudes_factory(tx, rx, view, ...)	Calculates the model coefficients once the ray weights are known.
reflection_at_interface(interface_kind, ...)	Compute the reflection coefficients for an interface.
reverse_beamspread_2d_for_path(ray_geometry)	Reverse beamspread for a path.
reverse_transmission_reflection_for_path(...)	Return the transmission-reflection coefficients of the reverse path.
sensitivity_model_assisted_tfm(...[, block_size])	Return the sensitivity for model assisted TFM (multiply TFM timetraces by conjugate of scatterer contribution).
sensitivity_uniform_tfm(model_amplitudes, ...)	Return the sensitivity for uniform TFM.
snell_angles(incidents_angles, c_incident, ...)	Returns the angles of the refracted rays according to Snell–Descartes law:
solid_l_fluid(alpha_l, rho_fluid, rho_solid, ...)	Returns the transmission and reflection coefficients for an incident longitudinal wave at a solid-to-fluid interface.
solid_t_fluid(alpha_t, rho_fluid, rho_solid, ...)	Returns the transmission and reflection coefficients for an incident transverse wave at a solid-to-fluid interface.
transfer_func_to_scanlines(...[, timetraces])
transfer_func_to_timetraces(...[, timetraces])	Returns time-domain timetraces from the unshifted transfer function and the toneburst
transmission_at_interface(interface_kind, ...)	Compute the transmission coefficients for an interface.
transmission_reflection_for_path(path, ...)	Return the transmission-reflection coefficients for a given path.