postprocessor.core.processes.butter.butterParameters¶
- class butterParameters(**kwargs)[source]¶
Bases:
ParametersABC
Parameters for the ‘butter’ process.
Parameters for the ‘butter’ process.
- Attributes
- orderint
The order of the filter.
- critical_freqsarray_like
The critical frequency or frequencies. For lowpass and highpass filters, Wn is a scalar; for bandpass and bandstop filters, Wn is a length-2 sequence. For a Butterworth filter, this is the point at which the gain drops to 1/sqrt(2) that of the passband (the “-3 dB point”). For digital filters, if fs is not specified, Wn units are normalized from 0 to 1, where 1 is the Nyquist frequency (Wn is thus in half cycles / sample and defined as 2*critical frequencies / fs). If fs is specified, Wn is in the same units as fs. For analog filters, Wn is an angular frequency (e.g. rad/s).
- filter_type{‘lowpass’, ‘highpass’, ‘bandpass’, ‘bandstop’}
The type of filter. Default is ‘lowpass’.
- sampling_freqfloat
The sampling frequency of the digital system.
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, replace data where existing found or add if not.
default
from_dict
Defines parameters as attributes
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, replace data where existing found or add if not.
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, replace data where existing found or add if not.
- classmethod from_yaml(source)¶
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.
- Return type
Dict
- to_yaml(path=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, new_value)¶
Update values recursively if name is a dictionary, replace data where existing found or add if not. It warns against type changes.
If the existing structure under name is a dictionary, it looks for the first occurrence and modifies it accordingly.
If a leaf node that is to be changed is a collection, it adds the new elements.