transix.fmt_mmss

Contents

transix.fmt_mmss#

transix.fmt_mmss(x, pos=None)#

Format a time value in seconds as mm:ss.mmm.

Intended for Matplotlib tick formatting via matplotlib.ticker.FuncFormatter.

Parameters:
xfloat

Time value in seconds (tick value).

posint, optional

Tick position index passed by Matplotlib (unused).

Returns:
str

Formatted time label in minutes and seconds with milliseconds precision (e.g., "02:05.700").

Examples

>>> import transix as tx
>>> import matplotlib.pyplot as plt
>>> from matplotlib.ticker import FuncFormatter
>>>
>>> t = tx.time(duration=120, fs=10000)
>>> y = tx.generate_sine(mag=1, f=1, t=120, fs=10000)
>>> fig, ax = plt.subplots()
>>> ax.plot(t, y)
>>> ax.xaxis.set_major_formatter(FuncFormatter(tx.fmt_mmss))
>>> plt.show()