mcsas.bases.algorithm.algorithmbase module

class AlgorithmBase

Bases: object

Base class for all data filtering algorithms.

Creates instances from defined parameters and replaces the class attributes accordingly.

factory(*args, **kwargs)

Warning

method ‘bases.algorithm.algorithmbase.AlgorithmBase.factory’ undocumented

hdfWrite(hdf)

Warning

method ‘bases.algorithm.algorithmbase.AlgorithmBase.hdfWrite’ undocumented

classmethod makeDefault()

Warning

method ‘bases.algorithm.algorithmbase.AlgorithmBase.makeDefault’ undocumented

classmethod name()

Warning

method ‘bases.algorithm.algorithmbase.AlgorithmBase.name’ undocumented

param = functools.partial(<function AlgorithmBase.param>, <class 'bases.algorithm.algorithmbase.AlgorithmBase'>)

paramCount = functools.partial(<function AlgorithmBase.paramCount>, <class 'bases.algorithm.algorithmbase.AlgorithmBase'>)

params = functools.partial(<function AlgorithmBase.params>, <class 'bases.algorithm.algorithmbase.AlgorithmBase'>)

classmethod setName(name)

Warning

method ‘bases.algorithm.algorithmbase.AlgorithmBase.setName’ undocumented

setParam = functools.partial(<function AlgorithmBase.setParam>, <class 'bases.algorithm.algorithmbase.AlgorithmBase'>)

classmethod setParams(*parameters)

Expects a list of ParameterBase classes/types and sets them as class attributes to this class. They will become instances later, please see __init__()

showParams

A list of parameter names which defines the parameters and their ordering shown in a UI. To be overridden in sub classes.

update(other)

Copy parameter values from another algorithm of the same type.

exception AlgorithmError

Bases: Exception

exception AlgorithmNameError

Bases: bases.algorithm.algorithmbase.AlgorithmError

exception AlgorithmParameterError

Bases: bases.algorithm.algorithmbase.AlgorithmError

classproperty(func)

Warning

function ‘bases.algorithm.algorithmbase.classproperty’ undocumented