get_defaults#

syncopy.get_defaults(obj)[source]#

Parse input arguments of obj and return dictionary

Parameters:

obj (function or class) – Object whose input arguments to parse. Can be either a class or function.

Returns:

argdict – Dictionary of argument : default value pairs constructed from obj’s call-signature/instantiation.

Return type:

dictionary

Examples

To see the default input arguments of syncopy.freqanalysis() use

>>> spy.get_defaults(spy.freqanalysis)