Algorithms, Widgets and Filters

The algorithm-plugins are container for filters and widgets. They do not have an own instance.

Filters are called by the filter(...)-Methods. To get an online help use filterHelp(...). Widgets are used with ui-dialogs. To get an online help use widgetHelp(...).

itom.filter(name[, furtherParameters, ...]) → invoke a filter (or algorithm) function within an algorithm-plugin.
Parameters :

name : {str}

The name of the filter

furtherParameters : {variant}

Further parameters depend on the filter-methods itself (give the mandatory and then optional parameters in their defined order).

Returns :

output parameters : {variant}

The returned values depend on the definition of each filter. In general it is a tuple of all output parameters that are defined by the filter function.

Notes

This function is used to invoke itom filter-functions or algorithms, declared within itom-algorithm plugins. The parameters (arguments) depends on the specific filter function (see filterHelp(name)), By filterHelp() a list of available filter functions is retrieved.

itom.filterHelp([filterName, dictionary = 0, furtherInfos = 0]) → generates an online help for the given filter(s).

Generates an online help for the given widget or returns a list of available filter.

Parameters :

filterName : {str}, optional

is the fullname or a part of any filter-name which should be displayed. If filterName is none or no filter matches filterName casesensitiv a list with all suitable filters is given.

dictionary : {dict}, optional

if dictionary == 1, function returns an Py_Dictionary with parameters Default value is 0.

furtherInfos : {int}, optional

defines if a complete parameter-list of name-related filters to the given filterName should be displayed (1)

Returns :

Returns none or a PyDictionary depending on the value of dictionary. :

itom.widgetHelp([widgetName, dictionary = 0, furtherInfos = 0]) → generates an online help for the given widget(s).

Generates an online help for the given widget or returns a list of available widgets.

Parameters :

widgetName : {str}, optional

is the fullname or a part of any widget-name which should be displayed. If widgetName is none or no widget matches widgetName casesensitiv a list with all suitable widgets is given.

dictionary : {dict}, optional

if dictionary == 1, function returns an Py_Dictionary with parameters Default value is 0.

furtherInfos : {int}, optional

defines if a complete parameter-list of name-related widgets to the given widgetName should be displayed (1)

Returns :

Returns none or a PyDictionary depending on the value of dictionary. :

Previous topic

actuator

Next topic

figure

This Page