register_method#

gwpy.signal.spectral.register_method(
func: Callable,
name: str | None = None,
deprecated: bool = False,
) str[source]#

Register a method of calculating an average spectrogram.

Parameters:
funccallable

function to execute

namestr, optional

name of the method, defaults to func.__name__

deprecatedbool, optional

whether this method is deprecated (True) or not (False)

Returns:
namestr

the registered name of the function, which may differ pedantically from what was given by the user.