9.3. Algorithms, Widgets and Filters

The algorithm-plugins are containers 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 : str, *args, **kwds, _observer : progressObserver = None) → invoke a filter (or algorithm) function from an algorithm-plugin.

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.

Parameters

name : {str}

The name of the filter

*args : {variant}

positional arguments for the specific filter-method

**kwds : {variant}

keyword-based arguments for the specific filter-method. The argument name ‘observer’ is reserved for special use.

_observer : {progressObserver, optional}

if the called filter implements the extended interface with progress and status information, an optional itom.progressObserver object can be given (only as keyword-based parameter) which is then used as observer for the current progress of the filter execution. It is then also possible to interrupt the execution earlier (depending on the implementation of the filter). The observer object is reset() before passed to the called filter function (using the slot reset()).

Returns

out : {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.

See also

filterHelp

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

This method prints information about one specific filter (algorithm) or a list of filters to the console output. If one specific filter, defined in an algorithm plugin can be found that case-sensitively fits the given filterName its full documentation is printed. Else, a list of filters is printed whose name contains the given filterName.

Parameters

filterName : {str}, optional

is the fullname or a part of any filter-name which should be displayed. If filterName is empty or no filter matches filterName (case sensitive) a list with all suitable filters is given.

dictionary : {dict}, optional

if dictionary == 1, a dictionary with all relevant components of the filter’s documentation is returned and nothing is printed to the command line [default: 0]

furtherInfos : {int}, optional

Usually, filters or algorithms whose name only contains the given filterName are only listed at the end of the information text. If this parameter is set to 1 [default: 0], the full information for all these filters is printed as well.

Returns

out : {None or dict}

In its default parameterization this method returns None. Depending on the parameter dictionary it is also possible that this method returns a dictionary with the single components of the information text.

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

This method prints information about one specific widget or a list of widgets to the console output. If one specific widget, defined in an algorithm plugin can be found that case-sensitively fits the given widgetName its full documentation is printed. Else, a list of widgets is printed whose name contains the given widgetName.

Parameters

widgetName : {str}, optional

is the fullname or a part of any widget-name which should be displayed. If widgetName is empty or no widget matches widgetName (case sensitive) a list with all suitable widgets is given.

dictionary : {dict}, optional

if dictionary == 1, a dictionary with all relevant components of the widget’s documentation is returned and nothing is printed to the command line [default: 0]

furtherInfos : {int}, optional

Usually, widgets whose name only contains the given widgetName are only listed at the end of the information text. If this parameter is set to 1 [default: 0], the full information for all these widgets is printed as well.

Returns

out : {None or dict}

In its default parameterization this method returns None. Depending on the parameter dictionary it is also possible that this method returns a dictionary with the single components of the information text.