UFF - Ultrasound File Format

Point(r, θ, ϕ)

Point contains the position of a point in a tridimensional space. It express that location in spherical coordinates which allows to place points at infinity but in a given direction.

The Julia implementation of the UFF Point type is a derivation of the CoordinateTransformations.jl Spherical type. The UFF Point defines the azimuth θ as the angle from the point location to the YZ plane. The elevation ϕ is the angle from the point location to the XZ plane.

(::PointFromCartesian)(x::AbstractVector)

Transformation functor to map 3D Cartesian coordinates into UFFs Point type. The conversion for $[x, y, z]$ is given by

\[\begin{aligned} r &= \sqrt{x^2+y^2+z^2} \\ \theta &= \text{atan}(x, z) \\ \phi &= \text{asin}(y, r) \end{aligned}\]

(::CartesianFromPoint)(x::Point)

Transformation functor to map UFF Point into Cartesian coordinates. The conversion for $[r, \theta, \phi]$ is given by

\[\begin{aligned} x &= r\cdot\sin(\theta)\cdot\cos(\phi) \\ y &= r\cdot\sin(\phi) \\ z &= r\cdot\cos(\theta)\cdot\cos(\phi) \end{aligned}\]

Probe

Probe contains the position and attitude of all elements of a probe. Optionally PROBE can hold each element width and height, assuming the elements were rectangular. Information is stored in a single matrix form called geometry, one row per element containing: [x y z azimuth elevation width height]

Return the number of elements in the Probe

Implement the property interface for the same variables used by MATLAB

Base.getproperty(p::Probe, s::Symbol)

Allow indexing by property, similar to MATLABs dependent get methods, getproperty is extended to allow getting the geometries columns by symbols for lookups. Available symbols and [aliases] for lookup are given by

:x                    = p.geometry[:, 1]  # center of the element in the x axis[m]
:y                    = p.geometry[:, 2]  # center of the element in the y axis[m]
:z                    = p.geometry[:, 3]  # center of the element in the z axis[m]
:θ [:az, :azimuth]    = p.geometry[:, 4]  # orientation of the element in the azimuth direction [rad]
:ϕ [:alt, :elevation] = p.geometry[:, 5]  # orientation of the element in the elevation direction [rad]
:w [:width]           = p.geometry[:, 6]  # element width [m]
:h [:height]          = p.geometry[:, 7]  # element height [m]
:r [:distance]        = norm(p.geometry[:,1:3], dims=2) # Distance from elements to origin [m] 

Set property function

Forwarded Base.size to Probe.geometry

Forwarded Base.getindex to Probe.geometry

Forwarded Base.setindex! to Probe.geometry

mutable struct CurvilinearArray <: USTB.UFF.AbstractProbeArray

Composite type to define a curvilinear array probe geometry CurvilinearArray defines an array of regularly space elements on an arc in the azimuth dimensions. Optionally it can hold each element width and height, assuming the elements are rectangular.

Fields

• probe::USTB.UFF.Probe: Wrapped probe

• N::Integer: Number of elements in array

• pitch::Float64: Distance between the elements in the azimuth direction [m]

• radius::Float64: Radius of the curvilinear array [m]

• element_width::Float64: Width of the elements in the azimuth direction [m]

• element_height::Float64: Height of the elements in the elecation direction [m]

Example

prb = CurvilinearArray()
prb.N = 128;
prb.pitch = 500e-6;
prb.radius = 70e-3;

TODO: Link up Probe

Wavefront

Enumeration for wave types. Exported through USTB.UFF submodule. Available options are

See also WAVE

TODO: Cross link WAVE

Wavefront instance describing a plane wave

Wavefront instance describing a spherical wave

Wavefront instance describing a photoacustic wave

Window

Enumeration for window types. Available options and corresponding values are

See also PULSE, BEAM, PHANTOM, PROBE

TODO: Link up PULSE

TODO: Link up BEAM

TODO: Link up PHANTOM

TODO: Link up PROBE