parse_distance

pypillometry.parse_distance(value)

Convert a distance to mm.

Parameters:

value (float, str, Quantity or None) – e.g. "60 cm", 60 * u.cm, "0.6 m"; plain numbers are mm (with a one-time warning)

Return type:

float, ndarray or None

Returns:

distance in mm

Examples

>>> parse_distance("60 cm")
600.0
>>> parse_distance(60 * u.cm)
600.0