filters module

List of pre-defined filters

Filters in lys.filters

Functions

lys.filters.function.addFilter(filter, filterName=None, gui=None, guiName=None, guiGroup=None)[source]

Add new filter to lys.

Parameters

filter (class that implements FilterInterface) – filter to be added.
filterName (str) – name of filter. If omitted, default name is used.
gui (class that implements FilterSettingBase, and is decorated by filterGUI) – Widget that is used in FilterGUI.
guiName (str) – name of filter in GUI.
guiGroup (str) – name of group in GUI.

lys.filters.function.fromFile(file)[source]

Load filter from .fil file.

Parameters: file (str) – The path to the .fil file
Returns: The filter loaded form the .fil file.
Return type: filter

Example:

from lys import filters

f = filters.IntegralAllFilter(axes=[0], sumtype="Sum") # Create filter
filters.toFile(f, "test.fil")                          # Save filter as file

filt = filters.fromFile("test.fil")                    # Load filter from file
filt.execute(np.ones([3,3]))                           # [3. 3. 3.]

lys.filters.function.fromString(string)[source]

Load filter from string that is generated by toString() function.

Parameters: string (str) – The string that is generated by toString() function.
Returns: The filter loaded form the string.
Return type: filter

Example:

from lys import filters

f = filters.IntegralAllFilter(axes=[0], sumtype="Sum") # Create filter
filter_string = filters.toString(f)                    # Save filter as string

filt = filters.fromString(filter_string)               # Load filter from string
filt.execute(np.ones([3,3]))                           # [3. 3. 3.]

lys.filters.function.fromWave(wave)[source]

Load filter from wave that is automatically saved when filter is applied.

Parameters: wave (Wave) – The wave.
Returns: The filter loaded form the wave.
Return type: filter

Example:

from lys import filters

f = filters.IntegralAllFilter(axes=[0], sumtype="Sum")  # Create filter
result = f.execute(Wave(np.ones([3,3])))                # Execute

filt = filters.fromWave(result)                         # Load filter from wave

lys.filters.function.getFilter(filterName)[source]

Get a filter class from name.

Parameters: name (str) – The name of the filter. See addFilter().
Returns: The filter class
Return type: filterClass

lys.filters.function.toFile(filter, file)[source]

Save filter to .fil file.

Parameters

filter – The filter to be saved.
file – The filepath.

lys.filters.function.toString(filter)[source]

Save filter as file. The filter can be loaded by fromString() function.

Parameters: filter – The filter instance.
Returns: The string containing the information of the filter.
Return type: str

Interfaces

class lys.filters.interface.FilterInterface[source]

Bases: object

FilterInterface is a base class of all filters in lys.

See Adding your original filter for detail.

execute(wave, *args, **kwargs)[source]

Execute filter to wave

Parameters

wave (Wave or DaskWave) – Wave that the filter is applied
*args (any) – additional parameters
*kwargs (any) – additional keyward parameters

getParameters()[source]: Returns parameters used for this filter as dict

getRelativeDimension()[source]: Returns change of dimension for this filter

saveAsFile(file)[source]

Save filter as file. It is recommended to use lys.filters.function.toFile() function to save filter.

Parameters: file (str) – filename

class lys.filters.interface.FilterSettingBase(dimension)[source]

Bases: QWidget

Base class for setting widgets of filters.

See Adding your original filter for detail

GetFilter()[source]

Get a filter instance based on the present state of the widget.

Returns: A filter instance.
Return type: filter

dimensionChanged: Emitted when the dimension of the filter is changed.

getDimension()[source]

Return the dimension of the input data.

Returns: The dimension of the input data.
Return type: dimension(int)

classmethod getFilterClass()[source]

Return the filter class.

Returns: The filter class.
Return type: filterClass

getParameters()[source]

Get the parameters of the filter based on the current state of the widget.

See Adding your original filter for detail

setParameters(**kwargs)[source]

Set the state of the widget based on the keyword arguments. Developers should implement this method to make new filter.

See Adding your original filter for detail

class lys.filters.interface.Filters(filters)[source]

Bases: FilterInterface

The list of filters that can be successively applied.

filters(list of filter): The filters to be applied.

append(obj)[source]

Append the filter to the end.

Parameters: obj (filter) – The filter instance to append.

static fromFile(path)[source]: Do not use this method. Use lys.filters.function.fromFile()

static fromString(data)[source]: Do not use this method. Use lys.filters.function.fromString()

static fromWave(wave)[source]: Load filters automatically saved in wave.

getFilters()[source]

Get filters.

Returns: The list of filters.
Return type: list of filters

getParameters()[source]: Returns parameters used for this filter as dict

getRelativeDimension()[source]: Returns change of dimension for this filter

insert(index, obj)[source]

Insert a filter before the given index.

Parameters

index (int) – Index before which obj is inserted.
obj (filter) – The filter instance to insert.

isEmpty()[source]

Check if the filter is empty.

Returns: True if the filter is empty.
Return type: bool

saveAsFile(path)[source]

Save filter as file. It is recommended to use lys.filters.function.toFile() function to save filter.

Parameters: file (str) – filename

static toString(filter)[source]: Do not use this method. Use lys.filters.function.toString()

lys.filters.interface.filterGUI(filterClass)[source]

Decorator for filter GUI class.

See Adding your original filter for detail

GUI

class lys.filters.filtersGUI.FiltersGUI(dimension=2, parent=None)[source]

Bases: QTreeWidget

The GUI by which users can make list of filters.

This widget can be embedded in any Qt layout.

Parameters

dimension (int) – The dimension of the input data.
parent (QWidget) – The parent widget

clear()[source]: Clear all filters in GUI.

getFilters()[source]

Get filters based on the current state of the GUI.

Returns: The filters.
Return type: Filters

setDimension(dimension)[source]

Set the dimension of the input data.

Parameters: dimension (int) – The dimension of the input data.

setFilters(filt)[source]

Set filters to the GUI.

Parameters: filt (Filters) – The filters set.