pyudv.geometry.Probe#

class Probe(r, alpha, Pref, transducer=None)[source]#

A class used to represent a single probe.

Parameters:

r (ndarray, (N,)) – a numpy array containing the radial coordinates of the beam.
alpha (float) – orientation of the probe, in degree in the trigonometric referential.
Pref (list[float, ndarray]) – A list a size 2 defining a reference point by containing its radial coordinate, and a numpy array containing its coordinate in the “real” reference space.
transducer (Transducer, optional) – Transducer object giving the physical probe properties, by default None

Methods

`plot_probe`(ax[, color, plot_transducer])	Sketch the probe and its beam on a given matplotlib axe.
`r_to_x`(r)	Convert radial coordinates of the probe into x coordinates
`r_to_z`(r)	Convert radial coordinates of the probe into z coordinates
`xz_to_r`(xz[, axis])	Convert xz coordinates into probe radial coordinates

Attributes

`Probe.r`	vector along beam axis
`Probe.alpha`	beam axis inclination, trigo referential
`Probe.Pref`	reference point [r_ref, (x_ref, y_ref)]
`Probe.r_ref`	reference point radial coordinats
`Probe.X_ref`	reference point real coordinates
`Probe.unit_vec`	unit vector defining the beam direction in real coordinates
`Probe.unit_vec_perp`	unit vector defining the beam perpendicular direction in real coordinates
`Probe.O`	coordinates of the origin of the beam
`Probe.E`	coordinates of the end of the beam

Examples using `pyudv.geometry.Probe`#