maad.features.opt_shape_presets

maad.features.opt_shape_presets(resolution, opt_shape=None)[source]

Set parameters for multiresolution analysis using presets or custom parameters.

Parameters:

resolution: str: Select resolution of analysis using presets. Supported presets are: ‘low’, ‘med’, and ‘high’. Select ‘custom’ to select user-defined parameters using a dictionary.
opt_shape: dict: Key and values for shape settings. Valid keys are: ‘ntheta’, ‘bandwidth’, ‘frequency’, ‘gamma’, ‘npyr’

Returns:

opt_shape: dict: A valid dictionary with shape settings

See also

filter_bank_2d_nodc, filter_multires, shape_features

Examples

>>> import maad

Get parameters to analyse at low, med and high shape resolutions.

>>> from maad.features import opt_shape_presets 
>>> opt_shape_presets('low')  
{'ntheta': 2,
 'bandwidth': 0.8,
 'frequency': (0.35, 0.5),
 'gamma': 2,
 'npyr': 4}

>>> opt_shape_presets('med')  
{'ntheta': 4,
 'bandwidth': 0.8,
 'frequency': (0.35, 0.5),
 'gamma': 2,
 'npyr': 6}

>>> opt_shape_presets('high') 
{'ntheta': 8,
 'bandwidth': 0.8,
 'frequency': (0.35, 0.5),
 'gamma': 2,
 'npyr': 6}