ubermagutil.units.si_multiplier#

ubermagutil.units.si_multiplier(value)#

Compute SI multiplier.

SI multiplier of \(x\) is considered to be a value \(m=10^{n}\), for \(n = ..., -6, -3, 0, 3, 6,...\), for which \(1 \le x/m < 10^{3}\).

Parameters:: value (numbers.Real) – Value for which the multiplier is computed.
Returns:: Multiplier as \(10^{n}\). If multiplier cannot be found, None is returned.
Return type:: float

Examples

Find a multiplier.

>>> import ubermagutil.units as uu
...
>>> uu.si_multiplier(5e-9)  # value on a nanoscale
1e-09
>>> uu.si_multiplier(500e-6)  # value on a microscale
1e-06
>>> uu.si_multiplier(0.5e-9)  # value on a picoscale
1e-12