cycle_filter
CycleFilter
Class for filtering a cycle based on a parameter value (e.g. cycle length or cycle weight) It is possible to filter values equal to the parameter value, lower, higher than the parameter value or filter out the n lowest or n highest cycles, in this case n is the parameter value. In case of average, the closest value to the average is taken.
cycles = cycles
instance-attribute
mode = None
instance-attribute
parameter = None
instance-attribute
__init__(cycles)
filter(value)
Filter cycles by condition value and mode (see CycleFilter.set_mode).
Example
If parameter = 'cycle_lenght', mode = 'less', value = 20
Only cycles with a length smaller than 20 will remain.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value |
number
|
Parameter value for filtering. |
required |
Returns:
| Type | Description |
|---|---|
DataFrame
|
pd.Datagrame: Indices of cycles to keep |
set_mode(mode)
Five modes are available: equal - Filter out cycles with parameter equal to value. not_equal - Filter out cycles with parameter not equal to value. greater - Filter out cycles with parameter greater than value. less - Filter out cycles with parameter less than value. n_lowest - Filter out value number of cycles with the lowest parameter value. n_highest - Filter out value number of cycles with the lowest parameter value.