show_options

pyts.metrics.show_options(method: str | None = None, disp: bool = True) → str | None

Show documentation for additional options of Dynamic Time Warping methods.

These are method-specific options that can be supplied through the options dict.

Parameters:

methodNone or str (default = None)

If None, shows all methods. Otherwise, shows only the options for the specified method. If str, it must be either ‘classic’, ‘sakoechiba’, ‘itakura’, ‘region’, ‘multiscale’ or ‘fast’.

dispbool (default = True)

Whether to print the result rather than returning it.

Returns:

textNone or str

Either None (if disp=True) or the text string (if disp=False).

Notes

The available methods are:

• ‘classic’

• ‘sakoechiba’

• ‘itakura’

• ‘region’

• ‘multiscale’

• ‘fast’