postprocessor.core.processes.findpeaks.findpeaksParameters¶
- class postprocessor.core.processes.findpeaks.findpeaksParameters(**kwargs)¶
Bases:
ParametersABC
Parameters for the ‘findpeaks’ process.
- Attributes
- distance: number
Required minimal horizontal distance (>= 1) in samples between neighbouring peaks. Smaller peaks are removed first until the condition is fulfilled for all remaining peaks.
- prominence: number or ndarray or sequence
Required prominence of peaks. Either a number, None, an array matching x or a 2-element sequence of the former. The first element is always interpreted as the minimal and the second, if supplied, as the maximal required prominence.
Methods
from_yaml
(source)Returns instance from a yaml filename or stdin
to_dict
([iterable])Recursive function to return a nested dictionary of the attributes of the class instance.
to_yaml
([path])Returns a yaml stream of the attributes of the class instance.
update
(name, new_value)Update values recursively if name is a dictionary, inject data where found.
default
from_dict
- __init__(**kwargs)¶
Defines parameters as attributes
Methods
__init__
(**kwargs)Defines parameters as attributes
default
(**kwargs)from_dict
(d)from_yaml
(source)Returns instance from a yaml filename or stdin
to_dict
([iterable])Recursive function to return a nested dictionary of the attributes of the class instance.
to_yaml
([path])Returns a yaml stream of the attributes of the class instance.
update
(name, new_value)Update values recursively if name is a dictionary, inject data where found.
- classmethod from_yaml(source: Union[PosixPath, str])¶
Returns instance from a yaml filename or stdin
- to_dict(iterable='null')¶
Recursive function to return a nested dictionary of the attributes of the class instance.
- to_yaml(path: Optional[Union[PosixPath, str]] = None)¶
Returns a yaml stream of the attributes of the class instance. If path is provided, the yaml stream is saved there.
- Parameters
- pathUnion[PosixPath, str]
Output path.
- update(name: str, new_value)¶
Update values recursively if name is a dictionary, inject data where found. It forbids type changes.